[gtkmm/gtkmm-2-24] Regenerated the XML files containing the C API documentation.
- From: Murray Cumming <murrayc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtkmm/gtkmm-2-24] Regenerated the XML files containing the C API documentation.
- Date: Fri, 14 Jan 2011 13:28:29 +0000 (UTC)
commit a315b6ba3bbea02d811847e7318c80248180b366
Author: Murray Cumming <murrayc murrayc com>
Date: Fri Jan 14 13:57:08 2011 +0100
Regenerated the XML files containing the C API documentation.
* gdk/src/gdk_docs.xml:
* gtk/src/gtk_docs.xml: Regenerated with docextract_to_xml.py.
ChangeLog | 7 +
gdk/src/gdk_docs.xml |17431 +++++++------
gtk/src/gtk_docs.xml |72609 +++++++++++++++++++++++++-------------------------
3 files changed, 45479 insertions(+), 44568 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index cc90abe..61f6907 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,12 @@
2011-01-14 Murray Cumming <murrayc murrayc com>
+ Regenerated the XML files containing the C API documentation.
+
+ * gdk/src/gdk_docs.xml:
+ * gtk/src/gtk_docs.xml: Regenerated with docextract_to_xml.py.
+
+2011-01-14 Murray Cumming <murrayc murrayc com>
+
Added to *-extra_objects.defs to improve the generated documentation.
* gdk/src/gdk_extra_objects.defs:
diff --git a/gdk/src/gdk_docs.xml b/gdk/src/gdk_docs.xml
index a4daa77..15e3c58 100644
--- a/gdk/src/gdk_docs.xml
+++ b/gdk/src/gdk_docs.xml
@@ -1,29 +1,4 @@
<root>
-<function name="gdk_char_height">
-<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.
-
-</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 height of the character in pixels.
-
-</return>
-</function>
-
<function name="gdk_add_client_message_filter">
<description>
Adds a filter to the default display to be called when X ClientMessage events
@@ -49,314 +24,131 @@ XClientMessage event struct.
<return></return>
</function>
-<function name="gdk_display_get_screen">
-<description>
-Returns a screen object for one of the screens of the display.
-
-Since: 2.2
-
-</description>
-<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
-</parameter_description>
-</parameter>
-<parameter name="screen_num">
-<parameter_description> the screen number
-</parameter_description>
-</parameter>
-</parameters>
-<return> the #GdkScreen object
-
-</return>
-</function>
-
-<function name="gdk_x11_screen_get_xscreen">
-<description>
-Returns the screen of a #GdkScreen.
-
-Since: 2.2
-
-</description>
-<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen.
-</parameter_description>
-</parameter>
-</parameters>
-<return> an Xlib <type>Screen*</type>
-</return>
-</function>
-
-<function name="gdk_selection_send_notify_for_display">
+<function name="gdk_add_option_entries_libgtk_only">
<description>
-Send a response to SelectionRequest event.
-
-Since: 2.2
+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="display">
-<parameter_description> the #GdkDisplay where @requestor is realized
-</parameter_description>
-</parameter>
-<parameter name="requestor">
-<parameter_description> window to which to deliver response.
-</parameter_description>
-</parameter>
-<parameter name="selection">
-<parameter_description> selection that was requested.
-</parameter_description>
-</parameter>
-<parameter name="target">
-<parameter_description> target that was selected.
-</parameter_description>
-</parameter>
-<parameter name="property">
-<parameter_description> property in which the selection owner stored the data,
-or %GDK_NONE to indicate that the request was rejected.
-</parameter_description>
-</parameter>
-<parameter name="time_">
-<parameter_description> timestamp.
+<parameter name="group">
+<parameter_description> An option group.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_move_region">
+<function name="gdk_app_launch_context_new">
<description>
-Move the part of @window indicated by @region by @dy pixels in the Y
-direction and @dx pixels in the X direction. The portions of @region
-that not covered by the new position of @region are invalidated.
-
-Child windows are not moved.
+Creates a new #GdkAppLaunchContext.
-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_description>
-</parameter>
-<parameter name="dy">
-<parameter_description> Amount to move in the Y direction
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
-</function>
-
-<function name="gdk_screen_width">
-<description>
-Returns the width of the default screen in pixels.
-
+<return> a new #GdkAppLaunchContext
-</description>
-<parameters>
-</parameters>
-<return> the width of the default screen in pixels.
</return>
</function>
-<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.
-
-Deprecated: 2.22: Use Cairo for rendering.
-
-</description>
-<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
-</parameter_description>
-</parameter>
-<parameter name="values">
-<parameter_description> the #GdkGCValues structure in which to store the results.
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gdk_region_point_in">
+<function name="gdk_app_launch_context_set_desktop">
<description>
-Finds out if a point is in a region.
-
+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>.
-</description>
-<parameters>
-<parameter name="region">
-<parameter_description> a #GdkRegion
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> the x coordinate of a point
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> the y coordinate of a point
-</parameter_description>
-</parameter>
-</parameters>
-<return> %TRUE if the point is in @region.
-</return>
-</function>
+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.
-<function name="gdk_colors_free">
-<description>
-Frees colors allocated with gdk_colors_alloc(). This
-function is obsolete. See gdk_colormap_free_colors().
+Since: 2.14
</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="context">
+<parameter_description> a #GdkAppLaunchContext
</parameter_description>
</parameter>
-<parameter name="planes">
-<parameter_description> the plane masks for all planes to free, OR'd together.
+<parameter name="desktop">
+<parameter_description> the number of a workspace, or -1
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_pixmap_create_from_xpm">
+<function name="gdk_app_launch_context_set_display">
<description>
-Create a pixmap from a XPM file.
+Sets the display on which applications will be launched when
+using this context. See also gdk_app_launch_context_set_screen().
-Deprecated: 2.22: Use a #GdkPixbuf instead. You can use
-gdk_pixbuf_new_from_file() to create it.
-If you must use a pixmap, use gdk_pixmap_new() to
-create it and Cairo to draw the pixbuf onto it.
+Since: 2.14
</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 name="context">
+<parameter_description> a #GdkAppLaunchContext
</parameter_description>
</parameter>
-<parameter name="filename">
-<parameter_description> the filename of a file containing XPM data.
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkPixmap
-
-</return>
+<return></return>
</function>
-<function name="gdk_x11_cursor_get_xcursor">
+<function name="gdk_app_launch_context_set_icon">
<description>
-Returns the X cursor belonging to a #GdkCursor.
-
+Sets the icon for applications that are launched with this
+context.
-</description>
-<parameters>
-<parameter name="cursor">
-<parameter_description> a #GdkCursor.
-</parameter_description>
-</parameter>
-</parameters>
-<return> an Xlib <type>Cursor</type>.
-</return>
-</function>
+Window Managers can use this information when displaying startup
+notification.
-<function name="gdk_drag_status">
-<description>
-Selects one of the actions offered by the drag source.
+See also gdk_app_launch_context_set_icon_name().
-This function is called by the drag destination in response to
-gdk_drag_motion() called by the drag source.
+Since: 2.14
</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> a #GdkAppLaunchContext
</parameter_description>
</parameter>
-<parameter name="time_">
-<parameter_description> the timestamp for this operation.
+<parameter name="icon">
+<parameter_description> a #GIcon, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_shape_combine_mask">
+<function name="gdk_app_launch_context_set_icon_name">
<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.
+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().
-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.
+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.
-This function works on both toplevel and child windows.
+Since: 2.14
</description>
<parameters>
-<parameter name="window">
-<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 name="context">
+<parameter_description> a #GdkAppLaunchContext
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> Y position of shape mask with respect to @window
+<parameter name="icon_name">
+<parameter_description> an icon name, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -388,324 +180,313 @@ Since: 2.14
<return></return>
</function>
-<function name="gdk_event_get">
+<function name="gdk_app_launch_context_set_timestamp">
<description>
-Checks all open displays for a #GdkEvent to process,to be processed
-on, fetching events from the windowing system if necessary.
-See gdk_display_get_event().
-
-
-</description>
-<parameters>
-</parameters>
-<return> the next #GdkEvent to be processed, or %NULL if no events
-are pending. The returned #GdkEvent should be freed with gdk_event_free().
-</return>
-</function>
+Sets the timestamp of @context. The timestamp should ideally
+be taken from the event that triggered the launch.
-<function name="gdk_gc_set_clip_rectangle">
-<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()).
+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'.
-Deprecated: 2.22: Use cairo_rectangle() and cairo_clip() in Cairo.
+Since: 2.14
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
+<parameter name="context">
+<parameter_description> a #GdkAppLaunchContext
</parameter_description>
</parameter>
-<parameter name="rectangle">
-<parameter_description> the rectangle to clip to.
+<parameter name="timestamp">
+<parameter_description> a timestamp
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_display_get_default_group">
+<function name="gdk_atom_intern_static_string">
<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().
+Finds or creates an atom corresponding to a given string.
-Since: 2.4
+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="display">
-<parameter_description> a #GdkDisplay
+<parameter name="atom_name">
+<parameter_description> a static string
</parameter_description>
</parameter>
</parameters>
-<return> The default group leader window for @display
+<return> the atom corresponding to @atom_name
</return>
</function>
-<function name="gdk_gc_new_with_values">
+<function name="gdk_beep">
<description>
-Create a new GC with the given initial values.
-
-Deprecated: 2.22: Use Cairo for rendering.
+Emits a short beep on the default display.
</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_description>
-</parameter>
-<parameter name="values_mask">
-<parameter_description> a bit mask indicating which fields in @values
-are set.
-</parameter_description>
-</parameter>
</parameters>
-<return> the new graphics context.
-
-</return>
+<return></return>
</function>
-<function name="gdk_image_get_visual">
+<function name="gdk_cairo_create">
<description>
-Determines the visual that was used to create the image.
+Creates a Cairo context for drawing to @drawable.
-Since: 2.22
+<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>
-Deprecated: 2.22: #GdkImage should not be used anymore.
+Since: 2.8
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GdkImage
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkVisual
+<return> A newly created Cairo context. Free with
+cairo_destroy() when you are done drawing.
</return>
</function>
-<function name="gdk_drag_context_unref">
+<function name="gdk_cairo_rectangle">
<description>
-Deprecated function; use g_object_unref() instead.
+Adds the given rectangle to the current path of @cr.
-Deprecated: 2.2: Use g_object_unref() instead.
+Since: 2.8
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GdkDragContext.
+<parameter name="cr">
+<parameter_description> a #cairo_t
+</parameter_description>
+</parameter>
+<parameter name="rectangle">
+<parameter_description> a #GdkRectangle
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_pango_renderer_set_gc">
+<function name="gdk_cairo_region">
<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.
+Adds the given region to the current path of @cr.
-Since: 2.6
+Since: 2.8
</description>
<parameters>
-<parameter name="gdk_renderer">
-<parameter_description> a #GdkPangoRenderer
+<parameter name="cr">
+<parameter_description> a #cairo_t
</parameter_description>
</parameter>
-<parameter name="gc">
-<parameter_description> the new GC to use for drawing, or %NULL
+<parameter name="region">
+<parameter_description> a #GdkRegion
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_spawn_on_screen_with_pipes">
+<function name="gdk_cairo_reset_clip">
<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.
+Resets the clip region for a Cairo context created by gdk_cairo_create().
-This is useful for applications which wish to launch an application
-on a specific screen.
+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.
-Since: 2.4
+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.
+
+Since: 2.18
</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_description>
-</parameter>
-<parameter name="standard_output">
-<parameter_description> return location for file descriptor to read child's
-stdout, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="standard_error">
-<parameter_description> return location for file descriptor to read child's
-stderr, or %NULL
+<parameter name="cr">
+<parameter_description> a #cairo_t
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for error
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable
</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_cairo_set_source_color">
<description>
-Get the default #GdkScreen for @display.
+Sets the specified #GdkColor as the source color of @cr.
-Since: 2.2
+Since: 2.8
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="cr">
+<parameter_description> a #cairo_t
+</parameter_description>
+</parameter>
+<parameter name="color">
+<parameter_description> a #GdkColor
</parameter_description>
</parameter>
</parameters>
-<return> the default #GdkScreen object for @display
-
-</return>
+<return></return>
</function>
-<function name="gdk_screen_height">
+<function name="gdk_cairo_set_source_pixbuf">
<description>
-Returns the height of the default screen in pixels.
+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
+Since: 2.8
</description>
<parameters>
+<parameter name="cr">
+<parameter_description> a #Cairo context
+</parameter_description>
+</parameter>
+<parameter name="pixbuf">
+<parameter_description> a #GdkPixbuf
+</parameter_description>
+</parameter>
+<parameter name="pixbuf_x">
+<parameter_description> X coordinate of location to place upper left corner of @pixbuf
+</parameter_description>
+</parameter>
+<parameter name="pixbuf_y">
+<parameter_description> Y coordinate of location to place upper left corner of @pixbuf
+</parameter_description>
+</parameter>
</parameters>
-<return> the height of the default screen in pixels.
-</return>
+<return></return>
</function>
-<function name="gdk_window_new">
+<function name="gdk_cairo_set_source_pixmap">
<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.
+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
+
+Since: 2.10
+Deprecated: 2.24: This function is being removed in GTK+ 3 (together
+with #GdkPixmap). Instead, use gdk_cairo_set_source_window() where
+appropriate.
</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 name="cr">
+<parameter_description> a #Cairo context
</parameter_description>
</parameter>
-<parameter name="attributes">
-<parameter_description> attributes of the new window
+<parameter name="pixmap">
+<parameter_description> a #GdkPixmap
</parameter_description>
</parameter>
-<parameter name="attributes_mask">
-<parameter_description> mask indicating which fields in @attributes are valid
+<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_description>
</parameter>
</parameters>
-<return> the new #GdkWindow
-</return>
+<return></return>
</function>
-<function name="gdk_window_get_update_area">
+<function name="gdk_cairo_set_source_window">
<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.
+Sets the given window 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 @window is @x, @y. The window contains all its
+subwindows when rendering.
+
+Note that the contents of @window are undefined outside of the
+visible part of @window, so use this function with care.
+Since: 2.24
</description>
<parameters>
+<parameter name="cr">
+<parameter_description> a #Cairo context
+</parameter_description>
+</parameter>
<parameter name="window">
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
+<parameter name="x">
+<parameter_description> X coordinate of location to place upper left corner of @window
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> Y coordinate of location to place upper left corner of @window
+</parameter_description>
+</parameter>
</parameters>
-<return> the update area for @window
-</return>
+<return></return>
</function>
-<function name="gdk_colormap_ref">
+<function name="gdk_char_height">
<description>
-Deprecated function; use g_object_ref() instead.
+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.0: Use g_object_ref() instead.
+Deprecated: 2.2: Use gdk_text_extents() instead.
</description>
<parameters>
-<parameter name="cmap">
-<parameter_description> a #GdkColormap
+<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 colormap
+<return> the height of the character in pixels.
</return>
</function>
-<function name="gdk_font_unref">
+<function name="gdk_char_measure">
<description>
-Decreases the reference count of a font by one.
-If the result is zero, destroys the font.
+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.
+
</description>
<parameters>
@@ -713,279 +494,274 @@ If the result is zero, destroys the font.
<parameter_description> a #GdkFont
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gdk_offscreen_window_get_pixmap">
-<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.
-
-Since: 2.18
-
-</description>
-<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="character">
+<parameter_description> the character to measure.
</parameter_description>
</parameter>
</parameters>
-<return> The offscreen pixmap, or %NULL if not offscreen
-
+<return> the right bearing of the character in pixels.
</return>
</function>
-<function name="gdk_window_foreign_new_for_display">
+<function name="gdk_char_width">
<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>.
+Determines the width of a given character.
-Since: 2.2
+Deprecated: 2.2: Use gdk_text_extents() instead.
</description>
<parameters>
-<parameter name="display">
-<parameter_description> the #GdkDisplay where the window handle comes from.
+<parameter name="font">
+<parameter_description> a #GdkFont
</parameter_description>
</parameter>
-<parameter name="anid">
-<parameter_description> a native window handle.
+<parameter name="character">
+<parameter_description> the character to measure.
</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> the width of the character in pixels.
</return>
</function>
-<function name="gdk_window_get_focus_on_map">
+<function name="gdk_char_width_wc">
<description>
-Determines whether or not the desktop environment should be hinted that the
-window does not want to receive input focus when it is mapped.
+Determines the width of a given wide character. (Encoded
+in the wide-character encoding of the current locale).
-Since: 2.22
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow.
+<parameter name="font">
+<parameter_description> a #GdkFont
+</parameter_description>
+</parameter>
+<parameter name="character">
+<parameter_description> the character to measure.
</parameter_description>
</parameter>
</parameters>
-<return> whether or not the window wants to receive input focus when
-it is mapped.
-
+<return> the width of the character in pixels.
</return>
</function>
-<function name="gdk_pango_attr_emboss_color_new">
+<function name="gdk_color_alloc">
<description>
-Creates a new attribute specifying the color to emboss text with.
+Allocates a single color from a colormap.
-Since: 2.12
+Deprecated: 2.2: Use gdk_colormap_alloc_color() instead.
</description>
<parameters>
+<parameter name="colormap">
+<parameter_description> a #GdkColormap.
+</parameter_description>
+</parameter>
<parameter name="color">
-<parameter_description> a GdkColor representing the color to emboss with
+<parameter_description> The color to allocate. On return, the
+<structfield>pixel</structfield> field will be filled in.
</parameter_description>
</parameter>
</parameters>
-<return> new #PangoAttribute
+<return> %TRUE if the allocation succeeded.
</return>
</function>
-<function name="gdk_x11_drawable_get_xdisplay">
+<function name="gdk_color_black">
<description>
-Returns the display of a #GdkDrawable.
+Returns the black color for a given colormap. The resulting
+value has already been allocated.
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable.
+<parameter name="colormap">
+<parameter_description> a #GdkColormap.
+</parameter_description>
+</parameter>
+<parameter name="color">
+<parameter_description> the location to store the color.
</parameter_description>
</parameter>
</parameters>
-<return> an Xlib <type>Display*</type>.
+<return> %TRUE if the allocation succeeded.
</return>
</function>
-<function name="gdk_utf8_to_string_target">
+<function name="gdk_color_change">
<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.
+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.
</description>
<parameters>
-<parameter name="str">
-<parameter_description> a UTF-8 string
+<parameter name="colormap">
+<parameter_description> a #GdkColormap.
+</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_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> %TRUE if the color was successfully changed.
</return>
</function>
-<function name="gdk_display_get_default_cursor_size">
+<function name="gdk_color_copy">
<description>
-Returns the default size to use for cursors on @display.
+Makes a copy of a color structure. The result
+must be freed using gdk_color_free().
-Since: 2.4
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="color">
+<parameter_description> a #GdkColor.
</parameter_description>
</parameter>
</parameters>
-<return> the default cursor size.
-
+<return> a copy of @color.
</return>
</function>
-<function name="gdk_drag_context_list_targets">
+<function name="gdk_color_equal">
<description>
-Retrieves the list of targets of the context.
+Compares two colors.
-Since: 2.22
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GdkDragContext
+<parameter name="colora">
+<parameter_description> a #GdkColor.
+</parameter_description>
+</parameter>
+<parameter name="colorb">
+<parameter_description> another #GdkColor.
</parameter_description>
</parameter>
</parameters>
-<return> a #GList of targets
-
+<return> %TRUE if the two colors compare equal
</return>
</function>
-<function name="gdk_device_get_source">
+<function name="gdk_color_free">
<description>
-Determines the type of the device.
-
-Since: 2.22
+Frees a color structure created with
+gdk_color_copy().
</description>
<parameters>
-<parameter name="device">
-<parameter_description> a #GdkDevice
+<parameter name="color">
+<parameter_description> a #GdkColor.
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkInputSource
-
-</return>
+<return></return>
</function>
-<function name="gdk_set_pointer_hooks">
+<function name="gdk_color_hash">
<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 is not multihead safe. For multihead operation,
-see gdk_display_set_pointer_hooks().
+A hash function suitable for using for a hash
+table that stores #GdkColor's.
</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="colora">
+<parameter_description> a #GdkColor.
</parameter_description>
</parameter>
</parameters>
-<return> the previous pointer hook table
+<return> The hash function applied to @colora
</return>
</function>
-<function name="gdk_display_set_double_click_distance">
+<function name="gdk_color_parse">
<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.
+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')
-Since: 2.4
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="spec">
+<parameter_description> the string specifying the color.
</parameter_description>
</parameter>
-<parameter name="distance">
-<parameter_description> distance in pixels
+<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_screen_get_number">
+<function name="gdk_color_to_string">
<description>
-Gets the index of @screen among the screens in the display
-to which it belongs. (See gdk_screen_get_display())
+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.2
+Since: 2.12
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="color">
+<parameter_description> a #GdkColor
</parameter_description>
</parameter>
</parameters>
-<return> the index
+<return> a newly-allocated text string
</return>
</function>
-<function name="gdk_device_get_mode">
+<function name="gdk_color_white">
<description>
-Determines the mode of the device.
+Returns the white color for a given colormap. The resulting
+value has already allocated been allocated.
-Since: 2.22
</description>
<parameters>
-<parameter name="device">
-<parameter_description> a #GdkDevice
+<parameter name="colormap">
+<parameter_description> a #GdkColormap.
+</parameter_description>
+</parameter>
+<parameter name="color">
+<parameter_description> the location to store the color.
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkInputSource
-
+<return> %TRUE if the allocation succeeded.
</return>
</function>
-<function name="gdk_colormap_free_colors">
+<function name="gdk_colormap_alloc_color">
<description>
-Frees previously allocated colors.
+Allocates a single color from a colormap.
+
</description>
<parameters>
@@ -993,346 +769,329 @@ Frees previously allocated colors.
<parameter_description> a #GdkColormap.
</parameter_description>
</parameter>
-<parameter name="colors">
-<parameter_description> the colors to free.
+<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="n_colors">
-<parameter_description> the number of colors in @colors.
+<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_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the allocation succeeded.
+</return>
</function>
-<function name="gdk_test_simulate_key">
+<function name="gdk_colormap_alloc_colors">
<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.
+Allocates colors from a colormap.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> Gdk window to simulate a key event for.
+<parameter name="colormap">
+<parameter_description> a #GdkColormap.
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> x coordinate within @window for the key event.
+<parameter name="colors">
+<parameter_description> The color values to allocate. On return, the pixel
+values for allocated colors will be filled in.
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> y coordinate within @window for the key event.
+<parameter name="n_colors">
+<parameter_description> The number of colors in @colors.
</parameter_description>
</parameter>
-<parameter name="keyval">
-<parameter_description> A Gdk keyboard value.
+<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_description>
</parameter>
-<parameter name="modifiers">
-<parameter_description> Keyboard modifiers the event is setup with.
+<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_description>
</parameter>
-<parameter name="key_pressrelease">
-<parameter_description> either %GDK_KEY_PRESS or %GDK_KEY_RELEASE
+<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.
</parameter_description>
</parameter>
</parameters>
-<return> wether all actions neccessary for a key event simulation were carried out successfully.
+<return> The number of colors that were not successfully
+allocated.
</return>
</function>
-<function name="gdk_x11_window_set_user_time">
+<function name="gdk_colormap_change">
<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.
-
-Since: 2.6
+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().
</description>
<parameters>
-<parameter name="window">
-<parameter_description> A toplevel #GdkWindow
+<parameter name="colormap">
+<parameter_description> a #GdkColormap.
</parameter_description>
</parameter>
-<parameter name="timestamp">
-<parameter_description> An XServer timestamp to which the property should be set
+<parameter name="ncolors">
+<parameter_description> the number of colors to change.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_configure_finished">
+<function name="gdk_colormap_free_colors">
<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 previously allocated colors.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter name="colormap">
+<parameter_description> a #GdkColormap.
+</parameter_description>
+</parameter>
+<parameter name="colors">
+<parameter_description> the colors to free.
+</parameter_description>
+</parameter>
+<parameter name="n_colors">
+<parameter_description> the number of colors in @colors.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_screen_get_n_monitors">
+<function name="gdk_colormap_get_screen">
<description>
-Returns the number of monitors which @screen consists of.
+Gets the screen for which this colormap was created.
Since: 2.2
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="cmap">
+<parameter_description> a #GdkColormap
</parameter_description>
</parameter>
</parameters>
-<return> number of monitors which @screen consists of
+<return> the screen for which this colormap was created.
</return>
</function>
-<function name="gdk_screen_get_setting">
+<function name="gdk_colormap_get_system">
<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.
+Gets the system's default colormap for the default screen. (See
+gdk_colormap_get_system_for_screen ())
-Since: 2.2
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> the #GdkScreen where the setting is located
-</parameter_description>
-</parameter>
-<parameter name="name">
-<parameter_description> the name of the setting
-</parameter_description>
-</parameter>
-<parameter name="value">
-<parameter_description> location to store the value of the setting
-</parameter_description>
-</parameter>
</parameters>
-<return> %TRUE if the setting existed and a value was stored
-in @value, %FALSE otherwise.
-
+<return> the default colormap.
</return>
</function>
-<function name="gdk_image_get_pixels">
+<function name="gdk_colormap_get_system_size">
<description>
-Returns a pointer to the pixel data of the image.
-
-Since: 2.22
+Returns the size of the system's default colormap.
+(See the description of struct #GdkColormap for an
+explanation of the size of a colormap.)
-Deprecated: 2.22: #GdkImage should not be used anymore.
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GdkImage
-</parameter_description>
-</parameter>
</parameters>
-<return> the pixel data of the image
-
+<return> the size of the system's default colormap.
</return>
</function>
-<function name="gdk_keymap_get_for_display">
+<function name="gdk_colormap_get_visual">
<description>
-Returns the #GdkKeymap attached to @display.
+Returns the visual for which a given colormap was created.
-Since: 2.2
</description>
<parameters>
-<parameter name="display">
-<parameter_description> the #GdkDisplay.
+<parameter name="colormap">
+<parameter_description> a #GdkColormap.
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkKeymap attached to @display.
+<return> the visual of the colormap.
</return>
</function>
-<function name="gdk_font_equal">
+<function name="gdk_colormap_new">
<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.
+Creates a new colormap for the given visual.
</description>
<parameters>
-<parameter name="fonta">
-<parameter_description> a #GdkFont.
+<parameter name="visual">
+<parameter_description> a #GdkVisual.
</parameter_description>
</parameter>
-<parameter name="fontb">
-<parameter_description> another #GdkFont.
+<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_description>
</parameter>
</parameters>
-<return> %TRUE if the fonts are equal.
+<return> the new #GdkColormap.
</return>
</function>
-<function name="gdk_gc_set_tile">
+<function name="gdk_colormap_query_color">
<description>
-Set a tile pixmap for a graphics context.
-This will only be used if the fill mode
-is %GDK_TILED.
+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.
-Deprecated: 2.22: The following code snippet sets a tiling #GdkPixmap
-as the source in Cairo:
-|[gdk_cairo_set_source_pixmap (cr, tile, ts_origin_x, ts_origin_y);
-cairo_pattern_set_extend (cairo_get_source (cr), CAIRO_EXTEND_REPEAT);]|
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
+<parameter name="colormap">
+<parameter_description> a #GdkColormap
</parameter_description>
</parameter>
-<parameter name="tile">
-<parameter_description> the new tile pixmap.
+<parameter name="pixel">
+<parameter_description> pixel value in hardware display format
+</parameter_description>
+</parameter>
+<parameter name="result">
+<parameter_description> #GdkColor with red, green, blue fields initialized
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_x11_gc_get_xgc">
+<function name="gdk_colormap_ref">
<description>
-Returns the X GC of a #GdkGC.
+Deprecated function; use g_object_ref() instead.
-Deprecated: 2.22: #GdkGC has been replaced by #cairo_t.
+Deprecated: 2.0: Use g_object_ref() instead.
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
+<parameter name="cmap">
+<parameter_description> a #GdkColormap
</parameter_description>
</parameter>
</parameters>
-<return> an Xlib <type>GC</type>.
+<return> the colormap
</return>
</function>
-<function name="gdk_gc_set_rgb_fg_color">
+<function name="gdk_colormap_unref">
<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.
-
-Calling this function for a GC without a colormap is an error.
+Deprecated function; use g_object_unref() instead.
-Deprecated: 2.22: Use gdk_cairo_set_source_color() instead.
+Deprecated: 2.0: Use g_object_unref() instead.
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC
-</parameter_description>
-</parameter>
-<parameter name="color">
-<parameter_description> an unallocated #GdkColor.
+<parameter name="cmap">
+<parameter_description> a #GdkColormap
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_begin_move_drag">
+<function name="gdk_colors_alloc">
<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.
+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>.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter name="colormap">
+<parameter_description> a #GdkColormap.
</parameter_description>
</parameter>
-<parameter name="button">
-<parameter_description> the button being used to drag
+<parameter name="contiguous">
+<parameter_description> if %TRUE, the colors should be allocated
+in contiguous color cells.
</parameter_description>
</parameter>
-<parameter name="root_x">
-<parameter_description> root window X coordinate of mouse click that began the drag
+<parameter name="planes">
+<parameter_description> an array in which to store the plane masks.
</parameter_description>
</parameter>
-<parameter name="root_y">
-<parameter_description> root window Y coordinate of mouse click that began the drag
+<parameter name="nplanes">
+<parameter_description> the number of planes to allocate. (Or zero,
+to indicate that the color allocation should not be planar.)
</parameter_description>
</parameter>
-<parameter name="timestamp">
-<parameter_description> timestamp of mouse click that began the drag
+<parameter name="pixels">
+<parameter_description> an array into which to store allocated pixel values.
+</parameter_description>
+</parameter>
+<parameter name="npixels">
+<parameter_description> the number of pixels in each plane to allocate.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the allocation was successful
+</return>
</function>
-<function name="gdk_visual_get_best_depth">
+<function name="gdk_colors_free">
<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.
-
+Frees colors allocated with gdk_colors_alloc(). This
+function is obsolete. See gdk_colormap_free_colors().
</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_description>
+</parameter>
+<parameter name="planes">
+<parameter_description> the plane masks for all planes to free, OR'd together.
+</parameter_description>
+</parameter>
</parameters>
-<return> best available depth
-</return>
+<return></return>
</function>
<function name="gdk_colors_store">
@@ -1359,164 +1118,355 @@ should not be used. See gdk_color_change().
<return></return>
</function>
-<function name="gdk_font_from_description_for_display">
+<function name="gdk_cursor_get_cursor_type">
<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.
+Returns the cursor type for this cursor.
-Since: 2.2
+Since: 2.22
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="cursor">
+<parameter_description> a #GdkCursor
</parameter_description>
</parameter>
-<parameter name="font_desc">
-<parameter_description> a #PangoFontDescription.
+</parameters>
+<return> a #GdkCursorType
+
+</return>
+</function>
+
+<function name="gdk_cursor_get_display">
+<description>
+Returns the display on which the #GdkCursor is defined.
+
+Since: 2.2
+
+</description>
+<parameters>
+<parameter name="cursor">
+<parameter_description> a #GdkCursor.
</parameter_description>
</parameter>
</parameters>
-<return> the newly loaded font, or %NULL if the font
-cannot be loaded.
+<return> the #GdkDisplay associated to @cursor
</return>
</function>
-<function name="gdk_set_double_click_time">
+<function name="gdk_cursor_get_image">
<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 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="msec">
-<parameter_description> double click time in milliseconds (thousandths of a second)
+<parameter name="cursor">
+<parameter_description> a #GdkCursor
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #GdkPixbuf representing @cursor, or %NULL
+
+</return>
</function>
-<function name="gdk_font_load">
+<function name="gdk_cursor_new">
<description>
-Loads a font.
+Creates a new cursor from the set of builtin cursors for the default display.
+See gdk_cursor_new_for_display().
-The font may be newly loaded or looked up the font in a cache.
-You should make no assumptions about the initial reference count.
+To make the cursor invisible, use %GDK_BLANK_CURSOR.
</description>
<parameters>
-<parameter name="font_name">
-<parameter_description> a XLFD describing the font to load.
+<parameter name="cursor_type">
+<parameter_description> cursor to create
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkFont, or %NULL if the font could not be loaded.
+<return> a new #GdkCursor
</return>
</function>
-<function name="gdk_region_spans_intersect_foreach">
+<function name="gdk_cursor_new_for_display">
<description>
-Calls a function on each span in the intersection of @region and @spans.
+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>
-Deprecated: 2.22: There is no replacement.
+Since: 2.2
</description>
<parameters>
-<parameter name="region">
-<parameter_description> a #GdkRegion
+<parameter name="display">
+<parameter_description> the #GdkDisplay for which the cursor will be created
</parameter_description>
</parameter>
-<parameter name="spans">
-<parameter_description> an array of #GdkSpans
+<parameter name="cursor_type">
+<parameter_description> cursor to create
</parameter_description>
</parameter>
-<parameter name="n_spans">
-<parameter_description> the length of @spans
+</parameters>
+<return> a new #GdkCursor
+
+</return>
+</function>
+
+<function name="gdk_cursor_new_from_name">
+<description>
+Creates a new cursor by looking up @name in the current cursor
+theme.
+
+Since: 2.8
+
+</description>
+<parameters>
+<parameter name="display">
+<parameter_description> the #GdkDisplay for which the cursor will be created
</parameter_description>
</parameter>
-<parameter name="sorted">
-<parameter_description> %TRUE if @spans is sorted wrt. the y coordinate
+<parameter name="name">
+<parameter_description> the name of the cursor
</parameter_description>
</parameter>
-<parameter name="function">
-<parameter_description> function to call on each span in the intersection
+</parameters>
+<return> a new #GdkCursor, or %NULL if there is no cursor with
+the given name
+
+</return>
+</function>
+
+<function name="gdk_cursor_new_from_pixbuf">
+<description>
+Creates a new cursor from a pixbuf.
+
+Not all GDK backends support RGBA cursors. If they are not
+supported, a monochrome approximation will be displayed.
+The functions gdk_display_supports_cursor_alpha() and
+gdk_display_supports_cursor_color() can be used to determine
+whether RGBA cursors are supported;
+gdk_display_get_default_cursor_size() and
+gdk_display_get_maximal_cursor_size() give information about
+cursor sizes.
+
+If @x or @y are <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)
+
+On the X backend, support for RGBA cursors requires a
+sufficently new version of the X Render extension.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="display">
+<parameter_description> the #GdkDisplay for which the cursor will be created
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to pass to @function
+<parameter name="pixbuf">
+<parameter_description> the #GdkPixbuf containing the cursor image
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> the horizontal offset of the 'hotspot' of the cursor.
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> the vertical offset of the 'hotspot' of the cursor.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GdkCursor.
+
+</return>
</function>
-<function name="gdk_image_get_byte_order">
+<function name="gdk_cursor_new_from_pixmap">
<description>
-Determines the byte order of the image.
+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.
-Since: 2.22
+<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>
-Deprecated: 2.22: #GdkImage should not be used anymore.
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GdkImage
+<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_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_description>
+</parameter>
+<parameter name="x">
+<parameter_description> the horizontal offset of the 'hotspot' of the cursor.
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> the vertical offset of the 'hotspot' of the cursor.
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkVisual
-
+<return> a new #GdkCursor.
</return>
</function>
-<function name="gdk_display_get_name">
+<function name="gdk_cursor_ref">
<description>
-Gets the name of the display.
+Adds a reference to @cursor.
-Since: 2.2
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="cursor">
+<parameter_description> a #GdkCursor
</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> Same @cursor that was passed in
</return>
</function>
-<function name="gdk_rectangle_union">
+<function name="gdk_cursor_unref">
<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.
+Removes a reference from @cursor, deallocating the cursor
+if no references remain.
+
</description>
<parameters>
-<parameter name="src1">
-<parameter_description> a #GdkRectangle
+<parameter name="cursor">
+<parameter_description> a #GdkCursor
</parameter_description>
</parameter>
-<parameter name="src2">
-<parameter_description> a #GdkRectangle
+</parameters>
+<return></return>
+</function>
+
+<function name="gdk_device_free_history">
+<description>
+Frees an array of #GdkTimeCoord that was returned by gdk_device_get_history().
+
+</description>
+<parameters>
+<parameter name="events">
+<parameter_description> an array of #GdkTimeCoord.
</parameter_description>
</parameter>
-<parameter name="dest">
-<parameter_description> return location for the union of @src1 and @src2
+<parameter name="n_events">
+<parameter_description> the length of the array.
</parameter_description>
</parameter>
</parameters>
@@ -1552,432 +1502,414 @@ and locates the value in the array for a given axis use.
</return>
</function>
-<function name="gdk_pixmap_create_from_xpm_d">
+<function name="gdk_device_get_axis_use">
<description>
-Create a pixmap from data in XPM format.
+Returns the axis use for @index.
-Deprecated: 2.22: Use a #GdkPixbuf instead. You can use
-gdk_pixbuf_new_from_xpm_data() to create it.
-If you must use a pixmap, use gdk_pixmap_new() to
-create it and Cairo to draw the pixbuf onto it.
+Since: 2.22
</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> 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> 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="device">
+<parameter_description> a #GdkDevice.
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> Pointer to a string containing the XPM data.
+<parameter name="index">
+<parameter_description> the index of the axis.
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkPixmap.
+<return> a #GdkAxisUse specifying how the axis is used.
</return>
</function>
-<function name="gdk_set_show_events">
+<function name="gdk_device_get_core_pointer">
<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.
+Returns the core pointer device for the default display.
+
</description>
<parameters>
-<parameter name="show_events">
-<parameter_description> %TRUE to output event debugging information.
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> the core pointer device; this is owned by the
+display and should not be freed.
+</return>
</function>
-<function name="gdk_x11_get_server_time">
+<function name="gdk_device_get_has_cursor">
<description>
-Routine to get the current X server time stamp.
+Determines whether the pointer follows device motion.
+Since: 2.22
</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 #GdkDevice
</parameter_description>
</parameter>
</parameters>
-<return> the time stamp.
+<return> %TRUE if the pointer follows device motion
+
</return>
</function>
-<function name="gdk_x11_ungrab_server">
+<function name="gdk_device_get_history">
<description>
-Ungrab the default display after it has been grabbed with
-gdk_x11_grab_server().
+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.)
+
</description>
<parameters>
+<parameter name="device">
+<parameter_description> a #GdkDevice
+</parameter_description>
+</parameter>
+<parameter name="window">
+<parameter_description> the window with respect to which which the event coordinates will be reported
+</parameter_description>
+</parameter>
+<parameter name="start">
+<parameter_description> starting timestamp for range of events to return
+</parameter_description>
+</parameter>
+<parameter name="stop">
+<parameter_description> ending timestamp for the range of events to return
+</parameter_description>
+</parameter>
+<parameter name="events">
+<parameter_description> location to store a newly-allocated array of #GdkTimeCoord, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="n_events">
+<parameter_description> location to store the length of @events, or %NULL
+</parameter_description>
+</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the windowing system supports motion history and
+at least one event was found.
+</return>
</function>
-<function name="gdk_window_get_position">
+<function name="gdk_device_get_key">
<description>
-Obtains the position of the window as reported in the
-most-recently-processed #GdkEventConfigure. Contrast with
-gdk_window_get_geometry() which queries the X server for the
-current window position, regardless of which events have been
-received or processed.
-
-The position coordinates are relative to the window's parent window.
+If @index has a valid keyval, this function will
+fill in @keyval and @modifiers with the keyval settings.
+Since: 2.22
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="device">
+<parameter_description> a #GdkDevice.
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> X coordinate of window
+<parameter name="index">
+<parameter_description> the index of the macro button to get.
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> Y coordinate of window
+<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></return>
</function>
-<function name="gdk_cursor_ref">
+<function name="gdk_device_get_mode">
<description>
-Adds a reference to @cursor.
+Determines the mode of the device.
+Since: 2.22
</description>
<parameters>
-<parameter name="cursor">
-<parameter_description> a #GdkCursor
+<parameter name="device">
+<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
</parameters>
-<return> Same @cursor that was passed in
+<return> a #GdkInputSource
+
</return>
</function>
-<function name="gdk_region_xor">
+<function name="gdk_device_get_n_axes">
<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.
+Gets the number of axes of a device.
+
+Since: 2.22
</description>
<parameters>
-<parameter name="source1">
-<parameter_description> a #GdkRegion
-</parameter_description>
-</parameter>
-<parameter name="source2">
-<parameter_description> another #GdkRegion
+<parameter name="device">
+<parameter_description> a #GdkDevice.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the number of axes of @device
+
+</return>
</function>
-<function name="gdk_drag_abort">
+<function name="gdk_device_get_n_keys">
<description>
-Aborts a drag without dropping.
+Gets the number of keys of a device.
-This function is called by the drag source.
+Since: 2.24
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GdkDragContext.
-</parameter_description>
-</parameter>
-<parameter name="time_">
-<parameter_description> the timestamp for this operation.
+<parameter name="device">
+<parameter_description> a #GdkDevice.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the number of keys of @device
+
+</return>
</function>
-<function name="gdk_draw_layout_with_colors">
+<function name="gdk_device_get_name">
<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.
+Determines the name of the device.
-If you're using GTK+, the ususal way to obtain a #PangoLayout
-is gtk_widget_create_pango_layout().
+Since: 2.22
</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 name="device">
+<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> the X position of the left of the layout (in pixels)
+</parameters>
+<return> a name
+
+</return>
+</function>
+
+<function name="gdk_device_get_source">
+<description>
+Determines the type of the device.
+
+Since: 2.22
+
+</description>
+<parameters>
+<parameter name="device">
+<parameter_description> a #GdkDevice
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> the Y position of the top of the layout (in pixels)
+</parameters>
+<return> a #GdkInputSource
+
+</return>
+</function>
+
+<function name="gdk_device_get_state">
+<description>
+Gets the current state of a device.
+
+</description>
+<parameters>
+<parameter name="device">
+<parameter_description> a #GdkDevice.
</parameter_description>
</parameter>
-<parameter name="layout">
-<parameter_description> a #PangoLayout
+<parameter name="window">
+<parameter_description> a #GdkWindow.
</parameter_description>
</parameter>
-<parameter name="foreground">
-<parameter_description> foreground override color, or %NULL for none
+<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="background">
-<parameter_description> background override color, or %NULL for none
+<parameter name="mask">
+<parameter_description> location to store the modifiers, or %NULL.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_pixbuf_get_from_drawable">
+<function name="gdk_devices_list">
<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).
+Returns the list of available input devices for the default display.
+The list is statically allocated and should not be freed.
-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.
+</description>
+<parameters>
+</parameters>
+<return> a list of #GdkDevice
+</return>
+</function>
-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.
+<function name="gdk_directfb_visual_by_format">
+<description>
+This function is specific to the DirectFB backend. It allows
+to specify a GdkVisual by @pixel_format.
-If the target drawable is not mapped (typically because it's
-iconified/minimized or not on the current workspace), then %NULL
-will be returned.
+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.
-If memory can't be allocated for the return value, %NULL will be returned
-instead.
-(In short, there are several ways this function can fail, and if it fails
-it returns %NULL; so check the return value.)
+</description>
+<parameters>
+<parameter name="pixel_format">
+<parameter_description> the pixel_format of the requested visual
+</parameter_description>
+</parameter>
+</parameters>
+<return> a pointer to the GdkVisual or %NULL if the
+pixel_format is unsupported.
+</return>
+</function>
-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.
+<function name="gdk_display_add_client_message_filter">
+<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.
+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 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 name="display">
+<parameter_description> a #GdkDisplay for which this message filter applies
</parameter_description>
</parameter>
-<parameter name="dest_x">
-<parameter_description> Destination X coordinate in pixbuf, or 0 if @dest is NULL.
+<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="dest_y">
-<parameter_description> Destination Y coordinate in pixbuf, or 0 if @dest is NULL.
+<parameter name="func">
+<parameter_description> the function to call to process the event.
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> Width in pixels of region to get.
+<parameter name="data">
+<parameter_description> user data to pass to @func.
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> Height in pixels of region to get.
+</parameters>
+<return></return>
+</function>
+
+<function name="gdk_display_beep">
+<description>
+Emits a short beep on @display
+
+Since: 2.2
+
+</description>
+<parameters>
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return> 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>
+<return></return>
</function>
-<function name="gdk_window_get_children">
+<function name="gdk_display_close">
<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.
+Closes the connection to the windowing system for the given display,
+and cleans up associated resources.
+Since: 2.2
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return> list of child windows inside @window
-</return>
+<return></return>
</function>
-<function name="gdk_screen_width_mm">
+<function name="gdk_display_flush">
<description>
-Returns the width of the default screen in millimeters.
-Note that on many X servers this value will not be correct.
+Flushes any requests queued for the windowing system; this happens automatically
+when the main loop blocks waiting for new events, but if your application
+is drawing without returning control to the main loop, you may need
+to call this function explicitely. A common case where this function
+needs to be called is when an application is executing drawing commands
+from a thread other than the thread where the main loop is running.
+
+This is most useful for X11. On windowing systems where requests are
+handled synchronously, this function will do nothing.
+Since: 2.4
</description>
<parameters>
+<parameter name="display">
+<parameter_description> a #GdkDisplay
+</parameter_description>
+</parameter>
</parameters>
-<return> 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_display_get_core_pointer">
<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.)
+Returns the core pointer device for the given display
Since: 2.2
</description>
<parameters>
<parameter name="display">
-<parameter_description> The #GdkDisplay where the encoding is defined.
-</parameter_description>
-</parameter>
-<parameter name="encoding">
-<parameter_description> an atom representing the encoding. The most
-common values for this are STRING, or COMPOUND_TEXT.
-This is value used as the type for the property.
-</parameter_description>
-</parameter>
-<parameter name="format">
-<parameter_description> the format of the property.
-</parameter_description>
-</parameter>
-<parameter name="text">
-<parameter_description> The text data.
-</parameter_description>
-</parameter>
-<parameter name="length">
-<parameter_description> The number of items to transform.
-</parameter_description>
-</parameter>
-<parameter name="list">
-<parameter_description> location to store a terminated array of strings in
-the encoding of the current locale. This array should be
-freed using gdk_free_text_list().
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return> the number of strings stored in list, or 0,
-if the conversion failed.
+<return> the core pointer device; this is owned by the
+display and should not be freed.
</return>
</function>
-<function name="gdk_screen_get_toplevel_windows">
+<function name="gdk_display_get_default">
<description>
-Obtains a list of all toplevel windows known to GDK on the screen @screen.
-A toplevel window is a child of the root window (see
-gdk_get_default_root_window()).
-
-The returned list should be freed with g_list_free(), but
-its elements need not be freed.
+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="screen">
-<parameter_description> The #GdkScreen where the toplevels are located.
-</parameter_description>
-</parameter>
</parameters>
-<return> list of toplevel windows, free with g_list_free()
+<return> a #GdkDisplay, or %NULL if there is no default
+display.
</return>
</function>
-<function name="gdk_display_get_n_screens">
+<function name="gdk_display_get_default_cursor_size">
<description>
-Gets the number of screen managed by the @display.
+Returns the default size to use for cursors on @display.
-Since: 2.2
+Since: 2.4
</description>
<parameters>
@@ -1986,17 +1918,18 @@ Since: 2.2
</parameter_description>
</parameter>
</parameters>
-<return> number of screens.
+<return> the default cursor size.
</return>
</function>
-<function name="gdk_x11_display_ungrab">
+<function name="gdk_display_get_default_group">
<description>
-Ungrab @display after it has been grabbed with
-gdk_x11_display_grab().
+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>
@@ -2005,17 +1938,16 @@ Since: 2.2
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The default group leader window for @display
+
+</return>
</function>
-<function name="gdk_x11_display_get_user_time">
+<function name="gdk_display_get_default_screen">
<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().
+Get the default #GdkScreen for @display.
-Since: 2.8
+Since: 2.2
</description>
<parameters>
@@ -2024,61 +1956,58 @@ Since: 2.8
</parameter_description>
</parameter>
</parameters>
-<return> the timestamp of the last user interaction
+<return> the default #GdkScreen object for @display
</return>
</function>
-<function name="gdk_x11_image_get_xdisplay">
+<function name="gdk_display_get_event">
<description>
-Returns the display of a #GdkImage.
+Gets the next #GdkEvent to be processed for @display, fetching events from the
+windowing system if necessary.
+Since: 2.2
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GdkImage.
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return> an Xlib <type>Display*</type>.
+<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_cairo_set_source_pixmap">
+<function name="gdk_display_get_maximal_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
+Gets the maximal 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 name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="pixmap_x">
-<parameter_description> X coordinate of location to place upper left corner of @pixmap
+<parameter name="width">
+<parameter_description> the return location for the maximal cursor width
</parameter_description>
</parameter>
-<parameter name="pixmap_y">
-<parameter_description> Y coordinate of location to place upper left corner of @pixmap
+<parameter name="height">
+<parameter_description> the return location for the maximal cursor height
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_display_put_event">
+<function name="gdk_display_get_n_screens">
<description>
-Appends a copy of the given event onto the front of the event
-queue for @display.
+Gets the number of screen managed by the @display.
Since: 2.2
@@ -2088,659 +2017,664 @@ Since: 2.2
<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="event">
-<parameter_description> a #GdkEvent.
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> number of screens.
+
+</return>
</function>
-<function name="gdk_region_rectangle">
+<function name="gdk_display_get_name">
<description>
-Creates a new region containing the area @rectangle.
+Gets the name of the display.
+Since: 2.2
</description>
<parameters>
-<parameter name="rectangle">
-<parameter_description> a #GdkRectangle
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return> a new region
+<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_window_get_root_coords">
+<function name="gdk_display_get_pointer">
<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.
+Gets the current location of the pointer and the current modifier
+mask for a given 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>
-<parameter name="x">
-<parameter_description> X coordinate in window
+<parameter name="screen">
+<parameter_description> location to store the screen that the
+cursor is on, or %NULL.
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> Y coordinate in window
+<parameter name="x">
+<parameter_description> location to store root window X coordinate of pointer, or %NULL.
</parameter_description>
</parameter>
-<parameter name="root_x">
-<parameter_description> return location for X coordinate
+<parameter name="y">
+<parameter_description> location to store root window Y coordinate of pointer, or %NULL.
</parameter_description>
</parameter>
-<parameter name="root_y">
-<parameter_description> return location for Y coordinate
+<parameter name="mask">
+<parameter_description> location to store current modifier mask, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_gc_set_font">
+<function name="gdk_display_get_screen">
<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.)
+Returns a screen object for one of the screens of the 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="font">
-<parameter_description> the new font.
+<parameter name="screen_num">
+<parameter_description> the screen number
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GdkScreen object
+
+</return>
</function>
-<function name="gdk_screen_get_default_colormap">
+<function name="gdk_display_get_window_at_pointer">
<description>
-Gets the default colormap for @screen.
+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
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="display">
+<parameter_description> a #GdkDisplay
+</parameter_description>
+</parameter>
+<parameter name="win_x">
+<parameter_description> return location for x coordinate of the pointer location relative
+to the window origin, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="win_y">
+<parameter_description> return location for y coordinate of the pointer location relative
+ & to the window origin, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the default #GdkColormap.
+<return> the window under the mouse pointer, or %NULL
</return>
</function>
-<function name="gdk_offscreen_window_get_embedder">
+<function name="gdk_display_is_closed">
<description>
-Gets the window that @window is embedded in.
+Finds out if the display has been closed.
-Since: 2.18
+Since: 2.22
</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> %TRUE if the display is closed.
</return>
</function>
-<function name="gdk_mbstowcs">
+<function name="gdk_display_keyboard_ungrab">
<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').
+Release any keyboard grab
+Since: 2.2
</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="time_">
+<parameter_description> a timestap (e.g #GDK_CURRENT_TIME).
</parameter_description>
</parameter>
-<parameter name="dest_max">
-<parameter_description> the maximum number of wide characters to place in @dest.
+</parameters>
+<return></return>
+</function>
+
+<function name="gdk_display_list_devices">
+<description>
+Returns the list of available input devices attached to @display.
+The list is statically allocated and should not be freed.
+
+Since: 2.2
+
+</description>
+<parameters>
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return> the number of wide characters written into @dest, or -1 if
-the conversion failed.
+<return> a list of #GdkDevice
+
</return>
</function>
-<function name="gdk_window_set_opacity">
+<function name="gdk_display_manager_get">
<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.)
+Gets the singleton #GdkDisplayManager object.
-On X11, this works only on X screens with a compositing manager
-running.
+Since: 2.2
-For setting up per-pixel alpha, see gdk_screen_get_rgba_colormap().
-For making non-toplevel windows translucent, see
-gdk_window_set_composited().
+</description>
+<parameters>
+</parameters>
+<return> The global #GdkDisplayManager singleton; gdk_parse_pargs(),
+gdk_init(), or gdk_init_check() must have been called first.
-Since: 2.12
+</return>
+</function>
+
+<function name="gdk_display_manager_get_default_display">
+<description>
+Gets the default #GdkDisplay.
+
+Since: 2.2
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a top-level #GdkWindow
+<parameter name="display_manager">
+<parameter_description> a #GdkDisplayManager
</parameter_description>
</parameter>
-<parameter name="opacity">
-<parameter_description> opacity
+</parameters>
+<return> a #GdkDisplay, or %NULL if there is no default
+display.
+
+</return>
+</function>
+
+<function name="gdk_display_manager_list_displays">
+<description>
+List all currently open displays.
+
+Since: 2.2
+
+</description>
+<parameters>
+<parameter name="display_manager">
+<parameter_description> a #GdkDisplayManager
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<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_pango_context_set_colormap">
+<function name="gdk_display_manager_set_default_display">
<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.
+Sets @display as the default display.
+
+Since: 2.2
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #PangoContext
+<parameter name="display_manager">
+<parameter_description> a #GdkDisplayManager
</parameter_description>
</parameter>
-<parameter name="colormap">
-<parameter_description> a #GdkColormap
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_geometry_changed">
+<function name="gdk_display_open">
<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.
+Opens a display.
-Since: 2.18
+Since: 2.2
</description>
<parameters>
-<parameter name="window">
-<parameter_description> an embedded offscreen #GdkWindow
+<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_threads_add_timeout_full">
+<function name="gdk_display_open_default_libgtk_only">
<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;
+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.
-/ * do stuff with self * /
-self->timeout_id = 0;
+</description>
+<parameters>
+</parameters>
+<return> the default display, if it could be opened,
+otherwise %NULL.
+</return>
+</function>
-return FALSE;
-}
+<function name="gdk_display_peek_event">
+<description>
+Gets a copy of the first #GdkEvent in the @display's event queue, without
+removing the event from the queue. (Note that this function will
+not get more events from the windowing system. It only checks the events
+that have already been moved to the GDK event queue.)
-static void some_widget_do_stuff_later (SomeWidget *self)
-{
-self->timeout_id = g_timeout_add (timeout_callback, self)
-}
+Since: 2.2
-static void some_widget_finalize (GObject *object)
-{
-SomeWidget *self = SOME_WIDGET (object);
+</description>
+<parameters>
+<parameter name="display">
+<parameter_description> a #GdkDisplay
+</parameter_description>
+</parameter>
+</parameters>
+<return> a copy of the first #GdkEvent on the event queue, or %NULL
+if no events are in the queue. The returned #GdkEvent should be freed with
+gdk_event_free().
-if (self->timeout_id)
-g_source_remove (self->timeout_id);
+</return>
+</function>
-G_OBJECT_CLASS (parent_class)->finalize (object);
-}
-]|
+<function name="gdk_display_pointer_is_grabbed">
+<description>
+Test if the pointer is grabbed.
-Since: 2.12
+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 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 name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) of the event source.
+<return> %TRUE if an active X pointer grab is in effect
</return>
</function>
-<function name="gdk_threads_init">
+<function name="gdk_display_pointer_ungrab">
<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.
+Release any pointer grab.
-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
</description>
<parameters>
+<parameter name="display">
+<parameter_description> a #GdkDisplay.
+</parameter_description>
+</parameter>
+<parameter name="time_">
+<parameter_description> a timestap (e.g. %GDK_CURRENT_TIME).
+</parameter_description>
+</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_draw_pixbuf">
+<function name="gdk_display_put_event">
<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.
-
-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.
+Appends a copy of the given event onto the front of the event
+queue for @display.
Since: 2.2
-Deprecated: 2.22: Use gdk_cairo_set_source_pixbuf() and cairo_paint() or
-cairo_rectangle() and cairo_fill() instead.
-
</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 name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="dest_x">
-<parameter_description> Destination X coordinate within drawable.
+<parameter name="event">
+<parameter_description> a #GdkEvent.
</parameter_description>
</parameter>
-<parameter name="dest_y">
-<parameter_description> Destination Y coordinate within drawable.
+</parameters>
+<return></return>
+</function>
+
+<function name="gdk_display_request_selection_notification">
+<description>
+Request #GdkEventOwnerChange events for ownership changes
+of the selection named by the given atom.
+
+Since: 2.6
+
+</description>
+<parameters>
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> Width of region to render, in pixels, or -1 to use pixbuf width.
+<parameter name="selection">
+<parameter_description> the #GdkAtom naming the selection for which
+ownership change notification is requested
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> Height of region to render, in pixels, or -1 to use pixbuf height.
+</parameters>
+<return> whether #GdkEventOwnerChange events will
+be sent.
+
+</return>
+</function>
+
+<function name="gdk_display_set_double_click_distance">
+<description>
+Sets the double click distance (two clicks within this distance
+count as a double click and result in a #GDK_2BUTTON_PRESS event).
+See also gdk_display_set_double_click_time().
+Applications should <emphasis>not</emphasis> set this, it is a global
+user-configured setting.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="dither">
-<parameter_description> Dithering mode for #GdkRGB.
+<parameter name="distance">
+<parameter_description> distance in pixels
</parameter_description>
</parameter>
-<parameter name="x_dither">
-<parameter_description> X offset for dither.
+</parameters>
+<return></return>
+</function>
+
+<function name="gdk_display_set_double_click_time">
+<description>
+Sets the double click time (two clicks within this time interval
+count as a double click and result in a #GDK_2BUTTON_PRESS event).
+Applications should <emphasis>not</emphasis> set this, it is a global
+user-configured setting.
+
+Since: 2.2
+
+</description>
+<parameters>
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="y_dither">
-<parameter_description> Y offset for dither.
+<parameter name="msec">
+<parameter_description> double click time in milliseconds (thousandths of a second)
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_pixmap_foreign_new_for_display">
+<function name="gdk_display_set_pointer_hooks">
<description>
-Wraps a native pixmap 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>.
+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.
Since: 2.2
+Deprecated: 2.24: This function will go away in GTK 3 for lack of use cases.
+
</description>
<parameters>
<parameter name="display">
-<parameter_description> The #GdkDisplay where @anid is located.
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="anid">
-<parameter_description> a native pixmap handle.
+<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_description>
</parameter>
</parameters>
-<return> the newly-created #GdkPixmap wrapper for the
-native pixmap or %NULL if the pixmap has been destroyed.
+<return> the previous pointer hook table
</return>
</function>
-<function name="gdk_window_get_internal_paint_info">
+<function name="gdk_display_store_clipboard">
<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.
+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>.
-This function exposes details of the GDK implementation, and is thus
-likely to change in future releases of GDK.
+Since: 2.6
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="real_drawable">
-<parameter_description> location to store the drawable to which drawing should be
-done.
+<parameter name="clipboard_window">
+<parameter_description> a #GdkWindow belonging to the clipboard owner
</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 name="time_">
+<parameter_description> a timestamp
</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="targets">
+<parameter_description> an array of targets that should be saved, or %NULL
+if all available targets should be saved.
+</parameter_description>
+</parameter>
+<parameter name="n_targets">
+<parameter_description> length of the @targets array
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_gc_set_foreground">
+<function name="gdk_display_supports_clipboard_persistence">
<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.
+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.
-Deprecated: 2.22: Use gdk_cairo_set_source_color() to use a #GdkColor
-as the source in Cairo.
+Since: 2.6
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
-</parameter_description>
-</parameter>
-<parameter name="color">
-<parameter_description> the new foreground color.
+<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_screen_get_default">
+<function name="gdk_display_supports_composite">
<description>
-Gets the default screen for the default display. (See
-gdk_display_get_default ()).
+Returns %TRUE if gdk_window_set_composited() can be used
+to redirect drawing on the window using compositing.
-Since: 2.2
+Currently this only works on X11 with XComposite and
+XDamage extensions available.
+
+Since: 2.12
</description>
<parameters>
+<parameter name="display">
+<parameter_description> a #GdkDisplay
+</parameter_description>
+</parameter>
</parameters>
-<return> a #GdkScreen, or %NULL if there is no default display.
+<return> %TRUE if windows may be composited.
</return>
</function>
-<function name="gdk_color_hash">
+<function name="gdk_display_supports_cursor_alpha">
<description>
-A hash function suitable for using for a hash
-table that stores #GdkColor's.
+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="colora">
-<parameter_description> a #GdkColor.
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return> The hash function applied to @colora
+<return> whether cursors can have alpha channels.
+
</return>
</function>
-<function name="gdk_event_set_screen">
+<function name="gdk_display_supports_cursor_color">
<description>
-Sets the screen for @event to @screen. The event must
-have been allocated by GTK+, for instance, by
-gdk_event_copy().
+Returns %TRUE if multicolored cursors are supported
+on @display. Otherwise, cursors have only a forground
+and a background color.
-Since: 2.2
+Since: 2.4
</description>
<parameters>
-<parameter name="event">
-<parameter_description> a #GdkEvent
-</parameter_description>
-</parameter>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether cursors can have multiple colors.
+
+</return>
</function>
-<function name="gdk_event_get_axis">
+<function name="gdk_display_supports_input_shapes">
<description>
-Extract the axis value for a particular axis use from
-an event structure.
+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="event">
-<parameter_description> a #GdkEvent
-</parameter_description>
-</parameter>
-<parameter name="axis_use">
-<parameter_description> the axis use to look for
-</parameter_description>
-</parameter>
-<parameter name="value">
-<parameter_description> location to store the value found
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the specified axis was found, otherwise %FALSE
+<return> %TRUE if windows with modified input shape are supported
+
</return>
</function>
-<function name="gdk_screen_get_monitor_geometry">
+<function name="gdk_display_supports_selection_notification">
<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().
+Returns whether #GdkEventOwnerChange events will be
+sent when the owner of a selection changes.
-Since: 2.2
+Since: 2.6
</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">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return></return>
-</function>
-
-<function name="gdk_pango_context_get">
-<description>
-Creates a #PangoContext for the default GDK screen.
-
-The context must be freed when you're finished with it.
-
-When using GTK+, normally you should use gtk_widget_get_pango_context()
-instead of this function, to get the appropriate context for
-the widget you intend to render text onto.
-
-The newly created context will have the default font options (see
-#cairo_font_options_t) for the default screen; if these options
-change it will not be updated. Using gtk_widget_get_pango_context()
-is more convenient if you want to keep a context around and track
-changes to the screen's font rendering settings.
-
+<return> whether #GdkEventOwnerChange events will
+be sent.
-</description>
-<parameters>
-</parameters>
-<return> a new #PangoContext for the default display
</return>
</function>
-<function name="gdk_color_black">
+<function name="gdk_display_supports_shapes">
<description>
-Returns the black color for a given colormap. The resulting
-value has already been allocated.
+Returns %TRUE if gdk_window_shape_combine_mask() can
+be used to create shaped windows on @display.
+Since: 2.10
</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> %TRUE if shaped windows are supported
+
</return>
</function>
-<function name="gdk_window_clear_area_e">
+<function name="gdk_display_sync">
<description>
-Like gdk_window_clear_area(), but also generates an expose event for
-the cleared area.
+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 function has a stupid name because it dates back to the mists
-time, pre-GDK-1.0.
+This is most useful for X11. On windowing systems where requests are
+handled synchronously, this function will do nothing.
+Since: 2.2
</description>
<parameters>
-<parameter name="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_description>
-</parameter>
-<parameter name="height">
-<parameter_description> height of rectangle to clear
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
@@ -2785,273 +2719,228 @@ Since: 2.8
<return></return>
</function>
-<function name="gdk_gc_offset">
+<function name="gdk_drag_abort">
<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.
+Aborts a drag without dropping.
-Deprecated: 2.22: There is no direct replacement, as this is just a
-convenience function for gdk_gc_set_ts_origin and gdk_gc_set_clip_origin().
+This function is called by the drag source.
</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="context">
+<parameter_description> a #GdkDragContext.
</parameter_description>
</parameter>
-<parameter name="y_offset">
-<parameter_description> amount by which to offset the GC in the Y direction
+<parameter name="time_">
+<parameter_description> the timestamp for this operation.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_image_get">
+<function name="gdk_drag_begin">
<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.
+Starts a drag and creates a new drag context for it.
+
+This function is called by the drag source.
</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 name="window">
+<parameter_description> the source window for this drag.
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> width of area in @window
+<parameter name="targets">
+<parameter_description> the offered targets,
+as list of #GdkAtom<!-- -->s
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> height of area in @window
+</parameters>
+<return> a newly created #GdkDragContext.
+</return>
+</function>
+
+<function name="gdk_drag_context_get_actions">
+<description>
+Determines the bitmask of actions proposed by the source if
+gdk_drag_context_suggested_action() returns GDK_ACTION_ASK.
+
+Since: 2.22
+
+</description>
+<parameters>
+<parameter name="context">
+<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
</parameters>
-<return> a new #GdkImage or %NULL
+<return> the #GdkDragAction flags
+
</return>
</function>
-<function name="gdk_font_id">
+<function name="gdk_drag_context_get_dest_window">
<description>
-Returns the X Font ID for the given font.
+Returns the destination windw for the DND operation.
+Since: 2.24
</description>
<parameters>
-<parameter name="font">
-<parameter_description> a #GdkFont.
+<parameter name="context">
+<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
</parameters>
-<return> the numeric X Font ID
+<return> a #GdkWindow
+
</return>
</function>
-<function name="gdk_window_lookup">
+<function name="gdk_drag_context_get_protocol">
<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>.
+Returns the drag protocol thats used by this context.
+Since: 2.24
</description>
<parameters>
-<parameter name="anid">
-<parameter_description> a native window handle.
+<parameter name="context">
+<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkWindow wrapper for the native window,
-or %NULL if there is none.
+<return> the drag protocol
+
</return>
</function>
-<function name="gdk_image_get_bytes_per_pixel">
+<function name="gdk_drag_context_get_selected_action">
<description>
-Determines the number of bytes per pixel of the image.
+Determines the action chosen by the drag destination.
Since: 2.22
-Deprecated: 2.22: #GdkImage should not be used anymore.
-
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GdkImage
+<parameter name="context">
+<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
</parameters>
-<return> the bytes per pixel
+<return> a #GdkDragAction value
</return>
</function>
-<function name="gdk_region_intersect">
+<function name="gdk_drag_context_get_source_window">
<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.
+Returns the #GdkWindow where the DND operation started.
+
+Since: 2.22
</description>
<parameters>
-<parameter name="source1">
-<parameter_description> a #GdkRegion
-</parameter_description>
-</parameter>
-<parameter name="source2">
-<parameter_description> another #GdkRegion
+<parameter name="context">
+<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #GdkWindow
+
+</return>
</function>
-<function name="gdk_text_property_to_utf8_list_for_display">
+<function name="gdk_drag_context_get_suggested_action">
<description>
-Converts a text property in the given encoding to
-a list of UTF-8 strings.
+Determines the suggested drag action of the context.
-Since: 2.2
+Since: 2.22
</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 name="context">
+<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
</parameters>
-<return> the number of strings in the resulting
-list.
+<return> a #GdkDragAction value
</return>
</function>
-<function name="gdk_window_set_events">
+<function name="gdk_drag_context_list_targets">
<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.
+Retrieves the list of targets of the context.
+
+Since: 2.22
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="event_mask">
-<parameter_description> event mask for @window
+<parameter name="context">
+<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #GList of targets
+
+</return>
</function>
-<function name="gdk_window_set_keep_above">
+<function name="gdk_drag_context_new">
<description>
-Set if @window must be kept above other windows. If the
-window was already above, then this function does nothing.
+Creates a new #GdkDragContext.
-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.
+Deprecated: 2.24: This function is not useful, you always
+obtain drag contexts by gdk_drag_begin() or similar.
-Since: 2.4
+</description>
+<parameters>
+</parameters>
+<return> the newly created #GdkDragContext.
+
+</return>
+</function>
+
+<function name="gdk_drag_context_ref">
+<description>
+Deprecated function; use g_object_ref() instead.
+
+Deprecated: 2.2: Use g_object_ref() instead.
</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="context">
+<parameter_description> a #GdkDragContext.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_set_debug_updates">
+<function name="gdk_drag_context_unref">
<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.
+Deprecated function; use g_object_unref() instead.
+Deprecated: 2.2: Use g_object_unref() instead.
</description>
<parameters>
-<parameter name="setting">
-<parameter_description> %TRUE to turn on update debugging
+<parameter name="context">
+<parameter_description> a #GdkDragContext.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_drag_context_ref">
+<function name="gdk_drag_drop">
<description>
-Deprecated function; use g_object_ref() instead.
+Drops on the current destination.
-Deprecated: 2.2: Use g_object_ref() instead.
+This function is called by the drag source.
</description>
<parameters>
@@ -3059,504 +2948,852 @@ Deprecated: 2.2: Use g_object_ref() instead.
<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_get_default_root_window">
+<function name="gdk_drag_drop_succeeded">
<description>
-Obtains the root window (parent all other windows are inside)
-for the default display and screen.
+Returns whether the dropped data has been successfully
+transferred. This function is intended to be used while
+handling a %GDK_DROP_FINISHED event, its return value is
+meaningless at other times.
+Since: 2.6
</description>
<parameters>
+<parameter name="context">
+<parameter_description> a #GdkDragContext
+</parameter_description>
+</parameter>
</parameters>
-<return> the default root window
+<return> %TRUE if the drop was successful.
+
</return>
</function>
-<function name="gdk_string_height">
+<function name="gdk_drag_find_window">
<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().
+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.24: Use gdk_drag_find_window_for_screen() instead.
</description>
<parameters>
-<parameter name="font">
-<parameter_description> a #GdkFont
+<parameter name="context">
+<parameter_description> a #GdkDragContext.
</parameter_description>
</parameter>
-<parameter name="string">
-<parameter_description> the nul-terminated string to measure.
+<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="x_root">
+<parameter_description> the x position of the pointer in root coordinates.
+</parameter_description>
+</parameter>
+<parameter name="y_root">
+<parameter_description> the y position of the pointer in root coordinates.
+</parameter_description>
+</parameter>
+<parameter name="dest_window">
+<parameter_description> location to store the destination window in.
+</parameter_description>
+</parameter>
+<parameter name="protocol">
+<parameter_description> location to store the DND protocol in.
</parameter_description>
</parameter>
</parameters>
-<return> the height of the string in pixels.
-</return>
+<return></return>
</function>
-<function name="gdk_query_visual_types">
+<function name="gdk_drag_find_window_for_screen">
<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.
+Finds the destination window and DND protocol to use at the
+given pointer position.
-The array returned by this function should not be freed.
+This function is called by the drag source to obtain the
+ dest_window and @protocol parameters for gdk_drag_motion().
+
+Since: 2.2
</description>
<parameters>
-<parameter name="visual_types">
-<parameter_description> return location for the available visual types
+<parameter name="context">
+<parameter_description> a #GdkDragContext
</parameter_description>
</parameter>
-<parameter name="count">
-<parameter_description> return location for the number of available visual types
+<parameter name="drag_window">
+<parameter_description> a window which may be at the pointer position, but
+should be ignored, since it is put up by the drag source as an icon.
+</parameter_description>
+</parameter>
+<parameter name="screen">
+<parameter_description> the screen where the destination window is sought.
+</parameter_description>
+</parameter>
+<parameter name="x_root">
+<parameter_description> the x position of the pointer in root coordinates.
+</parameter_description>
+</parameter>
+<parameter name="y_root">
+<parameter_description> the y position of the pointer in root coordinates.
+</parameter_description>
+</parameter>
+<parameter name="dest_window">
+<parameter_description> location to store the destination window in.
+</parameter_description>
+</parameter>
+<parameter name="protocol">
+<parameter_description> location to store the DND protocol in.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_screen_get_monitor_height_mm">
+<function name="gdk_drag_get_protocol">
<description>
-Gets the height in millimeters of the specified monitor.
+Finds out the DND protocol supported by a window.
-Since: 2.14
+Deprecated: 2.24: Use gdk_drag_get_protocol_for_display() instead
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="xid">
+<parameter_description> the windowing system id of the destination window.
</parameter_description>
</parameter>
-<parameter name="monitor_num">
-<parameter_description> number of the monitor, between 0 and gdk_screen_get_n_monitors (screen)
+<parameter name="protocol">
+<parameter_description> location where the supported DND protocol is returned.
</parameter_description>
</parameter>
</parameters>
-<return> the height of the monitor, or -1 if not available
+<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>
</function>
-<function name="gdk_display_close">
+<function name="gdk_drag_get_protocol_for_display">
<description>
-Closes the connection to the windowing system for the given display,
-and cleans up associated resources.
+Finds out the DND protocol supported by a window.
Since: 2.2
</description>
<parameters>
<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter_description> the #GdkDisplay where the destination window resides
+</parameter_description>
+</parameter>
+<parameter name="xid">
+<parameter_description> the windowing system id of the destination window.
+</parameter_description>
+</parameter>
+<parameter name="protocol">
+<parameter_description> location where the supported DND protocol is returned.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<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>
</function>
-<function name="gdk_image_get_width">
+<function name="gdk_drag_get_selection">
<description>
-Determines the width of the image.
-
-Since: 2.22
+Returns the selection atom for the current source window.
-Deprecated: 2.22: #GdkImage should not be used anymore.
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GdkImage
+<parameter name="context">
+<parameter_description> a #GdkDragContext.
</parameter_description>
</parameter>
</parameters>
-<return> the width
-
+<return> the selection atom.
</return>
</function>
-<function name="gdk_query_depths">
+<function name="gdk_drag_motion">
<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.
+Updates the drag context when the pointer moves or the
+set of actions changes.
-The array returned by this function should not be freed.
+This function is called by the drag source.
</description>
<parameters>
-<parameter name="depths">
-<parameter_description> return location for available depths
+<parameter name="context">
+<parameter_description> a #GdkDragContext.
</parameter_description>
</parameter>
-<parameter name="count">
-<parameter_description> return location for number of available depths
+<parameter name="dest_window">
+<parameter_description> the new destination window, obtained by
+gdk_drag_find_window().
+</parameter_description>
+</parameter>
+<parameter name="protocol">
+<parameter_description> the DND protocol in use, obtained by gdk_drag_find_window().
+</parameter_description>
+</parameter>
+<parameter name="x_root">
+<parameter_description> the x position of the pointer in root coordinates.
+</parameter_description>
+</parameter>
+<parameter name="y_root">
+<parameter_description> the y position of the pointer in root coordinates.
+</parameter_description>
+</parameter>
+<parameter name="suggested_action">
+<parameter_description> the suggested action.
+</parameter_description>
+</parameter>
+<parameter name="possible_actions">
+<parameter_description> the possible actions.
+</parameter_description>
+</parameter>
+<parameter name="time_">
+<parameter_description> the timestamp for this operation.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> FIXME
+</return>
</function>
-<function name="gdk_char_measure">
+<function name="gdk_drag_status">
<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.
+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="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="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> the right bearing of the character in pixels.
-</return>
+<return></return>
</function>
-<function name="gdk_spawn_on_screen">
+<function name="gdk_draw_arc">
<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.
-
-This is useful for applications which wish to launch an application
-on a specific screen.
+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.
-Since: 2.4
+Deprecated: 2.22: Use cairo_arc() and cairo_fill() or cairo_stroke()
+instead. Note that arcs just like any drawing operation in Cairo are
+antialiased unless you call cairo_set_antialias().
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
</parameter_description>
</parameter>
-<parameter name="working_directory">
-<parameter_description> child's current working directory, or %NULL to
-inherit parent's
+<parameter name="gc">
+<parameter_description> a #GdkGC.
</parameter_description>
</parameter>
-<parameter name="argv">
-<parameter_description> child's argument vector
+<parameter name="filled">
+<parameter_description> %TRUE if the arc should be filled, producing a 'pie slice'.
</parameter_description>
</parameter>
-<parameter name="envp">
-<parameter_description> child's environment, or %NULL to inherit parent's
+<parameter name="x">
+<parameter_description> the x coordinate of the left edge of the bounding rectangle.
</parameter_description>
</parameter>
-<parameter name="flags">
-<parameter_description> flags from #GSpawnFlags
+<parameter name="y">
+<parameter_description> the y coordinate of the top edge of the bounding rectangle.
</parameter_description>
</parameter>
-<parameter name="child_setup">
-<parameter_description> function to run in the child just before exec()
+<parameter name="width">
+<parameter_description> the width of the bounding rectangle.
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data for @child_setup
+<parameter name="height">
+<parameter_description> the height of the bounding rectangle.
</parameter_description>
</parameter>
-<parameter name="child_pid">
-<parameter_description> return location for child process ID, or %NULL
+<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="error">
-<parameter_description> return location for error
+<parameter name="angle2">
+<parameter_description> the end angle of the arc, relative to @angle1, in 1/64ths
+of a degree.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success, %FALSE if error is set
-
-</return>
+<return></return>
</function>
-<function name="gdk_keymap_map_virtual_modifiers">
+<function name="gdk_draw_drawable">
<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.
+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.
-This function is useful when matching key events against
-accelerators.
+Most fields in @gc are not used for this operation, but notably the
+clip mask or clip region will be honored.
-Since: 2.20
+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.
+
+Deprecated: 2.22: Use gdk_cairo_set_source_pixmap(), cairo_rectangle()
+and cairo_fill() to draw pixmap on top of other drawables. Also keep
+in mind that the limitations on allowed sources do not apply to Cairo.
</description>
<parameters>
-<parameter name="keymap">
-<parameter_description> a #GdkKeymap
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable
</parameter_description>
</parameter>
-<parameter name="state">
-<parameter_description> pointer to the modifier state to map
+<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_description>
+</parameter>
+<parameter name="ydest">
+<parameter_description> Y position in @drawable where the rectangle should be drawn
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> width of rectangle to draw, or -1 for entire @src width
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> height of rectangle to draw, or -1 for entire @src height
</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>
+<return></return>
</function>
-<function name="gdk_window_get_modal_hint">
+<function name="gdk_draw_glyphs">
<description>
-Determines whether or not the window manager is hinted that @window
-has modal behaviour.
+This is a low-level function; 99% of text rendering should be done
+using gdk_draw_layout() instead.
-Since: 2.22
+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.
+
+Deprecated: 2.22: Use pango_cairo_show_glyphs() instead.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> A toplevel #GdkWindow.
+<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_description>
+</parameter>
+<parameter name="glyphs">
+<parameter_description> the glyph string to draw
</parameter_description>
</parameter>
</parameters>
-<return> whether or not the window has the modal hint set.
-
-</return>
+<return></return>
</function>
-<function name="gdk_pixmap_foreign_new_for_screen">
+<function name="gdk_draw_glyphs_transformed">
<description>
-Wraps a native pixmap in a #GdkPixmap.
-This may fail if the pixmap has been destroyed.
+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.
-For example in the X backend, a native pixmap handle is an Xlib
-<type>XID</type>.
+See also gdk_draw_glyphs(), gdk_draw_layout().
-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.6
-Since: 2.10
+Deprecated: 2.22: Use pango_cairo_show_glyphs() instead.
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable
</parameter_description>
</parameter>
-<parameter name="anid">
-<parameter_description> a native pixmap handle
+<parameter name="gc">
+<parameter_description> a #GdkGC
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> the width of the pixmap identified by @anid
+<parameter name="matrix">
+<parameter_description> a #PangoMatrix, or %NULL to use an identity transformation
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> the height of the pixmap identified by @anid
+<parameter name="font">
+<parameter_description> the font in which to draw the string
</parameter_description>
</parameter>
-<parameter name="depth">
-<parameter_description> the depth of the pixmap identified by @anid
+<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_description>
+</parameter>
+<parameter name="glyphs">
+<parameter_description> the glyph string to draw
</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_set_sm_client_id">
+<function name="gdk_draw_image">
<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.
+Draws a #GdkImage onto a drawable.
+The depth of the #GdkImage must match the depth of the #GdkDrawable.
-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.)
+Deprecated: 2.22: Do not use #GdkImage anymore, instead use Cairo image
+surfaces.
</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="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_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_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_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_unstick">
+<function name="gdk_draw_layout">
<description>
-Reverse operation for gdk_window_stick(); see gdk_window_stick(),
-and gtk_window_unstick().
+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.
+
+If you're using GTK+, the usual way to obtain a #PangoLayout
+is gtk_widget_create_pango_layout().
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<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_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_selection_property_get">
+<function name="gdk_draw_layout_line">
<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.
+Render a #PangoLayoutLine onto an GDK drawable
+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="requestor">
-<parameter_description> the window on which the data is stored
+<parameter name="drawable">
+<parameter_description> the drawable on which to draw the line
</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 name="gc">
+<parameter_description> base graphics to use
</parameter_description>
</parameter>
-<parameter name="prop_type">
-<parameter_description> location to store the type of the property.
+<parameter name="x">
+<parameter_description> the x position of start of string (in pixels)
</parameter_description>
</parameter>
-<parameter name="prop_format">
-<parameter_description> location to store the format of the property.
+<parameter name="y">
+<parameter_description> the y position of baseline (in pixels)
+</parameter_description>
+</parameter>
+<parameter name="line">
+<parameter_description> a #PangoLayoutLine
</parameter_description>
</parameter>
</parameters>
-<return> the length of the retrieved data.
-</return>
+<return></return>
</function>
-<function name="gdk_visual_get_system">
+<function name="gdk_draw_layout_line_with_colors">
<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.
+Render a #PangoLayoutLine 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 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_description>
+</parameter>
+<parameter name="foreground">
+<parameter_description> foreground override color, or %NULL for none
+</parameter_description>
+</parameter>
+<parameter name="background">
+<parameter_description> background override color, or %NULL for none
+</parameter_description>
+</parameter>
</parameters>
-<return> system visual
-</return>
+<return></return>
</function>
-<function name="gdk_threads_add_timeout">
+<function name="gdk_draw_layout_with_colors">
<description>
-A wrapper for the common usage of gdk_threads_add_timeout_full()
-assigning the default priority, #G_PRIORITY_DEFAULT.
+Render a #PangoLayout onto a #GdkDrawable, overriding the
+layout's normal colors with @foreground and/or @background.
+ foreground and @background need not be allocated.
-See gdk_threads_add_timeout_full().
+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.
-Since: 2.12
+If you're using GTK+, the ususal way to obtain a #PangoLayout
+is gtk_widget_create_pango_layout().
</description>
<parameters>
-<parameter name="interval">
-<parameter_description> the time between calls to the function, in milliseconds
-(1/1000ths of a second)
+<parameter name="drawable">
+<parameter_description> the drawable on which to draw string
</parameter_description>
</parameter>
-<parameter name="function">
-<parameter_description> function to call
+<parameter name="gc">
+<parameter_description> base graphics context to use
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to pass to @function
+<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_description>
+</parameter>
+<parameter name="foreground">
+<parameter_description> foreground override color, or %NULL for none
+</parameter_description>
+</parameter>
+<parameter name="background">
+<parameter_description> background override color, or %NULL for none
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) of the event source.
-
-</return>
+<return></return>
</function>
-<function name="gdk_x11_xatom_to_atom">
+<function name="gdk_draw_line">
<description>
-Convert from an X atom for the default display to the corresponding
-#GdkAtom.
+Draws a line, using the foreground color and other attributes of
+the #GdkGC.
+Deprecated: 2.22: Use cairo_line_to() and cairo_stroke() instead.
+Be aware that the default line width in Cairo is 2 pixels and that your
+coordinates need to describe the center of the line. To draw a single
+pixel wide pixel-aligned line, you would use:
+|[cairo_set_line_width (cr, 1.0);
+cairo_set_line_cap (cr, CAIRO_LINE_CAP_SQUARE);
+cairo_move_to (cr, 0.5, 0.5);
+cairo_line_to (cr, 9.5, 0.5);
+cairo_stroke (cr);]|
+See also <ulink url="http://cairographics.org/FAQ/#sharp_lines">the Cairo
+FAQ</ulink> on this topic.
</description>
<parameters>
-<parameter name="xatom">
-<parameter_description> an X atom for the default GDK display
+<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_description>
</parameter>
</parameters>
-<return> the corresponding G#dkAtom.
-</return>
+<return></return>
</function>
-<function name="gdk_gc_set_clip_mask">
+<function name="gdk_draw_lines">
<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()).
+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().
-Deprecated: 2.22: Use cairo_mask() instead.
+Deprecated: 2.22: Use cairo_line_to() and cairo_stroke() instead. See the
+documentation of gdk_draw_line() for notes on line drawing with Cairo.
</description>
<parameters>
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
+</parameter_description>
+</parameter>
<parameter name="gc">
-<parameter_description> the #GdkGC.
+<parameter_description> a #GdkGC.
</parameter_description>
</parameter>
-<parameter name="mask">
-<parameter_description> a bitmap.
+<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>
</function>
-<function name="gdk_drawable_get_screen">
+<function name="gdk_draw_pixbuf">
<description>
-Gets the #GdkScreen associated with a #GdkDrawable.
+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.
+
+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.
Since: 2.2
+Deprecated: 2.22: Use gdk_cairo_set_source_pixbuf() and cairo_paint() or
+cairo_rectangle() and cairo_fill() instead.
+
</description>
<parameters>
<parameter name="drawable">
-<parameter_description> a #GdkDrawable
+<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> the #GdkScreen associated with @drawable
-
-</return>
+<return></return>
</function>
-<function name="gdk_draw_text">
+<function name="gdk_draw_point">
<description>
-Draws a number of characters in the given font or fontset.
+Draws a point, using the foreground color and other attributes of
+the #GdkGC.
-Deprecated: 2.4: Use gdk_draw_layout() instead.
+Deprecated: 2.22: Use cairo_rectangle() and cairo_fill() or
+cairo_move_to() and cairo_stroke() instead.
</description>
<parameters>
@@ -3564,409 +3801,509 @@ Deprecated: 2.4: Use gdk_draw_layout() instead.
<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> the x coordinate of the point.
</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 characters to draw.
-</parameter_description>
-</parameter>
-<parameter name="text_length">
-<parameter_description> the number of characters of @text to draw.
+<parameter_description> the y coordinate of the point.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_keymap_add_virtual_modifiers">
+<function name="gdk_draw_points">
<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.
-
-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.
+Draws a number of points, using the foreground color and other
+attributes of the #GdkGC.
-Since: 2.20
+Deprecated: 2.22: Use @n_points calls to cairo_rectangle() and
+cairo_fill() instead.
</description>
<parameters>
-<parameter name="keymap">
-<parameter_description> a #GdkKeymap
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
</parameter_description>
</parameter>
-<parameter name="state">
-<parameter_description> pointer to the modifier mask to change
+<parameter name="gc">
+<parameter_description> a #GdkGC.
+</parameter_description>
+</parameter>
+<parameter name="points">
+<parameter_description> an array of #GdkPoint structures.
+</parameter_description>
+</parameter>
+<parameter name="n_points">
+<parameter_description> the number of points to be drawn.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_x11_font_get_name">
+<function name="gdk_draw_polygon">
<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.
+Draws an outlined or filled polygon.
+Deprecated: 2.22: Use cairo_line_to() or cairo_append_path() and
+cairo_fill() or cairo_stroke() instead.
</description>
<parameters>
-<parameter name="font">
-<parameter_description> a #GdkFont.
+<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_description>
</parameter>
</parameters>
-<return> the name of the font. This string is owned
-by GDK and must not be modified or freed.
-</return>
+<return></return>
</function>
-<function name="gdk_drawable_set_colormap">
+<function name="gdk_draw_rectangle">
<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.
+Draws a rectangular outline or filled rectangle, using the foreground color
+and other attributes of the #GdkGC.
+
+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.
+Deprecated: 2.22: Use cairo_rectangle() and cairo_fill() or cairo_stroke()
+instead. For stroking, the same caveats for converting code apply as for
+gdk_draw_line().
</description>
<parameters>
<parameter name="drawable">
-<parameter_description> a #GdkDrawable
+<parameter_description> a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
</parameter_description>
</parameter>
-<parameter name="colormap">
-<parameter_description> a #GdkColormap
+<parameter name="gc">
+<parameter_description> a #GdkGC.
+</parameter_description>
+</parameter>
+<parameter name="filled">
+<parameter_description> %TRUE if the rectangle should be filled.
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> the x coordinate of the left edge of the rectangle.
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> the y coordinate of the top edge of the rectangle.
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> the width of the rectangle.
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the height of the rectangle.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_pixmap_colormap_create_from_xpm_d">
+<function name="gdk_draw_rgb_32_image_dithalign">
<description>
-Create a pixmap from data in XPM format using a particular
-colormap.
+Like gdk_draw_rgb_32_image(), but allows you to specify the dither
+offsets. See gdk_draw_rgb_image_dithalign() for more details.
-Deprecated: 2.22: Use a #GdkPixbuf instead. You can use
-gdk_pixbuf_new_from_xpm_data() to create it.
-If you must use a pixmap, use gdk_pixmap_new() to
-create it and Cairo to draw the pixbuf onto it.
+Deprecated: 2.22: Cairo handles colors automatically.
</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> a #GdkDrawable
</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 name="gc">
+<parameter_description> a #GdkGC
</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="x">
+<parameter_description> X coordinate on @drawable where image should go
</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="y">
+<parameter_description> Y coordinate on @drawable where image should go
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> Pointer to a string containing the XPM data.
+<parameter name="width">
+<parameter_description> width of area of image to draw
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> height of area of image to draw
+</parameter_description>
+</parameter>
+<parameter name="dith">
+<parameter_description> dithering mode
+</parameter_description>
+</parameter>
+<parameter name="buf">
+<parameter_description> RGB image data
+</parameter_description>
+</parameter>
+<parameter name="rowstride">
+<parameter_description> rowstride of RGB image data
+</parameter_description>
+</parameter>
+<parameter name="xdith">
+<parameter_description> X dither offset
+</parameter_description>
+</parameter>
+<parameter name="ydith">
+<parameter_description> Y dither offset
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkPixmap.
-
-</return>
+<return></return>
</function>
-<function name="gdk_region_offset">
+<function name="gdk_draw_segments">
<description>
-Moves a region the specified distance.
+Draws a number of unconnected lines.
+
+Deprecated: 2.22: Use cairo_move_to(), cairo_line_to() and cairo_stroke()
+instead. See the documentation of gdk_draw_line() for notes on line drawing
+with Cairo.
</description>
<parameters>
-<parameter name="region">
-<parameter_description> a #GdkRegion
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
</parameter_description>
</parameter>
-<parameter name="dx">
-<parameter_description> the distance to move the region horizontally
+<parameter name="gc">
+<parameter_description> a #GdkGC.
</parameter_description>
</parameter>
-<parameter name="dy">
-<parameter_description> the distance to move the region vertically
+<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_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_clear_area">
+<function name="gdk_draw_string">
<description>
-Clears an area of @window to the background color or background pixmap.
+Draws a string of characters in the given font or fontset.
+Deprecated: 2.4: Use gdk_draw_layout() instead.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> x coordinate of rectangle to clear
+<parameter name="font">
+<parameter_description> a #GdkFont.
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> y coordinate of rectangle to clear
+<parameter name="gc">
+<parameter_description> a #GdkGC.
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> width of rectangle to clear
+<parameter name="x">
+<parameter_description> the x coordinate of the left edge of the text.
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> height of rectangle to clear
+<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_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_get_parent">
+<function name="gdk_draw_text">
<description>
-Obtains the parent of @window, as known to GDK. Does not query the
-X server; thus this returns the parent as passed to gdk_window_new(),
-not the actual parent. This should never matter unless you're using
-Xlib calls mixed with GDK calls on the X11 platform. It may also
-matter for toplevel windows, because the window manager may choose
-to reparent them.
-
-Note that you should use gdk_window_get_effective_parent() when
-writing generic code that walks up a window hierarchy, because
-gdk_window_get_parent() will most likely not do what you expect if
-there are offscreen windows in the hierarchy.
+Draws a number of characters in the given font or fontset.
+Deprecated: 2.4: Use gdk_draw_layout() instead.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<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 characters to draw.
+</parameter_description>
+</parameter>
+<parameter name="text_length">
+<parameter_description> the number of characters of @text to draw.
</parameter_description>
</parameter>
</parameters>
-<return> parent of @window
-</return>
+<return></return>
</function>
-<function name="gdk_display_request_selection_notification">
+<function name="gdk_draw_text_wc">
<description>
-Request #GdkEventOwnerChange events for ownership changes
-of the selection named by the given atom.
+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.
-Since: 2.6
+Deprecated: 2.4: Use gdk_draw_layout() instead.
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
</parameter_description>
</parameter>
-<parameter name="selection">
-<parameter_description> the #GdkAtom naming the selection for which
-ownership change notification is requested
+<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_description>
+</parameter>
+<parameter name="text_length">
+<parameter_description> the number of characters to draw.
</parameter_description>
</parameter>
</parameters>
-<return> whether #GdkEventOwnerChange events will
-be sent.
-
-</return>
+<return></return>
</function>
-<function name="gdk_display_sync">
+<function name="gdk_draw_trapezoids">
<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.
+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.
-This is most useful for X11. On windowing systems where requests are
-handled synchronously, this function will do nothing.
+Since: 2.6
-Since: 2.2
+Deprecated: 2.22: Use Cairo path contruction functions and cairo_fill()
+instead.
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<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_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_get_geometry">
+<function name="gdk_drawable_copy_to_image">
<description>
-Any of the return location arguments to this function may be %NULL,
-if you aren't interested in getting the value of that field.
-
-The X and Y coordinates returned are relative to the parent window
-of @window, which for toplevels usually means relative to the
-window decorations (titlebar, etc.) rather than relative to the
-root window (screen-size background window).
+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.
-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.
+Since: 2.4
-<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>
+Deprecated: 2.22: Use @drawable as the source and draw to a Cairo image
+surface if you want to download contents to the client.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> return location for X coordinate of window (relative to its parent)
+<parameter name="image">
+<parameter_description> a #GdkDrawable, or %NULL if a new @image should be created.
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> return location for Y coordinate of window (relative to its parent)
+<parameter name="src_x">
+<parameter_description> x coordinate on @drawable
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> return location for width of window
+<parameter name="src_y">
+<parameter_description> y coordinate on @drawable
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> return location for height of window
+<parameter name="dest_x">
+<parameter_description> x coordinate within @image. Must be 0 if @image is %NULL
</parameter_description>
</parameter>
-<parameter name="depth">
-<parameter_description> return location for bit depth of window
+<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_description>
</parameter>
</parameters>
-<return></return>
+<return> @image, or a new a #GdkImage containing the contents
+of @drawable
+
+</return>
</function>
-<function name="gdk_visual_get_colormap_size">
+<function name="gdk_drawable_get_clip_region">
<description>
-Returns the size of a colormap for this visual.
+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.
-Since: 2.22
</description>
<parameters>
-<parameter name="visual">
-<parameter_description> A #GdkVisual.
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable
</parameter_description>
</parameter>
</parameters>
-<return> The size of a colormap that is suitable for @visual.
-
+<return> a #GdkRegion. This must be freed with gdk_region_destroy()
+when you are done.
</return>
</function>
-<function name="gdk_pango_attr_stipple_new">
+<function name="gdk_drawable_get_colormap">
<description>
-Creates a new attribute containing a stipple bitmap to be used when
-rendering the text.
+Gets the colormap for @drawable, if one is set; returns
+%NULL otherwise.
</description>
<parameters>
-<parameter name="stipple">
-<parameter_description> a bitmap to be set as stipple
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable
</parameter_description>
</parameter>
</parameters>
-<return> new #PangoAttribute
+<return> the colormap, or %NULL
</return>
</function>
-<function name="gdk_window_has_native">
+<function name="gdk_drawable_get_data">
<description>
-Checks whether the window has a native window or not. Note that
-you can use gdk_window_ensure_native() if a native window is needed.
+Equivalent to g_object_get_data(); the #GObject variant should be
+used instead.
-Since: 2.22
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> name the data was stored under
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the %window has a native window, %FALSE otherwise.
-
+<return> the data stored at @key
</return>
</function>
-<function name="gdk_window_raise">
+<function name="gdk_drawable_get_depth">
<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.
+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.
-If @window is a toplevel, the window manager may choose to deny the
-request to move the window in the Z-order, gdk_window_raise() only
-requests the restack, does not guarantee it.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> number of bits per pixel
+</return>
</function>
<function name="gdk_drawable_get_display">
@@ -3975,6 +4312,8 @@ Gets the #GdkDisplay associated with a #GdkDrawable.
Since: 2.2
+Deprecated: 2.24: Use gdk_window_get_display() instead
+
</description>
<parameters>
<parameter name="drawable">
@@ -3987,481 +4326,437 @@ Since: 2.2
</return>
</function>
-<function name="gdk_window_set_hints">
+<function name="gdk_drawable_get_image">
<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.
+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.
-If using GDK directly, use gdk_window_set_geometry_hints().
+ 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.
+
+Deprecated: 2.22: Use @drawable as the source and draw to a Cairo image
+surface if you want to download contents to the client.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable
</parameter_description>
</parameter>
<parameter name="x">
-<parameter_description> ignored field, does not matter
+<parameter_description> x coordinate on @drawable
</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> y coordinate on @drawable
</parameter_description>
</parameter>
-<parameter name="max_width">
-<parameter_description> max width hint
+<parameter name="width">
+<parameter_description> width of region to get
</parameter_description>
</parameter>
-<parameter name="max_height">
-<parameter_description> max height hint
+<parameter name="height">
+<parameter_description> height or region to get
</parameter_description>
</parameter>
-<parameter name="flags">
-<parameter_description> logical OR of GDK_HINT_POS, GDK_HINT_MIN_SIZE, and/or GDK_HINT_MAX_SIZE
+</parameters>
+<return> a #GdkImage containing the contents of @drawable
+
+</return>
+</function>
+
+<function name="gdk_drawable_get_screen">
+<description>
+Gets the #GdkScreen associated with a #GdkDrawable.
+
+Since: 2.2
+
+Deprecated: 2.24: Use gdk_window_get_screen() instead
+
+</description>
+<parameters>
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GdkScreen associated with @drawable
+
+</return>
</function>
-<function name="gdk_threads_add_timeout_seconds">
+<function name="gdk_drawable_get_size">
<description>
-A wrapper for the common usage of gdk_threads_add_timeout_seconds_full()
-assigning the default priority, #G_PRIORITY_DEFAULT.
+Fills * width and * height with the size of @drawable.
+ width or @height can be %NULL if you only want the other one.
-For details, see gdk_threads_add_timeout_full().
+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.
-Since: 2.14
+Deprecated: 2.24: Use gdk_window_get_width() and gdk_window_get_height() for
+#GdkWindows. Use gdk_pixmap_get_size() for #GdkPixmaps.
</description>
<parameters>
-<parameter name="interval">
-<parameter_description> the time between calls to the function, in seconds
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable
</parameter_description>
</parameter>
-<parameter name="function">
-<parameter_description> function to call
+<parameter name="width">
+<parameter_description> location to store drawable's width, or %NULL
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to pass to @function
+<parameter name="height">
+<parameter_description> location to store drawable's height, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) of the event source.
-
-</return>
+<return></return>
</function>
-<function name="gdk_window_is_input_only">
+<function name="gdk_drawable_get_visible_region">
<description>
-Determines whether or not the window is an input only window.
+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.
-Since: 2.22
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @window is input only
-
+<return> a #GdkRegion. This must be freed with gdk_region_destroy()
+when you are done.
</return>
</function>
-<function name="gdk_window_lower">
+<function name="gdk_drawable_get_visual">
<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.
+Gets the #GdkVisual describing the pixel format of @drawable.
-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().)
+Deprecated: 2.24: Use gdk_window_get_visual()
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #GdkVisual
+
+</return>
</function>
-<function name="gdk_keymap_get_default">
+<function name="gdk_drawable_ref">
<description>
-Returns the #GdkKeymap attached to the default display.
+Deprecated equivalent of calling g_object_ref() on @drawable.
+(Drawables were not objects in previous versions of GDK.)
+
+Deprecated: 2.0: Use g_object_ref() instead.
</description>
<parameters>
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable
+</parameter_description>
+</parameter>
</parameters>
-<return> the #GdkKeymap attached to the default display.
+<return> the same @drawable passed in
+
</return>
</function>
-<function name="gdk_screen_broadcast_client_message">
+<function name="gdk_drawable_set_colormap">
<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.
-
-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.
+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.
-Since: 2.2
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> the #GdkScreen where the event will be broadcasted.
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable
</parameter_description>
</parameter>
-<parameter name="event">
-<parameter_description> the #GdkEvent.
+<parameter name="colormap">
+<parameter_description> a #GdkColormap
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_set_icon_list">
+<function name="gdk_drawable_set_data">
<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.
+This function is equivalent to g_object_set_data(),
+the #GObject variant should be used instead.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> The #GdkWindow toplevel window to set the icon of.
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable
</parameter_description>
</parameter>
-<parameter name="pixbufs">
-<parameter_description> A list of pixbufs, of different sizes.
+<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_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_gc_get_screen">
+<function name="gdk_drawable_unref">
<description>
-Gets the #GdkScreen for which @gc was created
+Deprecated equivalent of calling g_object_unref() on @drawable.
-Since: 2.2
+Deprecated: 2.0: Use g_object_unref() instead.
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkScreen for @gc.
-
-</return>
+<return></return>
</function>
-<function name="gdk_cursor_new_from_pixbuf">
+<function name="gdk_drop_finish">
<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.
+Ends the drag operation after a drop.
-Since: 2.4
+This function is called by the drag destination.
</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 name="context">
+<parameter_description> a #GtkDragContext.
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> the horizontal offset of the 'hotspot' of the cursor.
+<parameter name="success">
+<parameter_description> %TRUE if the data was successfully received.
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> the vertical offset of the 'hotspot' of the cursor.
+<parameter name="time_">
+<parameter_description> the timestamp for this operation.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GdkCursor.
-
-</return>
+<return></return>
</function>
-<function name="gdk_gc_unref">
+<function name="gdk_drop_reply">
<description>
-Decrement the reference count of @gc.
+Accepts or rejects a drop.
-Deprecated: 2.0: Use g_object_unref() instead.
+This function is called by the drag destination in response
+to a drop initiated by the drag source.
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC
+<parameter name="context">
+<parameter_description> a #GdkDragContext.
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gdk_test_render_sync">
-<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 name="ok">
+<parameter_description> %TRUE if the drop is accepted.
+</parameter_description>
+</parameter>
+<parameter name="time_">
+<parameter_description> the timestamp for this operation.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_set_user_data">
+<function name="gdk_event_copy">
<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.
+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="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 copy of @event. The returned #GdkEvent should be freed with
+gdk_event_free().
+</return>
</function>
-<function name="gdk_window_get_decorations">
+<function name="gdk_event_free">
<description>
-Returns the decorations set on the GdkWindow with #gdk_window_set_decorations
+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() and gdk_event_new().
</description>
<parameters>
-<parameter name="window">
-<parameter_description> The toplevel #GdkWindow to get the decorations from
-</parameter_description>
-</parameter>
-<parameter name="decorations">
-<parameter_description> The window decorations will be written here
+<parameter name="event">
+<parameter_description> a #GdkEvent.
</parameter_description>
</parameter>
</parameters>
-<return> TRUE if the window has decorations set, FALSE otherwise.
-</return>
+<return></return>
</function>
-<function name="gdk_keymap_have_bidi_layouts">
+<function name="gdk_event_get">
<description>
-Determines if keyboard layouts for both right-to-left and left-to-right
-languages are in use.
+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().
-Since: 2.12
</description>
<parameters>
-<parameter name="keymap">
-<parameter_description> a #GdkKeymap or %NULL to use the default keymap
-</parameter_description>
-</parameter>
</parameters>
-<return> %TRUE if there are layouts in both directions, %FALSE otherwise
-
+<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_pointer_grab_info_libgtk_only">
+<function name="gdk_event_get_axis">
<description>
-Determines information about the current pointer grab.
-This is not public API and must not be used by applications.
+Extract the axis value for a particular axis use from
+an event structure.
</description>
<parameters>
-<parameter name="display">
-<parameter_description> the #GdkDisplay for which to get the grab information
+<parameter name="event">
+<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
-<parameter name="grab_window">
-<parameter_description> location to store current grab window
+<parameter name="axis_use">
+<parameter_description> the axis use to look for
</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="value">
+<parameter_description> location to store the value found
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if this application currently has the
-pointer grabbed.
+<return> %TRUE if the specified axis was found, otherwise %FALSE
</return>
</function>
-<function name="gdk_draw_line">
+<function name="gdk_event_get_coords">
<description>
-Draws a line, using the foreground color and other attributes of
-the #GdkGC.
+Extract the event window relative x/y coordinates from an event.
-Deprecated: 2.22: Use cairo_line_to() and cairo_stroke() instead.
-Be aware that the default line width in Cairo is 2 pixels and that your
-coordinates need to describe the center of the line. To draw a single
-pixel wide pixel-aligned line, you would use:
-|[cairo_set_line_width (cr, 1.0);
-cairo_set_line_cap (cr, CAIRO_LINE_CAP_SQUARE);
-cairo_move_to (cr, 0.5, 0.5);
-cairo_line_to (cr, 9.5, 0.5);
-cairo_stroke (cr);]|
-See also <ulink url="http://cairographics.org/FAQ/#sharp_lines">the Cairo
-FAQ</ulink> on this topic.
</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 name="event">
+<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
-<parameter name="x2_">
-<parameter_description> the x coordinate of the end point.
+<parameter name="x_win">
+<parameter_description> location to put event window x coordinate
</parameter_description>
</parameter>
-<parameter name="y2_">
-<parameter_description> the y coordinate of the end point.
+<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_drag_drop">
+<function name="gdk_event_get_graphics_expose">
<description>
-Drops on the current destination.
+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.
-This function is called by the drag source.
+Deprecated: 2.18:
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GdkDragContext.
-</parameter_description>
-</parameter>
-<parameter name="time_">
-<parameter_description> the timestamp for this operation.
+<parameter name="window">
+<parameter_description> the #GdkWindow to wait for the events for.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #GdkEventExpose if a GraphicsExpose was received, or %NULL if a
+NoExpose event was received.
+
+</return>
</function>
-<function name="gdk_window_input_shape_combine_mask">
+<function name="gdk_event_get_root_coords">
<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".
-
-On the X11 platform, this requires version 1.1 of the
-shape extension.
-
-On the Win32 platform, this functionality is not present and the
-function does nothing.
+Extract the root window relative x/y coordinates from an event.
-Since: 2.10
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="mask">
-<parameter_description> shape mask, or %NULL
+<parameter name="event">
+<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> X position of shape mask with respect to @window
+<parameter name="x_root">
+<parameter_description> location to put root window x coordinate
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> Y position of shape mask with respect to @window
+<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_event_get_screen">
@@ -4488,937 +4783,1026 @@ Since: 2.2
</return>
</function>
-<function name="gdk_pixbuf_render_pixmap_and_mask">
+<function name="gdk_event_get_state">
<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().
+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.
-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().
-If the pixbuf does not have an alpha channel, then * mask_return will be set
-to %NULL.
+</description>
+<parameters>
+<parameter name="event">
+<parameter_description> a #GdkEvent or NULL
+</parameter_description>
+</parameter>
+<parameter name="state">
+<parameter_description> return location for state
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if there was a state field in the event
+</return>
+</function>
+
+<function name="gdk_event_get_time">
+<description>
+Returns the time stamp from @event, if there is one; otherwise
+returns #GDK_CURRENT_TIME. If @event is %NULL, returns #GDK_CURRENT_TIME.
+
</description>
<parameters>
-<parameter name="pixbuf">
-<parameter_description> A pixbuf.
+<parameter name="event">
+<parameter_description> a #GdkEvent
</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> time stamp field from @event
+</return>
+</function>
+
+<function name="gdk_event_handler_set">
+<description>
+Sets the function to call to handle all events from GDK.
+
+Note that GTK+ uses this to install its own event handler, so it is
+usually not useful for GTK+ applications. (Although an application
+can call this function then call gtk_main_do_event() to pass
+events to GTK+.)
+
+</description>
+<parameters>
+<parameter name="func">
+<parameter_description> the function to call to handle events from GDK.
</parameter_description>
</parameter>
-<parameter name="mask_return">
-<parameter_description> Location to store a pointer to the created mask,
-or %NULL if the mask is not needed.
+<parameter name="data">
+<parameter_description> user data to pass to the function.
</parameter_description>
</parameter>
-<parameter name="alpha_threshold">
-<parameter_description> Threshold value for opacity values.
+<parameter name="notify">
+<parameter_description> the function to call when the handler function is removed, i.e. when
+gdk_event_handler_set() is called with another event handler.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_display_manager_list_displays">
+<function name="gdk_event_new">
<description>
-List all currently open displays.
+Creates a new event of the given type. All fields are set to 0.
Since: 2.2
</description>
<parameters>
-<parameter name="display_manager">
-<parameter_description> a #GdkDisplayManager
+<parameter name="type">
+<parameter_description> a #GdkEventType
</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> a newly-allocated #GdkEvent. The returned #GdkEvent
+should be freed with gdk_event_free().
</return>
</function>
-<function name="gdk_xid_table_lookup">
+<function name="gdk_event_peek">
<description>
-Returns the Gdk object associated with the given X id for the default
-display.
+If there is an event waiting in the event queue of some open
+display, returns a copy of it. See gdk_display_peek_event().
</description>
<parameters>
-<parameter name="xid">
-<parameter_description> an X id.
+</parameters>
+<return> a copy of the first #GdkEvent on some event queue, or %NULL if no
+events are in any queues. The returned #GdkEvent should be freed with
+gdk_event_free().
+</return>
+</function>
+
+<function name="gdk_event_put">
+<description>
+Appends a copy of the given event onto the front of the event
+queue for event->any.window's display, or the default event
+queue if event->any.window is %NULL. See gdk_display_put_event().
+
+</description>
+<parameters>
+<parameter name="event">
+<parameter_description> a #GdkEvent.
</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_request_motions">
<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().
+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:
-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.
+|[
+{
+/ * 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.10
+Since: 2.12
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="event">
+<parameter_description> a valid #GdkEvent
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_x11_screen_supports_net_wm_hint">
+<function name="gdk_event_send_client_message">
<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.
+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.
-Since: 2.2
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> the relevant #GdkScreen.
+<parameter name="event">
+<parameter_description> the #GdkEvent to send, which should be a #GdkEventClient.
</parameter_description>
</parameter>
-<parameter name="property">
-<parameter_description> a property atom.
+<parameter name="winid">
+<parameter_description> the window to send the X ClientMessage event to.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the window manager supports @property
-
+<return> non-zero on success.
</return>
</function>
-<function name="gdk_window_begin_resize_drag">
+<function name="gdk_event_send_client_message_for_display">
<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.
+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.
+
+Since: 2.2
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter name="display">
+<parameter_description> the #GdkDisplay for the window where the message is to be sent.
</parameter_description>
</parameter>
-<parameter name="edge">
-<parameter_description> the edge or corner from which the drag is started
+<parameter name="event">
+<parameter_description> the #GdkEvent to send, which should be a #GdkEventClient.
</parameter_description>
</parameter>
-<parameter name="button">
-<parameter_description> the button being used to drag
+<parameter name="winid">
+<parameter_description> the window to send the client message to.
</parameter_description>
</parameter>
-<parameter name="root_x">
-<parameter_description> root window X coordinate of mouse click that began the drag
+</parameters>
+<return> non-zero on success.
+
+</return>
+</function>
+
+<function name="gdk_event_send_clientmessage_toall">
+<description>
+Sends an X ClientMessage event to all toplevel windows on the default
+#GdkScreen.
+
+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_description>
</parameter>
-<parameter name="root_y">
-<parameter_description> root window Y coordinate of mouse click that began the drag
+</parameters>
+<return></return>
+</function>
+
+<function name="gdk_event_set_screen">
+<description>
+Sets the screen for @event to @screen. The event must
+have been allocated by GTK+, for instance, by
+gdk_event_copy().
+
+Since: 2.2
+
+</description>
+<parameters>
+<parameter name="event">
+<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
-<parameter name="timestamp">
-<parameter_description> timestamp of mouse click that began the drag (use gdk_event_get_time())
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_set_accept_focus">
+<function name="gdk_events_pending">
<description>
-Setting @accept_focus to %FALSE hints the desktop environment that the
-window doesn't want to receive input focus.
+Checks if any events are ready to be processed for any display.
-On X, it is the responsibility of the window manager to interpret this
-hint. ICCCM-compliant window manager usually respect it.
-Since: 2.4
+</description>
+<parameters>
+</parameters>
+<return> %TRUE if any events are pending.
+</return>
+</function>
+
+<function name="gdk_font_equal">
+<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.
+
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter name="fonta">
+<parameter_description> a #GdkFont.
</parameter_description>
</parameter>
-<parameter name="accept_focus">
-<parameter_description> %TRUE if the window should receive input focus
+<parameter name="fontb">
+<parameter_description> another #GdkFont.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the fonts are equal.
+</return>
</function>
-<function name="gdk_cursor_get_display">
+<function name="gdk_font_from_description">
<description>
-Returns the display on which the #GdkCursor is defined.
+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.
-Since: 2.2
</description>
<parameters>
-<parameter name="cursor">
-<parameter_description> a #GdkCursor.
+<parameter name="font_desc">
+<parameter_description> a #PangoFontDescription.
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkDisplay associated to @cursor
-
+<return> the newly loaded font, or %NULL if the font
+cannot be loaded.
</return>
</function>
-<function name="gdk_image_get_height">
+<function name="gdk_font_from_description_for_display">
<description>
-Determines the height of the image.
-
-Since: 2.22
+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.
-Deprecated: 2.22: #GdkImage should not be used anymore.
+Since: 2.2
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GdkImage
+<parameter name="display">
+<parameter_description> a #GdkDisplay
+</parameter_description>
+</parameter>
+<parameter name="font_desc">
+<parameter_description> a #PangoFontDescription.
</parameter_description>
</parameter>
</parameters>
-<return> the height
+<return> the newly loaded font, or %NULL if the font
+cannot be loaded.
</return>
</function>
-<function name="gdk_draw_image">
+<function name="gdk_font_get_display">
<description>
-Draws a #GdkImage onto a drawable.
-The depth of the #GdkImage must match the depth of the #GdkDrawable.
+Returns the #GdkDisplay for @font.
-Deprecated: 2.22: Do not use #GdkImage anymore, instead use Cairo image
-surfaces.
+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="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_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="font">
+<parameter_description> the #GdkFont.
</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.
+</parameters>
+<return> the corresponding #GdkDisplay.
+
+</return>
+</function>
+
+<function name="gdk_font_id">
+<description>
+Returns the X Font ID for the given font.
+
+
+</description>
+<parameters>
+<parameter name="font">
+<parameter_description> a #GdkFont.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the numeric X Font ID
+</return>
</function>
-<function name="gdk_pointer_is_grabbed">
+<function name="gdk_font_load">
<description>
-Returns %TRUE if the pointer on the default display is currently
-grabbed by this application.
+Loads a font.
-Note that this does not take the inmplicit pointer grab on button
-presses into account.
+The font may be newly loaded or looked up the font in a cache.
+You should make no assumptions about the initial reference count.
</description>
<parameters>
+<parameter name="font_name">
+<parameter_description> a XLFD describing the font to load.
+</parameter_description>
+</parameter>
</parameters>
-<return> %TRUE if the pointer is currently grabbed by this application.*
+<return> a #GdkFont, or %NULL if the font could not be loaded.
</return>
</function>
-<function name="gdk_device_get_key">
+<function name="gdk_font_load_for_display">
<description>
-If @index has a valid keyval, this function will
-fill in @keyval and @modifiers with the keyval settings.
+Loads a font for use on @display.
-Since: 2.22
+The font may be newly loaded or looked up the font in a cache.
+You should make no assumptions about the initial reference count.
+
+Since: 2.2
</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 name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="modifiers">
-<parameter_description> return value for modifiers.
+<parameter name="font_name">
+<parameter_description> a XLFD describing the font to load.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #GdkFont, or %NULL if the font could not be loaded.
+</return>
</function>
-<function name="gdk_window_set_composited">
+<function name="gdk_font_ref">
<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.
+Increases the reference count of a font by one.
-Since: 2.12
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="font">
+<parameter_description> a #GdkFont
</parameter_description>
</parameter>
-<parameter name="composited">
-<parameter_description> %TRUE to set the window as composited
+</parameters>
+<return> @font
+</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_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_set_icon_name">
+<function name="gdk_fontset_load">
<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.
+Loads a fontset.
-After calling this with a non-%NULL @name, calls to gdk_window_set_title()
-will not update the icon title.
+The fontset may be newly loaded or looked up in a cache.
+You should make no assumptions about the initial reference count.
-Using %NULL for @name unsets the icon title; further calls to
-gdk_window_set_title() will again update the icon title as well.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="name">
-<parameter_description> name of window while iconified (minimized)
+<parameter 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></return>
+<return> a #GdkFont, or %NULL if the fontset could not be loaded.
+</return>
</function>
-<function name="gdk_image_get_image_type">
+<function name="gdk_fontset_load_for_display">
<description>
-Determines the type of a given image.
+Loads a fontset for use on @display.
-Since: 2.22
+The fontset may be newly loaded or looked up in a cache.
+You should make no assumptions about the initial reference count.
-Deprecated: 2.22: #GdkImage should not be used anymore.
+Since: 2.2
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GdkImage
+<parameter name="display">
+<parameter_description> a #GdkDisplay
+</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_description>
</parameter>
</parameters>
-<return> the #GdkImageType of the image
-
+<return> a #GdkFont, or %NULL if the fontset could not be loaded.
</return>
</function>
-<function name="gdk_pango_renderer_set_override_color">
+<function name="gdk_gc_copy">
<description>
-Sets the color for a particular render part (foreground,
-background, underline, etc.), overriding any attributes on the layouts
-renderered with this renderer.
+Copy the set of values from one graphics context
+onto another graphics context.
-Since: 2.6
+Deprecated: 2.22: Use Cairo for drawing. cairo_save() and cairo_restore()
+can be helpful in cases where you'd have copied a #GdkGC.
</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 name="dst_gc">
+<parameter_description> the destination graphics context.
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> the color to use, or %NULL to unset a previously
-set override color.
+<parameter name="src_gc">
+<parameter_description> the source graphics context.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_event_new">
+<function name="gdk_gc_get_colormap">
<description>
-Creates a new event of the given type. All fields are set to 0.
+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.
-Since: 2.2
+Deprecated: 2.22: There is no replacement. Cairo handles colormaps
+automatically, so there is no need to care about them.
</description>
<parameters>
-<parameter name="type">
-<parameter_description> a #GdkEventType
+<parameter name="gc">
+<parameter_description> a #GdkGC
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated #GdkEvent. The returned #GdkEvent
-should be freed with gdk_event_free().
+<return> the colormap of @gc, or %NULL if @gc doesn't have one.
</return>
</function>
-<function name="gdk_window_reparent">
+<function name="gdk_gc_get_screen">
<description>
-Reparents @window into the given @new_parent. The window being
-reparented will be unmapped as a side effect.
+Gets the #GdkScreen for which @gc was created
+Since: 2.2
</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 name="gc">
+<parameter_description> a #GdkGC.
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> X location inside the new parent
+</parameters>
+<return> the #GdkScreen for @gc.
+
+</return>
+</function>
+
+<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.
+
+Deprecated: 2.22: Use Cairo for rendering.
+
+</description>
+<parameters>
+<parameter name="gc">
+<parameter_description> a #GdkGC.
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> Y location inside the new parent
+<parameter name="values">
+<parameter_description> the #GdkGCValues structure in which to store the results.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_string_to_compound_text_for_display">
+<function name="gdk_gc_new">
<description>
-Convert a string from the encoding of the current
-locale into a form suitable for storing in a window property.
+Create a new graphics context with default values.
-Since: 2.2
+Deprecated: 2.22: Use Cairo for rendering.
</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 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>
</parameters>
-<return> 0 upon success, non-zero upon failure.
+<return> the new graphics context.
</return>
</function>
-<function name="gdk_drawable_get_colormap">
+<function name="gdk_gc_new_with_values">
<description>
-Gets the colormap for @drawable, if one is set; returns
-%NULL otherwise.
+Create a new GC with the given initial values.
+Deprecated: 2.22: Use Cairo for rendering.
</description>
<parameters>
<parameter name="drawable">
-<parameter_description> a #GdkDrawable
+<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_description>
+</parameter>
+<parameter name="values_mask">
+<parameter_description> a bit mask indicating which fields in @values
+are set.
</parameter_description>
</parameter>
</parameters>
-<return> the colormap, or %NULL
+<return> the new graphics context.
+
</return>
</function>
-<function name="gdk_image_unref">
+<function name="gdk_gc_offset">
<description>
-Deprecated function; use g_object_unref() instead.
+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.
-Deprecated: 2.0: Use g_object_unref() instead.
+Deprecated: 2.22: There is no direct replacement, as this is just a
+convenience function for gdk_gc_set_ts_origin and gdk_gc_set_clip_origin().
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GdkImage
+<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_description>
+</parameter>
+<parameter name="y_offset">
+<parameter_description> amount by which to offset the GC in the Y direction
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_display_supports_input_shapes">
+<function name="gdk_gc_ref">
<description>
-Returns %TRUE if gdk_window_input_shape_combine_mask() can
-be used to modify the input shape of windows on @display.
+Deprecated function; use g_object_ref() instead.
-Since: 2.10
+Deprecated: 2.0: Use g_object_ref() instead.
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="gc">
+<parameter_description> a #GdkGC
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if windows with modified input shape are supported
+<return> the gc.
</return>
</function>
-<function name="gdk_window_get_events">
+<function name="gdk_gc_set_background">
<description>
-Gets the event mask for @window. See gdk_window_set_events().
+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.
+Deprecated: 2.22: Use gdk_cairo_set_source_color() to use a #GdkColor
+as the source in Cairo. Note that if you want to draw a background and a
+foreground in Cairo, you need to call drawing functions (like cairo_fill())
+twice.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="gc">
+<parameter_description> a #GdkGC.
+</parameter_description>
+</parameter>
+<parameter name="color">
+<parameter_description> the new background color.
</parameter_description>
</parameter>
</parameters>
-<return> event mask for @window
-</return>
+<return></return>
</function>
-<function name="gdk_pixmap_colormap_create_from_xpm">
+<function name="gdk_gc_set_clip_mask">
<description>
-Create a pixmap from a XPM file using a particular colormap.
+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()).
-Deprecated: 2.22: Use a #GdkPixbuf instead. You can use
-gdk_pixbuf_new_from_file() to create it.
-If you must use a pixmap, use gdk_pixmap_new() to
-create it and Cairo to draw the pixbuf onto it.
+Deprecated: 2.22: Use cairo_mask() 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 name="gc">
+<parameter_description> the #GdkGC.
</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_description> a bitmap.
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkPixmap.
-
-</return>
+<return></return>
</function>
-<function name="gdk_window_set_transient_for">
+<function name="gdk_gc_set_clip_origin">
<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.
+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.
-See gtk_window_set_transient_for() if you're using #GtkWindow or
-#GtkDialog.
+Deprecated: 2.22: Use cairo_translate() before applying the clip path in
+Cairo.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter name="gc">
+<parameter_description> a #GdkGC.
</parameter_description>
</parameter>
-<parameter name="parent">
-<parameter_description> another toplevel #GdkWindow
+<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_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_visual_get_bits_per_rgb">
+<function name="gdk_gc_set_clip_rectangle">
<description>
-Returns the number of significant bits per red, green and blue value.
+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()).
-Since: 2.22
+Deprecated: 2.22: Use cairo_rectangle() and cairo_clip() in Cairo.
</description>
<parameters>
-<parameter name="visual">
-<parameter_description> a #GdkVisual
+<parameter name="gc">
+<parameter_description> a #GdkGC.
+</parameter_description>
+</parameter>
+<parameter name="rectangle">
+<parameter_description> the rectangle to clip to.
</parameter_description>
</parameter>
</parameters>
-<return> The number of significant bits per color value for @visual.
-
-</return>
+<return></return>
</function>
-<function name="gdk_events_pending">
+<function name="gdk_gc_set_clip_region">
<description>
-Checks if any events are ready to be processed for any display.
+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()).
+Deprecated: 2.22: Use gdk_cairo_region() and cairo_clip() in Cairo.
</description>
<parameters>
+<parameter name="gc">
+<parameter_description> a #GdkGC.
+</parameter_description>
+</parameter>
+<parameter name="region">
+<parameter_description> the #GdkRegion.
+</parameter_description>
+</parameter>
</parameters>
-<return> %TRUE if any events are pending.
-</return>
+<return></return>
</function>
-<function name="gdk_gc_set_exposures">
+<function name="gdk_gc_set_colormap">
<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()).
+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.
-Deprecated: 2.22: There is no replacement. If you need to control
-exposures, you must use drawing operations of the underlying window
-system or use gdk_window_invalidate_rect(). Cairo will never
-generate exposures.
+Deprecated: 2.22: There is no replacement. Cairo handles colormaps
+automatically, so there is no need to care about them.
</description>
<parameters>
<parameter name="gc">
-<parameter_description> a #GdkGC.
+<parameter_description> a #GdkGC
</parameter_description>
</parameter>
-<parameter name="exposures">
-<parameter_description> if %TRUE, exposure events will be generated.
+<parameter name="colormap">
+<parameter_description> a #GdkColormap
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_screen_get_monitor_at_point">
+<function name="gdk_gc_set_dashes">
<description>
-Returns the monitor number in which the point (@x,@y) is located.
+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().)
-Since: 2.2
+The @dash_offset defines the phase of the pattern,
+specifying how many pixels into the dash-list the pattern
+should actually begin.
+
+Deprecated: 2.22: Use cairo_set_dash() to set the dash in Cairo.
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen.
+<parameter name="gc">
+<parameter_description> a #GdkGC.
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> the x coordinate in the virtual screen.
+<parameter name="dash_offset">
+<parameter_description> the phase of the dash pattern.
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> the y coordinate in the virtual screen.
+<parameter name="dash_list">
+<parameter_description> an array of dash lengths.
+</parameter_description>
+</parameter>
+<parameter name="n">
+<parameter_description> the number of elements in @dash_list.
</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>
+<return></return>
</function>
-<function name="gdk_window_set_modal_hint">
+<function name="gdk_gc_set_exposures">
<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.
+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()).
-You should only use this on windows for which you have
-previously called gdk_window_set_transient_for()
+Deprecated: 2.22: There is no replacement. If you need to control
+exposures, you must use drawing operations of the underlying window
+system or use gdk_window_invalidate_rect(). Cairo will never
+generate exposures.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> A toplevel #GdkWindow
+<parameter name="gc">
+<parameter_description> a #GdkGC.
</parameter_description>
</parameter>
-<parameter name="modal">
-<parameter_description> %TRUE if the window is modal, %FALSE otherwise.
+<parameter name="exposures">
+<parameter_description> if %TRUE, exposure events will be generated.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_drag_get_protocol_for_display">
+<function name="gdk_gc_set_fill">
<description>
-Finds out the DND protocol supported by a window.
+Set the fill mode for a graphics context.
-Since: 2.2
+Deprecated: 2.22: You can achieve tiling in Cairo by using
+cairo_pattern_set_extend() on the source. For stippling, see the
+deprecation comments on gdk_gc_set_stipple().
</description>
<parameters>
-<parameter name="display">
-<parameter_description> the #GdkDisplay where the destination window resides
-</parameter_description>
-</parameter>
-<parameter name="xid">
-<parameter_description> the windowing system id of the destination window.
+<parameter name="gc">
+<parameter_description> a #GdkGC.
</parameter_description>
</parameter>
-<parameter name="protocol">
-<parameter_description> location where the supported DND protocol is returned.
+<parameter name="fill">
+<parameter_description> the new fill mode.
</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>
+<return></return>
</function>
-<function name="gdk_font_ref">
+<function name="gdk_gc_set_font">
<description>
-Increases the reference count of a font by one.
-
+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.)
</description>
<parameters>
+<parameter name="gc">
+<parameter_description> a #GdkGC.
+</parameter_description>
+</parameter>
<parameter name="font">
-<parameter_description> a #GdkFont
+<parameter_description> the new font.
</parameter_description>
</parameter>
</parameters>
-<return> @font
-</return>
+<return></return>
</function>
-<function name="gdk_keyboard_grab_info_libgtk_only">
+<function name="gdk_gc_set_foreground">
<description>
-Determines information about the current keyboard grab.
-This is not public API and must not be used by applications.
+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.
+Deprecated: 2.22: Use gdk_cairo_set_source_color() to use a #GdkColor
+as the source in Cairo.
</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 name="gc">
+<parameter_description> a #GdkGC.
</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="color">
+<parameter_description> the new foreground color.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if this application currently has the
-keyboard grabbed.
-</return>
+<return></return>
</function>
-<function name="gdk_pixmap_lookup">
+<function name="gdk_gc_set_function">
<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 how the current pixel values and the
+pixel values being drawn are combined to produce
+the final pixel values.
+Deprecated: 2.22: Use cairo_set_operator() with Cairo.
</description>
<parameters>
-<parameter name="anid">
-<parameter_description> a native pixmap handle.
+<parameter name="gc">
+<parameter_description> a #GdkGC.
+</parameter_description>
+</parameter>
+<parameter name="function">
+<parameter_description> the #GdkFunction to use
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkPixmap wrapper for the native pixmap,
-or %NULL if there is none.
-</return>
+<return></return>
</function>
-<function name="gdk_draw_layout_line">
+<function name="gdk_gc_set_line_attributes">
<description>
-Render a #PangoLayoutLine onto an GDK drawable
+Sets various attributes of how lines are drawn. See
+the corresponding members of #GdkGCValues for full
+explanations of the arguments.
-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.
+Deprecated: 2.22: Use the Cairo functions cairo_set_line_width(),
+cairo_set_line_join(), cairo_set_line_cap() and cairo_set_dash()
+to affect the stroking behavior in Cairo. Keep in mind that the default
+attributes of a #cairo_t are different from the default attributes of
+a #GdkGC.
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> the drawable on which to draw the line
+<parameter name="gc">
+<parameter_description> a #GdkGC.
</parameter_description>
</parameter>
-<parameter name="gc">
-<parameter_description> base graphics to use
+<parameter name="line_width">
+<parameter_description> the width of lines.
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> the x position of start of string (in pixels)
+<parameter name="line_style">
+<parameter_description> the dash-style for lines.
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> the y position of baseline (in pixels)
+<parameter name="cap_style">
+<parameter_description> the manner in which the ends of lines are drawn.
</parameter_description>
</parameter>
-<parameter name="line">
-<parameter_description> a #PangoLayoutLine
+<parameter name="join_style">
+<parameter_description> the in which lines are joined together.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_display_peek_event">
+<function name="gdk_gc_set_rgb_bg_color">
<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.)
+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.
-Since: 2.2
+Calling this function for a GC without a colormap is an error.
+
+Deprecated: 2.22: Use gdk_cairo_set_source_color() instead.
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="gc">
+<parameter_description> a #GdkGC
+</parameter_description>
+</parameter>
+<parameter name="color">
+<parameter_description> an unallocated #GdkColor.
</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>
+<return></return>
</function>
-<function name="gdk_gc_set_rgb_bg_color">
+<function name="gdk_gc_set_rgb_fg_color">
<description>
-Set the background color of a GC using an unallocated color. The
+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
@@ -5442,962 +5826,1057 @@ Deprecated: 2.22: Use gdk_cairo_set_source_color() instead.
<return></return>
</function>
-<function name="gdk_window_move">
+<function name="gdk_gc_set_stipple">
<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.
+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.
-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.
+Deprecated: 2.22: Stippling has no direct replacement in Cairo. If you
+want to achieve an identical look, you can use the stipple bitmap as a
+mask. Most likely, this involves rendering the source to an intermediate
+surface using cairo_push_group() first, so that you can then use
+cairo_mask() to achieve the stippled look.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> X coordinate relative to window's parent
+<parameter name="gc">
+<parameter_description> a #GdkGC.
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> Y coordinate relative to window's parent
+<parameter name="stipple">
+<parameter_description> the new stipple bitmap.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_x11_window_move_to_current_desktop">
+<function name="gdk_gc_set_subwindow">
<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.
+Sets how drawing with this GC on a window will affect child
+windows of that window.
-Since: 2.8
+Deprecated: 2.22: There is no replacement. If you need to control
+subwindows, you must use drawing operations of the underlying window
+system manually. Cairo will always use %GDK_INCLUDE_INFERIORS on sources
+and masks and %GDK_CLIP_BY_CHILDREN on targets.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="gc">
+<parameter_description> a #GdkGC.
+</parameter_description>
+</parameter>
+<parameter name="mode">
+<parameter_description> the subwindow mode.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_display_manager_get_default_display">
+<function name="gdk_gc_set_tile">
<description>
-Gets the default #GdkDisplay.
+Set a tile pixmap for a graphics context.
+This will only be used if the fill mode
+is %GDK_TILED.
-Since: 2.2
+Deprecated: 2.22: The following code snippet sets a tiling #GdkPixmap
+as the source in Cairo:
+|[gdk_cairo_set_source_pixmap (cr, tile, ts_origin_x, ts_origin_y);
+cairo_pattern_set_extend (cairo_get_source (cr), CAIRO_EXTEND_REPEAT);]|
</description>
<parameters>
-<parameter name="display_manager">
-<parameter_description> a #GdkDisplayManager
+<parameter name="gc">
+<parameter_description> a #GdkGC.
+</parameter_description>
+</parameter>
+<parameter name="tile">
+<parameter_description> the new tile pixmap.
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkDisplay, or %NULL if there is no default
-display.
-
-</return>
+<return></return>
</function>
-<function name="gdk_window_set_cursor">
+<function name="gdk_gc_set_ts_origin">
<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.
+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.
+
+Deprecated: 2.22: You can set the origin for tiles and stipples in Cairo
+by changing the source's matrix using cairo_pattern_set_matrix(). Or you
+can specify it with gdk_cairo_set_source_pixmap() as shown in the example
+for gdk_gc_set_tile().
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="gc">
+<parameter_description> a #GdkGC.
</parameter_description>
</parameter>
-<parameter name="cursor">
-<parameter_description> a cursor
+<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_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_drop_finish">
+<function name="gdk_gc_set_values">
<description>
-Ends the drag operation after a drop.
+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.
-This function is called by the drag destination.
+Deprecated: 2.22: Use Cairo for rendering.
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GtkDragContext.
+<parameter name="gc">
+<parameter_description> a #GdkGC
</parameter_description>
</parameter>
-<parameter name="success">
-<parameter_description> %TRUE if the data was successfully received.
+<parameter name="values">
+<parameter_description> struct containing the new values
</parameter_description>
</parameter>
-<parameter name="time_">
-<parameter_description> the timestamp for this operation.
+<parameter name="values_mask">
+<parameter_description> mask indicating which struct fields are to be used
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_thaw_toplevel_updates_libgtk_only">
+<function name="gdk_gc_unref">
<description>
-Thaws a window frozen with
-gdk_window_freeze_toplevel_updates_libgtk_only().
+Decrement the reference count of @gc.
-This function is not part of the GDK public API and is only
-for use by GTK+.
+Deprecated: 2.0: Use g_object_unref() instead.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="gc">
+<parameter_description> a #GdkGC
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_maximize">
+<function name="gdk_get_default_root_window">
<description>
-Maximizes the window. If the window was already maximized, then
-this function does nothing.
+Obtains the root window (parent all other windows are inside)
+for the default display and screen.
-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>
+</parameters>
+<return> the default root window
+</return>
+</function>
+
+<function name="gdk_get_display_arg_name">
+<description>
+Gets the display name specified in the command line arguments passed
+to gdk_init() or gdk_parse_args(), if any.
+Since: 2.2
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
-</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_visual_get_depth">
+<function name="gdk_get_show_events">
<description>
-Returns the bit depth of this visual.
+Gets whether event debugging output is enabled.
-Since: 2.22
</description>
<parameters>
-<parameter name="visual">
-<parameter_description> A #GdkVisual.
-</parameter_description>
-</parameter>
</parameters>
-<return> The bit depth of this visual.
-
+<return> %TRUE if event debugging output is enabled.
</return>
</function>
-<function name="gdk_rectangle_intersect">
+<function name="gdk_image_get">
<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.
+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.
</description>
<parameters>
-<parameter name="src1">
-<parameter_description> a #GdkRectangle
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable
</parameter_description>
</parameter>
-<parameter name="src2">
-<parameter_description> a #GdkRectangle
+<parameter name="x">
+<parameter_description> x coordinate in @window
</parameter_description>
</parameter>
-<parameter name="dest">
-<parameter_description> return location for the
-intersection of @src1 and @src2, or %NULL
+<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> %TRUE if the rectangles intersect.
+<return> a new #GdkImage or %NULL
</return>
</function>
-<function name="gdk_window_process_all_updates">
+<function name="gdk_image_get_bits_per_pixel">
<description>
-Calls gdk_window_process_updates() for all windows (see #GdkWindow)
-in the application.
+Determines the number of bits per pixel of the image.
+
+Since: 2.22
+Deprecated: 2.22: #GdkImage should not be used anymore.
</description>
<parameters>
+<parameter name="image">
+<parameter_description> a #GdkImage
+</parameter_description>
+</parameter>
</parameters>
-<return></return>
+<return> the bits per pixel
+
+</return>
</function>
-<function name="gdk_window_set_skip_pager_hint">
+<function name="gdk_image_get_byte_order">
<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.
+Determines the byte order of the image.
-Since: 2.2
+Since: 2.22
+
+Deprecated: 2.22: #GdkImage should not be used anymore.
</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 name="image">
+<parameter_description> a #GdkImage
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #GdkVisual
+
+</return>
</function>
-<function name="gdk_get_display_arg_name">
+<function name="gdk_image_get_bytes_per_line">
<description>
-Gets the display name specified in the command line arguments passed
-to gdk_init() or gdk_parse_args(), if any.
+Determines the number of bytes per line of the image.
-Since: 2.2
+Since: 2.22
+
+Deprecated: 2.22: #GdkImage should not be used anymore.
</description>
<parameters>
+<parameter name="image">
+<parameter_description> a #GdkImage
+</parameter_description>
+</parameter>
</parameters>
-<return> the display name, if specified explicitely, otherwise %NULL
-this string is owned by GTK+ and must not be modified or freed.
+<return> the bytes per line
</return>
</function>
-<function name="gdk_region_get_rectangles">
+<function name="gdk_image_get_bytes_per_pixel">
<description>
-Obtains the area covered by the region as a list of rectangles.
-The array returned in @rectangles must be freed with g_free().
+Determines the number of bytes per pixel of the image.
+
+Since: 2.22
+
+Deprecated: 2.22: #GdkImage should not be used anymore.
</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="image">
+<parameter_description> a #GdkImage
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the bytes per pixel
+
+</return>
</function>
-<function name="gdk_colormap_get_system_size">
+<function name="gdk_image_get_colormap">
<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.)
+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().
+Deprecated: 2.22: #GdkImage should not be used anymore.
</description>
<parameters>
+<parameter name="image">
+<parameter_description> a #GdkImage
+</parameter_description>
+</parameter>
</parameters>
-<return> the size of the system's default colormap.
+<return> colormap for the image
+
</return>
</function>
-<function name="gdk_colormap_alloc_color">
+<function name="gdk_image_get_depth">
<description>
-Allocates a single color from a colormap.
+Determines the depth of the image.
+
+Since: 2.22
+Deprecated: 2.22: #GdkImage should not be used anymore.
</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="image">
+<parameter_description> a #GdkImage
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the allocation succeeded.
+<return> the depth
+
</return>
</function>
-<function name="gdk_window_beep">
+<function name="gdk_image_get_height">
<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().
+Determines the height of the image.
-Since: 2.12
+Since: 2.22
+
+Deprecated: 2.22: #GdkImage should not be used anymore.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter name="image">
+<parameter_description> a #GdkImage
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the height
+
+</return>
</function>
-<function name="gdk_screen_get_rgb_visual">
+<function name="gdk_image_get_image_type">
<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.
+Determines the type of a given image.
-Since: 2.2
+Since: 2.22
-Deprecated: 2.22: Use gdk_screen_get_system_visual()
+Deprecated: 2.22: #GdkImage should not be used anymore.
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="image">
+<parameter_description> a #GdkImage
</parameter_description>
</parameter>
</parameters>
-<return> The #GdkVisual chosen by GdkRGB.
+<return> the #GdkImageType of the image
</return>
</function>
-<function name="gdk_pango_context_get_for_screen">
+<function name="gdk_image_get_pixels">
<description>
-Creates a #PangoContext for @screen.
-
-The context must be freed when you're finished with it.
-
-When using GTK+, normally you should use gtk_widget_get_pango_context()
-instead of this function, to get the appropriate context for
-the widget you intend to render text onto.
+Returns a pointer to the pixel data of the image.
-The newly created context will have the default font options
-(see #cairo_font_options_t) for the screen; if these options
-change it will not be updated. Using gtk_widget_get_pango_context()
-is more convenient if you want to keep a context around and track
-changes to the screen's font rendering settings.
+Since: 2.22
-Since: 2.2
+Deprecated: 2.22: #GdkImage should not be used anymore.
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> the #GdkScreen for which the context is to be created.
+<parameter name="image">
+<parameter_description> a #GdkImage
</parameter_description>
</parameter>
</parameters>
-<return> a new #PangoContext for @screen
+<return> the pixel data of the image
</return>
</function>
-<function name="gdk_xid_table_lookup_for_display">
+<function name="gdk_image_get_visual">
<description>
-Returns the GDK object associated with the given X id.
+Determines the visual that was used to create the image.
-Since: 2.2
+Since: 2.22
+
+Deprecated: 2.22: #GdkImage should not be used anymore.
</description>
<parameters>
-<parameter name="display">
-<parameter_description> the #GdkDisplay.
-</parameter_description>
-</parameter>
-<parameter name="xid">
-<parameter_description> an X id.
+<parameter name="image">
+<parameter_description> a #GdkImage
</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 #GdkVisual
</return>
</function>
-<function name="gdk_app_launch_context_set_desktop">
+<function name="gdk_image_get_width">
<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>.
+Determines the width of the image.
-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.22
-Since: 2.14
+Deprecated: 2.22: #GdkImage should not be used anymore.
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GdkAppLaunchContext
-</parameter_description>
-</parameter>
-<parameter name="desktop">
-<parameter_description> the number of a workspace, or -1
+<parameter name="image">
+<parameter_description> a #GdkImage
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the width
+
+</return>
</function>
-<function name="gdk_colormap_unref">
+<function name="gdk_image_new_bitmap">
<description>
-Deprecated function; use g_object_unref() instead.
+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>
-Deprecated: 2.0: Use g_object_unref() instead.
</description>
<parameters>
-<parameter name="cmap">
-<parameter_description> a #GdkColormap
+<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_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GdkImage.
+</return>
</function>
-<function name="gdk_screen_get_system_visual">
+<function name="gdk_image_ref">
<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.
+Deprecated function; use g_object_ref() instead.
-Since: 2.2
+Deprecated: 2.0: Use g_object_ref() instead.
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen.
+<parameter name="image">
+<parameter_description> a #GdkImage
</parameter_description>
</parameter>
</parameters>
-<return> the system visual
+<return> the image
</return>
</function>
-<function name="gdk_window_remove_filter">
+<function name="gdk_image_set_colormap">
<description>
-Remove a filter previously added with gdk_window_add_filter().
+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.
+Deprecated: 2.22: #GdkImage should not be used anymore.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="function">
-<parameter_description> previously-added filter function
+<parameter name="image">
+<parameter_description> a #GdkImage
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> user data for previously-added filter function
+<parameter name="colormap">
+<parameter_description> a #GdkColormap
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_event_get_coords">
+<function name="gdk_image_unref">
<description>
-Extract the event window relative x/y coordinates from an event.
+Deprecated function; use g_object_unref() instead.
+Deprecated: 2.0: Use g_object_unref() instead.
</description>
<parameters>
-<parameter name="event">
-<parameter_description> a #GdkEvent
+<parameter name="image">
+<parameter_description> a #GdkImage
</parameter_description>
</parameter>
-<parameter name="x_win">
-<parameter_description> location to put event window x coordinate
+</parameters>
+<return></return>
+</function>
+
+<function name="gdk_init">
+<description>
+
+</description>
+<parameters>
+<parameter name="argc">
+<parameter_description>
</parameter_description>
</parameter>
-<parameter name="y_win">
-<parameter_description> location to put event window y coordinate
+<parameter name="argv">
+<parameter_description>
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the event delivered event window coordinates
-</return>
+<return></return>
</function>
-<function name="gdk_event_send_clientmessage_toall">
+<function name="gdk_init_check">
<description>
-Sends an X ClientMessage event to all toplevel windows on the default
-#GdkScreen.
+Initialize the library for use.
-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.
+Arguments:
+"argc" is the number of arguments.
+"argv" is an array of strings.
+
+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.
+
+Side effects:
+The library is initialized.
+
+--------------------------------------------------------------
</description>
<parameters>
-<parameter name="event">
-<parameter_description> the #GdkEvent to send, which should be a #GdkEventClient.
+<parameter name="argc">
+<parameter_description>
+</parameter_description>
+</parameter>
+<parameter name="argv">
+<parameter_description>
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_draw_arc">
+<function name="gdk_input_add">
<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.
+Establish a callback when a condition becomes true on
+a file descriptor.
-Deprecated: 2.22: Use cairo_arc() and cairo_fill() or cairo_stroke()
-instead. Note that arcs just like any drawing operation in Cairo are
-antialiased unless you call cairo_set_antialias().
+Deprecated: 2.14: Use g_io_add_watch() on a #GIOChannel
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
+<parameter name="source">
+<parameter_description> a file descriptor.
</parameter_description>
</parameter>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
+<parameter name="condition">
+<parameter_description> the condition.
</parameter_description>
</parameter>
-<parameter name="filled">
-<parameter_description> %TRUE if the arc should be filled, producing a 'pie slice'.
+<parameter name="function">
+<parameter_description> the callback function.
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> the x coordinate of the left edge of the bounding rectangle.
+<parameter name="data">
+<parameter_description> callback data passed to @function.
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> the y coordinate of the top edge of the bounding rectangle.
+</parameters>
+<return> a tag that can later be used as an argument to
+gdk_input_remove().
+
+</return>
+</function>
+
+<function name="gdk_input_add_full">
+<description>
+Establish a callback when a condition becomes true on
+a file descriptor.
+
+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="width">
-<parameter_description> the width of the bounding rectangle.
+<parameter name="condition">
+<parameter_description> the condition.
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> the height of the bounding rectangle.
+<parameter name="function">
+<parameter_description> the callback function.
</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 name="data">
+<parameter_description> callback data passed to @function.
</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="destroy">
+<parameter_description> callback function to call with @data when the input
+handler is removed.
</parameter_description>
</parameter>
</parameters>
-<return></return>
-</function>
-
-<function name="gdk_x11_cursor_get_xdisplay">
-<description>
-Returns the display of a #GdkCursor.
-
+<return> a tag that can later be used as an argument to
+gdk_input_remove().
-</description>
-<parameters>
-<parameter name="cursor">
-<parameter_description> a #GdkCursor.
-</parameter_description>
-</parameter>
-</parameters>
-<return> an Xlib <type>Display*</type>.
</return>
</function>
-<function name="gdk_pango_layout_get_clip_region">
+<function name="gdk_keyboard_grab_info_libgtk_only">
<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.
+Determines information about the current keyboard grab.
+This is not public API and must not be used by applications.
</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 name="display">
+<parameter_description> the display for which to get the grab information
</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="grab_window">
+<parameter_description> location to store current grab window
</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="owner_events">
+<parameter_description> location to store boolean indicating whether
+the @owner_events flag to gdk_keyboard_grab() was %TRUE.
</parameter_description>
</parameter>
</parameters>
-<return> a clip region containing the given ranges
+<return> %TRUE if this application currently has the
+keyboard grabbed.
</return>
</function>
-<function name="gdk_notify_startup_complete">
+<function name="gdk_keyboard_ungrab">
<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
+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_description>
+</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_drawable_get_image">
+<function name="gdk_keymap_add_virtual_modifiers">
<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.
+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.
-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.
+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.
-If the source drawable is a #GdkWindow and partially offscreen
-or obscured, then the obscured portions of the returned image
-will contain undefined data.
+This function is useful when matching key events against
+accelerators.
-Deprecated: 2.22: Use @drawable as the source and draw to a Cairo image
-surface if you want to download contents to the client.
+Since: 2.20
</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 name="keymap">
+<parameter_description> a #GdkKeymap
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> width of region to get
+<parameter name="state">
+<parameter_description> pointer to the modifier mask to change
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> height or region to get
+</parameters>
+<return></return>
+</function>
+
+<function name="gdk_keymap_get_caps_lock_state">
+<description>
+Returns whether the Caps Lock modifer is locked.
+
+Since: 2.16
+
+</description>
+<parameters>
+<parameter name="keymap">
+<parameter_description> a #GdkKeymap
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkImage containing the contents of @drawable
+<return> %TRUE if Caps Lock is on
</return>
</function>
-<function name="gdk_window_invalidate_rect">
+<function name="gdk_keymap_get_default">
<description>
-A convenience wrapper around gdk_window_invalidate_region() which
-invalidates a rectangular region. See
-gdk_window_invalidate_region() for details.
+Returns the #GdkKeymap attached to the default display.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="rect">
-<parameter_description> rectangle to invalidate or %NULL to invalidate the whole
-window
-</parameter_description>
-</parameter>
-<parameter name="invalidate_children">
-<parameter_description> whether to also invalidate child windows
+</parameters>
+<return> the #GdkKeymap attached to the default display.
+</return>
+</function>
+
+<function name="gdk_keymap_get_direction">
+<description>
+Returns the direction of effective layout of the keymap.
+
+Note that passing %NULL for @keymap is deprecated and will stop
+to work in GTK+ 3.0. Use gdk_keymap_get_for_display() instead.
+
+
+</description>
+<parameters>
+<parameter name="keymap">
+<parameter_description> a #GdkKeymap or %NULL to use the default keymap
</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_window_resize">
+<function name="gdk_keymap_get_entries_for_keycode">
<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.
+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().
-Windows may not be resized below 1x1.
+Note that passing %NULL for @keymap is deprecated and will stop
+to work in GTK+ 3.0. Use gdk_keymap_get_for_display() instead.
-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="keymap">
+<parameter_description> a #GdkKeymap or %NULL to use the default keymap
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> new width of the window
+<parameter name="hardware_keycode">
+<parameter_description> a keycode
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> new height of the window
+<parameter name="keys">
+<parameter_description> return location for array of #GdkKeymapKey, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="keyvals">
+<parameter_description> return location for array of keyvals, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="n_entries">
+<parameter_description> length of @keys and @keyvals
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if there were any entries
+</return>
</function>
-<function name="gdk_device_get_state">
+<function name="gdk_keymap_get_entries_for_keyval">
<description>
-Gets the current state of a device.
+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().
+
+Note that passing %NULL for @keymap is deprecated and will stop
+to work in GTK+ 3.0. Use gdk_keymap_get_for_display() instead.
+
</description>
<parameters>
-<parameter name="device">
-<parameter_description> a #GdkDevice.
+<parameter name="keymap">
+<parameter_description> a #GdkKeymap, or %NULL to use the default keymap
</parameter_description>
</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow.
+<parameter name="keyval">
+<parameter_description> a keyval, such as %GDK_a, %GDK_Up, %GDK_Return, etc.
</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 name="keys">
+<parameter_description> return location for an array of #GdkKeymapKey
</parameter_description>
</parameter>
-<parameter name="mask">
-<parameter_description> location to store the modifiers, or %NULL.
+<parameter name="n_keys">
+<parameter_description> return location for number of elements in returned array
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if keys were found and returned
+</return>
</function>
-<function name="gdk_device_get_has_cursor">
+<function name="gdk_keymap_get_for_display">
<description>
-Determines whether the pointer follows device motion.
+Returns the #GdkKeymap attached to @display.
-Since: 2.22
+Since: 2.2
</description>
<parameters>
-<parameter name="device">
-<parameter_description> a #GdkDevice
+<parameter name="display">
+<parameter_description> the #GdkDisplay.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the pointer follows device motion
-
+<return> the #GdkKeymap attached to @display.
</return>
</function>
-<function name="gdk_gc_ref">
+<function name="gdk_keymap_have_bidi_layouts">
<description>
-Deprecated function; use g_object_ref() instead.
+Determines if keyboard layouts for both right-to-left and left-to-right
+languages are in use.
-Deprecated: 2.0: Use g_object_ref() instead.
+Note that passing %NULL for @keymap is deprecated and will stop
+to work in GTK+ 3.0. Use gdk_keymap_get_for_display() instead.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC
+<parameter name="keymap">
+<parameter_description> a #GdkKeymap or %NULL to use the default keymap
</parameter_description>
</parameter>
</parameters>
-<return> the gc.
+<return> %TRUE if there are layouts in both directions, %FALSE otherwise
</return>
</function>
-<function name="gdk_draw_rectangle">
+<function name="gdk_keymap_lookup_key">
<description>
-Draws a rectangular outline or filled rectangle, using the foreground color
-and other attributes of the #GdkGC.
+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.
-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.
+Note that passing %NULL for @keymap is deprecated and will stop
+to work in GTK+ 3.0. Use gdk_keymap_get_for_display() instead.
-Deprecated: 2.22: Use cairo_rectangle() and cairo_fill() or cairo_stroke()
-instead. For stroking, the same caveats for converting code apply as for
-gdk_draw_line().
</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 rectangle should be filled.
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> the x coordinate of the left edge of the rectangle.
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> the y coordinate of the top edge of the rectangle.
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> the width of the rectangle.
+<parameter name="keymap">
+<parameter_description> a #GdkKeymap or %NULL to use the default keymap
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> the height of the rectangle.
+<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_window_set_group">
+<function name="gdk_keymap_map_virtual_modifiers">
<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.
+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.
-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.
+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="leader">
-<parameter_description> group leader window, or %NULL to restore the default group leader window
+<parameter name="state">
+<parameter_description> pointer to the modifier state to map
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<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_x11_grab_server">
+<function name="gdk_keymap_translate_keyboard_state">
<description>
-Call gdk_x11_display_grab() on the default display.
-To ungrab the server again, use gdk_x11_ungrab_server().
+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>
+
+Note that passing %NULL for @keymap is deprecated and will stop
+to work in GTK+ 3.0. Use gdk_keymap_get_for_display() instead.
-gdk_x11_grab_server()/gdk_x11_ungrab_server() calls can be nested.
</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_description>
+</parameter>
</parameters>
-<return></return>
+<return> %TRUE if there was a keyval bound to the keycode/state/group
+</return>
</function>
<function name="gdk_keyval_convert_case">
@@ -6424,1521 +6903,1581 @@ Examples of keyvals are #GDK_a, #GDK_Enter, #GDK_F1, etc.
<return></return>
</function>
-<function name="gdk_draw_point">
+<function name="gdk_keyval_to_unicode">
<description>
-Draws a point, using the foreground color and other attributes of
-the #GdkGC.
+Convert from a GDK key symbol to the corresponding ISO10646 (Unicode)
+character.
-Deprecated: 2.22: Use cairo_rectangle() and cairo_fill() or
-cairo_move_to() and cairo_stroke() instead.
</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="x">
-<parameter_description> the x coordinate of the point.
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> the y coordinate of the point.
+<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_display_store_clipboard">
+<function name="gdk_list_visuals">
<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>.
+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.
-Since: 2.6
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
-</parameter_description>
-</parameter>
-<parameter name="clipboard_window">
-<parameter_description> a #GdkWindow belonging to the clipboard owner
-</parameter_description>
-</parameter>
-<parameter name="time_">
-<parameter_description> a timestamp
-</parameter_description>
-</parameter>
-<parameter name="targets">
-<parameter_description> an array of targets that should be saved, or %NULL
-if all available targets should be saved.
-</parameter_description>
-</parameter>
-<parameter name="n_targets">
-<parameter_description> length of the @targets array
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return>
+a list of visuals; the list must be freed, but not its contents
+</return>
</function>
-<function name="gdk_x11_font_get_xdisplay">
+<function name="gdk_mbstowcs">
<description>
-Returns the display of a #GdkFont.
+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').
</description>
<parameters>
-<parameter name="font">
-<parameter_description> a #GdkFont.
+<parameter name="dest">
+<parameter_description> the space to place the converted wide character string into.
+</parameter_description>
+</parameter>
+<parameter name="src">
+<parameter_description> the multi-byte string to convert, which must be nul-terminated.
+</parameter_description>
+</parameter>
+<parameter name="dest_max">
+<parameter_description> the maximum number of wide characters to place in @dest.
</parameter_description>
</parameter>
</parameters>
-<return> an Xlib <type>Display*</type>.
+<return> the number of wide characters written into @dest, or -1 if
+the conversion failed.
</return>
</function>
-<function name="gdk_visual_get_red_pixel_details">
+<function name="gdk_net_wm_supports">
<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.
+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.
-Since: 2.22
+Deprecated:2.24: Use gdk_x11_screen_supports_net_wm_hint() instead
</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 name="property">
+<parameter_description> a property atom.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the window manager supports @property
+
+</return>
</function>
-<function name="gdk_draw_trapezoids">
+<function name="gdk_notify_startup_complete">
<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.
+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.
-Since: 2.6
+GTK+ will call this function automatically after opening the first
+#GtkWindow unless gtk_window_set_auto_startup_notification() is called
+to disable that feature.
-Deprecated: 2.22: Use Cairo path contruction functions and cairo_fill()
-instead.
+Since: 2.2
</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_description>
-</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_drawable_get_size">
+<function name="gdk_notify_startup_complete_with_id">
<description>
-Fills * width and * height with the size of @drawable.
- width or @height can be %NULL if you only want the other one.
+Indicates to the GUI environment that the application has finished
+loading, using a given identifier.
-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.
+GTK+ will call this function automatically for #GtkWindow with custom
+startup-notification identifier unless
+gtk_window_set_auto_startup_notification() is called to disable
+that feature.
+Since: 2.12
</description>
<parameters>
-<parameter name="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="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_x11_screen_lookup_visual">
+<function name="gdk_offscreen_window_get_embedder">
<description>
-Looks up the #GdkVisual for a particular screen and X Visual ID.
+Gets the window that @window is embedded in.
-Since: 2.2
+Since: 2.18
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen.
-</parameter_description>
-</parameter>
-<parameter name="xvisualid">
-<parameter_description> an X Visual ID.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkVisual (owned by the screen object), or %NULL
-if the visual ID wasn't found.
+<return> the embedding #GdkWindow, or %NULL if @window is not an
+embedded offscreen window
</return>
</function>
-<function name="gdk_screen_get_primary_monitor">
+<function name="gdk_offscreen_window_get_pixmap">
<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.
+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.
-Since: 2.20
+Since: 2.18
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> An integer index for the primary monitor, or 0 if none is configured.
+<return> The offscreen pixmap, or %NULL if not offscreen
</return>
</function>
-<function name="gdk_win32_hdc_release">
+<function name="gdk_offscreen_window_set_embedder">
<description>
-This function deallocates the Windows device context allocated by
-<funcion>gdk_win32_hdc_get()</function>. It should be called with
-the same parameters.
+Sets @window to be embedded in @embedder.
+
+To fully embed an offscreen window, in addition to calling this
+function, it is also necessary to handle the #GdkWindow::pick-embedded-child
+signal on the @embedder and the #GdkWindow::to-embedder and
+#GdkWindow::from-embedder signals on @window.
+
+Since: 2.18
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> destination #GdkDrawable
-</parameter_description>
-</parameter>
-<parameter name="gc">
-<parameter_description> #GdkGC to use for drawing on @drawable
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="usage">
-<parameter_description> mask indicating what properties were set up
+<parameter name="embedder">
+<parameter_description> the #GdkWindow that @window gets embedded in
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_display_supports_selection_notification">
+<function name="gdk_pango_attr_emboss_color_new">
<description>
-Returns whether #GdkEventOwnerChange events will be
-sent when the owner of a selection changes.
+Creates a new attribute specifying the color to emboss text with.
-Since: 2.6
+Since: 2.12
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="color">
+<parameter_description> a GdkColor representing the color to emboss with
</parameter_description>
</parameter>
</parameters>
-<return> whether #GdkEventOwnerChange events will
-be sent.
+<return> new #PangoAttribute
</return>
</function>
-<function name="gdk_screen_get_display">
+<function name="gdk_pango_attr_embossed_new">
<description>
-Gets the display to which the @screen belongs.
+Creates a new attribute flagging a region as embossed or not.
-Since: 2.2
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="embossed">
+<parameter_description> if the region should be embossed
</parameter_description>
</parameter>
</parameters>
-<return> the display to which @screen belongs
-
+<return> new #PangoAttribute
</return>
</function>
-<function name="gdk_visual_get_green_pixel_details">
+<function name="gdk_pango_attr_stipple_new">
<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.
+Creates a new attribute containing a stipple bitmap to be used when
+rendering the text.
-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 name="stipple">
+<parameter_description> a bitmap to be set as stipple
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> new #PangoAttribute
+</return>
</function>
-<function name="gdk_rgb_find_color">
+<function name="gdk_pango_context_get">
<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().
+Creates a #PangoContext for the default GDK screen.
- 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.
+The context must be freed when you're finished with it.
-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().
+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.
-Deprecated: 2.22: Cairo handles colors automatically.
</description>
<parameters>
-<parameter name="colormap">
-<parameter_description> a #GdkColormap
-</parameter_description>
-</parameter>
-<parameter name="color">
-<parameter_description> a #GdkColor
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> a new #PangoContext for the default display
+</return>
</function>
-<function name="gdk_x11_screen_get_screen_number">
+<function name="gdk_pango_context_get_for_screen">
<description>
-Returns the index of a #GdkScreen.
+Creates a #PangoContext for @screen.
+
+The context must be freed when you're finished with it.
+
+When using GTK+, normally you should use gtk_widget_get_pango_context()
+instead of this function, to get the appropriate context for
+the widget you intend to render text onto.
+
+The newly created context will have the default font options
+(see #cairo_font_options_t) for the screen; if these options
+change it will not be updated. Using gtk_widget_get_pango_context()
+is more convenient if you want to keep a context around and track
+changes to the screen's font rendering settings.
Since: 2.2
</description>
<parameters>
<parameter name="screen">
-<parameter_description> a #GdkScreen.
+<parameter_description> the #GdkScreen for which the context is to be created.
</parameter_description>
</parameter>
</parameters>
-<return> the position of @screen among the screens of
-its display.
+<return> a new #PangoContext for @screen
+
</return>
</function>
-<function name="gdk_drag_context_get_actions">
+<function name="gdk_pango_context_set_colormap">
<description>
-Determines the bitmask of actions proposed by the source if
-gdk_drag_context_suggested_action() returns GDK_ACTION_ASK.
-
-Since: 2.22
+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.
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #GdkDragContext
+<parameter_description> a #PangoContext
+</parameter_description>
+</parameter>
+<parameter name="colormap">
+<parameter_description> a #GdkColormap
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkDragAction flags
-
-</return>
+<return></return>
</function>
-<function name="gdk_threads_add_idle_full">
+<function name="gdk_pango_layout_get_clip_region">
<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 * /
-}
+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.
-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);
-}
-]|
+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.12
</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 name="layout">
+<parameter_description> a #PangoLayout
</parameter_description>
</parameter>
-<parameter name="function">
-<parameter_description> function to call
+<parameter name="x_origin">
+<parameter_description> X pixel where you intend to draw the layout with this clip
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to pass to @function
+<parameter name="y_origin">
+<parameter_description> Y pixel where you intend to draw the layout with this clip
</parameter_description>
</parameter>
-<parameter name="notify">
-<parameter_description> function to call when the idle is removed, or %NULL
+<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> the ID (greater than 0) of the event source.
-
+<return> a clip region containing the given ranges
</return>
</function>
-<function name="gdk_draw_glyphs_transformed">
+<function name="gdk_pango_layout_line_get_clip_region">
<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().
+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.
-Since: 2.6
+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.
-Deprecated: 2.22: Use pango_cairo_show_glyphs() instead.
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
+<parameter name="line">
+<parameter_description> a #PangoLayoutLine
</parameter_description>
</parameter>
-<parameter name="gc">
-<parameter_description> a #GdkGC
+<parameter name="x_origin">
+<parameter_description> X pixel where you intend to draw the layout line with this clip
</parameter_description>
</parameter>
-<parameter name="matrix">
-<parameter_description> a #PangoMatrix, or %NULL to use an identity transformation
+<parameter name="y_origin">
+<parameter_description> baseline pixel where you intend to draw the layout line with this clip
</parameter_description>
</parameter>
-<parameter name="font">
-<parameter_description> the font in which to draw the string
+<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="x">
-<parameter_description> the x position of the start of the string (in Pango
-units in user space coordinates)
+<parameter name="n_ranges">
+<parameter_description> number of ranges in @index_ranges, i.e. half the size of @index_ranges
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> the y position of the baseline (in Pango units
-in user space coordinates)
+</parameters>
+<return> a clip region containing the given ranges
+</return>
+</function>
+
+<function name="gdk_pango_renderer_get_default">
+<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().
+
+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.
+
+Since: 2.6
+
+</description>
+<parameters>
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
-<parameter name="glyphs">
-<parameter_description> the glyph string to draw
+</parameters>
+<return> the default #PangoRenderer for @screen. The
+renderer is owned by GTK+ and will be kept around until the
+screen is closed.
+
+</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_description>
</parameter>
</parameters>
-<return></return>
+<return> a newly created #PangoRenderer. Free with g_object_unref().
+
+</return>
</function>
-<function name="gdk_window_get_user_data">
+<function name="gdk_pango_renderer_set_drawable">
<description>
-Retrieves the user data for @window, which is normally the widget
-that @window belongs to. See gdk_window_set_user_data().
+Sets the drawable the renderer draws to.
+Since: 2.6
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="gdk_renderer">
+<parameter_description> a #GdkPangoRenderer
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> return location for user data
+<parameter name="drawable">
+<parameter_description> the new target drawable, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_x11_font_get_xfont">
+<function name="gdk_pango_renderer_set_gc">
<description>
-Returns the X font belonging to a #GdkFont.
+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.
+Since: 2.6
</description>
<parameters>
-<parameter name="font">
-<parameter_description> a #GdkFont.
+<parameter name="gdk_renderer">
+<parameter_description> a #GdkPangoRenderer
+</parameter_description>
+</parameter>
+<parameter name="gc">
+<parameter_description> the new GC to use for drawing, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> an Xlib <type>XFontStruct*</type> or an <type>XFontSet</type>.
-</return>
+<return></return>
</function>
-<function name="gdk_display_get_core_pointer">
+<function name="gdk_pango_renderer_set_override_color">
<description>
-Returns the core pointer device for the given display
+Sets the color for a particular render part (foreground,
+background, underline, etc.), overriding any attributes on the layouts
+renderered with this renderer.
-Since: 2.2
+Since: 2.6
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<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> the core pointer device; this is owned by the
-display and should not be freed.
-
-</return>
+<return></return>
</function>
-<function name="gdk_x11_screen_get_monitor_output">
+<function name="gdk_pango_renderer_set_stipple">
<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.
+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.
-Since: 2.14
+Since: 2.6
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="gdk_renderer">
+<parameter_description> a #GdkPangoRenderer
</parameter_description>
</parameter>
-<parameter name="monitor_num">
-<parameter_description> number of the monitor, between 0 and gdk_screen_get_n_monitors (screen)
+<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> the XID of the monitor
-
-</return>
+<return></return>
</function>
-<function name="gdk_notify_startup_complete_with_id">
+<function name="gdk_parse_args">
<description>
-Indicates to the GUI environment that the application has finished
-loading, using a given identifier.
+Parse command line arguments, and store for future
+use by calls to gdk_display_open().
-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.
+Any arguments used by GDK are removed from the array and @argc and @argv are
+updated accordingly.
-Since: 2.12
+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="startup_id">
-<parameter_description> a startup-notification identifier, for which notification
-process should be completed
+<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_window_redirect_to_drawable">
+<function name="gdk_pixbuf_get_from_drawable">
<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 #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.
-Only drawing between gdk_window_begin_paint_region() or
-gdk_window_begin_paint_rect() and gdk_window_end_paint() is
-redirected.
+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.
-Redirection is active until gdk_window_remove_redirection()
-is called.
+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.
-Since: 2.14
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="dest">
+<parameter_description> Destination pixbuf, or %NULL if a new pixbuf should be created.
</parameter_description>
</parameter>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
+<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> x position in @window
+<parameter_description> Source X coordinate within drawable.
</parameter_description>
</parameter>
<parameter name="src_y">
-<parameter_description> y position in @window
+<parameter_description> Source Y coordinate within drawable.
</parameter_description>
</parameter>
<parameter name="dest_x">
-<parameter_description> x position in @drawable
+<parameter_description> Destination X coordinate in pixbuf, or 0 if @dest is NULL.
</parameter_description>
</parameter>
<parameter name="dest_y">
-<parameter_description> y position in @drawable
+<parameter_description> Destination Y coordinate in pixbuf, or 0 if @dest is NULL.
</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> 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>
</function>
-<function name="gdk_pango_attr_embossed_new">
+<function name="gdk_pixbuf_get_from_image">
<description>
-Creates a new attribute flagging a region as embossed or not.
+Same as gdk_pixbuf_get_from_drawable() but gets the pixbuf from
+an image.
</description>
<parameters>
-<parameter name="embossed">
-<parameter_description> if the region should be embossed
+<parameter name="dest">
+<parameter_description> Destination pixbuf, or %NULL if a new pixbuf should be created.
</parameter_description>
</parameter>
-</parameters>
-<return> new #PangoAttribute
-</return>
-</function>
-
-<function name="gdk_display_keyboard_ungrab">
-<description>
-Release any keyboard grab
-
-Since: 2.2
-
-</description>
-<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay.
+<parameter name="src">
+<parameter_description> Source #GdkImage.
</parameter_description>
</parameter>
-<parameter name="time_">
-<parameter_description> a timestap (e.g #GDK_CURRENT_TIME).
+<parameter name="cmap">
+<parameter_description> A colormap, or %NULL to use the one for @src
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gdk_net_wm_supports">
-<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.
-
-
-</description>
-<parameters>
-<parameter name="property">
-<parameter_description> a property atom.
+<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_description>
</parameter>
</parameters>
-<return> %TRUE if the window manager supports @property
+<return> @dest, newly-created pixbuf if @dest was %NULL, %NULL on error
</return>
</function>
-<function name="gdk_window_stick">
+<function name="gdk_pixbuf_render_pixmap_and_mask">
<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.)
+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().
-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.
+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().
+If the pixbuf does not have an alpha channel, then * mask_return will be set
+to %NULL.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<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_description>
+</parameter>
+<parameter name="alpha_threshold">
+<parameter_description> Threshold value for opacity values.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_screen_get_system_colormap">
+<function name="gdk_pixbuf_render_pixmap_and_mask_for_colormap">
<description>
-Gets the system's default colormap for @screen
+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().
-Since: 2.2
+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.
+
+If the pixbuf does not have an alpha channel, then * mask_return will be set
+to %NULL.
</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>
-</function>
-
-<function name="gdk_x11_xatom_to_atom_for_display">
-<description>
-Convert from an X atom for a #GdkDisplay to the corresponding
-#GdkAtom.
-
-Since: 2.2
-
-</description>
-<parameters>
-<parameter name="display">
-<parameter_description> A #GdkDisplay
+<parameter name="colormap">
+<parameter_description> A #GdkColormap
</parameter_description>
</parameter>
-<parameter name="xatom">
-<parameter_description> an X atom
+<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_description>
+</parameter>
+<parameter name="alpha_threshold">
+<parameter_description> Threshold value for opacity values.
</parameter_description>
</parameter>
</parameters>
-<return> the corresponding #GdkAtom.
-
-</return>
+<return></return>
</function>
-<function name="gdk_window_unmaximize">
+<function name="gdk_pixbuf_render_threshold_alpha">
<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.
+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.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<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_description>
+</parameter>
+<parameter name="width">
+<parameter_description> Width of region to threshold, or -1 to use pixbuf width
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> Height of region to threshold, or -1 to use pixbuf height
+</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_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_draw_layout">
+<function name="gdk_pixbuf_render_to_drawable">
<description>
-Render a #PangoLayout onto a GDK drawable
+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.
-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.
+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.
-If you're using GTK+, the usual way to obtain a #PangoLayout
-is gtk_widget_create_pango_layout().
+Deprecated: 2.4: This function is obsolete. Use gdk_draw_pixbuf() instead.
</description>
<parameters>
+<parameter name="pixbuf">
+<parameter_description> A pixbuf.
+</parameter_description>
+</parameter>
<parameter name="drawable">
-<parameter_description> the drawable on which to draw string
+<parameter_description> Destination drawable.
</parameter_description>
</parameter>
<parameter name="gc">
-<parameter_description> base graphics context to use
+<parameter_description> GC used for rendering.
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> the X position of the left of the layout (in pixels)
+<parameter name="src_x">
+<parameter_description> Source X coordinate within pixbuf.
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> the Y position of the top of the layout (in pixels)
+<parameter name="src_y">
+<parameter_description> Source Y coordinate within pixbuf.
</parameter_description>
</parameter>
-<parameter name="layout">
-<parameter_description> a #PangoLayout
+<parameter name="dest_x">
+<parameter_description> Destination X coordinate within drawable.
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gdk_window_process_updates">
-<description>
-Sends one or more expose events to @window. The areas in each
-expose event will cover the entire update area for the window (see
-gdk_window_invalidate_region() for details). Normally GDK calls
-gdk_window_process_all_updates() on your behalf, so there's no
-need to call this function unless you want to force expose events
-to be delivered immediately and synchronously (vs. the usual
-case, where GDK delivers them in an idle handler). Occasionally
-this is useful to produce nicer scrolling behavior, for example.
-
-
-</description>
-<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="dest_y">
+<parameter_description> Destination Y coordinate within drawable.
</parameter_description>
</parameter>
-<parameter name="update_children">
-<parameter_description> whether to also process updates for child windows
+<parameter name="width">
+<parameter_description> Width of region to render, in pixels, or -1 to use pixbuf width
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gdk_window_focus">
-<description>
-Sets keyboard focus to @window. In most cases, gtk_window_present()
-should be used on a #GtkWindow, rather than calling this function.
-
-
-</description>
-<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="height">
+<parameter_description> Height of region to render, in pixels, or -1 to use pixbuf height
</parameter_description>
</parameter>
-<parameter name="timestamp">
-<parameter_description> timestamp of the event triggering the window focus
+<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>
</function>
-<function name="gdk_draw_segments">
+<function name="gdk_pixbuf_render_to_drawable_alpha">
<description>
-Draws a number of unconnected lines.
+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.
-Deprecated: 2.22: Use cairo_move_to(), cairo_line_to() and cairo_stroke()
-instead. See the documentation of gdk_draw_line() for notes on line drawing
-with Cairo.
+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.
</description>
<parameters>
+<parameter name="pixbuf">
+<parameter_description> A pixbuf.
+</parameter_description>
+</parameter>
<parameter name="drawable">
-<parameter_description> a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
+<parameter_description> Destination drawable.
</parameter_description>
</parameter>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
+<parameter name="src_x">
+<parameter_description> Source X coordinate within pixbuf.
</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 name="src_y">
+<parameter_description> Source Y coordinates within pixbuf.
</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="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_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>
</function>
-<function name="gdk_window_get_composited">
+<function name="gdk_pixmap_colormap_create_from_xpm">
<description>
-Determines whether @window is composited.
-
-See gdk_window_set_composited().
+Create a pixmap from a XPM file using a particular colormap.
-Since: 2.22
+Deprecated: 2.22: Use a #GdkPixbuf instead. You can use
+gdk_pixbuf_new_from_file() to create it.
+If you must use a pixmap, use gdk_pixmap_new() to
+create it and Cairo to draw the pixbuf onto it.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<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_description>
</parameter>
</parameters>
-<return> %TRUE if the window is composited.
+<return> the #GdkPixmap.
</return>
</function>
-<function name="gdk_window_begin_paint_region">
+<function name="gdk_pixmap_colormap_create_from_xpm_d">
<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.
-
-The net result of all this is to remove flicker, because the user
-sees the finished product appear all at once when you call
-gdk_window_end_paint(). If you draw to @window directly without
-calling gdk_window_begin_paint_region(), the user may see flicker
-as individual drawing operations are performed in sequence. The
-clipping and background-initializing features of
-gdk_window_begin_paint_region() are conveniences for the
-programmer, so you can avoid doing that work yourself.
-
-When using GTK+, the widget system automatically places calls to
-gdk_window_begin_paint_region() and gdk_window_end_paint() around
-emissions of the expose_event signal. That is, if you're writing an
-expose event handler, you can assume that the exposed area in
-#GdkEventExpose has already been cleared to the window background,
-is already set as the clip region, and already has a backing store.
-Therefore in most cases, application code need not call
-gdk_window_begin_paint_region(). (You can disable the automatic
-calls around expose events on a widget-by-widget basis by calling
-gtk_widget_set_double_buffered().)
-
-If you call this function multiple times before calling the
-matching gdk_window_end_paint(), the backing stores are pushed onto
-a stack. gdk_window_end_paint() copies the topmost backing store
-onscreen, subtracts the topmost region from all other regions in
-the stack, and pops the stack. All drawing operations affect only
-the topmost backing store in the stack. One matching call to
-gdk_window_end_paint() is required for each call to
-gdk_window_begin_paint_region().
+Create a pixmap from data in XPM format using a particular
+colormap.
+Deprecated: 2.22: Use a #GdkPixbuf instead. You can use
+gdk_pixbuf_new_from_xpm_data() to create it.
+If you must use a pixmap, use gdk_pixmap_new() to
+create it and Cairo to draw the pixbuf onto it.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<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="region">
-<parameter_description> region you intend to draw to
+<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>
-</parameters>
-<return></return>
-</function>
-
-<function name="gdk_x11_register_standard_event_type">
-<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.
-
-This function should only be needed in unusual circumstances, e.g.
-when filtering XInput extension events on the root window.
-
-Since: 2.4
-
-</description>
-<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter 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="event_base">
-<parameter_description> first event type code to register
+<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="n_events">
-<parameter_description> number of event type codes to register
+<parameter name="data">
+<parameter_description> Pointer to a string containing the XPM data.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GdkPixmap.
+
+</return>
</function>
-<function name="gdk_color_to_string">
+<function name="gdk_pixmap_create_from_xpm">
<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.
+Create a pixmap from a XPM file.
-Since: 2.12
+Deprecated: 2.22: Use a #GdkPixbuf instead. You can use
+gdk_pixbuf_new_from_file() to create it.
+If you must use a pixmap, use gdk_pixmap_new() to
+create it and Cairo to draw the pixbuf onto it.
</description>
<parameters>
-<parameter name="color">
-<parameter_description> a #GdkColor
+<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_description>
</parameter>
</parameters>
-<return> a newly-allocated text string
+<return> the #GdkPixmap
</return>
</function>
-<function name="gdk_drag_drop_succeeded">
+<function name="gdk_pixmap_create_from_xpm_d">
<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.
+Create a pixmap from data in XPM format.
-Since: 2.6
+Deprecated: 2.22: Use a #GdkPixbuf instead. You can use
+gdk_pixbuf_new_from_xpm_data() to create it.
+If you must use a pixmap, use gdk_pixmap_new() to
+create it and Cairo to draw the pixbuf onto it.
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GdkDragContext
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable, used to determine default values
+for the new pixmap.
+</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_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_description>
+</parameter>
+<parameter name="data">
+<parameter_description> Pointer to a string containing the XPM data.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the drop was successful.
+<return> the #GdkPixmap.
</return>
</function>
-<function name="gdk_colormap_query_color">
+<function name="gdk_pixmap_foreign_new">
<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.)
+Wraps a native window for the default display in a #GdkPixmap.
+This may fail if the pixmap has been destroyed.
-This function is rarely useful; it's used for example to
-implement the eyedropper feature in #GtkColorSelection.
+For example in the X backend, a native pixmap handle is an Xlib
+<type>XID</type>.
</description>
<parameters>
-<parameter name="colormap">
-<parameter_description> a #GdkColormap
-</parameter_description>
-</parameter>
-<parameter name="pixel">
-<parameter_description> pixel value in hardware display format
-</parameter_description>
-</parameter>
-<parameter name="result">
-<parameter_description> #GdkColor with red, green, blue fields initialized
+<parameter name="anid">
+<parameter_description> a native pixmap handle.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the newly-created #GdkPixmap wrapper for the
+native pixmap or %NULL if the pixmap has been destroyed.
+</return>
</function>
-<function name="gdk_directfb_visual_by_format">
+<function name="gdk_pixmap_foreign_new_for_display">
<description>
-This function is specific to the DirectFB backend. It allows
-to specify a GdkVisual by @pixel_format.
+Wraps a native pixmap in a #GdkPixmap.
+This may fail if the pixmap has been destroyed.
-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.
+For example in the X backend, a native pixmap handle is an Xlib
+<type>XID</type>.
+Since: 2.2
</description>
<parameters>
-<parameter name="pixel_format">
-<parameter_description> the pixel_format of the requested visual
+<parameter name="display">
+<parameter_description> The #GdkDisplay where @anid is located.
+</parameter_description>
+</parameter>
+<parameter name="anid">
+<parameter_description> a native pixmap handle.
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the GdkVisual or %NULL if the
-pixel_format is unsupported.
+<return> the newly-created #GdkPixmap wrapper for the
+native pixmap or %NULL if the pixmap has been destroyed.
+
</return>
</function>
-<function name="gdk_text_property_to_utf8_list">
+<function name="gdk_pixmap_foreign_new_for_screen">
<description>
-Convert a text property in the giving encoding to
-a list of UTF-8 strings.
+Wraps a native pixmap 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>.
+
+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="encoding">
-<parameter_description> an atom representing the encoding of the text
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
-<parameter name="format">
-<parameter_description> the format of the property
+<parameter name="anid">
+<parameter_description> a native pixmap handle
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> the text to convert
+<parameter name="width">
+<parameter_description> the width of the pixmap identified by @anid
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> the length of @text, in bytes
+<parameter name="height">
+<parameter_description> the height of the pixmap identified by @anid
</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="depth">
+<parameter_description> the depth of the pixmap identified by @anid
</parameter_description>
</parameter>
</parameters>
-<return> the number of strings in the resulting
-list.
+<return> the newly-created #GdkPixmap wrapper for the
+native pixmap or %NULL if the pixmap has been destroyed.
+
</return>
</function>
-<function name="gdk_unicode_to_keyval">
+<function name="gdk_pixmap_get_size">
<description>
-Convert from a ISO10646 character to a key symbol.
+This function is purely to make it possible to query the size of pixmaps
+even when compiling without deprecated symbols and you must use pixmaps.
+It is identical to gdk_drawable_get_size(), but for pixmaps.
+Since: 2.24
</description>
<parameters>
-<parameter name="wc">
-<parameter_description> a ISO10646 encoded character
+<parameter name="pixmap">
+<parameter_description> a #GdkPixmap
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> location to store @pixmap's width, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> location to store @pixmap's height, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the corresponding GDK key symbol, if one exists.
-or, if there is no corresponding symbol,
-wc | 0x01000000
-</return>
+<return></return>
</function>
-<function name="gdk_x11_atom_to_xatom">
+<function name="gdk_pixmap_lookup">
<description>
-Converts from a #GdkAtom to the X atom for the default GDK display
-with the same string value.
+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>.
</description>
<parameters>
-<parameter name="atom">
-<parameter_description> A #GdkAtom
+<parameter name="anid">
+<parameter_description> a native pixmap handle.
</parameter_description>
</parameter>
</parameters>
-<return> the X atom corresponding to @atom.
+<return> the #GdkPixmap wrapper for the native pixmap,
+or %NULL if there is none.
</return>
</function>
-<function name="gdk_event_get_state">
+<function name="gdk_pixmap_lookup_for_display">
<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.
+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>.
+
+Since: 2.2
</description>
<parameters>
-<parameter name="event">
-<parameter_description> a #GdkEvent or NULL
+<parameter name="display">
+<parameter_description> the #GdkDisplay associated with @anid
</parameter_description>
</parameter>
-<parameter name="state">
-<parameter_description> return location for state
+<parameter name="anid">
+<parameter_description> a native pixmap handle.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if there was a state field in the event
+<return> the #GdkPixmap wrapper for the native pixmap,
+or %NULL if there is none.
+
</return>
</function>
-<function name="gdk_gc_get_colormap">
+<function name="gdk_pointer_grab_info_libgtk_only">
<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.
+Determines information about the current pointer grab.
+This is not public API and must not be used by applications.
-Deprecated: 2.22: There is no replacement. Cairo handles colormaps
-automatically, so there is no need to care about them.
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC
+<parameter name="display">
+<parameter_description> the #GdkDisplay 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_pointer_grab() was %TRUE.
</parameter_description>
</parameter>
</parameters>
-<return> the colormap of @gc, or %NULL if @gc doesn't have one.
-
+<return> %TRUE if this application currently has the
+pointer grabbed.
</return>
</function>
-<function name="gdk_display_open">
+<function name="gdk_pointer_is_grabbed">
<description>
-Opens a display.
+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.
-Since: 2.2
</description>
<parameters>
-<parameter name="display_name">
-<parameter_description> the name of the display to open
-</parameter_description>
-</parameter>
</parameters>
-<return> a #GdkDisplay, or %NULL if the display
-could not be opened.
+<return> %TRUE if the pointer is currently grabbed by this application.*
</return>
</function>
-<function name="gdk_window_restack">
+<function name="gdk_pointer_ungrab">
<description>
-Changes the position of @window in the Z-order (stacking order), so that
-it is above @sibling (if @above is %TRUE) or below @sibling (if @above is
-%FALSE).
-
-If @sibling is %NULL, then this either raises (if @above is %TRUE) or
-lowers the window.
-
-If @window is a toplevel, the window manager may choose to deny the
-request to move the window in the Z-order, gdk_window_restack() only
-requests the restack, does not guarantee it.
-
-Since: 2.18
+Ungrabs the pointer on the default display, if it is grabbed by this
+application.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="sibling">
-<parameter_description> a #GdkWindow that is a sibling of @window, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="above">
-<parameter_description> a boolean
+<parameter name="time_">
+<parameter_description> a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no
+timestamp is available.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_x11_get_xatom_name">
+<function name="gdk_query_depths">
<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.
+This function returns the available bit depths for the default
+screen. It's equivalent to listing the visuals
+(gdk_list_visuals()) and then looking at the depth field in each
+visual, removing duplicates.
+
+The array returned by this function should not be freed.
</description>
<parameters>
-<parameter name="xatom">
-<parameter_description> an X atom for GDK's default display
+<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> name of the X atom; this string is owned by GTK+,
-so it shouldn't be modifed or freed.
-</return>
+<return></return>
</function>
-<function name="gdk_display_beep">
+<function name="gdk_query_visual_types">
<description>
-Emits a short beep on @display
+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.
-Since: 2.2
+The array returned by this function should not be freed.
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="visual_types">
+<parameter_description> return location for the available visual types
+</parameter_description>
+</parameter>
+<parameter name="count">
+<parameter_description> return location for the number of available visual types
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_keymap_get_entries_for_keycode">
+<function name="gdk_rectangle_intersect">
<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().
+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="keymap">
-<parameter_description> a #GdkKeymap or %NULL to use the default keymap
-</parameter_description>
-</parameter>
-<parameter name="hardware_keycode">
-<parameter_description> a keycode
-</parameter_description>
-</parameter>
-<parameter name="keys">
-<parameter_description> return location for array of #GdkKeymapKey, or %NULL
+<parameter name="src1">
+<parameter_description> a #GdkRectangle
</parameter_description>
</parameter>
-<parameter name="keyvals">
-<parameter_description> return location for array of keyvals, or %NULL
+<parameter name="src2">
+<parameter_description> a #GdkRectangle
</parameter_description>
</parameter>
-<parameter name="n_entries">
-<parameter_description> length of @keys and @keyvals
+<parameter name="dest">
+<parameter_description> return location for the
+intersection of @src1 and @src2, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if there were any entries
+<return> %TRUE if the rectangles intersect.
</return>
</function>
-<function name="gdk_window_get_origin">
+<function name="gdk_rectangle_union">
<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.)
-
+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 #GdkWindow
+<parameter name="src1">
+<parameter_description> a #GdkRectangle
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> return location for X coordinate
+<parameter name="src2">
+<parameter_description> a #GdkRectangle
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> return location for Y coordinate
+<parameter name="dest">
+<parameter_description> return location for the union of @src1 and @src2
</parameter_description>
</parameter>
</parameters>
-<return> not meaningful, ignore
-</return>
+<return></return>
</function>
-<function name="gdk_window_get_window_type">
+<function name="gdk_region_copy">
<description>
-Gets the type of the window. See #GdkWindowType.
+Copies @region, creating an identical new region.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="region">
+<parameter_description> a #GdkRegion
</parameter_description>
</parameter>
</parameters>
-<return> type of window
+<return> a new region identical to @region
</return>
</function>
-<function name="gdk_gc_set_clip_region">
+<function name="gdk_region_destroy">
<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()).
-
-Deprecated: 2.22: Use gdk_cairo_region() and cairo_clip() in Cairo.
+Destroys a #GdkRegion.
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
-</parameter_description>
-</parameter>
<parameter name="region">
-<parameter_description> the #GdkRegion.
+<parameter_description> a #GdkRegion
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_colormap_alloc_colors">
+<function name="gdk_region_empty">
<description>
-Allocates colors from a colormap.
+Finds out if the #GdkRegion is empty.
</description>
<parameters>
-<parameter name="colormap">
-<parameter_description> a #GdkColormap.
-</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_description>
-</parameter>
-<parameter name="n_colors">
-<parameter_description> The number of colors in @colors.
-</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="region">
+<parameter_description> a #GdkRegion
</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.
+</parameters>
+<return> %TRUE if @region is empty.
+</return>
+</function>
+
+<function name="gdk_region_equal">
+<description>
+Finds out if the two regions are the same.
+
+
+</description>
+<parameters>
+<parameter name="region1">
+<parameter_description> a #GdkRegion
</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.
+<parameter name="region2">
+<parameter_description> a #GdkRegion
</parameter_description>
</parameter>
</parameters>
-<return> The number of colors that were not successfully
-allocated.
+<return> %TRUE if @region1 and @region2 are equal.
</return>
</function>
-<function name="gdk_screen_set_font_options">
+<function name="gdk_region_get_clipbox">
<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.
+Obtains the smallest rectangle which includes the entire #GdkRegion.
-Since: 2.10
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="region">
+<parameter_description> a #GdkRegion
</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="rectangle">
+<parameter_description> return location for the clipbox
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_region_shrink">
+<function name="gdk_region_get_rectangles">
<description>
-Resizes a region by the specified amount.
-Positive values shrink the region. Negative values expand it.
-
-Deprecated: 2.22: There is no replacement for this function.
+Obtains the area covered by the region as a list of rectangles.
+The array returned in @rectangles must be freed with g_free().
</description>
<parameters>
@@ -7946,101 +8485,121 @@ Deprecated: 2.22: There is no replacement for this function.
<parameter_description> a #GdkRegion
</parameter_description>
</parameter>
-<parameter name="dx">
-<parameter_description> the number of pixels to shrink the region horizontally
+<parameter name="rectangles">
+<parameter_description> return location for an array of rectangles
</parameter_description>
</parameter>
-<parameter name="dy">
-<parameter_description> the number of pixels to shrink the region vertically
+<parameter name="n_rectangles">
+<parameter_description> length of returned array
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_event_put">
+<function name="gdk_region_intersect">
<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().
+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.
</description>
<parameters>
-<parameter name="event">
-<parameter_description> a #GdkEvent.
+<parameter name="source1">
+<parameter_description> a #GdkRegion
+</parameter_description>
+</parameter>
+<parameter name="source2">
+<parameter_description> another #GdkRegion
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_colormap_get_system">
+<function name="gdk_region_new">
<description>
-Gets the system's default colormap for the default screen. (See
-gdk_colormap_get_system_for_screen ())
+Creates a new empty #GdkRegion.
</description>
<parameters>
</parameters>
-<return> the default colormap.
+<return> a new empty #GdkRegion
</return>
</function>
-<function name="gdk_window_is_destroyed">
+<function name="gdk_region_offset">
<description>
-Check to see if a window is destroyed..
-
-Since: 2.18
+Moves a region the specified distance.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="region">
+<parameter_description> a #GdkRegion
+</parameter_description>
+</parameter>
+<parameter name="dx">
+<parameter_description> the distance to move the region horizontally
+</parameter_description>
+</parameter>
+<parameter name="dy">
+<parameter_description> the distance to move the region vertically
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the window is destroyed
-
-</return>
+<return></return>
</function>
-<function name="gdk_visual_get_screen">
+<function name="gdk_region_point_in">
<description>
-Gets the screen to which this visual belongs
+Finds out if a point is in a region.
-Since: 2.2
</description>
<parameters>
-<parameter name="visual">
-<parameter_description> a #GdkVisual
+<parameter name="region">
+<parameter_description> a #GdkRegion
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> the x coordinate of a point
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> the y coordinate of a point
</parameter_description>
</parameter>
</parameters>
-<return> the screen to which this visual belongs.
-
+<return> %TRUE if the point is in @region.
</return>
</function>
-<function name="gdk_window_get_effective_parent">
+<function name="gdk_region_polygon">
<description>
-Obtains the parent of @window, as known to GDK. Works like
-gdk_window_get_parent() for normal windows, but returns the
-window's embedder for offscreen windows.
-
-See also: gdk_offscreen_window_get_embedder()
+Creates a new #GdkRegion using the polygon defined by a
+number of points.
-Since: 2.22
+Deprecated: 2.22: There is no replacement. For working with paths, please
+use Cairo.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<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_description>
+</parameter>
+<parameter name="fill_rule">
+<parameter_description> specifies which pixels are included in the region when the
+polygon overlaps itself.
</parameter_description>
</parameter>
</parameters>
-<return> effective parent of @window
+<return> a new #GdkRegion based on the given polygon
</return>
</function>
@@ -8070,783 +8629,638 @@ achieve the same effect.
</return>
</function>
-<function name="gdk_drawable_ref">
+<function name="gdk_region_rect_in">
<description>
-Deprecated equivalent of calling g_object_ref() on @drawable.
-(Drawables were not objects in previous versions of GDK.)
+Tests whether a rectangle is within a region.
-Deprecated: 2.0: Use g_object_ref() instead.
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
+<parameter name="region">
+<parameter_description> a #GdkRegion.
+</parameter_description>
+</parameter>
+<parameter name="rectangle">
+<parameter_description> a #GdkRectangle.
</parameter_description>
</parameter>
</parameters>
-<return> the same @drawable passed in
-
+<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>
</function>
-<function name="gdk_drawable_get_visible_region">
+<function name="gdk_region_rectangle">
<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.
+Creates a new region containing the area @rectangle.
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
+<parameter name="rectangle">
+<parameter_description> a #GdkRectangle
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkRegion. This must be freed with gdk_region_destroy()
-when you are done.
+<return> a new region
</return>
</function>
-<function name="gdk_gc_set_background">
+<function name="gdk_region_shrink">
<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.
+Resizes a region by the specified amount.
+Positive values shrink the region. Negative values expand it.
-Deprecated: 2.22: Use gdk_cairo_set_source_color() to use a #GdkColor
-as the source in Cairo. Note that if you want to draw a background and a
-foreground in Cairo, you need to call drawing functions (like cairo_fill())
-twice.
+Deprecated: 2.22: There is no replacement for this function.
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
+<parameter name="region">
+<parameter_description> a #GdkRegion
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> the new background color.
+<parameter name="dx">
+<parameter_description> the number of pixels to shrink the region horizontally
+</parameter_description>
+</parameter>
+<parameter name="dy">
+<parameter_description> the number of pixels to shrink the region vertically
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_drag_context_get_suggested_action">
+<function name="gdk_region_spans_intersect_foreach">
<description>
-Determines the suggested drag action of the context.
+Calls a function on each span in the intersection of @region and @spans.
-Since: 2.22
+Deprecated: 2.22: There is no replacement.
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GdkDragContext
+<parameter name="region">
+<parameter_description> a #GdkRegion
</parameter_description>
</parameter>
-</parameters>
-<return> a #GdkDragAction value
-
-</return>
-</function>
-
-<function name="gdk_window_move_resize">
-<description>
-Equivalent to calling gdk_window_move() and gdk_window_resize(),
-except that both operations are performed at once, avoiding strange
-visual effects. (i.e. the user may be able to see the window first
-move, then resize, if you don't use gdk_window_move_resize().)
-
-</description>
-<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="spans">
+<parameter_description> an array of #GdkSpans
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> new X position relative to window's parent
+<parameter name="n_spans">
+<parameter_description> the length of @spans
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> new Y position relative to window's parent
+<parameter name="sorted">
+<parameter_description> %TRUE if @spans is sorted wrt. the y coordinate
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> new width
+<parameter name="function">
+<parameter_description> function to call on each span in the intersection
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> new height
+<parameter name="data">
+<parameter_description> data to pass to @function
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_screen_list_visuals">
+<function name="gdk_region_subtract">
<description>
-Lists the available visuals for the specified @screen.
-A visual describes a hardware image data format.
-For example, a visual might support 24-bit color, or 8-bit color,
-and might expect pixels to be in a certain format.
-
-Call g_list_free() on the return value when you're finished with it.
-
-Since: 2.2
+Subtracts the area of @source2 from the area @source1. The resulting
+area is the set of pixels contained in @source1 but not in @source2.
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> the relevant #GdkScreen.
+<parameter name="source1">
+<parameter_description> a #GdkRegion
+</parameter_description>
+</parameter>
+<parameter name="source2">
+<parameter_description> another #GdkRegion
</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_fontset_load_for_display">
+<function name="gdk_region_union">
<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.
-
-Since: 2.2
+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.
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="source1">
+<parameter_description> a #GdkRegion
</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="source2">
+<parameter_description> a #GdkRegion
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkFont, or %NULL if the fontset could not be loaded.
-</return>
+<return></return>
</function>
-<function name="gdk_pointer_ungrab">
+<function name="gdk_region_union_with_rect">
<description>
-Ungrabs the pointer on the default display, if it is grabbed by this
-application.
+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="time_">
-<parameter_description> a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no
-timestamp is available.
+<parameter name="region">
+<parameter_description> a #GdkRegion.
+</parameter_description>
+</parameter>
+<parameter name="rect">
+<parameter_description> a #GdkRectangle.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_set_type_hint">
+<function name="gdk_region_xor">
<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.
+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.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> A toplevel #GdkWindow
+<parameter name="source1">
+<parameter_description> a #GdkRegion
</parameter_description>
</parameter>
-<parameter name="hint">
-<parameter_description> A hint of the function this window will have
+<parameter name="source2">
+<parameter_description> another #GdkRegion
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_x11_drawable_get_xid">
+<function name="gdk_rgb_find_color">
<description>
-Returns the X resource (window or pixmap) belonging to a #GdkDrawable.
+ 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().
+Deprecated: 2.22: Cairo handles colors automatically.
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable.
+<parameter name="colormap">
+<parameter_description> a #GdkColormap
+</parameter_description>
+</parameter>
+<parameter name="color">
+<parameter_description> a #GdkColor
</parameter_description>
</parameter>
</parameters>
-<return> the ID of @drawable's X resource.
-</return>
+<return></return>
</function>
-<function name="gdk_x11_colormap_get_xdisplay">
+<function name="gdk_rgb_get_colormap">
<description>
-Returns the display of a #GdkColormap.
+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.
+Deprecated: 2.22: Use gdk_screen_get_system_colormap (gdk_screen_get_default ()) instead.
</description>
<parameters>
-<parameter name="colormap">
-<parameter_description> a #GdkColormap.
-</parameter_description>
-</parameter>
</parameters>
-<return> an Xlib <type>Display*</type>.
+<return> the preferred colormap
+
</return>
</function>
-<function name="gdk_draw_rgb_32_image_dithalign">
+<function name="gdk_rgb_get_visual">
<description>
-Like gdk_draw_rgb_32_image(), but allows you to specify the dither
-offsets. See gdk_draw_rgb_image_dithalign() for more details.
+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.
-Deprecated: 2.22: Cairo handles colors automatically.
+Deprecated: 2.22: Use gdk_visual_get_system_visual (gdk_screen_get_default ()) instead.
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
-</parameter_description>
-</parameter>
-<parameter name="gc">
-<parameter_description> a #GdkGC
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> X coordinate on @drawable where image should go
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> Y coordinate on @drawable where image should go
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> width of area of image to draw
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> height of area of image to draw
-</parameter_description>
-</parameter>
-<parameter name="dith">
-<parameter_description> dithering mode
-</parameter_description>
-</parameter>
-<parameter name="buf">
-<parameter_description> RGB image data
-</parameter_description>
-</parameter>
-<parameter name="rowstride">
-<parameter_description> rowstride of RGB image data
-</parameter_description>
-</parameter>
-<parameter name="xdith">
-<parameter_description> X dither offset
-</parameter_description>
-</parameter>
-<parameter name="ydith">
-<parameter_description> Y dither offset
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> The #GdkVisual chosen by GdkRGB.
+
+</return>
</function>
-<function name="gdk_window_set_background">
+<function name="gdk_screen_broadcast_client_message">
<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.)
+On X11, sends an X ClientMessage event to all toplevel windows on
+ screen
-The @color must be allocated; gdk_rgb_find_color() is the best way
-to allocate a color.
+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.
-See also gdk_window_set_background_pixmap().
+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
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="screen">
+<parameter_description> the #GdkScreen where the event will be broadcasted.
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> an allocated #GdkColor
+<parameter name="event">
+<parameter_description> the #GdkEvent.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_keyboard_ungrab">
+<function name="gdk_screen_get_active_window">
<description>
-Ungrabs the keyboard on the default display, if it is grabbed by this
-application.
+Returns the screen's currently active window.
-</description>
-<parameters>
-<parameter name="time_">
-<parameter_description> a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no
-timestamp is available.
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
-</function>
+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.
-<function name="gdk_window_invalidate_region">
-<description>
-Adds @region to the update area for @window. The update area is the
-region that needs to be redrawn, or "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.
+On other platforms, this function may return %NULL, depending on whether
+it is implementable on that platform.
-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 returned window should be unrefed using g_object_unref() when
+no longer needed.
-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.10
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="region">
-<parameter_description> a #GdkRegion
-</parameter_description>
-</parameter>
-<parameter name="invalidate_children">
-<parameter_description> %TRUE to also invalidate child windows
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the currently active window, or %NULL.
+
+</return>
</function>
-<function name="gdk_x11_get_default_screen">
+<function name="gdk_screen_get_default">
<description>
-Gets the default GTK+ screen number.
+Gets the default screen for the default display. (See
+gdk_display_get_default ()).
+Since: 2.2
</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> a #GdkScreen, or %NULL if there is no default display.
+
</return>
</function>
-<function name="gdk_window_enable_synchronized_configure">
+<function name="gdk_screen_get_default_colormap">
<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.
+Gets the default colormap for @screen.
-Since: 2.6
+Since: 2.2
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the default #GdkColormap.
+
+</return>
</function>
-<function name="gdk_pixmap_lookup_for_display">
+<function name="gdk_screen_get_display">
<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 the display to which the @screen belongs.
Since: 2.2
</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="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkPixmap wrapper for the native pixmap,
-or %NULL if there is none.
+<return> the display to which @screen belongs
</return>
</function>
-<function name="gdk_window_set_back_pixmap">
+<function name="gdk_screen_get_font_options">
<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).
-
-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.
+Gets any options previously set with gdk_screen_set_font_options().
-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.10
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="pixmap">
-<parameter_description> a #GdkPixmap, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="parent_relative">
-<parameter_description> whether the tiling origin is at the origin of
- window's parent
+<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_screen_get_rgba_colormap">
+<function name="gdk_screen_get_height">
<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.
-
-This functionality is not implemented in the Windows backend.
-
-For setting an overall opacity for a top-level window, see
-gdk_window_set_opacity().
+Gets the height of @screen in pixels
-Since: 2.8
+Since: 2.2
</description>
<parameters>
<parameter name="screen">
-<parameter_description> a #GdkScreen.
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
-<return> a colormap to use for windows with
-an alpha channel or %NULL if the capability is not available.
+<return> the height of @screen in pixels.
</return>
</function>
-<function name="gdk_display_supports_cursor_color">
+<function name="gdk_screen_get_height_mm">
<description>
-Returns %TRUE if multicolored cursors are supported
-on @display. Otherwise, cursors have only a forground
-and a background color.
+Returns the height of @screen in millimeters.
+Note that on some X servers this value will not be correct.
-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>
</parameters>
-<return> whether cursors can have multiple colors.
+<return> the heigth of @screen in millimeters.
</return>
</function>
-<function name="gdk_pixbuf_render_threshold_alpha">
+<function name="gdk_screen_get_monitor_at_point">
<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.
+Returns the monitor number in which the point (@x,@y) is located.
+Since: 2.2
</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_description>
-</parameter>
-<parameter name="width">
-<parameter_description> Width of region to threshold, or -1 to use pixbuf width
+<parameter name="screen">
+<parameter_description> a #GdkScreen.
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> Height of region to threshold, or -1 to use pixbuf height
+<parameter name="x">
+<parameter_description> the x coordinate in the virtual screen.
</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="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="gdk_draw_layout_line_with_colors">
+<function name="gdk_screen_get_monitor_at_window">
<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.
+Returns the number of the monitor in which the largest area of the
+bounding rectangle of @window resides.
-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.
+Since: 2.2
</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_description>
-</parameter>
-<parameter name="foreground">
-<parameter_description> foreground override color, or %NULL for none
+<parameter name="screen">
+<parameter_description> a #GdkScreen.
</parameter_description>
</parameter>
-<parameter name="background">
-<parameter_description> background override color, or %NULL for none
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<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_drawable_unref">
+<function name="gdk_screen_get_monitor_geometry">
<description>
-Deprecated equivalent of calling g_object_unref() on @drawable.
+Retrieves the #GdkRectangle representing the size and position of
+the individual monitor within the entire screen area.
-Deprecated: 2.0: Use g_object_unref() instead.
+Note that the size of the entire screen area can be retrieved via
+gdk_screen_get_width() and gdk_screen_get_height().
+
+Since: 2.2
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
+<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_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_x11_atom_to_xatom_for_display">
+<function name="gdk_screen_get_monitor_height_mm">
<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 height in millimeters of the specified monitor.
-Since: 2.2
+Since: 2.14
</description>
<parameters>
-<parameter name="display">
-<parameter_description> A #GdkDisplay
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
-<parameter name="atom">
-<parameter_description> A #GdkAtom, or %GDK_NONE
+<parameter name="monitor_num">
+<parameter_description> number of the monitor, between 0 and gdk_screen_get_n_monitors (screen)
</parameter_description>
</parameter>
</parameters>
-<return> the X atom corresponding to @atom, or %None
+<return> the height of the monitor, or -1 if not available
</return>
</function>
-<function name="gdk_image_set_colormap">
+<function name="gdk_screen_get_monitor_plug_name">
<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.
+Returns the output name of the specified monitor.
+Usually something like VGA, DVI, or TV, not the actual
+product name of the display device.
-Deprecated: 2.22: #GdkImage should not be used anymore.
+Since: 2.14
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GdkImage
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
-<parameter name="colormap">
-<parameter_description> a #GdkColormap
+<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> a newly-allocated string containing the name of the monitor,
+or %NULL if the name cannot be determined
+
+</return>
</function>
-<function name="gdk_window_begin_paint_rect">
+<function name="gdk_screen_get_monitor_width_mm">
<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.
+Gets the width in millimeters of the specified monitor, if available.
+Since: 2.14
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
-<parameter name="rectangle">
-<parameter_description> rectangle you intend to draw to
+<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_event_get_root_coords">
+<function name="gdk_screen_get_n_monitors">
<description>
-Extract the root window relative x/y coordinates from an event.
+Returns the number of monitors which @screen consists of.
+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> number of monitors which @screen consists of
+
</return>
</function>
-<function name="gdk_visual_get_best_with_depth">
+<function name="gdk_screen_get_number">
<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.
+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="depth">
-<parameter_description> a bit depth
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
-<return> best visual for the given depth
+<return> the index
+
</return>
</function>
-<function name="gdk_x11_display_grab">
+<function name="gdk_screen_get_primary_monitor">
<description>
-Call XGrabServer() on @display.
-To ungrab the display again, use gdk_x11_display_ungrab().
+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.
-gdk_x11_display_grab()/gdk_x11_display_ungrab() calls can be nested.
+If no primary monitor is configured by the user, the return value
+will be 0, defaulting to the first monitor.
-Since: 2.2
+Since: 2.20
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="screen">
+<parameter_description> a #GdkScreen.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> An integer index for the primary monitor, or 0 if none is configured.
+
+</return>
</function>
-<function name="gdk_screen_make_display_name">
+<function name="gdk_screen_get_resolution">
<description>
-Determines the name to pass to gdk_display_open() to get
-a #GdkDisplay with this screen as the default screen.
+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>
@@ -8855,231 +9269,248 @@ Since: 2.2
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated string, free with g_free()
+<return> the current resolution, or -1 if no resolution
+has been set.
</return>
</function>
-<function name="gdk_utf8_to_compound_text">
+<function name="gdk_screen_get_rgb_colormap">
<description>
-Convert from UTF-8 to compound text.
+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
+
+Deprecated: 2.22: Use gdk_screen_get_system_colormap()
</description>
<parameters>
-<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> the preferred colormap
+
</return>
</function>
-<function name="gdk_font_get_display">
+<function name="gdk_screen_get_rgb_visual">
<description>
-Returns the #GdkDisplay for @font.
+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.
Since: 2.2
+Deprecated: 2.22: Use gdk_screen_get_system_visual()
+
</description>
<parameters>
-<parameter name="font">
-<parameter_description> the #GdkFont.
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
-<return> the corresponding #GdkDisplay.
+<return> The #GdkVisual chosen by GdkRGB.
</return>
</function>
-<function name="gdk_char_width">
+<function name="gdk_screen_get_rgba_colormap">
<description>
-Determines the width of a given character.
+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.
-Deprecated: 2.2: Use gdk_text_extents() instead.
+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="font">
-<parameter_description> a #GdkFont
-</parameter_description>
-</parameter>
-<parameter name="character">
-<parameter_description> the character to measure.
+<parameter name="screen">
+<parameter_description> a #GdkScreen.
</parameter_description>
</parameter>
</parameters>
-<return> the width of the character in pixels.
+<return> a colormap to use for windows with
+an alpha channel or %NULL if the capability is not available.
</return>
</function>
-<function name="gdk_gc_set_colormap">
+<function name="gdk_screen_get_rgba_visual">
<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.
+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.
-Deprecated: 2.22: There is no replacement. Cairo handles colormaps
-automatically, so there is no need to care about them.
+Since: 2.8
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC
-</parameter_description>
-</parameter>
-<parameter name="colormap">
-<parameter_description> a #GdkColormap
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<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_free">
+<function name="gdk_screen_get_root_window">
<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() and gdk_event_new().
+Gets the root window of @screen.
+
+Since: 2.2
</description>
<parameters>
-<parameter name="event">
-<parameter_description> a #GdkEvent.
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the root window
+
+</return>
</function>
-<function name="gdk_window_set_focus_on_map">
+<function name="gdk_screen_get_setting">
<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).
+Retrieves a desktop-wide setting such as double-click time
+for the #GdkScreen @screen.
-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.
+FIXME needs a list of valid settings here, or a link to
+more information.
-Since: 2.6
+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="focus_on_map">
-<parameter_description> %TRUE if the window should receive input focus when mapped
+<parameter name="name">
+<parameter_description> the name of the setting
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> location to store the value of the setting
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the setting existed and a value was stored
+in @value, %FALSE otherwise.
+
+</return>
</function>
-<function name="gdk_display_pointer_is_grabbed">
+<function name="gdk_screen_get_system_colormap">
<description>
-Test if the pointer is grabbed.
+Gets the system's default colormap for @screen
Since: 2.2
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if an active X pointer grab is in effect
+<return> the default colormap for @screen.
</return>
</function>
-<function name="gdk_screen_get_root_window">
+<function name="gdk_screen_get_system_visual">
<description>
-Gets the root window of @screen.
+Get the system's default visual for @screen.
+This is the visual for the root window of the display.
+The return value should not be freed.
Since: 2.2
</description>
<parameters>
<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter_description> a #GdkScreen.
</parameter_description>
</parameter>
</parameters>
-<return> the root window
+<return> the system visual
</return>
</function>
-<function name="gdk_device_get_axis_use">
+<function name="gdk_screen_get_toplevel_windows">
<description>
-Returns the axis use for @index.
+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()).
-Since: 2.22
+The returned list should be freed with g_list_free(), but
+its elements need not be freed.
+
+Since: 2.2
</description>
<parameters>
-<parameter name="device">
-<parameter_description> a #GdkDevice.
-</parameter_description>
-</parameter>
-<parameter name="index">
-<parameter_description> the index of the axis.
+<parameter name="screen">
+<parameter_description> The #GdkScreen where the toplevels are located.
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkAxisUse specifying how the axis is used.
+<return>
+list of toplevel windows, free with g_list_free()
</return>
</function>
-<function name="gdk_region_empty">
+<function name="gdk_screen_get_width">
<description>
-Finds out if the #GdkRegion is empty.
+Gets the width of @screen in pixels
+Since: 2.2
</description>
<parameters>
-<parameter name="region">
-<parameter_description> a #GdkRegion
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @region is empty.
+<return> the width of @screen in pixels.
+
</return>
</function>
-<function name="gdk_screen_get_monitor_width_mm">
+<function name="gdk_screen_get_width_mm">
<description>
-Gets the width in millimeters of the specified monitor, if available.
+Gets the width of @screen in millimeters.
+Note that on some X servers this value will not be correct.
-Since: 2.14
+Since: 2.2
</description>
<parameters>
@@ -9087,839 +9518,1154 @@ Since: 2.14
<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
-<parameter name="monitor_num">
-<parameter_description> number of the monitor, between 0 and gdk_screen_get_n_monitors (screen)
-</parameter_description>
-</parameter>
</parameters>
-<return> the width of the monitor, or -1 if not available
+<return> the width of @screen in millimeters.
</return>
</function>
-<function name="gdk_color_equal">
+<function name="gdk_screen_get_window_stack">
<description>
-Compares two colors.
+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.
+
+On other platforms, this function may return %NULL, depending on whether
+it is implementable on that platform.
+
+The returned list is newly allocated and owns references to the
+windows it contains, so it should be freed using g_list_free() and
+its windows unrefed using g_object_unref() when no longer needed.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="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>
+a list of #GdkWindow<!-- -->s for the current window stack,
+or %NULL.
+
</return>
</function>
-<function name="gdk_visual_get_best_with_type">
+<function name="gdk_screen_height">
<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 the height of the default screen in pixels.
</description>
<parameters>
-<parameter name="visual_type">
-<parameter_description> a visual type
-</parameter_description>
-</parameter>
</parameters>
-<return> best visual of the given type
+<return> the height of the default screen in pixels.
</return>
</function>
-<function name="gdk_font_from_description">
+<function name="gdk_screen_height_mm">
<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 height of the default screen in millimeters.
+Note that on many X servers this value will not be correct.
</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> the height of the default screen in millimeters,
+though it is not always correct.
</return>
</function>
-<function name="gdk_keymap_get_entries_for_keyval">
+<function name="gdk_screen_is_composited">
<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().
+Returns whether windows with an RGBA visual can reasonably
+be expected to have their alpha channel drawn correctly on
+the screen.
+
+On X11 this function returns whether a compositing manager is
+compositing @screen.
+Since: 2.10
</description>
<parameters>
-<parameter name="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 name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
-<parameter name="n_keys">
-<parameter_description> return location for number of elements in returned array
+</parameters>
+<return> Whether windows with RGBA visuals can reasonably be
+expected to have their alpha channels drawn correctly on the screen.
+
+</return>
+</function>
+
+<function name="gdk_screen_list_visuals">
+<description>
+Lists the available visuals for the specified @screen.
+A visual describes a hardware image data format.
+For example, a visual might support 24-bit color, or 8-bit color,
+and might expect pixels to be in a certain format.
+
+Call g_list_free() on the return value when you're finished with it.
+
+Since: 2.2
+
+</description>
+<parameters>
+<parameter name="screen">
+<parameter_description> the relevant #GdkScreen.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if keys were found and returned
+<return>
+a list of visuals; the list must be freed, but not its contents
+
</return>
</function>
-<function name="gdk_window_get_accept_focus">
+<function name="gdk_screen_make_display_name">
<description>
-Determines whether or not the desktop environment shuld be hinted that
-the window does not want to receive input focus.
+Determines the name to pass to gdk_display_open() to get
+a #GdkDisplay with this screen as the default screen.
-Since: 2.22
+Since: 2.2
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow.
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
-<return> whether or not the window should receive input focus.
+<return> a newly allocated string, free with g_free()
</return>
</function>
-<function name="gdk_x11_colormap_foreign_new">
+<function name="gdk_screen_set_default_colormap">
<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
+Sets the default @colormap for @screen.
Since: 2.2
</description>
<parameters>
-<parameter name="visual">
-<parameter_description> a #GdkVisual
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
-<parameter name="xcolormap">
-<parameter_description> The XID of a colormap with visual @visual
+<parameter name="colormap">
+<parameter_description> a #GdkColormap
</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>
+<return></return>
</function>
-<function name="gdk_window_set_urgency_hint">
+<function name="gdk_screen_set_font_options">
<description>
-Toggles whether a window needs the user's
-urgent attention.
+Sets the default font options for the screen. These
+options will be set on any #PangoContext's newly created
+with gdk_pango_context_get_for_screen(). Changing the
+default set of font options does not affect contexts that
+have already been created.
-Since: 2.8
+Since: 2.10
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
-<parameter name="urgent">
-<parameter_description> %TRUE if the window is urgent
+<parameter name="options">
+<parameter_description> a #cairo_font_options_t, or %NULL to unset any
+previously set default font options.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_cairo_rectangle">
+<function name="gdk_screen_set_resolution">
<description>
-Adds the given rectangle to the current path of @cr.
+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.8
+Since: 2.10
</description>
<parameters>
-<parameter name="cr">
-<parameter_description> a #cairo_t
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
-<parameter name="rectangle">
-<parameter_description> a #GdkRectangle
+<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></return>
</function>
-<function name="gdk_cursor_new">
+<function name="gdk_screen_width">
<description>
-Creates a new cursor from the set of builtin cursors for the default display.
-See gdk_cursor_new_for_display().
+Returns the width of the default screen in pixels.
-To make the cursor invisible, use %GDK_BLANK_CURSOR.
+
+</description>
+<parameters>
+</parameters>
+<return> the width of the default screen in pixels.
+</return>
+</function>
+
+<function name="gdk_screen_width_mm">
+<description>
+Returns the width of the default screen in millimeters.
+Note that on many X servers this value will not be correct.
</description>
<parameters>
-<parameter name="cursor_type">
-<parameter_description> cursor to create
-</parameter_description>
-</parameter>
</parameters>
-<return> a new #GdkCursor
+<return> the width of the default screen in millimeters,
+though it is not always correct.
</return>
</function>
-<function name="gdk_window_get_state">
+<function name="gdk_selection_owner_get_for_display">
<description>
-Gets the bitwise OR of the currently active window state flags,
-from the #GdkWindowState enumeration.
+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 #GdkWindow
+<parameter name="display">
+<parameter_description> a #GdkDisplay.
+</parameter_description>
+</parameter>
+<parameter name="selection">
+<parameter_description> an atom indentifying a selection.
</parameter_description>
</parameter>
</parameters>
-<return> window state bitfield
+<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_list_visuals">
+<function name="gdk_selection_owner_set_for_display">
<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.
+Sets the #GdkWindow @owner as the current owner of the selection @selection.
+Since: 2.2
</description>
<parameters>
+<parameter name="display">
+<parameter_description> the #GdkDisplay.
+</parameter_description>
+</parameter>
+<parameter name="owner">
+<parameter_description> a #GdkWindow or %NULL to indicate that the owner for
+the given should be unset.
+</parameter_description>
+</parameter>
+<parameter name="selection">
+<parameter_description> an atom identifying a selection.
+</parameter_description>
+</parameter>
+<parameter name="time_">
+<parameter_description> timestamp to use when setting the selection.
+If this is older than the timestamp given last time the owner was
+set for the given selection, the request will be ignored.
+</parameter_description>
+</parameter>
+<parameter name="send_event">
+<parameter_description> if %TRUE, and the new owner is different from the current
+owner, the current owner will be sent a SelectionClear event.
+</parameter_description>
+</parameter>
</parameters>
-<return> a list of visuals; the list must be freed, but not its contents
+<return> %TRUE if the selection owner was successfully changed to owner,
+otherwise %FALSE.
+
</return>
</function>
-<function name="gdk_window_coords_from_parent">
+<function name="gdk_selection_property_get">
<description>
-Transforms window coordinates from a parent window to a child
-window, where the parent window is the normal parent as returned by
-gdk_window_get_parent() for normal windows, and the window's
-embedder as returned by gdk_offscreen_window_get_embedder() for
-offscreen windows.
+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.
-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.
+</description>
+<parameters>
+<parameter name="requestor">
+<parameter_description> the window on which the data is stored
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> location to store a pointer to the retrieved data.
+ If the retrieval failed, %NULL we be stored here, otherwise, it
+ will be non-%NULL and the returned data should be freed with g_free()
+ when you are finished using it. The length of the
+ allocated memory is one more than the length
+ of the returned data, and the final byte will always
+ be zero, to ensure nul-termination of strings.
+</parameter_description>
+</parameter>
+<parameter name="prop_type">
+<parameter_description> location to store the type of the property.
+</parameter_description>
+</parameter>
+<parameter name="prop_format">
+<parameter_description> location to store the format of the property.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the length of the retrieved data.
+</return>
+</function>
-See also: gdk_window_coords_to_parent()
+<function name="gdk_selection_send_notify_for_display">
+<description>
+Send a response to SelectionRequest event.
-Since: 2.22
+Since: 2.2
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a child window
+<parameter name="display">
+<parameter_description> the #GdkDisplay where @requestor is realized
</parameter_description>
</parameter>
-<parameter name="parent_x">
-<parameter_description> X coordinate in parent's coordinate system
+<parameter name="requestor">
+<parameter_description> window to which to deliver response.
</parameter_description>
</parameter>
-<parameter name="parent_y">
-<parameter_description> Y coordinate in parent's coordinate system
+<parameter name="selection">
+<parameter_description> selection that was requested.
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> return location for X coordinate in child's coordinate system
+<parameter name="target">
+<parameter_description> target that was selected.
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> return location for Y coordinate in child's coordinate system
+<parameter name="property">
+<parameter_description> property in which the selection owner stored the data,
+or %GDK_NONE to indicate that the request was rejected.
+</parameter_description>
+</parameter>
+<parameter name="time_">
+<parameter_description> timestamp.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_region_union">
+<function name="gdk_set_double_click_time">
<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.
+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="source1">
-<parameter_description> a #GdkRegion
-</parameter_description>
-</parameter>
-<parameter name="source2">
-<parameter_description> a #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_devices_list">
+<function name="gdk_set_pointer_hooks">
<description>
-Returns the list of available input devices for the default display.
-The list is statically allocated and should not be freed.
+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 is not multihead safe. For multihead operation,
+see gdk_display_set_pointer_hooks().
+
+Deprecated: 2.24: This function will go away in GTK 3 for lack of use cases.
</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_description>
+</parameter>
</parameters>
-<return> a list of #GdkDevice
+<return> the previous pointer hook table
+
</return>
</function>
-<function name="gdk_draw_points">
+<function name="gdk_set_show_events">
<description>
-Draws a number of points, using the foreground color and other
-attributes of the #GdkGC.
-
-Deprecated: 2.22: Use @n_points calls to cairo_rectangle() and
-cairo_fill() instead.
+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="drawable">
-<parameter_description> a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
+<parameter name="show_events">
+<parameter_description> %TRUE to output event debugging information.
</parameter_description>
</parameter>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
+</parameters>
+<return></return>
+</function>
+
+<function name="gdk_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
+(ICCCM) for information on the <literal>WM_CLIENT_LEADER</literal> property.
+(Both documents are part of the X Window System distribution.)
+
+Deprecated:2.24: Use gdk_x11_set_sm_client_id() instead
+
+</description>
+<parameters>
+<parameter name="sm_client_id">
+<parameter_description> the client id assigned by the session manager when the
+connection was opened, or %NULL to remove the property.
</parameter_description>
</parameter>
-<parameter name="points">
-<parameter_description> an array of #GdkPoint structures.
+</parameters>
+<return></return>
+</function>
+
+<function name="gdk_setting_get">
+<description>
+Obtains a desktop-wide setting, such as the double-click time,
+for the default screen. See gdk_screen_get_setting().
+
+
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> the name of the setting.
</parameter_description>
</parameter>
-<parameter name="n_points">
-<parameter_description> the number of points to be drawn.
+<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_display_supports_cursor_alpha">
+<function name="gdk_spawn_command_line_on_screen">
<description>
-Returns %TRUE if cursors can use an 8bit alpha channel
-on @display. Otherwise, cursors are restricted to bilevel
-alpha (i.e. a mask).
+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.
Since: 2.4
+Deprecated: 2.24: This function is being removed in 3.0. Use
+either g_spawn_command_line_sync(), g_spawn_command_line_async() or
+#GdkAppLaunchContext instead.
+
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<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> whether cursors can have alpha channels.
+<return> %TRUE on success, %FALSE if error is set.
</return>
</function>
-<function name="gdk_pixbuf_get_from_image">
+<function name="gdk_spawn_on_screen">
<description>
-Same as gdk_pixbuf_get_from_drawable() but gets the pixbuf from
-an image.
+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.
+
+This is useful for applications which wish to launch an application
+on a specific screen.
+Since: 2.4
+
+Deprecated: 2.24: This function is being removed in 3.0. Use
+either g_spawn_sync(), g_spawn_async(), or #GdkAppLaunchContext instead.
</description>
<parameters>
-<parameter name="dest">
-<parameter_description> Destination pixbuf, or %NULL if a new pixbuf should be created.
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
-<parameter name="src">
-<parameter_description> Source #GdkImage.
+<parameter name="working_directory">
+<parameter_description> child's current working directory, or %NULL to
+inherit parent's
</parameter_description>
</parameter>
-<parameter name="cmap">
-<parameter_description> A colormap, or %NULL to use the one for @src
+<parameter name="argv">
+<parameter_description> child's argument vector
</parameter_description>
</parameter>
-<parameter name="src_x">
-<parameter_description> Source X coordinate within drawable.
+<parameter name="envp">
+<parameter_description> child's environment, or %NULL to inherit parent's
</parameter_description>
</parameter>
-<parameter name="src_y">
-<parameter_description> Source Y coordinate within drawable.
+<parameter name="flags">
+<parameter_description> flags from #GSpawnFlags
</parameter_description>
</parameter>
-<parameter name="dest_x">
-<parameter_description> Destination X coordinate in pixbuf, or 0 if @dest is NULL.
+<parameter name="child_setup">
+<parameter_description> function to run in the child just before exec()
</parameter_description>
</parameter>
-<parameter name="dest_y">
-<parameter_description> Destination Y coordinate in pixbuf, or 0 if @dest is NULL.
+<parameter name="user_data">
+<parameter_description> user data for @child_setup
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> Width in pixels of region to get.
+<parameter name="child_pid">
+<parameter_description> return location for child process ID, or %NULL
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> Height in pixels of region to get.
+<parameter name="error">
+<parameter_description> return location for error
</parameter_description>
</parameter>
</parameters>
-<return> @dest, newly-created pixbuf if @dest was %NULL, %NULL on error
+<return> %TRUE on success, %FALSE if error is set
+
</return>
</function>
-<function name="gdk_image_new_bitmap">
+<function name="gdk_spawn_on_screen_with_pipes">
<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>
+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.
+This is useful for applications which wish to launch an application
+on a specific screen.
+
+Since: 2.4
+
+Deprecated: 2.24: This function is being removed in 3.0. Use
+either g_spawn_async_with_pipes() or #GdkAppLaunchContext instead.
</description>
<parameters>
-<parameter name="visual">
-<parameter_description> the #GdkVisual to use for the image.
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> the pixel data.
+<parameter name="working_directory">
+<parameter_description> child's current working directory, or %NULL to
+inherit parent's
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> the width of the image in pixels.
+<parameter name="argv">
+<parameter_description> child's argument vector
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> the height of the image in pixels.
+<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_description>
+</parameter>
+<parameter name="standard_output">
+<parameter_description> return location for file descriptor to read child's
+stdout, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="standard_error">
+<parameter_description> return location for file descriptor to read child's
+stderr, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for error
</parameter_description>
</parameter>
</parameters>
-<return> a new #GdkImage.
+<return> %TRUE on success, %FALSE if an error was set
+
</return>
</function>
-<function name="gdk_display_list_devices">
+<function name="gdk_string_extents">
<description>
-Returns the list of available input devices attached to @display.
-The list is statically allocated and should not be freed.
-
-Since: 2.2
+Gets the metrics of a nul-terminated string.
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<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_description>
+</parameter>
+<parameter name="descent">
+<parameter_description> the descent of the string.
</parameter_description>
</parameter>
</parameters>
-<return> a list of #GdkDevice
-
-</return>
+<return></return>
</function>
-<function name="gdk_visual_get_best_type">
+<function name="gdk_string_height">
<description>
-Return the best available visual type for the default GDK screen.
+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().
</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>
</parameters>
-<return> best visual type
+<return> the height of the string in pixels.
</return>
</function>
-<function name="gdk_cairo_set_source_color">
+<function name="gdk_string_measure">
<description>
-Sets the specified #GdkColor as the source color of @cr.
+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().
-Since: 2.8
</description>
<parameters>
-<parameter name="cr">
-<parameter_description> a #cairo_t
+<parameter name="font">
+<parameter_description> a #GdkFont
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> a #GdkColor
+<parameter name="string">
+<parameter_description> the nul-terminated string to measure.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the right bearing of the string in pixels.
+</return>
</function>
-<function name="gdk_window_get_root_origin">
+<function name="gdk_string_to_compound_text_for_display">
<description>
-Obtains the top-left corner of the window manager frame in root
-window coordinates.
+Convert a string from the encoding of the current
+locale into a form suitable for storing in a window property.
+Since: 2.2
+
+Deprecated:2.24: Use gdk_x11_display_string_to_compound_text()
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter name="display">
+<parameter_description> the #GdkDisplay where the encoding is defined.
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> return location for X position of window frame
+<parameter name="str">
+<parameter_description> a nul-terminated string.
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> return location for Y position of window frame
+<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></return>
+<return> 0 upon success, non-zero upon failure.
+
+</return>
</function>
-<function name="gdk_cursor_unref">
+<function name="gdk_string_width">
<description>
-Removes a reference from @cursor, deallocating the cursor
-if no references remain.
+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)
</description>
<parameters>
-<parameter name="cursor">
-<parameter_description> a #GdkCursor
+<parameter name="font">
+<parameter_description> a #GdkFont
+</parameter_description>
+</parameter>
+<parameter name="string">
+<parameter_description> the nul-terminated string to measure
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the width of the string in pixels.
+</return>
</function>
-<function name="gdk_cairo_reset_clip">
+<function name="gdk_test_render_sync">
<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.
+This function retrieves a pixel from @window to force the windowing
+system to carry out any pending rendering commands.
+This function is intended to be used to syncronize with rendering
+pipelines, to benchmark windowing system rendering operations.
-Since: 2.18
+Since: 2.14
</description>
<parameters>
-<parameter name="cr">
-<parameter_description> a #cairo_t
-</parameter_description>
-</parameter>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
+<parameter name="window">
+<parameter_description> a mapped #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_draw_polygon">
+<function name="gdk_test_simulate_button">
<description>
-Draws an outlined or filled polygon.
+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.
-Deprecated: 2.22: Use cairo_line_to() or cairo_append_path() and
-cairo_fill() or cairo_stroke() instead.
+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.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable (a #GdkWindow or a #GdkPixmap).
+<parameter name="window">
+<parameter_description> a #GdkWindow to simulate a button event for.
</parameter_description>
</parameter>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
+<parameter name="x">
+<parameter_description> x coordinate within @window for the button event.
</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 name="y">
+<parameter_description> y coordinate within @window for the button event.
</parameter_description>
</parameter>
-<parameter name="points">
-<parameter_description> an array of #GdkPoint structures specifying the points making
-up the polygon.
+<parameter name="button">
+<parameter_description> Number of the pointer button for the event, usually 1, 2 or 3.
</parameter_description>
</parameter>
-<parameter name="n_points">
-<parameter_description> the number of points.
+<parameter name="modifiers">
+<parameter_description> Keyboard modifiers the event is setup with.
+</parameter_description>
+</parameter>
+<parameter name="button_pressrelease">
+<parameter_description> either %GDK_BUTTON_PRESS or %GDK_BUTTON_RELEASE
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether all actions neccessary for a button event simulation
+were carried out successfully.
+
+</return>
</function>
-<function name="gdk_window_peek_children">
+<function name="gdk_test_simulate_key">
<description>
-Like gdk_window_get_children(), but does not copy the list of
-children, so the list does not need to be freed.
+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.
+
+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> a reference to the list of child windows in @window
+<return> whether all actions neccessary for a key event simulation
+were carried out successfully.
+
</return>
</function>
-<function name="gdk_window_set_icon">
+<function name="gdk_text_extents">
<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().
-
+Gets the metrics of a string.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter name="font">
+<parameter_description> a #GdkFont
</parameter_description>
</parameter>
-<parameter name="icon_window">
-<parameter_description> a #GdkWindow to use for the icon, or %NULL to unset
+<parameter name="text">
+<parameter_description> the text to measure
</parameter_description>
</parameter>
-<parameter name="pixmap">
-<parameter_description> a #GdkPixmap to use as the icon, or %NULL to unset
+<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="mask">
-<parameter_description> a 1-bit pixmap (#GdkBitmap) to use as mask for @pixmap, or %NULL to have none
+<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_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_drawable_get_data">
+<function name="gdk_text_extents_wc">
<description>
-Equivalent to g_object_get_data(); the #GObject variant should be
-used instead.
-
+Gets the metrics of a string of wide characters.
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
+<parameter name="font">
+<parameter_description> a #GdkFont
</parameter_description>
</parameter>
-<parameter name="key">
-<parameter_description> name the data was stored under
+<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_description>
</parameter>
-</parameters>
-<return> the data stored at @key
-</return>
-</function>
-
-<function name="gdk_beep">
-<description>
-Emits a short beep on the default display.
-
-</description>
-<parameters>
</parameters>
<return></return>
</function>
-<function name="gdk_fontset_load">
+<function name="gdk_text_height">
<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.
+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().
</description>
<parameters>
-<parameter name="fontset_name">
-<parameter_description> a comma-separated list of XLFDs describing
-the component fonts of the fontset to load.
+<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.
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkFont, or %NULL if the fontset could not be loaded.
+<return> the height of the string in pixels.
</return>
</function>
-<function name="gdk_window_unfullscreen">
+<function name="gdk_text_measure">
<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.
+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().
-Since: 2.2
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter name="font">
+<parameter_description> a #GdkFont
</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 name="text">
+<parameter_description> the text to measure.
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gdk_device_get_name">
-<description>
-Determines the name of the device.
-
-Since: 2.22
-
-</description>
-<parameters>
-<parameter name="device">
-<parameter_description> a #GdkDevice
+<parameter name="text_length">
+<parameter_description> the length of the text in bytes.
</parameter_description>
</parameter>
</parameters>
-<return> a name
-
+<return> the right bearing of the string in pixels.
</return>
</function>
-<function name="gdk_screen_get_active_window">
+<function name="gdk_text_property_to_text_list_for_display">
<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.
+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.)
-The returned window should be unrefed using g_object_unref() when
-no longer needed.
+Since: 2.2
-Since: 2.10
+Deprecated:2.24: Use gdk_x11_display_text_property_to_text_list()
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<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 a terminated array of strings in
+the encoding of the current locale. This array should be
+freed using gdk_free_text_list().
</parameter_description>
</parameter>
</parameters>
-<return> the currently active window, or %NULL.
+<return> the number of strings stored in list, or 0,
+if the conversion failed.
</return>
</function>
-<function name="gdk_color_alloc">
+<function name="gdk_text_property_to_utf8_list">
<description>
-Allocates a single color from a colormap.
+Convert a text property in the giving encoding to
+a list of UTF-8 strings.
-Deprecated: 2.2: Use gdk_colormap_alloc_color() instead.
</description>
<parameters>
-<parameter name="colormap">
-<parameter_description> a #GdkColormap.
+<parameter name="encoding">
+<parameter_description> an atom representing the encoding of the text
</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="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> %TRUE if the allocation succeeded.
-
+<return> the number of strings in the resulting
+list.
</return>
</function>
-<function name="gdk_utf8_to_compound_text_for_display">
+<function name="gdk_text_property_to_utf8_list_for_display">
<description>
-Converts from UTF-8 to compound text.
+Converts a text property in the given encoding to
+a list of UTF-8 strings.
Since: 2.2
@@ -9929,762 +10675,824 @@ Since: 2.2
<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> an atom representing the encoding of the text
</parameter_description>
</parameter>
<parameter name="format">
-<parameter_description> location to store format of the result
+<parameter_description> the format of the property
</parameter_description>
</parameter>
-<parameter name="ctext">
-<parameter_description> location to store the data of the result
+<parameter name="text">
+<parameter_description> the text to convert
</parameter_description>
</parameter>
<parameter name="length">
-<parameter_description> location to store the length of the data
-stored in @ctext
+<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> %TRUE if the conversion succeeded, otherwise
-%FALSE.
+<return> the number of strings in the resulting
+list.
</return>
</function>
-<function name="gdk_input_add">
+<function name="gdk_text_width">
<description>
-Establish a callback when a condition becomes true on
-a file descriptor.
+Determines the width of a given string.
-Deprecated: 2.14: Use g_io_add_watch() on a #GIOChannel
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a file descriptor.
-</parameter_description>
-</parameter>
-<parameter name="condition">
-<parameter_description> the condition.
+<parameter name="font">
+<parameter_description> a #GdkFont
</parameter_description>
</parameter>
-<parameter name="function">
-<parameter_description> the callback function.
+<parameter name="text">
+<parameter_description> the text to measure.
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> callback data passed to @function.
+<parameter name="text_length">
+<parameter_description> the length of the text in bytes.
</parameter_description>
</parameter>
</parameters>
-<return> a tag that can later be used as an argument to
-gdk_input_remove().
-
+<return> the width of the string in pixels.
</return>
</function>
-<function name="gdk_screen_get_font_options">
+<function name="gdk_text_width_wc">
<description>
-Gets any options previously set with gdk_screen_set_font_options().
+Determines the width of a given wide-character string.
-Since: 2.10
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<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_description>
</parameter>
</parameters>
-<return> the current font options, or %NULL if no default
-font options have been set.
-
+<return> the width of the string in pixels.
</return>
</function>
-<function name="gdk_screen_get_rgb_colormap">
+<function name="gdk_threads_add_idle">
<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.
+A wrapper for the common usage of gdk_threads_add_idle_full()
+assigning the default priority, #G_PRIORITY_DEFAULT_IDLE.
-Since: 2.2
+See gdk_threads_add_idle_full().
-Deprecated: 2.22: Use gdk_screen_get_system_colormap()
+Since: 2.12
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen.
+<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 preferred colormap
+<return> the ID (greater than 0) of the event source.
</return>
</function>
-<function name="gdk_window_remove_redirection">
+<function name="gdk_threads_add_idle_full">
<description>
-Removes any active redirection started by
-gdk_window_redirect_to_drawable().
+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.
-Since: 2.14
+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:
-</description>
-<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
-</function>
+|[
+static gboolean
+idle_callback (gpointer data)
+{
+/ * gdk_threads_enter(); would be needed for g_idle_add() * /
-<function name="gdk_draw_string">
-<description>
-Draws a string of characters in the given font or fontset.
+SomeWidget *self = data;
+/ * do stuff with self * /
-Deprecated: 2.4: Use gdk_draw_layout() instead.
+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="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 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="x">
-<parameter_description> the x coordinate of the left edge of the text.
+<parameter name="function">
+<parameter_description> function to call
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> the y coordinate of the baseline of the text.
+<parameter name="data">
+<parameter_description> data to pass to @function
</parameter_description>
</parameter>
-<parameter name="string">
-<parameter_description> the string of characters to draw.
+<parameter name="notify">
+<parameter_description> function to call when the idle is removed, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the ID (greater than 0) of the event source.
+
+</return>
</function>
-<function name="gdk_visual_get_best">
+<function name="gdk_threads_add_timeout">
<description>
-Get the visual with the most available colors for the default
-GDK screen. The return value should not be freed.
+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> best visual
+<return> the ID (greater than 0) of the event source.
+
</return>
</function>
-<function name="gdk_window_set_skip_taskbar_hint">
+<function name="gdk_threads_add_timeout_full">
<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.
+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.
-Since: 2.2
+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="window">
-<parameter_description> a toplevel #GdkWindow
+<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="skips_taskbar">
-<parameter_description> %TRUE to skip the taskbar
+<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></return>
+<return> the ID (greater than 0) of the event source.
+
+</return>
</function>
-<function name="gdk_window_set_geometry_hints">
+<function name="gdk_threads_add_timeout_seconds">
<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.
+A wrapper for the common usage of gdk_threads_add_timeout_seconds_full()
+assigning the default priority, #G_PRIORITY_DEFAULT.
-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.
+For details, see gdk_threads_add_timeout_full().
+Since: 2.14
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter name="interval">
+<parameter_description> the time between calls to the function, in seconds
</parameter_description>
</parameter>
-<parameter name="geometry">
-<parameter_description> geometry hints
+<parameter name="function">
+<parameter_description> function to call
</parameter_description>
</parameter>
-<parameter name="geom_mask">
-<parameter_description> bitmask indicating fields of @geometry to pay attention to
+<parameter name="data">
+<parameter_description> data to pass to @function
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the ID (greater than 0) of the event source.
+
+</return>
</function>
-<function name="gdk_display_get_pointer">
+<function name="gdk_threads_add_timeout_seconds_full">
<description>
-Gets the current location of the pointer and the current modifier
-mask for a given display.
+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.
-Since: 2.2
+Since: 2.14
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<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="screen">
-<parameter_description> location to store the screen that the
-cursor is on, or %NULL.
+<parameter name="interval">
+<parameter_description> the time between calls to the function, in seconds
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> location to store root window X coordinate of pointer, or %NULL.
+<parameter name="function">
+<parameter_description> function to call
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> location to store root window Y coordinate of pointer, or %NULL.
+<parameter name="data">
+<parameter_description> data to pass to @function
</parameter_description>
</parameter>
-<parameter name="mask">
-<parameter_description> location to store current modifier mask, or %NULL
+<parameter name="notify">
+<parameter_description> function to call when the timeout is removed, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the ID (greater than 0) of the event source.
+
+</return>
</function>
-<function name="gdk_event_send_client_message">
+<function name="gdk_threads_init">
<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.
+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>
-<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_description>
-</parameter>
</parameters>
-<return> non-zero on success.
-</return>
+<return></return>
</function>
-<function name="gdk_window_set_override_redirect">
+<function name="gdk_threads_set_lock_functions">
<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.
+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().
-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.
+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="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter name="enter_fn">
+<parameter_description> function called to guard GDK
</parameter_description>
</parameter>
-<parameter name="override_redirect">
-<parameter_description> %TRUE if window should be override redirect
+<parameter name="leave_fn">
+<parameter_description> function called to release the guard
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_hide">
+<function name="gdk_unicode_to_keyval">
<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().
+Convert from a ISO10646 character to a key symbol.
+
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="wc">
+<parameter_description> a ISO10646 encoded character
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the corresponding GDK key symbol, if one exists.
+or, if there is no corresponding symbol,
+wc | 0x01000000
+</return>
</function>
-<function name="gdk_drag_motion">
+<function name="gdk_utf8_to_compound_text">
<description>
-Updates the drag context when the pointer moves or the
-set of actions changes.
-
-This function is called by the drag source.
+Convert from UTF-8 to compound text.
</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="str">
+<parameter_description> a UTF-8 string
</parameter_description>
</parameter>
-<parameter name="y_root">
-<parameter_description> the y position of the pointer in root coordinates.
+<parameter name="encoding">
+<parameter_description> location to store resulting encoding
</parameter_description>
</parameter>
-<parameter name="suggested_action">
-<parameter_description> the suggested action.
+<parameter name="format">
+<parameter_description> location to store format of the result
</parameter_description>
</parameter>
-<parameter name="possible_actions">
-<parameter_description> the possible actions.
+<parameter name="ctext">
+<parameter_description> location to store the data of the result
</parameter_description>
</parameter>
-<parameter name="time_">
-<parameter_description> the timestamp for this operation.
+<parameter name="length">
+<parameter_description> location to store the length of the data
+stored in @ctext
</parameter_description>
</parameter>
</parameters>
-<return> FIXME
+<return> %TRUE if the conversion succeeded, otherwise
+false.
</return>
</function>
-<function name="gdk_test_simulate_button">
+<function name="gdk_utf8_to_compound_text_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.
+Converts from UTF-8 to compound text.
+
+Since: 2.2
+Deprecated:2.24: Use gdk_x11_display_utf8_to_compound_text()
</description>
<parameters>
-<parameter name="window">
-<parameter_description> Gdk window to simulate a button event for.
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> x coordinate within @window for the button event.
+<parameter name="str">
+<parameter_description> a UTF-8 string
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> y coordinate within @window for the button event.
+<parameter name="encoding">
+<parameter_description> location to store resulting encoding
</parameter_description>
</parameter>
-<parameter name="button">
-<parameter_description> Number of the pointer button for the event, usually 1, 2 or 3.
+<parameter name="format">
+<parameter_description> location to store format of the result
</parameter_description>
</parameter>
-<parameter name="modifiers">
-<parameter_description> Keyboard modifiers the event is setup with.
+<parameter name="ctext">
+<parameter_description> location to store the data of the result
</parameter_description>
</parameter>
-<parameter name="button_pressrelease">
-<parameter_description> either %GDK_BUTTON_PRESS or %GDK_BUTTON_RELEASE
+<parameter name="length">
+<parameter_description> location to store the length of the data
+stored in @ctext
</parameter_description>
</parameter>
</parameters>
-<return> wether all actions neccessary for a button event simulation were carried out successfully.
+<return> %TRUE if the conversion succeeded, otherwise
+%FALSE.
+
</return>
</function>
-<function name="gdk_window_withdraw">
+<function name="gdk_utf8_to_string_target">
<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.
+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="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter name="str">
+<parameter_description> a UTF-8 string
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<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_image_get_depth">
+<function name="gdk_visual_get_best">
<description>
-Determines the depth of the image.
-
-Since: 2.22
+Get the visual with the most available colors for the default
+GDK screen. The return value should not be freed.
-Deprecated: 2.22: #GdkImage should not be used anymore.
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GdkImage
-</parameter_description>
-</parameter>
</parameters>
-<return> the depth
+<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_window_deiconify">
+<function name="gdk_visual_get_best_type">
<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.
+Return the best available visual type for the default GDK screen.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> best visual type
+</return>
</function>
-<function name="gdk_display_get_maximal_cursor_size">
+<function name="gdk_visual_get_best_with_both">
<description>
-Gets the maximal size to use for cursors on @display.
+Combines gdk_visual_get_best_with_depth() and gdk_visual_get_best_with_type().
-Since: 2.4
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> the return location for the maximal cursor width
+<parameter name="depth">
+<parameter_description> a bit depth
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> the return location for the maximal cursor height
+<parameter name="visual_type">
+<parameter_description> a visual type
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> best visual with both @depth and
+ visual_type, or %NULL if none
+</return>
</function>
-<function name="gdk_display_add_client_message_filter">
+<function name="gdk_visual_get_best_with_depth">
<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.
+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.
-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_description>
-</parameter>
-<parameter name="data">
-<parameter_description> user data to pass to @func.
+<parameter name="depth">
+<parameter_description> a bit depth
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> best visual for the given depth
+</return>
</function>
-<function name="gdkx_colormap_get">
+<function name="gdk_visual_get_best_with_type">
<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+
-
-Always use gdk_x11_colormap_foreign_new() instead.
+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="xcolormap">
-<parameter_description> the XID of a colormap for the default screen.
+<parameter name="visual_type">
+<parameter_description> a visual type
</parameter_description>
</parameter>
</parameters>
-<return> the existing #GdkColormap object if it was
-already known to GTK+, otherwise warns and return
-%NULL.
+<return> best visual of the given type
</return>
</function>
-<function name="gdk_app_launch_context_new">
+<function name="gdk_visual_get_bits_per_rgb">
<description>
-Creates a new #GdkAppLaunchContext.
+Returns the number of significant bits per red, green and blue value.
-Since: 2.14
+Since: 2.22
</description>
<parameters>
+<parameter name="visual">
+<parameter_description> a #GdkVisual
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GdkAppLaunchContext
+<return> The number of significant bits per color value for @visual.
</return>
</function>
-<function name="gdk_drag_find_window">
+<function name="gdk_visual_get_blue_pixel_details">
<description>
-Finds the destination window and DND protocol to use at the
-given pointer position.
+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.
-This function is called by the drag source to obtain the
- dest_window and @protocol parameters for gdk_drag_motion().
+Since: 2.22
</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="x_root">
-<parameter_description> the x position of the pointer in root coordinates.
+<parameter name="visual">
+<parameter_description> a #GdkVisual
</parameter_description>
</parameter>
-<parameter name="y_root">
-<parameter_description> the y position of the pointer in root coordinates.
+<parameter name="mask">
+<parameter_description> A pointer to a #guint32 to be filled in, or %NULL.
</parameter_description>
</parameter>
-<parameter name="dest_window">
-<parameter_description> location to store the destination window in.
+<parameter name="shift">
+<parameter_description> A pointer to a #gint to be filled in, or %NULL.
</parameter_description>
</parameter>
-<parameter name="protocol">
-<parameter_description> location to store the DND protocol in.
+<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_window_ensure_native">
+<function name="gdk_visual_get_byte_order">
<description>
-Tries to ensure that there is a window-system native window for this
-GdkWindow. This may fail in some situations, returning %FALSE.
-
-Offscreen window and children of them can never have native windows.
-
-Some backends may not support native child windows.
+Returns the byte order of this visual.
-Since: 2.18
+Since: 2.22
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="visual">
+<parameter_description> A #GdkVisual.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the window has a native window, %FALSE otherwise
+<return> A #GdkByteOrder stating the byte order of @visual.
</return>
</function>
-<function name="gdk_window_set_title">
+<function name="gdk_visual_get_colormap_size">
<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.
+Returns the size of a colormap for this visual.
+
+Since: 2.22
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="title">
-<parameter_description> title of @window
+<parameter name="visual">
+<parameter_description> A #GdkVisual.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The size of a colormap that is suitable for @visual.
+
+</return>
</function>
-<function name="gdk_colormap_get_screen">
+<function name="gdk_visual_get_depth">
<description>
-Gets the screen for which this colormap was created.
+Returns the bit depth of this visual.
-Since: 2.2
+Since: 2.22
</description>
<parameters>
-<parameter name="cmap">
-<parameter_description> a #GdkColormap
+<parameter name="visual">
+<parameter_description> A #GdkVisual.
</parameter_description>
</parameter>
</parameters>
-<return> the screen for which this colormap was created.
+<return> The bit depth of this visual.
</return>
</function>
-<function name="gdk_window_flush">
+<function name="gdk_visual_get_green_pixel_details">
<description>
-Flush all outstanding cached operations on a window, leaving the
-window in a state which reflects all that has been drawn before.
+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.
-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.
+Since: 2.22
-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.
+</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>
-Since: 2.18
+<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="window">
-<parameter_description> a #GdkWindow
+<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_display_get_event">
+<function name="gdk_visual_get_screen">
<description>
-Gets the next #GdkEvent to be processed for @display, fetching events from the
-windowing system if necessary.
+Gets the screen to which this visual belongs
Since: 2.2
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="visual">
+<parameter_description> a #GdkVisual
</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> the screen to which this visual belongs.
</return>
</function>
-<function name="gdk_window_get_frame_extents">
+<function name="gdk_visual_get_system">
<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().
+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>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="rect">
-<parameter_description> rectangle to fill with bounding box of the window frame
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> system visual
+</return>
</function>
-<function name="gdk_visual_get_byte_order">
+<function name="gdk_visual_get_visual_type">
<description>
-Returns the byte order of this visual.
+Returns the type of visual this is (PseudoColor, TrueColor, etc).
Since: 2.22
@@ -10695,312 +11503,398 @@ Since: 2.22
</parameter_description>
</parameter>
</parameters>
-<return> A #GdkByteOrder stating the byte order of @visual.
+<return> A #GdkVisualType stating the type of @visual.
</return>
</function>
-<function name="gdk_display_supports_shapes">
+<function name="gdk_wcstombs">
<description>
-Returns %TRUE if gdk_window_shape_combine_mask() can
-be used to create shaped windows on @display.
+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').
-Since: 2.10
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="src">
+<parameter_description> a wide character string.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if shaped windows are supported
-
+<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>
</function>
-<function name="gdk_rgb_get_visual">
+<function name="gdk_win32_hdc_get">
<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.
+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:
+
+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.
+
+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.
+
+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.
+
+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.
+
+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.)
+
+When the HDC is no longer used, it should be released by calling
+<function>gdk_win32_hdc_release()</function> with the same
+parameters.
+
+If you modify the HDC by calling <function>SelectObject</function>
+you should undo those modifications before calling
+<function>gdk_win32_hdc_release()</function>.
-Deprecated: 2.22: Use gdk_get_system_visual()
</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 needs to be set up
+</parameter_description>
+</parameter>
</parameters>
-<return> The #GdkVisual chosen by GdkRGB.
-
+<return> The HDC.
</return>
</function>
-<function name="gdk_pixbuf_render_pixmap_and_mask_for_colormap">
+<function name="gdk_win32_hdc_release">
<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().
-
-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.
-
-If the pixbuf does not have an alpha channel, then * mask_return will be set
-to %NULL.
+This function deallocates the Windows device context allocated by
+<funcion>gdk_win32_hdc_get()</function>. It should be called with
+the same parameters.
</description>
<parameters>
-<parameter name="pixbuf">
-<parameter_description> A pixbuf.
+<parameter name="drawable">
+<parameter_description> destination #GdkDrawable
</parameter_description>
</parameter>
-<parameter name="colormap">
-<parameter_description> A #GdkColormap
+<parameter name="gc">
+<parameter_description> #GdkGC to use for drawing on @drawable
</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 name="usage">
+<parameter_description> mask indicating what properties were set up
</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.
+</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.
+
+See gdk_display_add_client_message_filter() if you are interested
+in X ClientMessage events.
+
+</description>
+<parameters>
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="alpha_threshold">
-<parameter_description> Threshold value for opacity values.
+<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_set_startup_id">
+<function name="gdk_window_at_pointer">
<description>
-When using GTK+, typically you should use gtk_window_set_startup_id()
-instead of this low-level function.
+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())
-Since: 2.12
+NOTE: For multihead-aware widgets or applications use
+gdk_display_get_window_at_pointer() instead.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter name="win_x">
+<parameter_description> return location for origin of the window under the pointer
</parameter_description>
</parameter>
-<parameter name="startup_id">
-<parameter_description> a string with startup-notification identifier
+<parameter name="win_y">
+<parameter_description> return location for origin of the window under the pointer
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> window under the mouse pointer
+</return>
</function>
-<function name="gdk_window_coords_to_parent">
+<function name="gdk_window_beep">
<description>
-Transforms window coordinates from a child window to its parent
-window, where the parent window is the normal parent as returned by
-gdk_window_get_parent() for normal windows, and the window's
-embedder as returned by gdk_offscreen_window_get_embedder() for
-offscreen windows.
+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().
-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.
+Since: 2.12
-You should always use this function when writing generic code that
-walks up a window hierarchy.
+</description>
+<parameters>
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-See also: gdk_window_coords_from_parent()
+<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.
-Since: 2.22
</description>
<parameters>
<parameter name="window">
-<parameter_description> a child window
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> X coordinate in child's coordinate system
+<parameter name="button">
+<parameter_description> the button being used to drag
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> Y coordinate in child's coordinate system
+<parameter name="root_x">
+<parameter_description> root window X coordinate of mouse click that began the drag
</parameter_description>
</parameter>
-<parameter name="parent_x">
-<parameter_description> return location for X coordinate
-in parent's coordinate system, or %NULL
+<parameter name="root_y">
+<parameter_description> root window Y coordinate of mouse click that began the drag
</parameter_description>
</parameter>
-<parameter name="parent_y">
-<parameter_description> return location for Y coordinate
-in parent's coordinate system, or %NULL
+<parameter name="timestamp">
+<parameter_description> timestamp of mouse click that began the drag
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_x11_get_xatom_by_name_for_display">
+<function name="gdk_window_begin_paint_rect">
<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.
+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="display">
-<parameter_description> a #GdkDisplay
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="atom_name">
-<parameter_description> a string
+<parameter name="rectangle">
+<parameter_description> rectangle you intend to draw to
</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_begin_paint_region">
<description>
-Set if @window must be kept below other windows. If the
-window was already below, then this function does nothing.
+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.
-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.
+The net result of all this is to remove flicker, because the user
+sees the finished product appear all at once when you call
+gdk_window_end_paint(). If you draw to @window directly without
+calling gdk_window_begin_paint_region(), the user may see flicker
+as individual drawing operations are performed in sequence. The
+clipping and background-initializing features of
+gdk_window_begin_paint_region() are conveniences for the
+programmer, so you can avoid doing that work yourself.
+
+When using GTK+, the widget system automatically places calls to
+gdk_window_begin_paint_region() and gdk_window_end_paint() around
+emissions of the expose_event signal. That is, if you're writing an
+expose event handler, you can assume that the exposed area in
+#GdkEventExpose has already been cleared to the window background,
+is already set as the clip region, and already has a backing store.
+Therefore in most cases, application code need not call
+gdk_window_begin_paint_region(). (You can disable the automatic
+calls around expose events on a widget-by-widget basis by calling
+gtk_widget_set_double_buffered().)
+
+If you call this function multiple times before calling the
+matching gdk_window_end_paint(), the backing stores are pushed onto
+a stack. gdk_window_end_paint() copies the topmost backing store
+onscreen, subtracts the topmost region from all other regions in
+the stack, and pops the stack. All drawing operations affect only
+the topmost backing store in the stack. One matching call to
+gdk_window_end_paint() is required for each call to
+gdk_window_begin_paint_region().
-Since: 2.4
</description>
<parameters>
<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="setting">
-<parameter_description> whether to keep @window below other windows
+<parameter name="region">
+<parameter_description> region you intend to draw to
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_screen_get_monitor_plug_name">
+<function name="gdk_window_begin_resize_drag">
<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.
+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.14
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="monitor_num">
-<parameter_description> number of the monitor, between 0 and gdk_screen_get_n_monitors (screen)
+<parameter name="edge">
+<parameter_description> the edge or corner from which the drag is started
</parameter_description>
</parameter>
-</parameters>
-<return> a newly-allocated string containing the name of the monitor,
-or %NULL if the name cannot be determined
-
-</return>
-</function>
-
-<function name="gdk_drawable_set_data">
-<description>
-This function is equivalent to g_object_set_data(),
-the #GObject variant should be used instead.
-
-
-</description>
-<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
+<parameter name="button">
+<parameter_description> the button being used to drag
</parameter_description>
</parameter>
-<parameter name="key">
-<parameter_description> name to store the data under
+<parameter name="root_x">
+<parameter_description> root window X coordinate of mouse click that began the drag
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> arbitrary data
+<parameter name="root_y">
+<parameter_description> root window Y coordinate of mouse click that began the drag
</parameter_description>
</parameter>
-<parameter name="destroy_func">
-<parameter_description> function to free @data, or %NULL
+<parameter name="timestamp">
+<parameter_description> timestamp of mouse click that began the drag (use gdk_event_get_time())
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_x11_colormap_get_xcolormap">
+<function name="gdk_window_clear">
<description>
-Returns the X colormap belonging to a #GdkColormap.
-
+Clears an entire @window to the background color or background pixmap.
</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_clear_area">
<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.
+Clears an area of @window to the background color or background pixmap.
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
+<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_description>
+</parameter>
+<parameter name="height">
+<parameter_description> height of rectangle to clear
</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_clear_area_e">
<description>
-Sets @window to be embedded in @embedder.
+Like gdk_window_clear_area(), but also generates an expose event for
+the cleared area.
-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.
+This function has a stupid name because it dates back to the mists
+time, pre-GDK-1.0.
-Since: 2.18
</description>
<parameters>
@@ -11008,223 +11902,298 @@ Since: 2.18
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="embedder">
-<parameter_description> the #GdkWindow that @window gets embedded in
+<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_description>
+</parameter>
+<parameter name="height">
+<parameter_description> height of rectangle to clear
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_display_supports_clipboard_persistence">
+<function name="gdk_window_configure_finished">
<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.
+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="display">
-<parameter_description> a #GdkDisplay
+<parameter name="window">
+<parameter_description> a toplevel #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_constrain_size">
<description>
-Checks whether the window has been mapped (with gdk_window_show() or
-gdk_window_show_unraised()).
-
+Constrains a desired width and height according to a
+set of geometry hints (such as minimum and maximum size).
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<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> %TRUE if the window is mapped
-</return>
+<return></return>
</function>
-<function name="gdk_color_white">
+<function name="gdk_window_coords_from_parent">
<description>
-Returns the white color for a given colormap. The resulting
-value has already allocated been allocated.
+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="colormap">
-<parameter_description> a #GdkColormap.
+<parameter name="window">
+<parameter_description> a child window
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> the location to store the color.
+<parameter name="parent_x">
+<parameter_description> X coordinate in parent's coordinate system
+</parameter_description>
+</parameter>
+<parameter name="parent_y">
+<parameter_description> Y coordinate in parent's coordinate system
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> return location for X coordinate in child's coordinate system
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> return location for Y coordinate in child's coordinate system
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the allocation succeeded.
-</return>
+<return></return>
</function>
-<function name="gdk_wcstombs">
+<function name="gdk_window_coords_to_parent">
<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').
+Transforms window coordinates from a child window to its parent
+window, where the parent window is the normal parent as returned by
+gdk_window_get_parent() for normal windows, and the window's
+embedder as returned by gdk_offscreen_window_get_embedder() for
+offscreen windows.
+For normal windows, calling this function is equivalent to adding
+the return values of gdk_window_get_position() to the child coordinates.
+For offscreen windows however (which can be arbitrarily transformed),
+this function calls the GdkWindow::to-embedder: signal to translate
+the coordinates.
-</description>
-<parameters>
-<parameter name="src">
-<parameter_description> a wide character string.
-</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>
-</function>
+You should always use this function when writing generic code that
+walks up a window hierarchy.
-<function name="gdk_input_add_full">
-<description>
-Establish a callback when a condition becomes true on
-a file descriptor.
+See also: gdk_window_coords_from_parent()
-Deprecated: 2.14: Use g_io_add_watch_full() on a #GIOChannel
+Since: 2.22
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a file descriptor.
+<parameter name="window">
+<parameter_description> a child window
</parameter_description>
</parameter>
-<parameter name="condition">
-<parameter_description> the condition.
+<parameter name="x">
+<parameter_description> X coordinate in child's coordinate system
</parameter_description>
</parameter>
-<parameter name="function">
-<parameter_description> the callback function.
+<parameter name="y">
+<parameter_description> Y coordinate in child's coordinate system
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> callback data passed to @function.
+<parameter name="parent_x">
+<parameter_description> return location for X coordinate
+in parent's coordinate system, or %NULL
</parameter_description>
</parameter>
-<parameter name="destroy">
-<parameter_description> callback function to call with @data when the input
-handler is removed.
+<parameter name="parent_y">
+<parameter_description> return location for Y coordinate
+in parent's coordinate system, or %NULL
</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_display_get_default">
+<function name="gdk_window_create_similar_surface">
<description>
-Gets the default #GdkDisplay. This is a convenience
-function for
-<literal>gdk_display_manager_get_default_display (gdk_display_manager_get ())</literal>.
+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().
-Since: 2.2
+Initially the surface contents are all 0 (transparent if contents
+have transparency, black otherwise.)
+
+Since: 2.22
</description>
<parameters>
+<parameter name="window">
+<parameter_description> window to make new surface similar to
+</parameter_description>
+</parameter>
+<parameter name="content">
+<parameter_description> the content for the new surface
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> width of the new surface
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> height of the new surface
+</parameter_description>
+</parameter>
</parameters>
-<return> a #GdkDisplay, or %NULL if there is no default
-display.
+<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_get_cursor">
+<function name="gdk_window_deiconify">
<description>
-Retrieves a #GdkCursor pointer for the cursor currently set on the
-specified #GdkWindow, or %NULL. If the return value is %NULL then
-there is no custom cursor set on the specified window, and it is
-using the cursor for its parent window.
+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.
-Since: 2.18
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkCursor, or %NULL. The returned object is owned
-by the #GdkWindow and should not be unreferenced directly. Use
-gdk_window_set_cursor() to unset the cursor of the window
-
-</return>
+<return></return>
</function>
-<function name="gdk_device_get_n_axes">
+<function name="gdk_window_destroy">
<description>
-Gets the number of axes of a device.
+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.
-Since: 2.22
</description>
<parameters>
-<parameter name="device">
-<parameter_description> a #GdkDevice.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the number of axes of @device
-
-</return>
+<return></return>
</function>
-<function name="gdk_text_height">
+<function name="gdk_window_enable_synchronized_configure">
<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().
+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.
+
+Since: 2.6
</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.
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the height of the string in pixels.
-</return>
+<return></return>
</function>
-<function name="gdk_window_set_child_input_shapes">
+<function name="gdk_window_end_paint">
<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.
+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.10
</description>
<parameters>
@@ -11236,55 +12205,63 @@ Since: 2.10
<return></return>
</function>
-<function name="gdk_keymap_get_direction">
+<function name="gdk_window_ensure_native">
<description>
-Returns the direction of effective layout of the keymap.
+Tries to ensure that there is a window-system native window for this
+GdkWindow. This may fail in some situations, returning %FALSE.
+Offscreen window and children of them can never have native windows.
+
+Some backends may not support native child windows.
+
+Since: 2.18
</description>
<parameters>
-<parameter name="keymap">
-<parameter_description> a #GdkKeymap or %NULL to use the default keymap
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> %PANGO_DIRECTION_LTR or %PANGO_DIRECTION_RTL
-if it can determine the direction. %PANGO_DIRECTION_NEUTRAL
-otherwise.
+<return> %TRUE if the window has a native window, %FALSE otherwise
+
</return>
</function>
-<function name="gdk_display_set_double_click_time">
+<function name="gdk_window_flush">
<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.
+Flush all outstanding cached operations on a window, leaving the
+window in a state which reflects all that has been drawn before.
-Since: 2.2
+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.
+
+Normally this should be completely invisible to applications, as
+we automatically flush the windows when required, but this might
+be needed if you for instance mix direct native drawing with
+gdk drawing. For Gtk widgets that don't use double buffering this
+will be called automatically before sending the expose event.
+
+Since: 2.18
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
-</parameter_description>
-</parameter>
-<parameter name="msec">
-<parameter_description> double click time in milliseconds (thousandths of a second)
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_destroy">
+<function name="gdk_window_focus">
<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.
+Sets keyboard focus to @window. In most cases, gtk_window_present()
+should be used on a #GtkWindow, rather than calling this function.
</description>
@@ -11293,260 +12270,278 @@ reaches zero. You must call this function yourself before that happens.
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
+<parameter name="timestamp">
+<parameter_description> timestamp of the event triggering the window focus
+</parameter_description>
+</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_display_open_default_libgtk_only">
+<function name="gdk_window_foreign_new">
<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.
+Wraps a native window for the default display in a #GdkWindow.
+This may fail if the window has been destroyed.
+
+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_description>
+</parameter>
</parameters>
-<return> the default display, if it could be opened,
-otherwise %NULL.
+<return> the newly-created #GdkWindow wrapper for the
+native window or %NULL if the window has been destroyed.
</return>
</function>
-<function name="gdk_event_send_client_message_for_display">
+<function name="gdk_window_foreign_new_for_display">
<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.
+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.
-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.
+For example in the X backend, a native window handle is an Xlib
+<type>XID</type>.
Since: 2.2
+Deprecated:2.24: Use gdk_x11_window_foreign_new_for_display() or
+equivalent backend-specific API instead
+
</description>
<parameters>
<parameter name="display">
-<parameter_description> the #GdkDisplay for the window where the message is to be sent.
-</parameter_description>
-</parameter>
-<parameter name="event">
-<parameter_description> the #GdkEvent to send, which should be a #GdkEventClient.
+<parameter_description> the #GdkDisplay where the window handle comes from.
</parameter_description>
</parameter>
-<parameter name="winid">
-<parameter_description> the window to send the client message to.
+<parameter name="anid">
+<parameter_description> a native window handle.
</parameter_description>
</parameter>
</parameters>
-<return> non-zero on success.
+<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_destroy">
+<function name="gdk_window_freeze_toplevel_updates_libgtk_only">
<description>
-Destroys a #GdkRegion.
+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="region">
-<parameter_description> a #GdkRegion
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_event_copy">
+<function name="gdk_window_freeze_updates">
<description>
-Copies a #GdkEvent, copying or incrementing the reference count of the
-resources associated with it (e.g. #GdkWindow's and strings).
-
+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="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>
+<return></return>
</function>
-<function name="gdk_text_measure">
+<function name="gdk_window_fullscreen">
<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().
+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.
+
+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 bytes.
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the right bearing of the string in pixels.
-</return>
+<return></return>
</function>
-<function name="gdk_window_show_unraised">
+<function name="gdk_window_geometry_changed">
<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.
+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.
-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).
+Since: 2.18
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter_description> an embedded offscreen #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_drawable_get_clip_region">
+<function name="gdk_window_get_accept_focus">
<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.
+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="drawable">
-<parameter_description> a #GdkDrawable
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow.
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkRegion. This must be freed with gdk_region_destroy()
-when you are done.
+<return> whether or not the window should receive input focus.
+
</return>
</function>
-<function name="gdk_screen_get_monitor_at_window">
+<function name="gdk_window_get_background_pattern">
<description>
-Returns the number of the monitor in which the largest area of the
-bounding rectangle of @window resides.
+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.2
+Since: 2.22
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen.
-</parameter_description>
-</parameter>
<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter_description> a window
</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> The pattern to use for the background or %NULL to use the
+parent's background.
+
</return>
</function>
-<function name="gdk_keymap_get_caps_lock_state">
+<function name="gdk_window_get_children">
<description>
-Returns whether the Caps Lock modifer is locked.
+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.
-Since: 2.16
</description>
<parameters>
-<parameter name="keymap">
-<parameter_description> a #GdkKeymap
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if Caps Lock is on
-
+<return>
+list of child windows inside @window
</return>
</function>
-<function name="gdk_drag_begin">
+<function name="gdk_window_get_composited">
<description>
-Starts a drag and creates a new drag context for it.
+Determines whether @window is composited.
-This function is called by the drag source.
+See gdk_window_set_composited().
+Since: 2.22
</description>
<parameters>
<parameter name="window">
-<parameter_description> the source window for this drag.
-</parameter_description>
-</parameter>
-<parameter name="targets">
-<parameter_description> the offered targets, as list of #GdkAtom<!-- -->s
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> a newly created #GdkDragContext.
+<return> %TRUE if the window is composited.
+
</return>
</function>
-<function name="gdk_display_manager_get">
+<function name="gdk_window_get_cursor">
<description>
-Gets the singleton #GdkDisplayManager object.
+Retrieves a #GdkCursor pointer for the cursor currently set on the
+specified #GdkWindow, or %NULL. If the return value is %NULL then
+there is no custom cursor set on the specified window, and it is
+using the cursor for its parent window.
-Since: 2.2
+Since: 2.18
</description>
<parameters>
+<parameter name="window">
+<parameter_description> a #GdkWindow
+</parameter_description>
+</parameter>
</parameters>
-<return> The global #GdkDisplayManager singleton; gdk_parse_pargs(),
-gdk_init(), or gdk_init_check() must have been called first.
+<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_gc_set_function">
+<function name="gdk_window_get_decorations">
<description>
-Determines how the current pixel values and the
-pixel values being drawn are combined to produce
-the final pixel values.
-
-Deprecated: 2.22: Use cairo_set_operator() with Cairo.
+Returns the decorations set on the GdkWindow with #gdk_window_set_decorations
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
+<parameter name="window">
+<parameter_description> The toplevel #GdkWindow to get the decorations from
</parameter_description>
</parameter>
-<parameter name="function">
-<parameter_description> the #GdkFunction to use
+<parameter name="decorations">
+<parameter_description> The window decorations will be written here
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> TRUE if the window has decorations set, FALSE otherwise.
+</return>
</function>
<function name="gdk_window_get_deskrelative_origin">
@@ -11578,263 +12573,288 @@ It's deprecated for that reason.
</return>
</function>
-<function name="gdk_cursor_new_from_pixmap">
+<function name="gdk_window_get_display">
<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.
+Gets the #GdkDisplay associated with a #GdkWindow.
-<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};
+Since: 2.24
-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};
+</description>
+<parameters>
+<parameter name="window">
+<parameter_description> a #GdkWindow
+</parameter_description>
+</parameter>
+</parameters>
+<return> the #GdkDisplay associated with @window
+</return>
+</function>
-GdkCursor *cursor;
-GdkPixmap *source, *mask;
-GdkColor fg = { 0, 65535, 0, 0 }; /<!-- -->* Red. *<!-- -->/
-GdkColor bg = { 0, 0, 0, 65535 }; /<!-- -->* Blue. *<!-- -->/
+<function name="gdk_window_get_effective_parent">
+<description>
+Obtains the parent of @window, as known to GDK. Works like
+gdk_window_get_parent() for normal windows, but returns the
+window's embedder for offscreen windows.
+See also: gdk_offscreen_window_get_embedder()
-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);
+Since: 2.22
+</description>
+<parameters>
+<parameter name="window">
+<parameter_description> a #GdkWindow
+</parameter_description>
+</parameter>
+</parameters>
+<return> effective parent of @window
-gdk_window_set_cursor (widget->window, cursor);
-</programlisting>
-</example>
+</return>
+</function>
+
+<function name="gdk_window_get_effective_toplevel">
+<description>
+Gets the toplevel window that's an ancestor of @window.
+
+Works like gdk_window_get_toplevel(), but treats an offscreen window's
+embedder as its parent, using gdk_window_get_effective_parent().
+
+See also: gdk_offscreen_window_get_embedder()
+Since: 2.22
</description>
<parameters>
-<parameter name="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_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_description>
-</parameter>
-<parameter name="x">
-<parameter_description> the horizontal offset of the 'hotspot' of the cursor.
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> the vertical offset of the 'hotspot' of the cursor.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> a new #GdkCursor.
+<return> the effective toplevel window containing @window
+
</return>
</function>
-<function name="gdk_drop_reply">
+<function name="gdk_window_get_events">
<description>
-Accepts or rejects a drop.
+Gets the event mask for @window. See gdk_window_set_events().
-This function is called by the drag destination in response
-to a drop initiated by the drag source.
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GdkDragContext.
-</parameter_description>
-</parameter>
-<parameter name="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> event mask for @window
+</return>
</function>
-<function name="gdk_screen_get_width_mm">
+<function name="gdk_window_get_focus_on_map">
<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 desktop environment should be hinted that the
+window does not want to receive input focus when it is mapped.
-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 wants to receive input focus when
+it is mapped.
</return>
</function>
-<function name="gdk_screen_set_resolution">
+<function name="gdk_window_get_frame_extents">
<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 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().
-Since: 2.10
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="window">
+<parameter_description> a toplevel #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="rect">
+<parameter_description> rectangle to fill with bounding box of the window frame
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_set_functions">
+<function name="gdk_window_get_geometry">
<description>
-Sets hints about the window management functions to make available
-via buttons on the window frame.
+Any of the return location arguments to this function may be %NULL,
+if you aren't interested in getting the value of that field.
-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 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).
-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.
+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.
+<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 toplevel #GdkWindow
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="functions">
-<parameter_description> bitmask of operations to allow on @window
+<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>
+<parameter name="depth">
+<parameter_description> return location for bit depth of window
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_event_get_time">
+<function name="gdk_window_get_group">
<description>
-Returns the time stamp from @event, if there is one; otherwise
-returns #GDK_CURRENT_TIME. If @event is %NULL, returns #GDK_CURRENT_TIME.
+Returns the group leader window for @window. See gdk_window_set_group().
+Since: 2.4
</description>
<parameters>
-<parameter name="event">
-<parameter_description> a #GdkEvent
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> time stamp field from @event
+<return> the group leader window for @window
+
</return>
</function>
-<function name="gdk_keyval_to_unicode">
+<function name="gdk_window_get_height">
<description>
-Convert from a GDK key symbol to the corresponding ISO10646 (Unicode)
-character.
+Returns the height of the given @window.
+
+On the X11 platform the returned size is the size reported in the
+most-recently-processed configure event, rather than the current
+size on the X server.
+Since: 2.24
</description>
<parameters>
-<parameter name="keyval">
-<parameter_description> a GDK key symbol
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the corresponding unicode character, or 0 if there
-is no corresponding character.
+<return> The height of @window
+
</return>
</function>
-<function name="gdk_event_handler_set">
+<function name="gdk_window_get_internal_paint_info">
<description>
-Sets the function to call to handle all events from GDK.
+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.
-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+.)
+This function exposes details of the GDK implementation, and is thus
+likely to change in future releases of GDK.
</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="real_drawable">
+<parameter_description> location to store the drawable to which drawing should be
+done.
</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="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_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_shape_combine_region">
+<function name="gdk_window_get_modal_hint">
<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.
+Determines whether or not the window manager is hinted that @window
+has modal behaviour.
-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.
+Since: 2.22
-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.
+</description>
+<parameters>
+<parameter name="window">
+<parameter_description> A toplevel #GdkWindow.
+</parameter_description>
+</parameter>
+</parameters>
+<return> whether or not the window has the modal hint set.
+
+</return>
+</function>
+
+<function name="gdk_window_get_origin">
+<description>
+Obtains the position of a window in root window coordinates.
+(Compare with gdk_window_get_position() and
+gdk_window_get_geometry() which return the position of a window
+relative to its parent window.)
-This function works on both toplevel and child windows.
</description>
<parameters>
@@ -11842,701 +12862,668 @@ 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_description>
-</parameter>
-<parameter name="offset_x">
-<parameter_description> X position of @shape_region in @window coordinates
+<parameter name="x">
+<parameter_description> return location for X coordinate
</parameter_description>
</parameter>
-<parameter name="offset_y">
-<parameter_description> Y position of @shape_region in @window coordinates
+<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_lookup_for_display">
+<function name="gdk_window_get_parent">
<description>
-Looks up the #GdkWindow that wraps the given native window handle.
+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.
-For example in the X backend, a native window handle is an Xlib
-<type>XID</type>.
+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.
-Since: 2.2
</description>
<parameters>
-<parameter name="display">
-<parameter_description> the #GdkDisplay corresponding to the window handle
-</parameter_description>
-</parameter>
-<parameter name="anid">
-<parameter_description> a native window handle.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkWindow wrapper for the native window,
-or %NULL if there is none.
-
+<return> parent of @window
</return>
</function>
-<function name="gdk_app_launch_context_set_display">
+<function name="gdk_window_get_pointer">
<description>
-Sets the display on which applications will be launched when
-using this context. See also gdk_app_launch_context_set_screen().
+Obtains the current pointer position and modifier state.
+The position is given in coordinates relative to the upper left
+corner of @window.
-Since: 2.14
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GdkAppLaunchContext
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<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></return>
+<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_drawable_copy_to_image">
+<function name="gdk_window_get_position">
<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.
+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.
-Since: 2.4
+The position coordinates are relative to the window's parent window.
-Deprecated: 2.22: Use @drawable as the source and draw to a Cairo image
-surface if you want to download contents to the client.
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="image">
-<parameter_description> a #GdkDrawable, or %NULL if a new @image should be created.
+<parameter name="x">
+<parameter_description> X coordinate of window
</parameter_description>
</parameter>
-<parameter name="src_x">
-<parameter_description> x coordinate on @drawable
+<parameter name="y">
+<parameter_description> Y coordinate of window
</parameter_description>
</parameter>
-<parameter name="src_y">
-<parameter_description> y coordinate on @drawable
+</parameters>
+<return></return>
+</function>
+
+<function name="gdk_window_get_root_coords">
+<description>
+Obtains the position of a window position in root
+window coordinates. This is similar to
+gdk_window_get_origin() but allows you go pass
+in any position in the window, not just the origin.
+
+Since: 2.18
+
+</description>
+<parameters>
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="dest_x">
-<parameter_description> x coordinate within @image. Must be 0 if @image is %NULL
+<parameter name="x">
+<parameter_description> X coordinate in window
</parameter_description>
</parameter>
-<parameter name="dest_y">
-<parameter_description> y coordinate within @image. Must be 0 if @image is %NULL
+<parameter name="y">
+<parameter_description> Y coordinate in window
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> width of region to get
+<parameter name="root_x">
+<parameter_description> return location for X coordinate
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> height or region to get
+<parameter name="root_y">
+<parameter_description> return location for Y coordinate
</parameter_description>
</parameter>
</parameters>
-<return> @image, or a new a #GdkImage containing the contents
-of @drawable
-
-</return>
+<return></return>
</function>
-<function name="gdk_pango_renderer_new">
+<function name="gdk_window_get_root_origin">
<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.
+Obtains the top-left corner of the window manager frame in root
+window coordinates.
-Since: 2.6
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> return location for X position of window frame
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> return location for Y position of window frame
</parameter_description>
</parameter>
</parameters>
-<return> 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
</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_string_measure">
+<function name="gdk_window_get_state">
<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().
+Gets the bitwise OR of the currently active window state flags,
+from the #GdkWindowState enumeration.
</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="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the right bearing of the string in pixels.
+<return> window state bitfield
</return>
</function>
-<function name="gdk_drag_context_get_selected_action">
+<function name="gdk_window_get_toplevel">
<description>
-Determines the action chosen by the drag destination.
+Gets the toplevel window that's an ancestor of @window.
+
+Any window type but %GDK_WINDOW_CHILD is considered a
+toplevel window, as is a %GDK_WINDOW_CHILD window that
+has a root window as parent.
+
+Note that you should use gdk_window_get_effective_toplevel() when
+you want to get to a window's toplevel as seen on screen, because
+gdk_window_get_toplevel() will most likely not do what you expect
+if there are offscreen windows in the hierarchy.
-Since: 2.22
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GdkDragContext
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkDragAction value
-
+<return> the toplevel window containing @window
</return>
</function>
-<function name="gdk_device_get_core_pointer">
+<function name="gdk_window_get_toplevels">
<description>
-Returns the core pointer device for the default display.
+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.
+Deprecated: 2.16: Use gdk_screen_get_toplevel_windows() instead.
</description>
<parameters>
</parameters>
-<return> the core pointer device; this is owned by the
-display and should not be freed.
+<return> list of toplevel windows, free with g_list_free()
+
</return>
</function>
-<function name="gdk_atom_intern_static_string">
+<function name="gdk_window_get_type_hint">
<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).
+This function returns the type hint set for a window.
Since: 2.10
</description>
<parameters>
-<parameter name="atom_name">
-<parameter_description> a static string
+<parameter name="window">
+<parameter_description> A toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the atom corresponding to @atom_name
+<return> The type hint set for @window
</return>
</function>
-<function name="gdk_selection_owner_get_for_display">
+<function name="gdk_window_get_update_area">
<description>
-Determine the owner of the given selection.
-
-Note that the return value may be owned by a different
-process if a foreign window was previously created for that
-window, but a new foreign window will never be created by this call.
+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.
-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 update area for @window
</return>
</function>
-<function name="gdk_device_get_history">
+<function name="gdk_window_get_user_data">
<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.)
+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="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> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="n_events">
-<parameter_description> location to store the length of @events, or %NULL
+<parameter name="data">
+<parameter_description> return location for user data
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the windowing system supports motion history and
-at least one event was found.
-</return>
+<return></return>
</function>
-<function name="gdk_gc_set_ts_origin">
+<function name="gdk_window_get_visual">
<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.
+Gets the #GdkVisual describing the pixel format of @window.
-Deprecated: 2.22: You can set the origin for tiles and stipples in Cairo
-by changing the source's matrix using cairo_pattern_set_matrix(). Or you
-can specify it with gdk_cairo_set_source_pixmap() as shown in the example
-for gdk_gc_set_tile().
+Since: 2.24
</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> a #GdkVisual
+
+</return>
</function>
-<function name="gdk_window_iconify">
+<function name="gdk_window_get_width">
<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.
+Returns the width of the given @window.
-This function only makes sense when @window is a toplevel window.
+On the X11 platform the returned size is the size reported in the
+most-recently-processed configure event, rather than the current
+size on the X server.
+Since: 2.24
</description>
<parameters>
<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The width of @window
+
+</return>
</function>
-<function name="gdk_window_set_decorations">
+<function name="gdk_window_get_window_type">
<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.
+Gets the type of the window. See #GdkWindowType.
</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> type of window
+</return>
</function>
-<function name="gdk_window_is_shaped">
+<function name="gdk_window_has_native">
<description>
-Determines whether or not the window is shaped.
+Checks whether the window has a native window or not. Note that
+you can use gdk_window_ensure_native() if a native window is needed.
Since: 2.22
</description>
<parameters>
<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @window is shaped
+<return> %TRUE if the %window has a native window, %FALSE otherwise.
</return>
</function>
-<function name="gdk_threads_add_idle">
+<function name="gdk_window_hide">
<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
+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="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_x11_display_set_cursor_theme">
+<function name="gdk_window_iconify">
<description>
-Sets the cursor theme from which the images for cursor
-should be taken.
+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.
-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).
+This function only makes sense when @window is a toplevel window.
-Since: 2.8
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
-</parameter_description>
-</parameter>
-<parameter name="theme">
-<parameter_description> the name of the cursor theme to use, or %NULL to unset
-a previously set value
-</parameter_description>
-</parameter>
-<parameter name="size">
-<parameter_description> the cursor size to use, or 0 to keep the previous size
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_init">
+<function name="gdk_window_input_shape_combine_mask">
<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".
+
+On the X11 platform, this requires version 1.1 of the
+shape extension.
+
+On the Win32 platform, this functionality is not present and the
+function does nothing.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="argc">
-<parameter_description>
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="argv">
-<parameter_description>
+<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_display_manager_set_default_display">
+<function name="gdk_window_input_shape_combine_region">
<description>
-Sets @display as the default display.
+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.
-Since: 2.2
+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".
+
+On the X11 platform, this requires version 1.1 of the
+shape extension.
+
+On the Win32 platform, this functionality is not present and the
+function does nothing.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="display_manager">
-<parameter_description> a #GdkDisplayManager
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<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_visual_get_blue_pixel_details">
+<function name="gdk_window_invalidate_maybe_recurse">
<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.
+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.
-Since: 2.22
+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="visual">
-<parameter_description> a #GdkVisual
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="mask">
-<parameter_description> A pointer to a #guint32 to be filled in, or %NULL.
+<parameter name="region">
+<parameter_description> a #GdkRegion
</parameter_description>
</parameter>
-<parameter name="shift">
-<parameter_description> A pointer to a #gint to be filled in, or %NULL.
+<parameter name="child_func">
+<parameter_description> function to use to decide if to recurse to a child,
+%NULL means never recurse.
</parameter_description>
</parameter>
-<parameter name="precision">
-<parameter_description> A pointer to a #gint to be filled in, or %NULL.
+<parameter name="user_data">
+<parameter_description> data passed to @child_func
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_add_option_entries_libgtk_only">
+<function name="gdk_window_invalidate_rect">
<description>
-Appends gdk option entries to the passed in option group. This is
-not public API and must not be used by applications.
+A convenience wrapper around gdk_window_invalidate_region() which
+invalidates a rectangular region. See
+gdk_window_invalidate_region() for details.
</description>
<parameters>
-<parameter name="group">
-<parameter_description> An option group.
+<parameter name="window">
+<parameter_description> a #GdkWindow
+</parameter_description>
+</parameter>
+<parameter name="rect">
+<parameter_description> rectangle to invalidate or %NULL to invalidate the whole
+window
+</parameter_description>
+</parameter>
+<parameter name="invalidate_children">
+<parameter_description> whether to also invalidate child windows
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_colors_alloc">
+<function name="gdk_window_invalidate_region">
<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>.
+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.
+
+The @invalidate_children parameter controls whether the region of
+each child window that intersects @region will also be invalidated.
+If %FALSE, then the update area for child windows will remain
+unaffected. See gdk_window_invalidate_maybe_recurse if you need
+fine grained control over which children are invalidated.
</description>
<parameters>
-<parameter name="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_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="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="pixels">
-<parameter_description> an array into which to store allocated pixel values.
+<parameter name="region">
+<parameter_description> a #GdkRegion
</parameter_description>
</parameter>
-<parameter name="npixels">
-<parameter_description> the number of pixels in each plane to allocate.
+<parameter name="invalidate_children">
+<parameter_description> %TRUE to also invalidate child windows
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the allocation was successful
-</return>
+<return></return>
</function>
-<function name="gdk_window_foreign_new">
+<function name="gdk_window_is_destroyed">
<description>
-Wraps a native window for the default display in a #GdkWindow.
-This may fail if the window has been destroyed.
-
-For example in the X backend, a native window handle is an Xlib
-<type>XID</type>.
+Check to see if a window is destroyed..
+Since: 2.18
</description>
<parameters>
-<parameter name="anid">
-<parameter_description> a native window handle.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the newly-created #GdkWindow wrapper for the
-native window or %NULL if the window has been destroyed.
+<return> %TRUE if the window is destroyed
+
</return>
</function>
-<function name="gdk_win32_hdc_get">
+<function name="gdk_window_is_input_only">
<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:
-
-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.
-
-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.
-
-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.
-
-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.
-
-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.)
-
-When the HDC is no longer used, it should be released by calling
-<function>gdk_win32_hdc_release()</function> with the same
-parameters.
-
-If you modify the HDC by calling <function>SelectObject</function>
-you should undo those modifications before calling
-<function>gdk_win32_hdc_release()</function>.
+Determines whether or not the window is an input only window.
+Since: 2.22
</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 needs to be set up
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> The HDC.
+<return> %TRUE if @window is input only
+
</return>
</function>
-<function name="gdk_x11_get_xatom_by_name">
+<function name="gdk_window_is_shaped">
<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.
+Determines whether or not the window is shaped.
+Since: 2.22
</description>
<parameters>
-<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 GDK's default display.
+<return> %TRUE if @window is shaped
+
</return>
</function>
-<function name="gdk_window_clear">
+<function name="gdk_window_is_viewable">
<description>
-Clears an entire @window to the background color or background pixmap.
+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>
@@ -12545,21 +13532,15 @@ Clears an entire @window to the background color or background pixmap.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the window is viewable
+</return>
</function>
-<function name="gdk_window_freeze_toplevel_updates_libgtk_only">
+<function name="gdk_window_is_visible">
<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.
+Checks whether the window has been mapped (with gdk_window_show() or
+gdk_window_show_unraised()).
-This function is not part of the GDK public API and is only
-for use by GTK+.
</description>
<parameters>
@@ -12568,144 +13549,121 @@ for use by GTK+.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the window is mapped
+</return>
</function>
-<function name="gdk_cairo_create">
+<function name="gdk_window_lookup">
<description>
-Creates a Cairo context for drawing to @drawable.
+Looks up the #GdkWindow that wraps the given native window handle.
-<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>
+For example in the X backend, a native window handle is an Xlib
+<type>XID</type>.
-Since: 2.8
+Deprecated: 2.24: Use gdk_x11_window_lookup_for_display() or equivalent
+backend-specific functionality instead
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
+<parameter name="anid">
+<parameter_description> a native window handle.
</parameter_description>
</parameter>
</parameters>
-<return> A newly created Cairo context. Free with
-cairo_destroy() when you are done drawing.
+<return> the #GdkWindow wrapper for the native window,
+or %NULL if there is none.
</return>
</function>
-<function name="gdk_spawn_command_line_on_screen">
+<function name="gdk_window_lookup_for_display">
<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.
+Looks up the #GdkWindow that wraps the given native window handle.
-This is useful for applications which wish to launch an application
-on a specific screen.
+For example in the X backend, a native window handle is an Xlib
+<type>XID</type>.
-Since: 2.4
+Since: 2.2
+
+Deprecated:2.24: Use gdk_x11_window_lookup_for_display() instead
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
-</parameter_description>
-</parameter>
-<parameter name="command_line">
-<parameter_description> a command line
+<parameter name="display">
+<parameter_description> the #GdkDisplay corresponding to the window handle
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for errors
+<parameter name="anid">
+<parameter_description> a native window handle.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success, %FALSE if error is set.
+<return> the #GdkWindow wrapper for the native window,
+or %NULL if there is none.
</return>
</function>
-<function name="gdk_event_peek">
+<function name="gdk_window_lower">
<description>
-If there is an event waiting in the event queue of some open
-display, returns a copy of it. See gdk_display_peek_event().
-
-
-</description>
-<parameters>
-</parameters>
-<return> a copy of the first #GdkEvent on some event queue, or %NULL if no
-events are in any queues. The returned #GdkEvent should be freed with
-gdk_event_free().
-</return>
-</function>
+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.
-<function name="gdk_gc_copy">
-<description>
-Copy the set of values from one graphics context
-onto another graphics context.
+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.
-Deprecated: 2.22: Use Cairo for drawing. cairo_save() and cairo_restore()
-can be helpful in cases where you'd have copied a #GdkGC.
+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="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 #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_rgb_get_colormap">
+<function name="gdk_window_maximize">
<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.
-
-Deprecated: 2.22: Use gdk_get_system_colormap()
-
-</description>
-<parameters>
-</parameters>
-<return> the preferred colormap
+Maximizes the window. If the window was already maximized, then
+this function does nothing.
-</return>
-</function>
+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.
-<function name="gdk_colormap_get_visual">
-<description>
-Returns the visual for which a given colormap was created.
+On Windows, reliably maximizes the window.
</description>
<parameters>
-<parameter name="colormap">
-<parameter_description> a #GdkColormap.
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the visual of the colormap.
-</return>
+<return></return>
</function>
-<function name="gdk_window_is_viewable">
+<function name="gdk_window_merge_child_input_shapes">
<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.)
+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().
+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>
@@ -12714,1453 +13672,1209 @@ window.)
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the window is viewable
-</return>
+<return></return>
</function>
-<function name="gdk_screen_get_height_mm">
+<function name="gdk_window_merge_child_shapes">
<description>
-Returns the height of @screen in millimeters.
-Note that on some X servers this value will not be correct.
+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().
-Since: 2.2
+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="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_move">
<description>
-Returns the display of a #GdkGC.
+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.
-Deprecated: 2.22: #GdkGC has been replaced by #cairo_t.
+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="gc">
-<parameter_description> a #GdkGC.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-</parameters>
-<return> an Xlib <type>Display*</type>.
-
-</return>
-</function>
-
-<function name="gdk_gc_new">
-<description>
-Create a new graphics context with default values.
-
-Deprecated: 2.22: Use Cairo for rendering.
-
-</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="x">
+<parameter_description> X coordinate relative to window's parent
</parameter_description>
</parameter>
-</parameters>
-<return> the new graphics context.
-
-</return>
-</function>
-
-<function name="gdk_display_flush">
-<description>
-Flushes any requests queued for the windowing system; this happens automatically
-when the main loop blocks waiting for new events, but if your application
-is drawing without returning control to the main loop, you may need
-to call this function explicitely. A common case where this function
-needs to be called is when an application is executing drawing commands
-from a thread other than the thread where the main loop is running.
-
-This is most useful for X11. On windowing systems where requests are
-handled synchronously, this function will do nothing.
-
-Since: 2.4
-
-</description>
-<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="y">
+<parameter_description> Y coordinate relative to window's parent
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_display_is_closed">
+<function name="gdk_window_move_region">
<description>
-Finds out if the display has been closed.
+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.
-Since: 2.22
+Child windows are not moved.
+
+Since: 2.8
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<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_description>
+</parameter>
+<parameter name="dy">
+<parameter_description> Amount to move in the Y direction
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the display is closed.
-
-</return>
+<return></return>
</function>
-<function name="gdk_pango_layout_line_get_clip_region">
+<function name="gdk_window_move_resize">
<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.
-
+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="line">
-<parameter_description> a #PangoLayoutLine
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="x_origin">
-<parameter_description> X pixel where you intend to draw the layout line with this clip
+<parameter name="x">
+<parameter_description> new X position relative to window's parent
</parameter_description>
</parameter>
-<parameter name="y_origin">
-<parameter_description> baseline pixel where you intend to draw the layout line with this clip
+<parameter name="y">
+<parameter_description> new Y position relative to window's parent
</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="width">
+<parameter_description> new width
</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="height">
+<parameter_description> new height
</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_new">
<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.
+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.
-GDK will call gdk_window_process_all_updates() on your behalf
-whenever your program returns to the main loop and becomes idle, so
-normally there's no need to do that manually, you just need to
-invalidate regions that you know should be redrawn.
-
-The @child_func parameter controls whether the region of
-each child window that intersects @region will also be invalidated.
-Only children for which @child_func returns TRUE will have the area
-invalidated.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="region">
-<parameter_description> a #GdkRegion
+<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="child_func">
-<parameter_description> function to use to decide if to recurse to a child,
-%NULL means never recurse.
+<parameter name="attributes">
+<parameter_description> attributes of the new window
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> data passed to @child_func
+<parameter name="attributes_mask">
+<parameter_description> mask indicating which fields in @attributes are valid
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the new #GdkWindow
+</return>
</function>
-<function name="gdk_string_width">
+<function name="gdk_window_peek_children">
<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)
+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="font">
-<parameter_description> a #GdkFont
-</parameter_description>
-</parameter>
-<parameter name="string">
-<parameter_description> the nul-terminated string to measure
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the width of the string in pixels.
+<return>
+a reference to the list of child windows in @window
</return>
</function>
-<function name="gdk_region_union_with_rect">
+<function name="gdk_window_process_all_updates">
<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.
+Calls gdk_window_process_updates() for all windows (see #GdkWindow)
+in the application.
+
</description>
<parameters>
-<parameter name="region">
-<parameter_description> a #GdkRegion.
-</parameter_description>
-</parameter>
-<parameter name="rect">
-<parameter_description> a #GdkRectangle.
-</parameter_description>
-</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_screen_is_composited">
+<function name="gdk_window_process_updates">
<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.
+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.
-Since: 2.10
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="window">
+<parameter_description> a #GdkWindow
+</parameter_description>
+</parameter>
+<parameter name="update_children">
+<parameter_description> whether to also process updates for child windows
</parameter_description>
</parameter>
</parameters>
-<return> Whether windows with RGBA visuals can reasonably be
-expected to have their alpha channels drawn correctly on the screen.
-
-</return>
+<return></return>
</function>
-<function name="gdk_drag_context_get_source_window">
+<function name="gdk_window_raise">
<description>
-Returns the #GdkWindow where the DND operation started.
+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.22
+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 #GdkDragContext
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkWindow
-
-</return>
+<return></return>
</function>
-<function name="gdk_keymap_translate_keyboard_state">
+<function name="gdk_window_redirect_to_drawable">
<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.
+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.
-<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>
+Only drawing between gdk_window_begin_paint_region() or
+gdk_window_begin_paint_rect() and gdk_window_end_paint() is
+redirected.
+Redirection is active until gdk_window_remove_redirection()
+is called.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="keymap">
-<parameter_description> a #GdkKeymap, or %NULL to use the default
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="hardware_keycode">
-<parameter_description> a keycode
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable
</parameter_description>
</parameter>
-<parameter name="state">
-<parameter_description> a modifier state
+<parameter name="src_x">
+<parameter_description> x position in @window
</parameter_description>
</parameter>
-<parameter name="group">
-<parameter_description> active keyboard group
+<parameter name="src_y">
+<parameter_description> y position in @window
</parameter_description>
</parameter>
-<parameter name="keyval">
-<parameter_description> return location for keyval, or %NULL
+<parameter name="dest_x">
+<parameter_description> x position in @drawable
</parameter_description>
</parameter>
-<parameter name="effective_group">
-<parameter_description> return location for effective group, or %NULL
+<parameter name="dest_y">
+<parameter_description> y position in @drawable
</parameter_description>
</parameter>
-<parameter name="level">
-<parameter_description> return location for level, or %NULL
+<parameter name="width">
+<parameter_description> width of redirection, or -1 to use the width of @window
</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="height">
+<parameter_description> height of redirection or -1 to use the height of @window
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if there was a keyval bound to the keycode/state/group
-</return>
-</function>
-
-<function name="gdk_drag_context_new">
-<description>
-Creates a new #GdkDragContext.
-
-
-</description>
-<parameters>
-</parameters>
-<return> the newly created #GdkDragContext.
-</return>
+<return></return>
</function>
-<function name="gdk_draw_text_wc">
+<function name="gdk_window_remove_filter">
<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.
+Remove a filter previously added with gdk_window_add_filter().
-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 name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> the wide characters to draw.
+<parameter name="function">
+<parameter_description> previously-added filter function
</parameter_description>
</parameter>
-<parameter name="text_length">
-<parameter_description> the number of characters to draw.
+<parameter name="data">
+<parameter_description> user data for previously-added filter function
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_app_launch_context_set_icon_name">
+<function name="gdk_window_remove_redirection">
<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.
+Removes any active redirection started by
+gdk_window_redirect_to_drawable().
Since: 2.14
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GdkAppLaunchContext
-</parameter_description>
-</parameter>
-<parameter name="icon_name">
-<parameter_description> an icon name, or %NULL
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_draw_drawable">
+<function name="gdk_window_reparent">
<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.
+Reparents @window into the given @new_parent. The window being
+reparented will be unmapped as a side effect.
-Deprecated: 2.22: Use gdk_cairo_set_source_pixmap(), cairo_rectangle()
-and cairo_fill() to draw pixmap on top of other drawables. Also keep
-in mind that the limitations on allowed sources do not apply to Cairo.
</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
+<parameter name="new_parent">
+<parameter_description> new parent to move @window into
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> width of rectangle to draw, or -1 for entire @src width
+<parameter name="x">
+<parameter_description> X location inside the new parent
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> height of rectangle to draw, or -1 for entire @src height
+<parameter name="y">
+<parameter_description> Y location inside the new parent
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_create_similar_surface">
+<function name="gdk_window_resize">
<description>
-Create a new surface that is as compatible as possible with the
-given @window. For example the new surface will have the same
-fallback resolution and font options as @window. Generally, the new
-surface will also use the same backend as @window, unless that is
-not possible for some reason. The type of the returned surface may
-be examined with cairo_surface_get_type().
+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.
-Initially the surface contents are all 0 (transparent if contents
-have transparency, black otherwise.)
+Windows may not be resized below 1x1.
-Since: 2.22
+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> window to make new surface similar to
-</parameter_description>
-</parameter>
-<parameter name="content">
-<parameter_description> the content for the new surface
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
<parameter name="width">
-<parameter_description> width of the new surface
+<parameter_description> new width of the window
</parameter_description>
</parameter>
<parameter name="height">
-<parameter_description> height of the new surface
+<parameter_description> new height of the window
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the newly allocated surface. The caller
-owns the surface and should call cairo_surface_destroy() when done
-with it.
-
-This function always returns a valid pointer, but it will return a
-pointer to a "nil" surface if @other is already in an error state
-or any other error occurs.
-
-</return>
+<return></return>
</function>
-<function name="gdk_event_get_graphics_expose">
+<function name="gdk_window_restack">
<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.
+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).
-Deprecated: 2.18:
+If @sibling is %NULL, then this either raises (if @above is %TRUE) or
+lowers the window.
+
+If @window is a toplevel, the window manager may choose to deny the
+request to move the window in the Z-order, gdk_window_restack() only
+requests the restack, does not guarantee it.
+
+Since: 2.18
</description>
<parameters>
<parameter name="window">
-<parameter_description> the #GdkWindow to wait for the events for.
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-</parameters>
-<return> a #GdkEventExpose if a GraphicsExpose was received, or %NULL if a
-NoExpose event was received.
-
-</return>
-</function>
-
-<function name="gdk_x11_visual_get_xvisual">
-<description>
-Returns the X visual belonging to a #GdkVisual.
-
-
-</description>
-<parameters>
-<parameter name="visual">
-<parameter_description> a #GdkVisual.
+<parameter 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.
-
-Since: 2.2
+Scroll the contents of its window, both pixels and children, by
+the given amount. Portions of the window that the scroll operation
+brings in from offscreen areas are invalidated.
</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_gc_set_line_attributes">
+<function name="gdk_window_set_back_pixmap">
<description>
-Sets various attributes of how lines are drawn. See
-the corresponding members of #GdkGCValues for full
-explanations of the arguments.
+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.
-Deprecated: 2.22: Use the Cairo functions cairo_set_line_width(),
-cairo_set_line_join(), cairo_set_line_cap() and cairo_set_dash()
-to affect the stroking behavior in Cairo. Keep in mind that the default
-attributes of a #cairo_t are different from the default attributes of
-a #GdkGC.
+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).
+
+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().
</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 name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="cap_style">
-<parameter_description> the manner in which the ends of lines are drawn.
+<parameter name="pixmap">
+<parameter_description> a #GdkPixmap, or %NULL
</parameter_description>
</parameter>
-<parameter name="join_style">
-<parameter_description> the in which lines are joined together.
+<parameter name="parent_relative">
+<parameter_description> whether the tiling origin is at the origin of
+ window's parent
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_gc_set_clip_origin">
+<function name="gdk_window_set_background">
<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 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.)
-Deprecated: 2.22: Use cairo_translate() before applying the clip path in
-Cairo.
+The @color must be allocated; gdk_rgb_find_color() is the best way
+to allocate a color.
+
+See also gdk_window_set_background_pixmap().
</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="color">
+<parameter_description> an allocated #GdkColor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_cursor_get_cursor_type">
+<function name="gdk_window_set_child_input_shapes">
<description>
-Returns the cursor type for this cursor.
+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.22
+Since: 2.10
</description>
<parameters>
-<parameter name="cursor">
-<parameter_description> a #GdkCursor
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkCursorType
-
-</return>
+<return></return>
</function>
-<function name="gdk_color_change">
+<function name="gdk_window_set_child_shapes">
<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 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="colormap">
-<parameter_description> a #GdkColormap.
-</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="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the color was successfully changed.
-</return>
+<return></return>
</function>
-<function name="gdk_image_get_bits_per_pixel">
+<function name="gdk_window_set_composited">
<description>
-Determines the number of bits per pixel of the image.
+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.
-Since: 2.22
+It only makes sense for child windows to be composited; see
+gdk_window_set_opacity() if you need translucent toplevel
+windows.
-Deprecated: 2.22: #GdkImage should not be used anymore.
+An additional effect of this call is that the area of this
+window is no longer clipped from regions marked for
+invalidation on its parent. Draws done on the parent
+window are also no longer clipped by the child.
+
+This call is only supported on some systems (currently,
+only X11 with new enough Xcomposite and Xdamage extensions).
+You must call gdk_display_supports_composite() to check if
+setting a window as composited is supported before
+attempting to do so.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GdkImage
+<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> the bits per pixel
-
-</return>
+<return></return>
</function>
-<function name="gdk_drag_get_protocol">
+<function name="gdk_window_set_cursor">
<description>
-Finds out the DND protocol supported by a window.
-
+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.
</description>
<parameters>
-<parameter name="xid">
-<parameter_description> the windowing system id of the destination window.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="protocol">
-<parameter_description> location where the supported DND protocol is returned.
+<parameter name="cursor">
+<parameter_description> a cursor
</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>
+<return></return>
</function>
-<function name="gdk_image_ref">
+<function name="gdk_window_set_debug_updates">
<description>
-Deprecated function; use g_object_ref() instead.
+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.
-Deprecated: 2.0: Use g_object_ref() instead.
</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> the image
-
-</return>
+<return></return>
</function>
-<function name="gdk_selection_owner_set_for_display">
+<function name="gdk_window_set_decorations">
<description>
-Sets the #GdkWindow @owner as the current owner of the selection @selection.
+"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="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 toplevel #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="decorations">
+<parameter_description> decoration hint mask
</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_events">
<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>.
-
+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.
</description>
<parameters>
-<parameter name="anid">
-<parameter_description> a native pixmap handle.
+<parameter name="window">
+<parameter_description> a #GdkWindow
+</parameter_description>
+</parameter>
+<parameter name="event_mask">
+<parameter_description> event mask for @window
</parameter_description>
</parameter>
</parameters>
-<return> 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_focus_on_map">
<description>
-Returns the X image belonging to a #GdkImage.
+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="image">
-<parameter_description> a #GdkImage.
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
+</parameter_description>
+</parameter>
+<parameter name="focus_on_map">
+<parameter_description> %TRUE if the window should receive input focus when mapped
</parameter_description>
</parameter>
</parameters>
-<return> an <type>XImage*</type>.
-</return>
+<return></return>
</function>
-<function name="gdk_screen_get_height">
+<function name="gdk_window_set_functions">
<description>
-Gets the height of @screen in pixels
+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.2
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
+</parameter_description>
+</parameter>
+<parameter name="functions">
+<parameter_description> bitmask of operations to allow on @window
</parameter_description>
</parameter>
</parameters>
-<return> the height of @screen in pixels.
-
-</return>
+<return></return>
</function>
-<function name="gdk_window_get_pointer">
+<function name="gdk_window_set_geometry_hints">
<description>
-Obtains the current pointer position and modifier state.
-The position is given in coordinates relative to the upper left
-corner of @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.
+
+This function provides hints to the windowing system about
+acceptable sizes for a toplevel window. The purpose of
+this is to constrain user resizing, but the windowing system
+will typically (but is not required to) also constrain the
+current size of the window to the provided values and
+constrain programatic resizing via gdk_window_resize() or
+gdk_window_move_resize().
+
+Note that on X11, this effect has no effect on windows
+of type %GDK_WINDOW_TEMP or windows where override redirect
+has been turned on via gdk_window_set_override_redirect()
+since these windows are not resizable by the user.
+
+Since you can't count on the windowing system doing the
+constraints for programmatic resizes, you should generally
+call gdk_window_constrain_size() yourself to determine
+appropriate sizes.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #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 toplevel #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="geometry">
+<parameter_description> geometry hints
</parameter_description>
</parameter>
-<parameter name="mask">
-<parameter_description> return location for modifier mask or %NULL to not return the
-modifier mask
+<parameter name="geom_mask">
+<parameter_description> bitmask indicating fields of @geometry to pay attention to
</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_group">
<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.
+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.
-Deprecated: 2.4: This function is obsolete. Use gdk_draw_pixbuf() instead.
+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="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_description>
-</parameter>
-<parameter name="x_dither">
-<parameter_description> X offset for dither.
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="y_dither">
-<parameter_description> Y offset for dither.
+<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_pixbuf_render_to_drawable">
+<function name="gdk_window_set_hints">
<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.
+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.
-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.
+If using GDK directly, use gdk_window_set_geometry_hints().
-Deprecated: 2.4: This function is obsolete. Use gdk_draw_pixbuf() instead.
</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 name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="dest_x">
-<parameter_description> Destination X coordinate within drawable.
+<parameter name="x">
+<parameter_description> ignored field, does not matter
</parameter_description>
</parameter>
-<parameter name="dest_y">
-<parameter_description> Destination Y coordinate within drawable.
+<parameter name="y">
+<parameter_description> ignored field, does not matter
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> Width of region to render, in pixels, or -1 to use pixbuf width
+<parameter name="min_width">
+<parameter_description> minimum width hint
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> Height of region to render, in pixels, or -1 to use pixbuf height
+<parameter name="min_height">
+<parameter_description> minimum height hint
</parameter_description>
</parameter>
-<parameter name="dither">
-<parameter_description> Dithering mode for GdkRGB.
+<parameter name="max_width">
+<parameter_description> max width hint
</parameter_description>
</parameter>
-<parameter name="x_dither">
-<parameter_description> X offset for dither.
+<parameter name="max_height">
+<parameter_description> max height hint
</parameter_description>
</parameter>
-<parameter name="y_dither">
-<parameter_description> Y offset for dither.
+<parameter name="flags">
+<parameter_description> logical OR of GDK_HINT_POS, GDK_HINT_MIN_SIZE, and/or GDK_HINT_MAX_SIZE
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_colormap_change">
+<function name="gdk_window_set_icon">
<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().
+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().
+
</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="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>
-<function name="gdk_cairo_region">
+<function name="gdk_window_set_icon_list">
<description>
-Adds the given region to the current path of @cr.
+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.
-Since: 2.8
</description>
<parameters>
-<parameter name="cr">
-<parameter_description> a #cairo_t
+<parameter name="window">
+<parameter_description> The #GdkWindow toplevel window to set the icon of.
</parameter_description>
</parameter>
-<parameter name="region">
-<parameter_description> a #GdkRegion
+<parameter name="pixbufs">
+<parameter_description>
+A list of pixbufs, of different sizes.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_window_input_shape_combine_region">
+<function name="gdk_window_set_icon_name">
<description>
-Like gdk_window_shape_combine_region(), but the shape applies
-only to event handling. Mouse events which happen while
-the pointer position corresponds to an unset bit in the
-mask will be passed on the window below @window.
-
-An input shape is typically used with RGBA windows.
-The alpha channel of the window defines which pixels are
-invisible and allows for nicely antialiased borders,
-and the input shape controls where the window is
-"clickable".
-
-On the X11 platform, this requires version 1.1 of the
-shape extension.
+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.
-On the Win32 platform, this functionality is not present and the
-function does nothing.
+After calling this with a non-%NULL @name, calls to gdk_window_set_title()
+will not update the icon title.
-Since: 2.10
+Using %NULL for @name unsets the icon title; further calls to
+gdk_window_set_title() will again update the icon title as well.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a #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> a toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="offset_y">
-<parameter_description> Y position of @shape_region in @window coordinates
+<parameter name="name">
+<parameter_description> name of window while iconified (minimized)
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_draw_glyphs">
+<function name="gdk_window_set_keep_above">
<description>
-This is a low-level function; 99% of text rendering should be done
-using gdk_draw_layout() instead.
+Set if @window must be kept above other windows. If the
+window was already above, then this function does nothing.
-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.
+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.
-Deprecated: 2.22: Use pango_cairo_show_glyphs() instead.
+Since: 2.4
</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="setting">
+<parameter_description> whether to keep @window above other windows
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_text_width">
+<function name="gdk_window_set_keep_below">
<description>
-Determines the width of a given string.
+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="font">
-<parameter_description> a #GdkFont
-</parameter_description>
-</parameter>
-<parameter name="text">
-<parameter_description> the text to measure.
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="text_length">
-<parameter_description> the length of the text in bytes.
+<parameter name="setting">
+<parameter_description> whether to keep @window below other windows
</parameter_description>
</parameter>
</parameters>
-<return> the width of the string in pixels.
-</return>
+<return></return>
</function>
-<function name="gdk_window_get_toplevel">
+<function name="gdk_window_set_modal_hint">
<description>
-Gets the toplevel window that's an ancestor of @window.
-
-Any window type but %GDK_WINDOW_CHILD is considered a
-toplevel window, as is a %GDK_WINDOW_CHILD window that
-has a root window as parent.
-
-Note that you should use gdk_window_get_effective_toplevel() when
-you want to get to a window's toplevel as seen on screen, because
-gdk_window_get_toplevel() will most likely not do what you expect
-if there are offscreen windows in the hierarchy.
+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 #GdkWindow
+<parameter_description> A toplevel #GdkWindow
+</parameter_description>
+</parameter>
+<parameter name="modal">
+<parameter_description> %TRUE if the window is modal, %FALSE otherwise.
</parameter_description>
</parameter>
</parameters>
-<return> the toplevel window containing @window
-</return>
+<return></return>
</function>
-<function name="gdk_display_get_window_at_pointer">
+<function name="gdk_window_set_opacity">
<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).
+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.)
-Since: 2.2
+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().
+
+Since: 2.12
</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 top-level #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="opacity">
+<parameter_description> opacity
</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_override_redirect">
<description>
-Returns a #GdkPixbuf with the image used to display the cursor.
+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.
-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.
+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.
-Since: 2.8
</description>
<parameters>
-<parameter name="cursor">
-<parameter_description> a #GdkCursor
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
-</parameters>
-<return> a #GdkPixbuf representing @cursor, or %NULL
-
-</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 name="override_redirect">
+<parameter_description> %TRUE if window should be override redirect
</parameter_description>
</parameter>
</parameters>
-<return> A #GdkVisualType stating the type of @visual.
-
-</return>
+<return></return>
</function>
-<function name="gdk_gc_set_subwindow">
+<function name="gdk_window_set_role">
<description>
-Sets how drawing with this GC on a window will affect child
-windows of that window.
+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.
-Deprecated: 2.22: There is no replacement. If you need to control
-subwindows, you must use drawing operations of the underlying window
-system manually. Cairo will always use %GDK_INCLUDE_INFERIORS on sources
-and masks and %GDK_CLIP_BY_CHILDREN on targets.
</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="role">
+<parameter_description> a string indicating its role
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_region_rect_in">
+<function name="gdk_window_set_skip_pager_hint">
<description>
-Tests whether a rectangle is within a region.
+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="region">
-<parameter_description> a #GdkRegion.
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="rectangle">
-<parameter_description> a #GdkRectangle.
+<parameter name="skips_pager">
+<parameter_description> %TRUE to skip the pager
</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_skip_taskbar_hint">
<description>
-Gets the metrics of a nul-terminated string.
+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="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="skips_taskbar">
+<parameter_description> %TRUE to skip the taskbar
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_region_polygon">
+<function name="gdk_window_set_startup_id">
<description>
-Creates a new #GdkRegion using the polygon defined by a
-number of points.
+When using GTK+, typically you should use gtk_window_set_startup_id()
+instead of this low-level function.
+
+Since: 2.12
-Deprecated: 2.22: There is no replacement. For working with paths, please
-use Cairo.
</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="startup_id">
+<parameter_description> a string with startup-notification identifier
</parameter_description>
</parameter>
</parameters>
-<return> a new #GdkRegion based on the given polygon
-
-</return>
+<return></return>
</function>
<function name="gdk_window_set_static_gravities">
@@ -14186,172 +14900,138 @@ windowing system. Don't worry about it unless you have to.
</return>
</function>
-<function name="gdk_gc_set_stipple">
+<function name="gdk_window_set_title">
<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.
-
-Deprecated: 2.22: Stippling has no direct replacement in Cairo. If you
-want to achieve an identical look, you can use the stipple bitmap as a
-mask. Most likely, this involves rendering the source to an intermediate
-surface using cairo_push_group() first, so that you can then use
-cairo_mask() to achieve the stippled look.
+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="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="title">
+<parameter_description> title of @window
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_app_launch_context_set_timestamp">
+<function name="gdk_window_set_transient_for">
<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'.
+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.
-Since: 2.14
+See gtk_window_set_transient_for() if you're using #GtkWindow or
+#GtkDialog.
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GdkAppLaunchContext
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="timestamp">
-<parameter_description> a timestamp
+<parameter name="parent">
+<parameter_description> another toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_screen_set_default_colormap">
+<function name="gdk_window_set_type_hint">
<description>
-Sets the default @colormap for @screen.
+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.
-Since: 2.2
+The hint must be set before the window is mapped.
</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="hint">
+<parameter_description> A hint of the function this window will have
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_x11_get_xatom_name_for_display">
+<function name="gdk_window_set_urgency_hint">
<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.
+Toggles whether a window needs the user's
+urgent attention.
-Since: 2.2
+Since: 2.8
</description>
<parameters>
-<parameter name="display">
-<parameter_description> the #GdkDisplay where @xatom is defined
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="xatom">
-<parameter_description> an X atom
+<parameter name="urgent">
+<parameter_description> %TRUE if the window is urgent
</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>
+<return></return>
</function>
-<function name="gdk_text_extents">
+<function name="gdk_window_set_user_data">
<description>
-Gets the metrics of a string.
+For most purposes this function is deprecated in favor of
+g_object_set_data(). However, for historical reasons GTK+ stores
+the #GtkWidget that owns a #GdkWindow as user data on the
+#GdkWindow. So, custom widget implementations should use
+this function for that. If GTK+ receives an event for a #GdkWindow,
+and the user data for the window is non-%NULL, GTK+ will assume the
+user data is a #GtkWidget, and forward the event to that widget.
+
</description>
<parameters>
-<parameter name="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="user_data">
+<parameter_description> user data
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_screen_height_mm">
+<function name="gdk_window_shape_combine_mask">
<description>
-Returns the height of the default screen in millimeters.
-Note that on many X servers this value will not be correct.
-
+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.
-</description>
-<parameters>
-</parameters>
-<return> the height of the default screen in millimeters,
-though it is not always correct.
-</return>
-</function>
+If @mask is %NULL, the shape mask will be unset, and the @x/@y
+parameters are not used.
-<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.
+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.
-See gdk_display_add_client_message_filter() if you are interested
-in X ClientMessage events.
+This function works on both toplevel and child windows.
</description>
<parameters>
@@ -14359,1456 +15039,1148 @@ in X ClientMessage events.
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="function">
-<parameter_description> filter callback
+<parameter name="mask">
+<parameter_description> shape mask
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to pass to filter callback
+<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_region_equal">
+<function name="gdk_window_shape_combine_region">
<description>
-Finds out if the two regions are the same.
+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.
+This function works on both toplevel and child windows.
</description>
<parameters>
-<parameter name="region1">
-<parameter_description> a #GdkRegion
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="region2">
-<parameter_description> a #GdkRegion
+<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> %TRUE if @region1 and @region2 are equal.
-</return>
+<return></return>
</function>
-<function name="gdk_window_fullscreen">
+<function name="gdk_window_show">
<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.
+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).
-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.
+This function maps a window so it's visible onscreen. Its opposite
+is gdk_window_hide().
-Since: 2.2
+When implementing a #GtkWidget, you should call this function on the widget's
+#GdkWindow as part of the "map" method.
</description>
<parameters>
<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_parse_args">
+<function name="gdk_window_show_unraised">
<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().
+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.
-Since: 2.2
+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="argc">
-<parameter_description> the number of command line arguments.
-</parameter_description>
-</parameter>
-<parameter name="argv">
-<parameter_description> the array of command line arguments.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_event_request_motions">
+<function name="gdk_window_stick">
<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:
+"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.)
-|[
-{
-/ * 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 * /
-}
-]|
+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.12
</description>
<parameters>
-<parameter name="event">
-<parameter_description> a valid #GdkEvent
+<parameter name="window">
+<parameter_description> a toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_threads_set_lock_functions">
+<function name="gdk_window_thaw_toplevel_updates_libgtk_only">
<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.
+Thaws a window frozen with
+gdk_window_freeze_toplevel_updates_libgtk_only().
-Since: 2.4
+This function is not part of the GDK public API and is only
+for use by GTK+.
</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_thaw_updates">
<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().
-
-Deprecated: 2.22: #GdkImage should not be used anymore.
+Thaws a window frozen with gdk_window_freeze_updates().
</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_unfullscreen">
<description>
-Loads a font for use on @display.
+Moves the window out of fullscreen mode. If the window was not
+fullscreen, does nothing.
-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 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="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_cursor_new_for_display">
+<function name="gdk_window_unmaximize">
<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>
+Unmaximizes the window. If the window wasn't maximized, then this
+function does nothing.
-Since: 2.2
+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.
-</description>
-<parameters>
-<parameter name="display">
-<parameter_description> the #GdkDisplay for which the cursor will be created
-</parameter_description>
-</parameter>
-<parameter name="cursor_type">
-<parameter_description> cursor to create
-</parameter_description>
-</parameter>
-</parameters>
-<return> a new #GdkCursor
+On Windows, reliably unmaximizes the window.
-</return>
-</function>
-
-<function name="gdk_region_subtract">
-<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.
</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 toplevel #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_x11_screen_get_window_manager_name">
+<function name="gdk_window_unstick">
<description>
-Returns the name of the window manager for @screen.
+Reverse operation for gdk_window_stick(); see gdk_window_stick(),
+and gtk_window_unstick().
-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_withdraw">
<description>
-Returns %TRUE if gdk_window_set_composited() can be used
-to redirect drawing on the window using compositing.
-
-Currently this only works on X11 with XComposite and
-XDamage extensions available.
-
-Since: 2.12
+Withdraws a window (unmaps it and asks the window manager to forget about it).
+This function is not really useful as gdk_window_hide() automatically
+withdraws toplevel windows before hiding them.
</description>
<parameters>
-<parameter name="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_x11_atom_to_xatom">
<description>
-Returns the selection atom for the current source window.
+Converts from a #GdkAtom to the X atom for the default GDK display
+with the same string value.
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GdkDragContext.
+<parameter name="atom">
+<parameter_description> A #GdkAtom
</parameter_description>
</parameter>
</parameters>
-<return> the selection atom.
+<return> the X atom corresponding to @atom.
</return>
</function>
-<function name="gdk_init_check">
+<function name="gdk_x11_atom_to_xatom_for_display">
<description>
-Initialize the library for use.
-
-Arguments:
-"argc" is the number of arguments.
-"argv" is an array of strings.
-
-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.
-
-Side effects:
-The library is initialized.
+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="argc">
-<parameter_description>
+<parameter name="display">
+<parameter_description> A #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="argv">
-<parameter_description>
+<parameter name="atom">
+<parameter_description> A #GdkAtom, or %GDK_NONE
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the X atom corresponding to @atom, or %None
+
+</return>
</function>
-<function name="gdk_keymap_lookup_key">
+<function name="gdk_x11_colormap_foreign_new">
<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.
+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
+Since: 2.2
</description>
<parameters>
-<parameter name="keymap">
-<parameter_description> a #GdkKeymap or %NULL to use the default keymap
+<parameter name="visual">
+<parameter_description> a #GdkVisual
</parameter_description>
</parameter>
-<parameter name="key">
-<parameter_description> a #GdkKeymapKey with keycode, group, and level initialized
+<parameter name="xcolormap">
+<parameter_description> The XID of a colormap with visual @visual
</parameter_description>
</parameter>
</parameters>
-<return> a keyval, or 0 if none was mapped to the given @key
+<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>
</function>
-<function name="gdk_drawable_get_visual">
+<function name="gdk_x11_colormap_get_xcolormap">
<description>
-Gets the #GdkVisual describing the pixel format of @drawable.
+Returns the X colormap belonging to a #GdkColormap.
</description>
<parameters>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
+<parameter name="colormap">
+<parameter_description> a #GdkColormap.
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkVisual
+<return> an Xlib <type>Colormap</type>.
</return>
</function>
-<function name="gdk_setting_get">
+<function name="gdk_x11_colormap_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 #GdkColormap.
</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="colormap">
+<parameter_description> a #GdkColormap.
</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_cursor_get_xcursor">
<description>
-Creates a new cursor by looking up @name in the current cursor
-theme.
+Returns the X cursor belonging to a #GdkCursor.
-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="cursor">
+<parameter_description> a #GdkCursor.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GdkCursor, or %NULL if there is no cursor with
-the given name
-
+<return> an Xlib <type>Cursor</type>.
</return>
</function>
-<function name="gdk_cairo_set_source_pixbuf">
+<function name="gdk_x11_cursor_get_xdisplay">
<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 display of a #GdkCursor.
-Since: 2.8
</description>
<parameters>
-<parameter name="cr">
-<parameter_description> a #Cairo context
-</parameter_description>
-</parameter>
-<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf
-</parameter_description>
-</parameter>
-<parameter name="pixbuf_x">
-<parameter_description> X coordinate of location to place upper left corner of @pixbuf
-</parameter_description>
-</parameter>
-<parameter name="pixbuf_y">
-<parameter_description> Y coordinate of location to place upper left corner of @pixbuf
+<parameter name="cursor">
+<parameter_description> a #GdkCursor.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> an Xlib <type>Display*</type>.
+</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="gdkx_visual_get">
+<function name="gdk_x11_display_get_startup_notification_id">
<description>
-Returns a #GdkVisual corresponding to a X visual.
+Gets the startup notification ID for a display.
+Since: 2.12
</description>
<parameters>
-<parameter name="xvisualid">
-<parameter_description> a X visual id.
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkVisual.
+<return> the startup notification ID for @display
+
</return>
</function>
-<function name="gdk_display_pointer_ungrab">
+<function name="gdk_x11_display_get_user_time">
<description>
-Release any pointer grab.
+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.2
+Since: 2.8
</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> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the timestamp of the last user interaction
+
+</return>
</function>
-<function name="gdk_gc_set_fill">
+<function name="gdk_x11_display_get_xdisplay">
<description>
-Set the fill mode for a graphics context.
+Returns the X display of a #GdkDisplay.
-Deprecated: 2.22: You can achieve tiling in Cairo by using
-cairo_pattern_set_extend() on the source. For stippling, see the
-deprecation comments on gdk_gc_set_stipple().
+Since: 2.2
</description>
<parameters>
-<parameter name="gc">
-<parameter_description> a #GdkGC.
-</parameter_description>
-</parameter>
-<parameter name="fill">
-<parameter_description> the new fill mode.
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> an X display.
+</return>
</function>
-<function name="gdk_screen_get_window_stack">
+<function name="gdk_x11_display_grab">
<description>
-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.
-
-On other platforms, this function may return %NULL, depending on whether
-it is implementable on that platform.
+Call XGrabServer() on @display.
+To ungrab the display again, use gdk_x11_display_ungrab().
-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.
+gdk_x11_display_grab()/gdk_x11_display_ungrab() calls can be nested.
-Since: 2.10
+Since: 2.2
</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>
+<return></return>
</function>
-<function name="gdk_screen_get_rgba_visual">
+<function name="gdk_x11_display_set_cursor_theme">
<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.
+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).
Since: 2.8
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<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 visual to use for windows with an
-alpha channel or %NULL if the capability is not available.
-
-</return>
+<return></return>
</function>
-<function name="gdk_text_extents_wc">
+<function name="gdk_x11_display_ungrab">
<description>
-Gets the metrics of a string of wide characters.
+Ungrab @display after it has been grabbed with
+gdk_x11_display_grab().
+
+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>
</function>
-<function name="gdk_pango_renderer_set_drawable">
+<function name="gdk_x11_drawable_get_xdisplay">
<description>
-Sets the drawable the renderer draws to.
+Returns the display of a #GdkDrawable.
-Since: 2.6
</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_description> a #GdkDrawable.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> an Xlib <type>Display*</type>.
+</return>
</function>
-<function name="gdk_window_set_role">
+<function name="gdk_x11_drawable_get_xid">
<description>
-When using GTK+, typically you should use gtk_window_set_role() instead
-of this low-level function.
-
-The window manager and session manager use a window's role to
-distinguish it from other kinds of window in the same application.
-When an application is restarted after being saved in a previous
-session, all windows with the same title and role are treated as
-interchangeable. So if you have two windows with the same title
-that should be distinguished for session management purposes, you
-should set the role on those windows. It doesn't matter what string
-you use for the role, as long as you have a different role for each
-non-interchangeable kind of window.
+Returns the X resource (window or pixmap) belonging to a #GdkDrawable.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a toplevel #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="role">
-<parameter_description> a string indicating its role
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the ID of @drawable's X resource.
+</return>
</function>
-<function name="gdk_window_get_effective_toplevel">
+<function name="gdk_x11_font_get_name">
<description>
-Gets the toplevel window that's an ancestor of @window.
-
-Works like gdk_window_get_toplevel(), but treats an offscreen window's
-embedder as its parent, using gdk_window_get_effective_parent().
-
-See also: gdk_offscreen_window_get_embedder()
+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.
-Since: 2.22
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="font">
+<parameter_description> a #GdkFont.
</parameter_description>
</parameter>
</parameters>
-<return> the effective toplevel window containing @window
-
+<return> the name of the font. This string is owned
+by GDK and must not be modified or freed.
</return>
</function>
-<function name="gdk_get_show_events">
+<function name="gdk_x11_font_get_xdisplay">
<description>
-Gets whether event debugging output is enabled.
+Returns the display of a #GdkFont.
</description>
<parameters>
+<parameter name="font">
+<parameter_description> a #GdkFont.
+</parameter_description>
+</parameter>
</parameters>
-<return> %TRUE if event debugging output is enabled.
+<return> an Xlib <type>Display*</type>.
</return>
</function>
-<function name="gdk_window_merge_child_shapes">
+<function name="gdk_x11_font_get_xfont">
<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().
+Returns the X font belonging to a #GdkFont.
-This function is distinct from gdk_window_set_child_shapes()
-because it includes @window's shape mask in the set of shapes to
-be merged.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="font">
+<parameter_description> a #GdkFont.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> an Xlib <type>XFontStruct*</type> or an <type>XFontSet</type>.
+</return>
</function>
-<function name="gdk_window_at_pointer">
+<function name="gdk_x11_gc_get_xdisplay">
<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.
+Returns the display of a #GdkGC.
+Deprecated: 2.22: #GdkGC has been replaced by #cairo_t.
</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="gc">
+<parameter_description> a #GdkGC.
</parameter_description>
</parameter>
</parameters>
-<return> window under the mouse pointer
+<return> an Xlib <type>Display*</type>.
+
</return>
</function>
-<function name="gdk_window_get_type_hint">
+<function name="gdk_x11_gc_get_xgc">
<description>
-This function returns the type hint set for a window.
+Returns the X GC of a #GdkGC.
-Since: 2.10
+Deprecated: 2.22: #GdkGC has been replaced by #cairo_t.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> A toplevel #GdkWindow
+<parameter name="gc">
+<parameter_description> a #GdkGC.
</parameter_description>
</parameter>
</parameters>
-<return> The type hint set for @window
+<return> an Xlib <type>GC</type>.
</return>
</function>
-<function name="gdk_colormap_new">
+<function name="gdk_x11_get_default_root_xwindow">
<description>
-Creates a new colormap for the given visual.
+Gets the root window of the default screen
+(see gdk_x11_get_default_screen()).
</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_description>
-</parameter>
</parameters>
-<return> the new #GdkColormap.
+<return> an Xlib <type>Window</type>.
</return>
</function>
-<function name="gdk_screen_get_resolution">
+<function name="gdk_x11_get_default_screen">
<description>
-Gets the resolution for font handling on the screen; see
-gdk_screen_set_resolution() for full details.
+Gets the default GTK+ screen number.
-Since: 2.10
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
-</parameter_description>
-</parameter>
</parameters>
-<return> the current resolution, or -1 if no resolution
-has been set.
-
+<return> 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_draw_lines">
+<function name="gdk_x11_get_default_xdisplay">
<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 default GTK+ display.
-Deprecated: 2.22: Use cairo_line_to() and cairo_stroke() instead. See the
-documentation of gdk_draw_line() for notes on line drawing with Cairo.
</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> 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_pango_renderer_set_stipple">
+<function name="gdk_x11_get_server_time">
<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.
+Routine to get the current X server time stamp.
-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 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_x11_display_get_xdisplay">
+<function name="gdk_x11_get_xatom_by_name">
<description>
-Returns the X display of a #GdkDisplay.
+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.2
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="atom_name">
+<parameter_description> a string
</parameter_description>
</parameter>
</parameters>
-<return> an X display.
+<return> a X atom for GDK's default display.
</return>
</function>
-<function name="gdk_color_free">
+<function name="gdk_x11_get_xatom_by_name_for_display">
<description>
-Frees a color structure created with
-gdk_color_copy().
+Returns the X atom for a #GdkDisplay corresponding to @atom_name.
+This function caches the result, so if called repeatedly it is much
+faster than XInternAtom(), which is a round trip to the server each time.
+
+Since: 2.2
</description>
<parameters>
-<parameter name="color">
-<parameter_description> a #GdkColor.
+<parameter name="display">
+<parameter_description> a #GdkDisplay
+</parameter_description>
+</parameter>
+<parameter name="atom_name">
+<parameter_description> a string
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a X atom for a #GdkDisplay
+
+</return>
</function>
-<function name="gdk_window_end_paint">
+<function name="gdk_x11_get_xatom_name">
<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.
+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.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="xatom">
+<parameter_description> an X atom for GDK's default display
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<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_gc_set_dashes">
+<function name="gdk_x11_get_xatom_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().)
-
-The @dash_offset defines the phase of the pattern,
-specifying how many pixels into the dash-list the pattern
-should actually begin.
+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.
-Deprecated: 2.22: Use cairo_set_dash() to set the dash in Cairo.
+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> the #GdkDisplay where @xatom is defined
</parameter_description>
</parameter>
-<parameter name="n">
-<parameter_description> the number of elements in @dash_list.
+<parameter name="xatom">
+<parameter_description> an X atom
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<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_region_new">
+<function name="gdk_x11_grab_server">
<description>
-Creates a new empty #GdkRegion.
+Call gdk_x11_display_grab() on the default display.
+To ungrab the server again, use gdk_x11_ungrab_server().
+gdk_x11_grab_server()/gdk_x11_ungrab_server() calls can be nested.
</description>
<parameters>
</parameters>
-<return> a new empty #GdkRegion
-</return>
+<return></return>
</function>
-<function name="gdk_window_get_toplevels">
+<function name="gdk_x11_image_get_xdisplay">
<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 display of a #GdkImage.
-Deprecated: 2.16: Use gdk_screen_get_toplevel_windows() instead.
</description>
<parameters>
+<parameter name="image">
+<parameter_description> a #GdkImage.
+</parameter_description>
+</parameter>
</parameters>
-<return> list of toplevel windows, free with g_list_free()
-
+<return> an Xlib <type>Display*</type>.
</return>
</function>
-<function name="gdk_threads_add_timeout_seconds_full">
+<function name="gdk_x11_image_get_ximage">
<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 X image belonging to a #GdkImage.
-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 name="image">
+<parameter_description> a #GdkImage.
</parameter_description>
</parameter>
</parameters>
-<return> the ID (greater than 0) of the event source.
-
+<return> an <type>XImage*</type>.
</return>
</function>
-<function name="gdk_char_width_wc">
+<function name="gdk_x11_lookup_xdisplay">
<description>
-Determines the width of a given wide character. (Encoded
-in the wide-character encoding of the current locale).
+Find the #GdkDisplay corresponding to @display, if any exists.
+Since: 2.2
</description>
<parameters>
-<parameter name="font">
-<parameter_description> a #GdkFont
-</parameter_description>
-</parameter>
-<parameter name="character">
-<parameter_description> the character to measure.
+<parameter name="xdisplay">
+<parameter_description> a pointer to an X Display
</parameter_description>
</parameter>
</parameters>
-<return> the width of the character in pixels.
+<return> the #GdkDisplay, if found, otherwise %NULL.
+
</return>
</function>
-<function name="gdk_drag_find_window_for_screen">
+<function name="gdk_x11_register_standard_event_type">
<description>
-Finds the destination window and DND protocol to use at the
-given pointer position.
+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).
-This function is called by the drag source to obtain the
- dest_window and @protocol parameters for gdk_drag_motion().
+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.
-Since: 2.2
+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="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 name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
-<parameter name="dest_window">
-<parameter_description> location to store the destination window in.
+<parameter name="event_base">
+<parameter_description> first event type code to register
</parameter_description>
</parameter>
-<parameter name="protocol">
-<parameter_description> location to store the DND protocol in.
+<parameter name="n_events">
+<parameter_description> number of event type codes to register
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_color_parse">
+<function name="gdk_x11_screen_get_monitor_output">
<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')
+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="spec">
-<parameter_description> the string specifying the color.
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> the #GdkColor to fill in
+<parameter name="monitor_num">
+<parameter_description> number of the monitor, between 0 and gdk_screen_get_n_monitors (screen)
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the parsing succeeded.
+<return> the XID of the monitor
+
</return>
</function>
-<function name="gdk_window_get_background_pattern">
+<function name="gdk_x11_screen_get_screen_number">
<description>
-Gets the pattern used to clear the background on @window. If @window
-does not have its own background and reuses the parent's, %NULL is
-returned and you'll have to query it yourself.
+Returns the index of a #GdkScreen.
-Since: 2.22
+Since: 2.2
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a window
+<parameter name="screen">
+<parameter_description> a #GdkScreen.
</parameter_description>
</parameter>
</parameters>
-<return> The pattern to use for the background or %NULL to use the
-parent's background.
-
+<return> the position of @screen among the screens of
+its display.
</return>
</function>
-<function name="gdk_visual_get_best_with_both">
+<function name="gdk_x11_screen_get_window_manager_name">
<description>
-Combines gdk_visual_get_best_with_depth() and gdk_visual_get_best_with_type().
+Returns the name of the window manager for @screen.
+Since: 2.2
</description>
<parameters>
-<parameter name="depth">
-<parameter_description> a bit depth
-</parameter_description>
-</parameter>
-<parameter name="visual_type">
-<parameter_description> a visual type
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
-<return> best visual with both @depth and
- visual_type, or %NULL if none
-</return>
-</function>
-
-<function name="gdk_x11_get_default_xdisplay">
-<description>
-Gets the default GTK+ display.
-
+<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.
-</description>
-<parameters>
-</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>
</function>
-<function name="gdk_screen_get_width">
+<function name="gdk_x11_screen_get_xscreen">
<description>
-Gets the width of @screen in pixels
+Returns the screen of a #GdkScreen.
Since: 2.2
</description>
<parameters>
<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter_description> a #GdkScreen.
</parameter_description>
</parameter>
</parameters>
-<return> the width of @screen in pixels.
-
+<return> an Xlib <type>Screen*</type>
</return>
</function>
-<function name="gdk_device_free_history">
-<description>
-Frees an array of #GdkTimeCoord that was returned by gdk_device_get_history().
-
-</description>
-<parameters>
-<parameter name="events">
-<parameter_description> an array of #GdkTimeCoord.
-</parameter_description>
-</parameter>
-<parameter name="n_events">
-<parameter_description> the length of the array.
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gdk_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.
-Deprecated: 2.22: Use Cairo for rendering.
+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_window_set_child_shapes">
+<function name="gdk_x11_set_sm_client_id">
<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.
+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="window">
-<parameter_description> a #GdkWindow
+<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.
-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_lookup_for_display">
<description>
-Copies @region, creating an identical new region.
+Looks up the #GdkWindow that wraps the given native window handle.
+Since: 2.24
</description>
<parameters>
-<parameter name="region">
-<parameter_description> a #GdkRegion
+<parameter name="display">
+<parameter_description> the #GdkDisplay corresponding to the window handle
+</parameter_description>
+</parameter>
+<parameter name="window">
+<parameter_description> an XLib <type>Window</type>
</parameter_description>
</parameter>
</parameters>
-<return> a new region identical to @region
+<return> the #GdkWindow wrapper for the native window,
+or %NULL if there is none.
+
</return>
</function>
-<function name="gdk_window_show">
+<function name="gdk_x11_window_move_to_current_desktop">
<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().
+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.
-When implementing a #GtkWidget, you should call this function on the widget's
-#GdkWindow as part of the "map" method.
+Since: 2.8
</description>
<parameters>
@@ -15820,162 +16192,167 @@ When implementing a #GtkWidget, you should call this function on the widget's
<return></return>
</function>
-<function name="gdk_window_constrain_size">
+<function name="gdk_x11_window_set_user_time">
<description>
-Constrains a desired width and height according to a
-set of geometry hints (such as minimum and maximum size).
+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="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 name="window">
+<parameter_description> A toplevel #GdkWindow
</parameter_description>
</parameter>
-<parameter name="new_height">
-<parameter_description> location to store resulting height
+<parameter name="timestamp">
+<parameter_description> An XServer timestamp to which the property should be set
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gdk_color_copy">
+<function name="gdk_x11_xatom_to_atom">
<description>
-Makes a copy of a color structure. The result
-must be freed using gdk_color_free().
+Convert from an X atom for the default display to the corresponding
+#GdkAtom.
</description>
<parameters>
-<parameter name="color">
-<parameter_description> a #GdkColor.
+<parameter name="xatom">
+<parameter_description> an X atom for the default GDK display
</parameter_description>
</parameter>
</parameters>
-<return> a copy of @color.
+<return> the corresponding G#dkAtom.
</return>
</function>
-<function name="gdk_window_thaw_updates">
+<function name="gdk_x11_xatom_to_atom_for_display">
<description>
-Thaws a window frozen with gdk_window_freeze_updates().
+Convert from an X atom for a #GdkDisplay to the corresponding
+#GdkAtom.
+
+Since: 2.2
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="display">
+<parameter_description> A #GdkDisplay
+</parameter_description>
+</parameter>
+<parameter name="xatom">
+<parameter_description> an X atom
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the corresponding #GdkAtom.
+
+</return>
</function>
-<function name="gdk_x11_get_default_root_xwindow">
+<function name="gdk_xid_table_lookup">
<description>
-Gets the root window of the default screen
-(see gdk_x11_get_default_screen()).
+Returns the Gdk object associated with the given X id for the default
+display.
+Deprecated:2.24: This function will be removed in GTK+ 3.0. GTK+
+only stores windows in its X id table nowadays, so use
+gdk_x11_window_lookup_for_display() instead.
</description>
<parameters>
+<parameter name="xid">
+<parameter_description> an X id.
+</parameter_description>
+</parameter>
</parameters>
-<return> an Xlib <type>Window</type>.
+<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>
</function>
-<function name="gdk_text_width_wc">
+<function name="gdk_xid_table_lookup_for_display">
<description>
-Determines the width of a given wide-character string.
+Returns the GDK object associated with the given X id.
+
+Since: 2.2
+Deprecated:2.24: This function will be removed in GTK+ 3.0. GTK+
+only stores windows in its X id table nowadays, so use
+gdk_x11_window_lookup_for_display() instead.
</description>
<parameters>
-<parameter name="font">
-<parameter_description> a #GdkFont
-</parameter_description>
-</parameter>
-<parameter name="text">
-<parameter_description> the text to measure.
+<parameter name="display">
+<parameter_description> the #GdkDisplay.
</parameter_description>
</parameter>
-<parameter name="text_length">
-<parameter_description> the length of the text in characters.
+<parameter name="xid">
+<parameter_description> an X id.
</parameter_description>
</parameter>
</parameters>
-<return> the width of the string in pixels.
+<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>
</function>
-<function name="gdk_image_get_bytes_per_line">
+<function name="gdkx_colormap_get">
<description>
-Determines the number of bytes per line of the image.
+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+
-Since: 2.22
+Always use gdk_x11_colormap_foreign_new() instead.
-Deprecated: 2.22: #GdkImage should not be used anymore.
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GdkImage
+<parameter name="xcolormap">
+<parameter_description> the XID of a colormap for the default screen.
</parameter_description>
</parameter>
</parameters>
-<return> the bytes per line
-
+<return> the existing #GdkColormap object if it was
+already known to GTK+, otherwise warns and return
+%NULL.
</return>
</function>
-<function name="gdk_x11_display_broadcast_startup_message">
+<function name="gdkx_visual_get">
<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.
+Returns a #GdkVisual corresponding to a X visual.
-Since: 2.12
+Deprecated:2.24: Use gdk_x11_screen_lookup_visual() instead
</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 name="xvisualid">
+<parameter_description> a X visual id.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GdkVisual.
+
+</return>
</function>
</root>
diff --git a/gtk/src/gtk_docs.xml b/gtk/src/gtk_docs.xml
index d4f5dc2..d066683 100644
--- a/gtk/src/gtk_docs.xml
+++ b/gtk/src/gtk_docs.xml
@@ -1,2251 +1,2215 @@
<root>
-<function name="gtk_tree_view_get_enable_search">
+<function name="add_file">
<description>
-Returns whether or not the tree allows to start interactive searching
-by typing in text.
-
+Adds the given @file with its associated @info to the @model.
+If the model is frozen, the file will only show up after it is thawn.
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView
+<parameter name="model">
+<parameter_description> the model
+</parameter_description>
+</parameter>
+<parameter name="file">
+<parameter_description> the file to add
+</parameter_description>
+</parameter>
+<parameter name="info">
+<parameter_description> the information to associate with the file
</parameter_description>
</parameter>
</parameters>
-<return> whether or not to let the user search interactively
-</return>
+<return></return>
</function>
-<function name="gtk_status_icon_set_from_file">
+<function name="gtk_about_dialog_get_artists">
<description>
-Makes @status_icon display the file @filename.
-See gtk_status_icon_new_from_file() for details.
+Returns the string which are displayed in the artists tab
+of the secondary credits dialog.
-Since: 2.10
+Since: 2.6
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
-</parameter_description>
-</parameter>
-<parameter name="filename">
-<parameter_description> a filename
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A %NULL-terminated string array containing
+the artists. The array is owned by the about dialog
+and must not be modified.
+
+</return>
</function>
-<function name="gtk_tree_view_set_tooltip_row">
+<function name="gtk_about_dialog_get_authors">
<description>
-Sets the tip area of @tooltip to be the area covered by the row at @path.
-See also gtk_tree_view_set_tooltip_column() for a simpler alternative.
-See also gtk_tooltip_set_tip_area().
+Returns the string which are displayed in the authors tab
+of the secondary credits dialog.
-Since: 2.12
+Since: 2.6
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
-</parameter_description>
-</parameter>
-<parameter name="tooltip">
-<parameter_description> a #GtkTooltip
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> a #GtkTreePath
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A %NULL-terminated string array containing
+the authors. The array is owned by the about dialog
+and must not be modified.
+
+</return>
</function>
-<function name="gtk_icon_theme_has_icon">
+<function name="gtk_about_dialog_get_comments">
<description>
-Checks whether an icon theme includes an icon
-for a particular name.
+Returns the comments string.
-Since: 2.4
+Since: 2.6
</description>
<parameters>
-<parameter name="icon_theme">
-<parameter_description> a #GtkIconTheme
-</parameter_description>
-</parameter>
-<parameter name="icon_name">
-<parameter_description> the name of an icon
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @icon_theme includes an
-icon for @icon_name.
+<return> The comments. The string is owned by the about
+dialog and must not be modified.
</return>
</function>
-<function name="gtk_clipboard_set_with_owner">
+<function name="gtk_about_dialog_get_copyright">
<description>
-Virtually sets the contents of the specified clipboard by providing
-a list of supported formats for the clipboard data and a function
-to call to get the actual data when it is requested.
-
-The difference between this function and gtk_clipboard_set_with_data()
-is that instead of an generic @user_data pointer, a #GObject is passed
-in.
+Returns the copyright string.
+Since: 2.6
</description>
<parameters>
-<parameter name="clipboard">
-<parameter_description> a #GtkClipboard
-</parameter_description>
-</parameter>
-<parameter name="targets">
-<parameter_description> array containing information about the available forms for the
-clipboard data
-</parameter_description>
-</parameter>
-<parameter name="n_targets">
-<parameter_description> number of elements in @targets
-</parameter_description>
-</parameter>
-<parameter name="get_func">
-<parameter_description> function to call to get the actual clipboard data
-</parameter_description>
-</parameter>
-<parameter name="clear_func">
-<parameter_description> when the clipboard contents are set again, this function will
-be called, and @get_func will not be subsequently called.
-</parameter_description>
-</parameter>
-<parameter name="owner">
-<parameter_description> an object that "owns" the data. This object will be passed
-to the callbacks when called.
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if setting the clipboard data succeeded. If setting
-the clipboard data failed the provided callback functions
-will be ignored.
+<return> The copyright string. The string is owned by the about
+dialog and must not be modified.
+
</return>
</function>
-<function name="gtk_combo_box_entry_new">
+<function name="gtk_about_dialog_get_documenters">
<description>
-Creates a new #GtkComboBoxEntry which has a #GtkEntry as child. After
-construction, you should set a model using gtk_combo_box_set_model() and a
-text column using gtk_combo_box_entry_set_text_column().
+Returns the string which are displayed in the documenters
+tab of the secondary credits dialog.
-Since: 2.4
+Since: 2.6
</description>
<parameters>
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
+</parameter_description>
+</parameter>
</parameters>
-<return> A new #GtkComboBoxEntry.
+<return> A %NULL-terminated string array containing
+the documenters. The array is owned by the about dialog
+and must not be modified.
</return>
</function>
-<function name="gtk_text_iter_forward_sentence_end">
+<function name="gtk_about_dialog_get_license">
<description>
-Moves forward to the next sentence end. (If @iter is at the end of
-a sentence, moves to the next end of sentence.) Sentence
-boundaries are determined by Pango and should be correct for nearly
-any language (if not, the correct fix would be to the Pango text
-boundary algorithms).
+Returns the license information.
+Since: 2.6
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter moved and is not the end iterator
+<return> The license information. The string is owned by the about
+dialog and must not be modified.
+
</return>
</function>
-<function name="gtk_tool_palette_set_group_position">
+<function name="gtk_about_dialog_get_logo">
<description>
-Sets the position of the group as an index of the tool palette.
-If position is 0 the group will become the first child, if position is
--1 it will become the last child.
+Returns the pixbuf displayed as logo in the about dialog.
-Since: 2.20
+Since: 2.6
</description>
<parameters>
-<parameter name="palette">
-<parameter_description> a #GtkToolPalette
-</parameter_description>
-</parameter>
-<parameter name="group">
-<parameter_description> a #GtkToolItemGroup which is a child of palette
-</parameter_description>
-</parameter>
-<parameter name="position">
-<parameter_description> a new index for group
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the pixbuf displayed as logo. The pixbuf is
+owned by the about dialog. If you want to keep a reference
+to it, you have to call g_object_ref() on it.
+
+</return>
</function>
-<function name="gtk_entry_get_has_frame">
+<function name="gtk_about_dialog_get_logo_icon_name">
<description>
-Gets the value set by gtk_entry_set_has_frame().
+Returns the icon name displayed as logo in the about dialog.
+Since: 2.6
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
</parameter_description>
</parameter>
</parameters>
-<return> whether the entry has a beveled frame
+<return> the icon name displayed as logo. The string is
+owned by the dialog. If you want to keep a reference
+to it, you have to call g_strdup() on it.
+
</return>
</function>
-<function name="gtk_icon_theme_choose_icon">
+<function name="gtk_about_dialog_get_name">
<description>
-Looks up a named icon and returns a structure containing
-information such as the filename of the icon. The icon
-can then be rendered into a pixbuf using
-gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon()
-combines these two steps if all you need is the pixbuf.)
+Returns the program name displayed in the about dialog.
-If @icon_names contains more than one name, this function
-tries them all in the given order before falling back to
-inherited icon themes.
+Since: 2.6
-Since: 2.12
+Deprecated: 2.12: Use gtk_about_dialog_get_program_name() instead.
</description>
<parameters>
-<parameter name="icon_theme">
-<parameter_description> a #GtkIconTheme
-</parameter_description>
-</parameter>
-<parameter name="icon_names">
-<parameter_description> %NULL-terminated array of icon names to lookup
-</parameter_description>
-</parameter>
-<parameter name="size">
-<parameter_description> desired icon size
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> flags modifying the behavior of the icon lookup
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkIconInfo structure containing information
-about the icon, or %NULL if the icon wasn't found. Free with
-gtk_icon_info_free()
+<return> The program name. The string is owned by the about
+dialog and must not be modified.
</return>
</function>
-<function name="gtk_font_button_set_use_size">
+<function name="gtk_about_dialog_get_program_name">
<description>
-If @use_size is %TRUE, the font name will be written using the selected size.
+Returns the program name displayed in the about dialog.
-Since: 2.4
+Since: 2.12
</description>
<parameters>
-<parameter name="font_button">
-<parameter_description> a #GtkFontButton
-</parameter_description>
-</parameter>
-<parameter name="use_size">
-<parameter_description> If %TRUE, font name will be written using the selected size.
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The program name. The string is owned by the about
+dialog and must not be modified.
+
+</return>
</function>
-<function name="gtk_label_get_text">
+<function name="gtk_about_dialog_get_translator_credits">
<description>
-Fetches the text from a label widget, as displayed on the
-screen. This does not include any embedded underlines
-indicating mnemonics or Pango markup. (See gtk_label_get_label())
+Returns the translator credits string which is displayed
+in the translators tab of the secondary credits dialog.
+Since: 2.6
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
</parameter_description>
</parameter>
</parameters>
-<return> the text in the label widget. This is the internal
-string used by the label, and must not be modified.
+<return> The translator credits string. The string is
+owned by the about dialog and must not be modified.
+
</return>
</function>
-<function name="gtk_draw_slider">
+<function name="gtk_about_dialog_get_version">
<description>
-Draws a slider in the given rectangle on @window using the
-given style and orientation.
+Returns the version string.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
- @window: a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
-</parameter_description>
-</parameter>
-<parameter name="shadow_type">
-<parameter_description> a shadow
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> the x origin of the rectangle in which to draw a slider
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> the y origin of the rectangle in which to draw a slider
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> the width of the rectangle in which to draw a slider
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> the height of the rectangle in which to draw a slider
-</parameter_description>
-</parameter>
-<parameter name="orientation">
-<parameter_description> the orientation to be used
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The version string. The string is owned by the about
+dialog and must not be modified.
+
+</return>
</function>
-<function name="gtk_recent_manager_lookup_item">
+<function name="gtk_about_dialog_get_website">
<description>
-Searches for a URI inside the recently used resources list, and
-returns a structure containing informations about the resource
-like its MIME type, or its display name.
+Returns the website URL.
-Since: 2.10
+Since: 2.6
</description>
<parameters>
-<parameter name="manager">
-<parameter_description> a #GtkRecentManager
-</parameter_description>
-</parameter>
-<parameter name="uri">
-<parameter_description> a URI
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> a return location for a #GError, or %NULL
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkRecentInfo structure containing information
-about the resource pointed by @uri, or %NULL if the URI was
-not registered in the recently used resources list. Free with
-gtk_recent_info_unref().
+<return> The website URL. The string is owned by the about
+dialog and must not be modified.
</return>
</function>
-<function name="gtk_entry_get_icon_at_pos">
+<function name="gtk_about_dialog_get_website_label">
<description>
-Finds the icon at the given position and return its index.
-If @x, @y doesn't lie inside an icon, -1 is returned.
-This function is intended for use in a #GtkWidget::query-tooltip
-signal handler.
+Returns the label used for the website link.
-Since: 2.16
+Since: 2.6
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> the x coordinate of the position to find
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> the y coordinate of the position to find
+</parameters>
+<return> The label used for the website link. The string is
+owned by the about dialog and must not be modified.
+
+</return>
+</function>
+
+<function name="gtk_about_dialog_get_wrap_license">
+<description>
+Returns whether the license text in @about is
+automatically wrapped.
+
+Since: 2.8
+
+</description>
+<parameters>
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
</parameter_description>
</parameter>
</parameters>
-<return> the index of the icon at the given position, or -1
+<return> %TRUE if the license text is wrapped
</return>
</function>
-<function name="gtk_action_group_add_radio_actions">
+<function name="gtk_about_dialog_new">
<description>
-This is a convenience routine to create a group of radio actions and
-add them to the action group.
+Creates a new #GtkAboutDialog.
-The "changed" signal of the first radio action is connected to the
- on_change callback and the accel paths of the actions are set to
-<literal><Actions>/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.
+Since: 2.6
-Since: 2.4
+</description>
+<parameters>
+</parameters>
+<return> a newly created #GtkAboutDialog
+
+</return>
+</function>
+
+<function name="gtk_about_dialog_set_artists">
+<description>
+Sets the strings which are displayed in the artists tab
+of the secondary credits dialog.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="action_group">
-<parameter_description> the action group
-</parameter_description>
-</parameter>
-<parameter name="entries">
-<parameter_description> an array of radio action descriptions
-</parameter_description>
-</parameter>
-<parameter name="n_entries">
-<parameter_description> the number of entries
-</parameter_description>
-</parameter>
-<parameter name="value">
-<parameter_description> the value of the action to activate initially, or -1 if
-no action should be activated
-</parameter_description>
-</parameter>
-<parameter name="on_change">
-<parameter_description> the callback to connect to the changed signal
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> data to pass to the action callbacks
+<parameter name="artists">
+<parameter_description> a %NULL-terminated array of strings
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_dialog_set_default_response">
+<function name="gtk_about_dialog_set_authors">
<description>
-Sets the last widget in the dialog's action area with the given @response_id
-as the default widget for the dialog. Pressing "Enter" normally activates
-the default widget.
+Sets the strings which are displayed in the authors tab
+of the secondary credits dialog.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkDialog
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
</parameter_description>
</parameter>
-<parameter name="response_id">
-<parameter_description> a response ID
+<parameter name="authors">
+<parameter_description> a %NULL-terminated array of strings
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_container_child_set_property">
+<function name="gtk_about_dialog_set_comments">
<description>
-Sets a child property for @child and @container.
+Sets the comments string to display in the about dialog.
+This should be a short string of one or two lines.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
</parameter_description>
</parameter>
-<parameter name="child">
-<parameter_description> a widget which is a child of @container
+<parameter name="comments">
+<parameter_description> a comments string
</parameter_description>
</parameter>
-<parameter name="property_name">
-<parameter_description> the name of the property to set
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_about_dialog_set_copyright">
+<description>
+Sets the copyright string to display in the about dialog.
+This should be a short string of one or two lines.
+
+Since: 2.6
+
+</description>
+<parameters>
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> the value to set the property to
+<parameter name="copyright">
+<parameter_description> (allow-none) the copyright string
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_set_rules_hint">
+<function name="gtk_about_dialog_set_documenters">
<description>
-This function tells GTK+ that the user interface for your
-application requires users to read across tree rows and associate
-cells with one another. By default, GTK+ will then render the tree
-with alternating row colors. Do <emphasis>not</emphasis> use it
-just because you prefer the appearance of the ruled tree; that's a
-question for the theme. Some themes will draw tree rows in
-alternating colors even when rules are turned off, and users who
-prefer that appearance all the time can choose those themes. You
-should call this function only as a <emphasis>semantic</emphasis>
-hint to the theme engine that your tree makes alternating colors
-useful from a functional standpoint (since it has lots of columns,
-generally).
+Sets the strings which are displayed in the documenters tab
+of the secondary credits dialog.
+Since: 2.6
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
</parameter_description>
</parameter>
-<parameter name="setting">
-<parameter_description> %TRUE if the tree requires reading across rows
+<parameter name="documenters">
+<parameter_description> a %NULL-terminated array of strings
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_ui_manager_insert_action_group">
+<function name="gtk_about_dialog_set_email_hook">
<description>
-Inserts an action group into the list of action groups associated
-with @self. Actions in earlier groups hide actions with the same
-name in later groups.
+Installs a global function to be called whenever the user activates an
+email link in an about dialog.
-Since: 2.4
+Since 2.18 there exists a default function which uses gtk_show_uri(). To
+deactivate it, you can pass %NULL for @func.
+
+Since: 2.6
+
+Deprecated: 2.24: Use the #GtkAboutDialog::activate-link signal
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #GtkUIManager object
+<parameter name="func">
+<parameter_description> a function to call when an email link is activated.
</parameter_description>
</parameter>
-<parameter name="action_group">
-<parameter_description> the action group to be inserted
+<parameter name="data">
+<parameter_description> data to pass to @func
</parameter_description>
</parameter>
-<parameter name="pos">
-<parameter_description> the position at which the group will be inserted.
+<parameter name="destroy">
+<parameter_description> #GDestroyNotify for @data
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the previous email hook.
+
+</return>
</function>
-<function name="gtk_file_chooser_get_preview_widget">
+<function name="gtk_about_dialog_set_license">
<description>
-Gets the current preview widget; see
-gtk_file_chooser_set_preview_widget().
+Sets the license information to be displayed in the secondary
+license dialog. If @license is %NULL, the license button is
+hidden.
-Since: 2.4
+Since: 2.6
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
+</parameter_description>
+</parameter>
+<parameter name="license">
+<parameter_description> the license information or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the current preview widget, or %NULL
-
-</return>
+<return></return>
</function>
-<function name="gtk_text_view_get_accepts_tab">
+<function name="gtk_about_dialog_set_logo">
<description>
-Returns whether pressing the Tab key inserts a tab characters.
-gtk_text_view_set_accepts_tab().
+Sets the pixbuf to be displayed as logo in the about dialog.
+If it is %NULL, the default window icon set with
+gtk_window_set_default_icon() will be used.
-Since: 2.4
+Since: 2.6
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> A #GtkTextView
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
+</parameter_description>
+</parameter>
+<parameter name="logo">
+<parameter_description> a #GdkPixbuf, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if pressing the Tab key inserts a tab character,
-%FALSE if pressing the Tab key moves the keyboard focus.
-
-</return>
+<return></return>
</function>
-<function name="gtk_tree_view_column_get_sort_indicator">
+<function name="gtk_about_dialog_set_logo_icon_name">
<description>
-Gets the value set by gtk_tree_view_column_set_sort_indicator().
+Sets the pixbuf to be displayed as logo in the about dialog.
+If it is %NULL, the default window icon set with
+gtk_window_set_default_icon() will be used.
+Since: 2.6
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> a #GtkTreeViewColumn
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
+</parameter_description>
+</parameter>
+<parameter name="icon_name">
+<parameter_description> an icon name, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> whether the sort indicator arrow is displayed
-</return>
+<return></return>
</function>
-<function name="gtk_notebook_set_tab_reorderable">
+<function name="gtk_about_dialog_set_name">
<description>
-Sets whether the notebook tab can be reordered
-via drag and drop or not.
+Sets the name to display in the about dialog.
+If this is not set, it defaults to g_get_application_name().
-Since: 2.10
+Since: 2.6
+
+Deprecated: 2.12: Use gtk_about_dialog_set_program_name() instead.
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
</parameter_description>
</parameter>
-<parameter name="child">
-<parameter_description> a child #GtkWidget
+<parameter name="name">
+<parameter_description> the program name
</parameter_description>
</parameter>
-<parameter name="reorderable">
-<parameter_description> whether the tab is reorderable or not.
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_about_dialog_set_program_name">
+<description>
+Sets the name to display in the about dialog.
+If this is not set, it defaults to g_get_application_name().
+
+Since: 2.12
+
+</description>
+<parameters>
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> the program name
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_set_mark">
+<function name="gtk_about_dialog_set_translator_credits">
<description>
-Move the mark to the given position, if not @should_exist,
-create the mark.
+Sets the translator credits string which is displayed in
+the translators tab of the secondary credits dialog.
+The intended use for this string is to display the translator
+of the language which is currently used in the user interface.
+Using gettext(), a simple way to achieve that is to mark the
+string for translation:
+|[
+gtk_about_dialog_set_translator_credits (about, _("translator-credits"));
+]|
+It is a good idea to use the customary msgid "translator-credits" for this
+purpose, since translators will already know the purpose of that msgid, and
+since #GtkAboutDialog will detect if "translator-credits" is untranslated
+and hide the tab.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
</parameter_description>
</parameter>
-<parameter name="mark_name">
-<parameter_description> name of the mark
+<parameter name="translator_credits">
+<parameter_description> the translator credits
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> location for the mark
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_about_dialog_set_url_hook">
+<description>
+Installs a global function to be called whenever the user activates a
+URL link in an about dialog.
+
+Since 2.18 there exists a default function which uses gtk_show_uri(). To
+deactivate it, you can pass %NULL for @func.
+
+Since: 2.6
+
+Deprecated: 2.24: Use the #GtkAboutDialog::activate-link signal
+
+</description>
+<parameters>
+<parameter name="func">
+<parameter_description> a function to call when a URL link is activated.
</parameter_description>
</parameter>
-<parameter name="left_gravity">
-<parameter_description> if the mark is created by this function, gravity for
-the new mark
+<parameter name="data">
+<parameter_description> data to pass to @func
</parameter_description>
</parameter>
-<parameter name="should_exist">
-<parameter_description> if %TRUE, warn if the mark does not exist, and return
-immediately
+<parameter name="destroy">
+<parameter_description> #GDestroyNotify for @data
</parameter_description>
</parameter>
</parameters>
-<return> mark
+<return> the previous URL hook.
+
</return>
</function>
-<function name="gtk_accel_group_new">
+<function name="gtk_about_dialog_set_version">
<description>
-Creates a new #GtkAccelGroup.
+Sets the version string to display in the about dialog.
+
+Since: 2.6
</description>
<parameters>
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
+</parameter_description>
+</parameter>
+<parameter name="version">
+<parameter_description> the version string
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GtkAccelGroup object
-</return>
+<return></return>
</function>
-<function name="gtk_notebook_remove_page">
+<function name="gtk_about_dialog_set_website">
<description>
-Removes a page from the notebook given its index
-in the notebook.
+Sets the URL to use for the website link.
+
+Note that that the hook functions need to be set up
+before calling this function.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook.
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
</parameter_description>
</parameter>
-<parameter name="page_num">
-<parameter_description> the index of a notebook page, starting
-from 0. If -1, the last page will
-be removed.
+<parameter name="website">
+<parameter_description> a URL string starting with "http://"
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_scale_set_draw_value">
+<function name="gtk_about_dialog_set_website_label">
<description>
-Specifies whether the current value is displayed as a string next
-to the slider.
+Sets the label to be used for the website link.
+It defaults to the website URL.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="scale">
-<parameter_description> a #GtkScale
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
</parameter_description>
</parameter>
-<parameter name="draw_value">
-<parameter_description> %TRUE to draw the value
+<parameter name="website_label">
+<parameter_description> the label used for the website link
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_column_set_clickable">
+<function name="gtk_about_dialog_set_wrap_license">
<description>
-Sets the header to be active if @active is %TRUE. When the header is active,
-then it can take keyboard focus, and can be clicked.
+Sets whether the license text in @about is
+automatically wrapped.
+
+Since: 2.8
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn.
+<parameter name="about">
+<parameter_description> a #GtkAboutDialog
</parameter_description>
</parameter>
-<parameter name="clickable">
-<parameter_description> %TRUE if the header is active.
+<parameter name="wrap_license">
+<parameter_description> whether to wrap the license
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_vbox_new">
+<function name="gtk_accel_group_activate">
<description>
-Creates a new #GtkVBox.
+Finds the first accelerator in @accel_group
+that matches @accel_key and @accel_mods, and
+activates it.
</description>
<parameters>
-<parameter name="homogeneous">
-<parameter_description> %TRUE if all children are to be given equal space allotments.
+<parameter name="accel_group">
+<parameter_description> a #GtkAccelGroup
</parameter_description>
</parameter>
-<parameter name="spacing">
-<parameter_description> the number of pixels to place by default between children.
+<parameter name="accel_quark">
+<parameter_description> the quark for the accelerator name
+</parameter_description>
+</parameter>
+<parameter name="acceleratable">
+<parameter_description> the #GObject, usually a #GtkWindow, on which
+to activate the accelerator.
+</parameter_description>
+</parameter>
+<parameter name="accel_key">
+<parameter_description> accelerator keyval from a key event
+</parameter_description>
+</parameter>
+<parameter name="accel_mods">
+<parameter_description> keyboard state mask from a key event
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkVBox.
+<return> %TRUE if an accelerator was activated and handled this keypress
</return>
</function>
-<function name="gtk_editable_select_region">
+<function name="gtk_accel_group_connect">
<description>
-Selects a region of text. The characters that are selected are
-those characters at positions from @start_pos up to, but not
-including @end_pos. If @end_pos is negative, then the the
-characters selected are those characters from @start_pos to
-the end of the text.
+Installs an accelerator in this group. When @accel_group is being activated
+in response to a call to gtk_accel_groups_activate(), @closure will be
+invoked if the @accel_key and @accel_mods from gtk_accel_groups_activate()
+match those of this connection.
-Note that positions are specified in characters, not bytes.
+The signature used for the @closure is that of #GtkAccelGroupActivate.
+
+Note that, due to implementation details, a single closure can only be
+connected to one accelerator group.
</description>
<parameters>
-<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter name="accel_group">
+<parameter_description> the accelerator group to install an accelerator in
</parameter_description>
</parameter>
-<parameter name="start_pos">
-<parameter_description> start of region
+<parameter name="accel_key">
+<parameter_description> key value of the accelerator
</parameter_description>
</parameter>
-<parameter name="end_pos">
-<parameter_description> end of region
+<parameter name="accel_mods">
+<parameter_description> modifier combination of the accelerator
+</parameter_description>
+</parameter>
+<parameter name="accel_flags">
+<parameter_description> a flag mask to configure this accelerator
+</parameter_description>
+</parameter>
+<parameter name="closure">
+<parameter_description> closure to be executed upon accelerator activation
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_delete_interactive">
+<function name="gtk_accel_group_connect_by_path">
<description>
-Deletes all <emphasis>editable</emphasis> text in the given range.
-Calls gtk_text_buffer_delete() for each editable sub-range of
-[ start,@end). @start and @end are revalidated to point to
-the location of the last deleted range, or left untouched if
-no text was deleted.
+Installs an accelerator in this group, using an accelerator path to look
+up the appropriate key and modifiers (see gtk_accel_map_add_entry()).
+When @accel_group is being activated in response to a call to
+gtk_accel_groups_activate(), @closure will be invoked if the @accel_key and
+ accel_mods from gtk_accel_groups_activate() match the key and modifiers
+for the path.
+
+The signature used for the @closure is that of #GtkAccelGroupActivate.
+Note that @accel_path string will be stored in a #GQuark. Therefore, if you
+pass a static string, you can save some memory by interning it first with
+g_intern_static_string().
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="start_iter">
-<parameter_description> start of range to delete
+<parameter name="accel_group">
+<parameter_description> the accelerator group to install an accelerator in
</parameter_description>
</parameter>
-<parameter name="end_iter">
-<parameter_description> end of range
+<parameter name="accel_path">
+<parameter_description> path used for determining key and modifiers.
</parameter_description>
</parameter>
-<parameter name="default_editable">
-<parameter_description> whether the buffer is editable by default
+<parameter name="closure">
+<parameter_description> closure to be executed upon accelerator activation
</parameter_description>
</parameter>
</parameters>
-<return> whether some text was actually deleted
-</return>
+<return></return>
</function>
-<function name="gtk_tree_view_get_columns">
+<function name="gtk_accel_group_disconnect">
<description>
-Returns a #GList of all the #GtkTreeViewColumn s currently in @tree_view.
-The returned list must be freed with g_list_free ().
+Removes an accelerator previously installed through
+gtk_accel_group_connect().
+Since 2.20 @closure can be %NULL.
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView
+<parameter name="accel_group">
+<parameter_description> the accelerator group to remove an accelerator from
+</parameter_description>
+</parameter>
+<parameter name="closure">
+<parameter_description> the closure to remove from this accelerator group, or %NULL
+to remove all closures
</parameter_description>
</parameter>
</parameters>
-<return> A list of #GtkTreeViewColumn s
+<return> %TRUE if the closure was found and got disconnected
</return>
</function>
-<function name="gtk_text_buffer_select_range">
+<function name="gtk_accel_group_disconnect_key">
<description>
-This function moves the "insert" and "selection_bound" marks
-simultaneously. If you move them in two steps
-with gtk_text_buffer_move_mark(), you will temporarily select a
-region in between their old and new locations, which can be pretty
-inefficient since the temporarily-selected region will force stuff
-to be recalculated. This function moves them as a unit, which can
-be optimized.
-
-Since: 2.4
+Removes an accelerator previously installed through
+gtk_accel_group_connect().
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="accel_group">
+<parameter_description> the accelerator group to install an accelerator in
</parameter_description>
</parameter>
-<parameter name="ins">
-<parameter_description> where to put the "insert" mark
+<parameter name="accel_key">
+<parameter_description> key value of the accelerator
</parameter_description>
</parameter>
-<parameter name="bound">
-<parameter_description> where to put the "selection_bound" mark
+<parameter name="accel_mods">
+<parameter_description> modifier combination of the accelerator
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if there was an accelerator which could be
+removed, %FALSE otherwise
+</return>
</function>
-<function name="gtk_recent_info_get_uri">
+<function name="gtk_accel_group_find">
<description>
-Gets the URI of the resource.
+Finds the first entry in an accelerator group for which
+ find_func returns %TRUE and returns its #GtkAccelKey.
-Since: 2.10
</description>
<parameters>
-<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter name="accel_group">
+<parameter_description> a #GtkAccelGroup
+</parameter_description>
+</parameter>
+<parameter name="find_func">
+<parameter_description> a function to filter the entries of @accel_group with
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to pass to @find_func
</parameter_description>
</parameter>
</parameters>
-<return> the URI of the resource. The returned string is
-owned by the recent manager, and should not be freed.
-
+<return> the key of the first entry passing @find_func. The key is
+owned by GTK+ and must not be freed.
</return>
</function>
-<function name="gtk_container_get_focus_chain">
+<function name="gtk_accel_group_from_accel_closure">
<description>
-Retrieves the focus chain of the container, if one has been
-set explicitly. If no focus chain has been explicitly
-set, GTK+ computes the focus chain based on the positions
-of the children. In that case, GTK+ stores %NULL in
- focusable_widgets and returns %FALSE.
-
+Finds the #GtkAccelGroup to which @closure is connected;
+see gtk_accel_group_connect().
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
-</parameter_description>
-</parameter>
-<parameter name="focusable_widgets">
-<parameter_description> location
-to store the focus chain of the
-container, or %NULL. You should free this list
-using g_list_free() when you are done with it, however
-no additional reference count is added to the
-individual widgets in the focus chain.
+<parameter name="closure">
+<parameter_description> a #GClosure
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the focus chain of the container
-has been set explicitly.
+<return> the #GtkAccelGroup to which @closure is connected, or %NULL.
</return>
</function>
-<function name="gtk_tree_selection_select_all">
+<function name="gtk_accel_group_get_is_locked">
<description>
-Selects all the nodes. @selection must be set to #GTK_SELECTION_MULTIPLE
-mode.
+Locks are added and removed using gtk_accel_group_lock() and
+gtk_accel_group_unlock().
+
+Since: 2.14
</description>
<parameters>
-<parameter name="selection">
-<parameter_description> A #GtkTreeSelection.
+<parameter name="accel_group">
+<parameter_description> a #GtkAccelGroup
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if there are 1 or more locks on the @accel_group,
+%FALSE otherwise.
+
+</return>
</function>
-<function name="gtk_file_chooser_button_set_focus_on_click">
+<function name="gtk_accel_group_get_modifier_mask">
<description>
-Sets whether the button will grab focus when it is clicked with the mouse.
-Making mouse clicks not grab focus is useful in places like toolbars where
-you don't want the keyboard focus removed from the main area of the
-application.
+Gets a #GdkModifierType representing the mask for this
+ accel_group For example, #GDK_CONTROL_MASK, #GDK_SHIFT_MASK, etc.
-Since: 2.10
+Since: 2.14
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkFileChooserButton
-</parameter_description>
-</parameter>
-<parameter name="focus_on_click">
-<parameter_description> whether the button grabs focus when clicked with the mouse
+<parameter name="accel_group">
+<parameter_description> a #GtkAccelGroup
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the modifier mask for this accel group.
+
+</return>
</function>
-<function name="gtk_tree_view_column_get_tree_view">
+<function name="gtk_accel_group_lock">
<description>
-Returns the #GtkTreeView wherein @tree_column has been inserted. If
- column is currently not inserted in any tree view, %NULL is
-returned.
+Locks the given accelerator group.
-Since: 2.12
+Locking an acelerator group prevents the accelerators contained
+within it to be changed during runtime. Refer to
+gtk_accel_map_change_entry() about runtime accelerator changes.
+
+If called more than once, @accel_group remains locked until
+gtk_accel_group_unlock() has been called an equivalent number
+of times.
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn
+<parameter name="accel_group">
+<parameter_description> a #GtkAccelGroup
</parameter_description>
</parameter>
</parameters>
-<return> The tree view wherein @column has been inserted if any,
-%NULL otherwise.
+<return></return>
+</function>
+<function name="gtk_accel_group_new">
+<description>
+Creates a new #GtkAccelGroup.
+
+</description>
+<parameters>
+</parameters>
+<return> a new #GtkAccelGroup object
</return>
</function>
-<function name="gtk_paint_expander">
+<function name="gtk_accel_group_query">
<description>
-Draws an expander as used in #GtkTreeView. @x and @y specify the
-center the expander. The size of the expander is determined by the
-"expander-size" style property of @widget. (If widget is not
-specified or doesn't have an "expander-size" property, an
-unspecified default size will be used, since the caller doesn't
-have sufficient information to position the expander, this is
-likely not useful.) The expander is expander_size pixels tall
-in the collapsed position and expander_size pixels wide in the
-expanded position.
+Queries an accelerator group for all entries matching @accel_key and
+ accel_mods
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
-</parameter_description>
-</parameter>
-<parameter name="area">
-<parameter_description> clip rectangle, or %NULL if the
-output should not be clipped
-</parameter_description>
-</parameter>
-<parameter name="widget">
-<parameter_description> the widget
-</parameter_description>
-</parameter>
-<parameter name="detail">
-<parameter_description> a style detail
+<parameter name="accel_group">
+<parameter_description> the accelerator group to query
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> the x position to draw the expander at
+<parameter name="accel_key">
+<parameter_description> key value of the accelerator
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> the y position to draw the expander at
+<parameter name="accel_mods">
+<parameter_description> modifier combination of the accelerator
</parameter_description>
</parameter>
-<parameter name="expander_style">
-<parameter_description> the style to draw the expander in; determines
-whether the expander is collapsed, expanded, or in an
-intermediate state.
+<parameter name="n_entries">
+<parameter_description> location to return the number of entries found, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> an array of @n_entries #GtkAccelGroupEntry elements, or %NULL. The array is owned by GTK+ and must not be freed.
+</return>
</function>
-<function name="gtk_text_iter_inside_word">
+<function name="gtk_accel_group_unlock">
<description>
-Determines whether @iter is inside a natural-language word (as
-opposed to say inside some whitespace). Word breaks are determined
-by Pango and should be correct for nearly any language (if not, the
-correct fix would be to the Pango word break algorithms).
-
+Undoes the last call to gtk_accel_group_lock() on this @accel_group.
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="accel_group">
+<parameter_description> a #GtkAccelGroup
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter is inside a word
-</return>
+<return></return>
</function>
-<function name="gtk_binding_entry_skip">
+<function name="gtk_accel_groups_activate">
<description>
-Install a binding on @binding_set which causes key lookups
-to be aborted, to prevent bindings from lower priority sets
-to be activated.
+Finds the first accelerator in any #GtkAccelGroup attached
+to @object that matches @accel_key and @accel_mods, and
+activates that accelerator.
-Since: 2.12
</description>
<parameters>
-<parameter name="binding_set">
-<parameter_description> a #GtkBindingSet to skip an entry of
+<parameter name="object">
+<parameter_description> the #GObject, usually a #GtkWindow, on which
+to activate the accelerator.
</parameter_description>
</parameter>
-<parameter name="keyval">
-<parameter_description> key value of binding to skip
+<parameter name="accel_key">
+<parameter_description> accelerator keyval from a key event
</parameter_description>
</parameter>
-<parameter name="modifiers">
-<parameter_description> key modifier of binding to skip
+<parameter name="accel_mods">
+<parameter_description> keyboard state mask from a key event
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if an accelerator was activated and handled this keypress
+</return>
</function>
-<function name="gtk_assistant_set_page_complete">
+<function name="gtk_accel_groups_from_object">
<description>
-Sets whether @page contents are complete. This will make
- assistant update the buttons state to be able to continue the task.
+Gets a list of all accel groups which are attached to @object.
-Since: 2.10
</description>
<parameters>
-<parameter name="assistant">
-<parameter_description> a #GtkAssistant
-</parameter_description>
-</parameter>
-<parameter name="page">
-<parameter_description> a page of @assistant
-</parameter_description>
-</parameter>
-<parameter name="complete">
-<parameter_description> the completeness status of the page
+<parameter name="object">
+<parameter_description> a #GObject, usually a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a list of all accel groups which are attached to @object
+</return>
</function>
-<function name="gtk_cell_renderer_set_sensitive">
+<function name="gtk_accel_label_get_accel_widget">
<description>
-Sets the cell renderer's sensitivity.
+Fetches the widget monitored by this accelerator label. See
+gtk_accel_label_set_accel_widget().
-Since: 2.18
</description>
<parameters>
-<parameter name="cell">
-<parameter_description> A #GtkCellRenderer
-</parameter_description>
-</parameter>
-<parameter name="sensitive">
-<parameter_description> the sensitivity of the cell
+<parameter name="accel_label">
+<parameter_description> a #GtkAccelLabel
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the object monitored by the accelerator label, or %NULL.
+</return>
</function>
-<function name="gtk_button_get_event_window">
+<function name="gtk_accel_label_get_accel_width">
<description>
-Returns the button's event window if it is realized, %NULL otherwise.
-This function should be rarely needed.
+Returns the width needed to display the accelerator key(s).
+This is used by menus to align all of the #GtkMenuItem widgets, and shouldn't
+be needed by applications.
-Since: 2.22
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkButton
+<parameter name="accel_label">
+<parameter_description> a #GtkAccelLabel.
</parameter_description>
</parameter>
</parameters>
-<return> @button's event window.
-
+<return> the width needed to display the accelerator key(s).
</return>
</function>
-<function name="gtk_tree_row_reference_get_path">
+<function name="gtk_accel_label_new">
<description>
-Returns a path that the row reference currently points to, or %NULL if the
-path pointed to is no longer valid.
+Creates a new #GtkAccelLabel.
</description>
<parameters>
-<parameter name="reference">
-<parameter_description> A #GtkTreeRowReference
+<parameter name="string">
+<parameter_description> the label string. Must be non-%NULL.
</parameter_description>
</parameter>
</parameters>
-<return> A current path, or %NULL.
+<return> a new #GtkAccelLabel.
</return>
</function>
-<function name="gtk_text_buffer_insert">
+<function name="gtk_accel_label_refetch">
<description>
-Inserts @len bytes of @text at position @iter. If @len is -1,
- text must be nul-terminated and will be inserted in its
-entirety. Emits the "insert-text" signal; insertion actually occurs
-in the default handler for the signal. @iter is invalidated when
-insertion occurs (because the buffer contents change), but the
-default signal handler revalidates it to point to the end of the
-inserted text.
+Recreates the string representing the accelerator keys.
+This should not be needed since the string is automatically updated whenever
+accelerators are added or removed from the associated widget.
+
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> a position in the buffer
+<parameter name="accel_label">
+<parameter_description> a #GtkAccelLabel.
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> text in UTF-8 format
+</parameters>
+<return> always returns %FALSE.
+</return>
+</function>
+
+<function name="gtk_accel_label_set_accel_closure">
+<description>
+Sets the closure to be monitored by this accelerator label. The closure
+must be connected to an accelerator group; see gtk_accel_group_connect().
+
+</description>
+<parameters>
+<parameter name="accel_label">
+<parameter_description> a #GtkAccelLabel
</parameter_description>
</parameter>
-<parameter name="len">
-<parameter_description> length of text in bytes, or -1
+<parameter name="accel_closure">
+<parameter_description> the closure to monitor for accelerator changes.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_mount_operation_new">
+<function name="gtk_accel_label_set_accel_widget">
<description>
-Creates a new #GtkMountOperation
-
-Since: 2.14
+Sets the widget to be monitored by this accelerator label.
</description>
<parameters>
-<parameter name="parent">
-<parameter_description> transient parent of the window, or %NULL
+<parameter name="accel_label">
+<parameter_description> a #GtkAccelLabel
+</parameter_description>
+</parameter>
+<parameter name="accel_widget">
+<parameter_description> the widget to be monitored.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkMountOperation
-
-</return>
+<return></return>
</function>
-<function name="gtk_offscreen_window_get_pixbuf">
+<function name="gtk_accel_map_add_entry">
<description>
-Retrieves a snapshot of the contained widget in the form of
-a #GdkPixbuf. This is a new pixbuf with a reference count of 1,
-and the application should unreference it once it is no longer
-needed.
+Registers a new accelerator with the global accelerator map.
+This function should only be called once per @accel_path
+with the canonical @accel_key and @accel_mods for this path.
+To change the accelerator during runtime programatically, use
+gtk_accel_map_change_entry().
+The accelerator path must consist of "<WINDOWTYPE>/Category1/Category2/.../Action",
+where <WINDOWTYPE> should be a unique application-specific identifier, that
+corresponds to the kind of window the accelerator is being used in, e.g. "Gimp-Image",
+"Abiword-Document" or "Gnumeric-Settings".
+The Category1/.../Action portion is most appropriately chosen by the action the
+accelerator triggers, i.e. for accelerators on menu items, choose the item's menu path,
+e.g. "File/Save As", "Image/View/Zoom" or "Edit/Select All".
+So a full valid accelerator path may look like:
+"<Gimp-Toolbox>/File/Dialogs/Tool Options...".
-Since: 2.20
+Note that @accel_path string will be stored in a #GQuark. Therefore, if you
+pass a static string, you can save some memory by interning it first with
+g_intern_static_string().
</description>
<parameters>
-<parameter name="offscreen">
-<parameter_description> the #GtkOffscreenWindow contained widget.
+<parameter name="accel_path">
+<parameter_description> valid accelerator path
+</parameter_description>
+</parameter>
+<parameter name="accel_key">
+<parameter_description> the accelerator key
+</parameter_description>
+</parameter>
+<parameter name="accel_mods">
+<parameter_description> the accelerator modifiers
</parameter_description>
</parameter>
</parameters>
-<return> A #GdkPixbuf pointer, or %NULL.
-
-</return>
+<return></return>
</function>
-<function name="gtk_text_view_get_wrap_mode">
+<function name="gtk_accel_map_add_filter">
<description>
-Gets the line wrapping for the view.
+Adds a filter to the global list of accel path filters.
+Accel map entries whose accel path matches one of the filters
+are skipped by gtk_accel_map_foreach().
+
+This function is intended for GTK+ modules that create their own
+menus, but don't want them to be saved into the applications accelerator
+map dump.
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="filter_pattern">
+<parameter_description> a pattern (see #GPatternSpec)
</parameter_description>
</parameter>
</parameters>
-<return> the line wrap setting
-</return>
+<return></return>
</function>
-<function name="gtk_message_dialog_new_with_markup">
+<function name="gtk_accel_map_change_entry">
<description>
-Creates a new message dialog, which is a simple dialog with an icon
-indicating the dialog type (error, warning, etc.) and some text which
-is marked up with the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
-When the user clicks a button a "response" signal is emitted with
-response IDs from #GtkResponseType. See #GtkDialog for more details.
-
-Special XML characters in the printf() arguments passed to this
-function will automatically be escaped as necessary.
-(See g_markup_printf_escaped() for how this is implemented.)
-Usually this is what you want, but if you have an existing
-Pango markup string that you want to use literally as the
-label, then you need to use gtk_message_dialog_set_markup()
-instead, since you can't pass the markup string either
-as the format (it might contain '%' characters) or as a string
-argument.
-|[
-GtkWidget *dialog;
-dialog = gtk_message_dialog_new (main_application_window,
-GTK_DIALOG_DESTROY_WITH_PARENT,
-GTK_MESSAGE_ERROR,
-GTK_BUTTONS_CLOSE,
-NULL);
-gtk_message_dialog_set_markup (GTK_MESSAGE_DIALOG (dialog),
-markup);
-]|
+Changes the @accel_key and @accel_mods currently associated with @accel_path.
+Due to conflicts with other accelerators, a change may not always be possible,
+ replace indicates whether other accelerators may be deleted to resolve such
+conflicts. A change will only occur if all conflicts could be resolved (which
+might not be the case if conflicting accelerators are locked). Successful
+changes are indicated by a %TRUE return value.
-Since: 2.4
+Note that @accel_path string will be stored in a #GQuark. Therefore, if you
+pass a static string, you can save some memory by interning it first with
+g_intern_static_string().
</description>
<parameters>
-<parameter name="parent">
-<parameter_description> transient parent, or %NULL for none
+<parameter name="accel_path">
+<parameter_description> a valid accelerator path
</parameter_description>
</parameter>
-<parameter name="flags">
-<parameter_description> flags
+<parameter name="accel_key">
+<parameter_description> the new accelerator key
</parameter_description>
</parameter>
-<parameter name="type">
-<parameter_description> type of message
+<parameter name="accel_mods">
+<parameter_description> the new accelerator modifiers
</parameter_description>
</parameter>
-<parameter name="buttons">
-<parameter_description> set of buttons to use
+<parameter name="replace">
+<parameter_description> %TRUE if other accelerators may be deleted upon conflicts
</parameter_description>
</parameter>
-<parameter name="message_format">
-<parameter_description> printf()-style format string, or %NULL
+</parameters>
+<return> %TRUE if the accelerator could be changed, %FALSE otherwise
+</return>
+</function>
+
+<function name="gtk_accel_map_foreach">
+<description>
+Loops over the entries in the accelerator map whose accel path
+doesn't match any of the filters added with gtk_accel_map_add_filter(),
+and execute @foreach_func on each. The signature of @foreach_func is
+that of #GtkAccelMapForeach, the @changed parameter indicates whether
+this accelerator was changed during runtime (thus, would need
+saving during an accelerator map dump).
+
+</description>
+<parameters>
+<parameter name="data">
+<parameter_description> data to be passed into @foreach_func
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> arguments for @message_format
+<parameter name="foreach_func">
+<parameter_description> function to be executed for each accel map entry which
+is not filtered out
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkMessageDialog
-
-</return>
+<return></return>
</function>
-<function name="gtk_window_mnemonic_activate">
+<function name="gtk_accel_map_foreach_unfiltered">
<description>
-Activates the targets associated with the mnemonic.
+Loops over all entries in the accelerator map, and execute
+ foreach_func on each. The signature of @foreach_func is that of
+#GtkAccelMapForeach, the @changed parameter indicates whether
+this accelerator was changed during runtime (thus, would need
+saving during an accelerator map dump).
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
-</parameter_description>
-</parameter>
-<parameter name="keyval">
-<parameter_description> the mnemonic
+<parameter name="data">
+<parameter_description> data to be passed into @foreach_func
</parameter_description>
</parameter>
-<parameter name="modifier">
-<parameter_description> the modifiers
+<parameter name="foreach_func">
+<parameter_description> function to be executed for each accel map entry
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the activation is done.
-</return>
+<return></return>
</function>
-<function name="gtk_print_settings_get_use_color">
+<function name="gtk_accel_map_get">
<description>
-Gets the value of %GTK_PRINT_SETTINGS_USE_COLOR.
+Gets the singleton global #GtkAccelMap object. This object
+is useful only for notification of changes to the accelerator
+map via the ::changed signal; it isn't a parameter to the
+other accelerator map functions.
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
-</parameter_description>
-</parameter>
</parameters>
-<return> whether to use color
+<return> the global #GtkAccelMap object
</return>
</function>
-<function name="gtk_draw_vline">
+<function name="gtk_accel_map_load">
<description>
-Draws a vertical line from (@x, @y1_) to (@x, @y2_) in @window
-using the given style and state.
-
-Deprecated: 2.0: Use gtk_paint_vline() instead.
+Parses a file previously saved with gtk_accel_map_save() for
+accelerator specifications, and propagates them accordingly.
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
-</parameter_description>
-</parameter>
-<parameter name="y1_">
-<parameter_description> the starting y coordinate
-</parameter_description>
-</parameter>
-<parameter name="y2_">
-<parameter_description> the ending y coordinate
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> the x coordinate
+<parameter name="file_name">
+<parameter_description> a file containing accelerator specifications,
+in the GLib file name encoding
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_font_button_get_use_size">
+<function name="gtk_accel_map_load_fd">
<description>
-Returns whether the selected size is used in the label.
+Filedescriptor variant of gtk_accel_map_load().
-Since: 2.4
+Note that the file descriptor will not be closed by this function.
</description>
<parameters>
-<parameter name="font_button">
-<parameter_description> a #GtkFontButton
+<parameter name="fd">
+<parameter_description> a valid readable file descriptor
</parameter_description>
</parameter>
</parameters>
-<return> whether the selected size is used in the label.
-
-</return>
+<return></return>
</function>
-<function name="gtk_tree_view_get_search_position_func">
+<function name="gtk_accel_map_load_scanner">
<description>
-Returns the positioning function currently in use.
-
-Since: 2.10
+#GScanner variant of gtk_accel_map_load().
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView
+<parameter name="scanner">
+<parameter_description> a #GScanner which has already been provided with an input file
</parameter_description>
</parameter>
</parameters>
-<return> the currently used function for positioning the search dialog.
-
-</return>
+<return></return>
</function>
-<function name="gtk_ui_manager_remove_action_group">
+<function name="gtk_accel_map_lock_path">
<description>
-Removes an action group from the list of action groups associated
-with @self.
+Locks the given accelerator path. If the accelerator map doesn't yet contain
+an entry for @accel_path, a new one is created.
+
+Locking an accelerator path prevents its accelerator from being changed
+during runtime. A locked accelerator path can be unlocked by
+gtk_accel_map_unlock_path(). Refer to gtk_accel_map_change_entry()
+for information about runtime accelerator changes.
+
+If called more than once, @accel_path remains locked until
+gtk_accel_map_unlock_path() has been called an equivalent number
+of times.
+
+Note that locking of individual accelerator paths is independent from
+locking the #GtkAccelGroup containing them. For runtime accelerator
+changes to be possible both the accelerator path and its #GtkAccelGroup
+have to be unlocked.
Since: 2.4
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #GtkUIManager object
-</parameter_description>
-</parameter>
-<parameter name="action_group">
-<parameter_description> the action group to be removed
+<parameter name="accel_path">
+<parameter_description> a valid accelerator path
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_list_store_insert_before">
+<function name="gtk_accel_map_lookup_entry">
<description>
-Inserts a new row before @sibling. If @sibling is %NULL, then the row will
-be appended to the end of the list. @iter will be changed to point to this
-new row. The row will be empty after this function is called. To fill in
-values, you need to call gtk_list_store_set() or gtk_list_store_set_value().
-
+Looks up the accelerator entry for @accel_path and fills in @key.
</description>
<parameters>
-<parameter name="list_store">
-<parameter_description> A #GtkListStore
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> An unset #GtkTreeIter to set to the new row
+<parameter name="accel_path">
+<parameter_description> a valid accelerator path
</parameter_description>
</parameter>
-<parameter name="sibling">
-<parameter_description> A valid #GtkTreeIter, or %NULL
+<parameter name="key">
+<parameter_description> the accelerator key to be filled in (optional)
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @accel_path is known, %FALSE otherwise
+</return>
</function>
-<function name="gtk_button_new_with_mnemonic">
+<function name="gtk_accel_map_save">
<description>
-Creates a new #GtkButton containing a label.
-If characters in @label are preceded by an underscore, they are underlined.
-If you need a literal underscore character in a label, use '__' (two
-underscores). The first underlined character represents a keyboard
-accelerator called a mnemonic.
-Pressing Alt and that key activates the button.
+Saves current accelerator specifications (accelerator path, key
+and modifiers) to @file_name.
+The file is written in a format suitable to be read back in by
+gtk_accel_map_load().
</description>
<parameters>
-<parameter name="label">
-<parameter_description> The text of the button, with an underscore in front of the
-mnemonic character
+<parameter name="file_name">
+<parameter_description> the name of the file to contain accelerator specifications,
+in the GLib file name encoding
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkButton
-</return>
+<return></return>
</function>
-<function name="gtk_widget_map">
+<function name="gtk_accel_map_save_fd">
<description>
-This function is only for use in widget implementations. Causes
-a widget to be mapped if it isn't already.
+Filedescriptor variant of gtk_accel_map_save().
+
+Note that the file descriptor will not be closed by this function.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="fd">
+<parameter_description> a valid writable file descriptor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_info_get_builtin_pixbuf">
+<function name="gtk_accel_map_unlock_path">
<description>
-Gets the built-in image for this icon, if any. To allow
-GTK+ to use built in icon images, you must pass the
-%GTK_ICON_LOOKUP_USE_BUILTIN to
-gtk_icon_theme_lookup_icon().
+Undoes the last call to gtk_accel_map_lock_path() on this @accel_path.
+Refer to gtk_accel_map_lock_path() for information about accelerator path locking.
Since: 2.4
</description>
<parameters>
-<parameter name="icon_info">
-<parameter_description> a #GtkIconInfo structure
+<parameter name="accel_path">
+<parameter_description> a valid accelerator path
</parameter_description>
</parameter>
</parameters>
-<return> the built-in image pixbuf, or %NULL. No
-extra reference is added to the returned pixbuf, so if
-you want to keep it around, you must use g_object_ref().
-The returned image must not be modified.
+<return></return>
+</function>
+<function name="gtk_accelerator_get_default_mod_mask">
+<description>
+Gets the value set by gtk_accelerator_set_default_mod_mask().
+
+</description>
+<parameters>
+</parameters>
+<return> the default accelerator modifier mask
</return>
</function>
-<function name="gtk_menu_tool_button_new">
+<function name="gtk_accelerator_get_label">
<description>
-Creates a new #GtkMenuToolButton using @icon_widget as icon and
- label as label.
+Converts an accelerator keyval and modifier mask into a string
+which can be used to represent the accelerator to the user.
Since: 2.6
</description>
<parameters>
-<parameter name="icon_widget">
-<parameter_description> a widget that will be used as icon widget, or %NULL
+<parameter name="accelerator_key">
+<parameter_description> accelerator keyval
</parameter_description>
</parameter>
-<parameter name="label">
-<parameter_description> a string that will be used as label, or %NULL
+<parameter name="accelerator_mods">
+<parameter_description> accelerator modifier mask
</parameter_description>
</parameter>
</parameters>
-<return> the new #GtkMenuToolButton
+<return> a newly-allocated string representing the accelerator.
</return>
</function>
-<function name="gtk_file_chooser_set_show_hidden">
+<function name="gtk_accelerator_name">
<description>
-Sets whether hidden files and folders are displayed in the file selector.
+Converts an accelerator keyval and modifier mask
+into a string parseable by gtk_accelerator_parse().
+For example, if you pass in #GDK_q and #GDK_CONTROL_MASK,
+this function returns "<Control>q".
+
+If you need to display accelerators in the user interface,
+see gtk_accelerator_get_label().
-Since: 2.6
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="accelerator_key">
+<parameter_description> accelerator keyval
</parameter_description>
</parameter>
-<parameter name="show_hidden">
-<parameter_description> %TRUE if hidden files and folders should be displayed.
+<parameter name="accelerator_mods">
+<parameter_description> accelerator modifier mask
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a newly-allocated accelerator name
+</return>
</function>
-<function name="gtk_file_chooser_add_shortcut_folder">
+<function name="gtk_accelerator_parse">
<description>
-Adds a folder to be displayed with the shortcut folders in a file chooser.
-Note that shortcut folders do not get saved, as they are provided by the
-application. For example, you can use this to add a
-"/usr/share/mydrawprogram/Clipart" folder to the volume list.
+Parses a string representing an accelerator. The
+format looks like "<Control>a" or "<Shift><Alt>F1" or
+"<Release>z" (the last one is for key release).
+The parser is fairly liberal and allows lower or upper case,
+and also abbreviations such as "<Ctl>" and "<Ctrl>".
+Key names are parsed using gdk_keyval_from_name(). For character keys the
+name is not the symbol, but the lowercase name, e.g. one would use
+"<Ctrl>minus" instead of "<Ctrl>-".
-Since: 2.4
+If the parse fails, @accelerator_key and @accelerator_mods will
+be set to 0 (zero).
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="accelerator">
+<parameter_description> string representing an accelerator
</parameter_description>
</parameter>
-<parameter name="folder">
-<parameter_description> filename of the folder to add
+<parameter name="accelerator_key">
+<parameter_description> return location for accelerator keyval
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> location to store error, or %NULL
+<parameter name="accelerator_mods">
+<parameter_description> return location for accelerator modifier mask
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the folder could be added successfully, %FALSE
-otherwise. In the latter case, the @error will be set as appropriate.
-
-</return>
+<return></return>
</function>
-<function name="gtk_selection_data_set_uris">
+<function name="gtk_accelerator_set_default_mod_mask">
<description>
-Sets the contents of the selection from a list of URIs.
-The string is converted to the form determined by
- selection_data->target.
+Sets the modifiers that will be considered significant for keyboard
+accelerators. The default mod mask is #GDK_CONTROL_MASK |
+#GDK_SHIFT_MASK | #GDK_MOD1_MASK | #GDK_SUPER_MASK |
+#GDK_HYPER_MASK | #GDK_META_MASK, that is, Control, Shift, Alt,
+Super, Hyper and Meta. Other modifiers will by default be ignored
+by #GtkAccelGroup.
+You must include at least the three modifiers Control, Shift
+and Alt in any value you pass to this function.
-Since: 2.6
+The default mod mask should be changed on application startup,
+before using any accelerator groups.
</description>
<parameters>
-<parameter name="selection_data">
-<parameter_description> a #GtkSelectionData
+<parameter name="default_mod_mask">
+<parameter_description> accelerator modifier mask
</parameter_description>
</parameter>
-<parameter name="uris">
-<parameter_description> a %NULL-terminated array of strings holding URIs
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_accelerator_valid">
+<description>
+Determines whether a given keyval and modifier mask constitute
+a valid keyboard accelerator. For example, the #GDK_a keyval
+plus #GDK_CONTROL_MASK is valid - this is a "Ctrl+a" accelerator.
+But, you can't, for instance, use the #GDK_Control_L keyval
+as an accelerator.
+
+</description>
+<parameters>
+<parameter name="keyval">
+<parameter_description> a GDK keyval
+</parameter_description>
+</parameter>
+<parameter name="modifiers">
+<parameter_description> modifier mask
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the selection was successfully set,
-otherwise %FALSE.
-
+<return> %TRUE if the accelerator is valid
</return>
</function>
-<function name="gtk_widget_hide">
+<function name="gtk_accessible_connect_widget_destroyed">
<description>
-Reverses the effects of gtk_widget_show(), causing the widget to be
-hidden (invisible to the user).
+This function specifies the callback function to be called when the widget
+corresponding to a GtkAccessible is destroyed.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="accessible">
+<parameter_description> a #GtkAccessible
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_paper_size_new">
+<function name="gtk_accessible_get_widget">
<description>
-Creates a new #GtkPaperSize object by parsing a
-<ulink url="ftp://ftp.pwg.org/pub/pwg/candidates/cs-pwgmsn10-20020226-5101.1.pdf">PWG 5101.1-2002</ulink>
-paper name.
-
-If @name is %NULL, the default paper size is returned,
-see gtk_paper_size_get_default().
+Gets the #GtkWidget corresponding to the #GtkAccessible. The returned widget
+does not have a reference added, so you do not need to unref it.
-Since: 2.10
+Since: 2.22
</description>
<parameters>
-<parameter name="name">
-<parameter_description> a paper size name, or %NULL
+<parameter name="accessible">
+<parameter_description> a #GtkAccessible
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPaperSize, use gtk_paper_size_free()
-to free it
+<return> pointer to the #GtkWidget corresponding to
+the #GtkAccessible, or %NULL.
</return>
</function>
-<function name="gtk_range_set_flippable">
+<function name="gtk_accessible_set_widget">
<description>
-If a range is flippable, it will switch its direction if it is
-horizontal and its direction is %GTK_TEXT_DIR_RTL.
-
-See gtk_widget_get_direction().
+Sets the #GtkWidget corresponding to the #GtkAccessible.
-Since: 2.18
+Since: 2.22
</description>
<parameters>
-<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter name="accessible">
+<parameter_description> a #GtkAccessible
</parameter_description>
</parameter>
-<parameter name="flippable">
-<parameter_description> %TRUE to make the range flippable
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_spin_button_set_numeric">
+<function name="gtk_action_activate">
<description>
-Sets the flag that determines if non-numeric text can be typed into
-the spin button.
+Emits the "activate" signal on the specified action, if it isn't
+insensitive. This gets called by the proxy widgets when they get
+activated.
+
+It can also be used to manually activate an action.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
-</parameter_description>
-</parameter>
-<parameter name="numeric">
-<parameter_description> flag indicating if only numeric entry is allowed.
+<parameter name="action">
+<parameter_description> the action object
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_view_get_item_width">
+<function name="gtk_action_block_activate">
<description>
-Returns the value of the ::item-width property.
+Disable activation signals from the action
-Since: 2.6
+This is needed when updating the state of your proxy
+#GtkActivatable widget could result in calling gtk_action_activate(),
+this is a convenience function to avoid recursing in those
+cases (updating toggle state for instance).
+
+Since: 2.16
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
+<parameter name="action">
+<parameter_description> a #GtkAction
</parameter_description>
</parameter>
</parameters>
-<return> the width of a single item, or -1
-
-</return>
+<return></return>
</function>
-<function name="gtk_color_selection_dialog_get_color_selection">
+<function name="gtk_action_block_activate_from">
<description>
-Retrieves the #GtkColorSelection widget embedded in the dialog.
+Disables calls to the gtk_action_activate()
+function by signals on the given proxy widget. This is used to
+break notification loops for things like check or radio actions.
-Since: 2.14
+This function is intended for use by action implementations.
+
+Since: 2.4
+
+Deprecated: 2.16: activatables are now responsible for activating the
+action directly so this doesnt apply anymore.
</description>
<parameters>
-<parameter name="colorsel">
-<parameter_description> a #GtkColorSelectionDialog
+<parameter name="action">
+<parameter_description> the action object
+</parameter_description>
+</parameter>
+<parameter name="proxy">
+<parameter_description> a proxy widget
</parameter_description>
</parameter>
</parameters>
-<return> the embedded #GtkColorSelection
-
-</return>
+<return></return>
</function>
-<function name="gtk_container_set_focus_child">
+<function name="gtk_action_connect_accelerator">
<description>
-Sets, or unsets if @child is %NULL, the focused child of @container.
+Installs the accelerator for @action if @action has an
+accel path and group. See gtk_action_set_accel_path() and
+gtk_action_set_accel_group()
-This function emits the GtkContainer::set_focus_child signal of
- container Implementations of #GtkContainer can override the
-default behaviour by overriding the class closure of this signal.
+Since multiple proxies may independently trigger the installation
+of the accelerator, the @action counts the number of times this
+function has been called and doesn't remove the accelerator until
+gtk_action_disconnect_accelerator() has been called as many times.
-This is function is mostly meant to be used by widgets. Applications can use
-gtk_widget_grab_focus() to manualy set the focus to a specific widget.
+Since: 2.4
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
-</parameter_description>
-</parameter>
-<parameter name="child">
-<parameter_description> a #GtkWidget, or %NULL
+<parameter name="action">
+<parameter_description> a #GtkAction
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_expander_set_spacing">
+<function name="gtk_action_connect_proxy">
<description>
-Sets the spacing field of @expander, which is the number of pixels to
-place between expander and the child.
+Connects a widget to an action object as a proxy. Synchronises
+various properties of the action with the widget (such as label
+text, icon, tooltip, etc), and attaches a callback so that the
+action gets activated when the proxy widget does.
+
+If the widget is already connected to an action, it is disconnected
+first.
Since: 2.4
+Deprecated: 2.16: Use gtk_activatable_set_related_action() instead.
+
</description>
<parameters>
-<parameter name="expander">
-<parameter_description> a #GtkExpander
+<parameter name="action">
+<parameter_description> the action object
</parameter_description>
</parameter>
-<parameter name="spacing">
-<parameter_description> distance between the expander and child in pixels.
+<parameter name="proxy">
+<parameter_description> the proxy widget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_draw_box">
+<function name="gtk_action_create_icon">
<description>
-Draws a box on @window with the given parameters.
+This function is intended for use by action implementations to
+create icons displayed in the proxy widgets.
-Deprecated: 2.0: Use gtk_paint_box() instead.
+Since: 2.4
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
-</parameter_description>
-</parameter>
-<parameter name="shadow_type">
-<parameter_description> the type of shadow to draw
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> x origin of the box
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> y origin of the box
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> the width of the box
+<parameter name="action">
+<parameter_description> the action object
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> the height of the box
+<parameter name="icon_size">
+<parameter_description> the size of the icon that should be created.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a widget that displays the icon for this action.
+
+</return>
</function>
-<function name="gtk_icon_view_get_markup_column">
+<function name="gtk_action_create_menu">
<description>
-Returns the column with markup text for @icon_view.
+If @action provides a #GtkMenu widget as a submenu for the menu
+item or the toolbar item it creates, this function returns an
+instance of that menu.
-Since: 2.6
+Since: 2.12
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> A #GtkIconView.
+<parameter name="action">
+<parameter_description> a #GtkAction
</parameter_description>
</parameter>
</parameters>
-<return> the markup column, or -1 if it's unset.
+<return> the menu item provided by the action, or %NULL.
</return>
</function>
-<function name="gtk_image_get_icon_name">
+<function name="gtk_action_create_menu_item">
<description>
-Gets the icon name and size being displayed by the #GtkImage.
-The storage type of the image must be %GTK_IMAGE_EMPTY or
-%GTK_IMAGE_ICON_NAME (see gtk_image_get_storage_type()).
-The returned string is owned by the #GtkImage and should not
-be freed.
+Creates a menu item widget that proxies for the given action.
-Since: 2.6
+Since: 2.4
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GtkImage
+<parameter name="action">
+<parameter_description> the action object
</parameter_description>
</parameter>
-<parameter name="icon_name">
-<parameter_description> place to store an
-icon name, or %NULL
+</parameters>
+<return> a menu item connected to the action.
+
+</return>
+</function>
+
+<function name="gtk_action_create_tool_item">
+<description>
+Creates a toolbar item widget that proxies for the given action.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="action">
+<parameter_description> the action object
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> place to store an icon size,
-or %NULL
+</parameters>
+<return> a toolbar item connected to the action.
+
+</return>
+</function>
+
+<function name="gtk_action_disconnect_accelerator">
+<description>
+Undoes the effect of one call to gtk_action_connect_accelerator().
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="action">
+<parameter_description> a #GtkAction
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_view_get_window_type">
+<function name="gtk_action_disconnect_proxy">
<description>
-Usually used to find out which window an event corresponds to.
-If you connect to an event signal on @text_view, this function
-should be called on <literal>event->window</literal> to
-see which window it was.
+Disconnects a proxy widget from an action.
+Does <emphasis>not</emphasis> destroy the widget, however.
+Since: 2.4
+
+Deprecated: 2.16: Use gtk_activatable_set_related_action() instead.
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="action">
+<parameter_description> the action object
</parameter_description>
</parameter>
-<parameter name="window">
-<parameter_description> a window type
+<parameter name="proxy">
+<parameter_description> the proxy widget
</parameter_description>
</parameter>
</parameters>
-<return> the window type.
-</return>
+<return></return>
</function>
-<function name="gtk_accel_map_load_fd">
+<function name="gtk_action_get_accel_closure">
<description>
-Filedescriptor variant of gtk_accel_map_load().
+Returns the accel closure for this action.
+
+Since: 2.8
-Note that the file descriptor will not be closed by this function.
</description>
<parameters>
-<parameter name="fd">
-<parameter_description> a valid readable file descriptor
+<parameter name="action">
+<parameter_description> the action object
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the accel closure for this action. The returned closure is
+owned by GTK+ and must not be unreffed or modified.
+</return>
</function>
-<function name="gtk_text_view_get_indent">
+<function name="gtk_action_get_accel_path">
<description>
-Gets the default indentation of paragraphs in @text_view.
-Tags in the view's buffer may override the default.
-The indentation may be negative.
+Returns the accel path for this action.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="action">
+<parameter_description> the action object
</parameter_description>
</parameter>
</parameters>
-<return> number of pixels of indentation
+<return> the accel path for this action, or %NULL
+if none is set. The returned string is owned by GTK+
+and must not be freed or modified.
</return>
</function>
-<function name="gtk_action_is_visible">
+<function name="gtk_action_get_always_show_image">
<description>
-Returns whether the action is effectively visible.
+Returns whether @action<!-- -->'s menu item proxies will ignore the
+#GtkSettings:gtk-menu-images setting and always show their image,
+if available.
-Since: 2.4
+Since: 2.20
</description>
<parameters>
<parameter name="action">
-<parameter_description> the action object
+<parameter_description> a #GtkAction
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the action and its associated action group
-are both visible.
+<return> %TRUE if the menu item proxies will always show their image
</return>
</function>
-<function name="gtk_text_iter_backward_visible_lines">
+<function name="gtk_action_get_gicon">
<description>
-Moves @count visible lines backward, if possible (if @count would move
-past the start or end of the buffer, moves to the start or end of
-the buffer). The return value indicates whether the iterator moved
-onto a dereferenceable position; if the iterator didn't move, or
-moved onto the end iterator, then %FALSE is returned. If @count is 0,
-the function does nothing and returns %FALSE. If @count is negative,
-moves forward by 0 - @count lines.
+Gets the gicon of @action.
-Since: 2.8
+Since: 2.16
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
-</parameter_description>
-</parameter>
-<parameter name="count">
-<parameter_description> number of lines to move backward
+<parameter name="action">
+<parameter_description> a #GtkAction
</parameter_description>
</parameter>
</parameters>
-<return> whether @iter moved and is dereferenceable
+<return> The action's #GIcon if one is set.
</return>
</function>
-<function name="gtk_tree_view_column_get_resizable">
+<function name="gtk_action_get_icon_name">
<description>
-Returns %TRUE if the @tree_column can be resized by the end user.
+Gets the icon name of @action.
+Since: 2.16
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn
+<parameter name="action">
+<parameter_description> a #GtkAction
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE, if the @tree_column can be resized.
+<return> the icon name
+
</return>
</function>
-<function name="gtk_list_store_insert">
+<function name="gtk_action_get_is_important">
<description>
-Creates a new row at @position. @iter will be changed to point to this new
-row. If @position is larger than the number of rows on the list, then the
-new row will be appended to the list. The row will be empty after this
-function is called. To fill in values, you need to call
-gtk_list_store_set() or gtk_list_store_set_value().
+Checks whether @action is important or not
+Since: 2.16
</description>
<parameters>
-<parameter name="list_store">
-<parameter_description> A #GtkListStore
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> An unset #GtkTreeIter to set to the new row
-</parameter_description>
-</parameter>
-<parameter name="position">
-<parameter_description> position to insert the new row
+<parameter name="action">
+<parameter_description> a #GtkAction
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether @action is important
+
+</return>
</function>
-<function name="gtk_recent_chooser_set_show_numbers">
+<function name="gtk_action_get_label">
<description>
-Whether to show recently used resources prepended by a unique number.
-
-Deprecated: 2.12: Use gtk_recent_chooser_menu_set_show_numbers() instead.
+Gets the label text of @action.
-Since: 2.10
+Since: 2.16
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
-</parameter_description>
-</parameter>
-<parameter name="show_numbers">
-<parameter_description> %TRUE to show numbers, %FALSE otherwise
+<parameter name="action">
+<parameter_description> a #GtkAction
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the label text
+
+</return>
</function>
-<function name="gtk_tool_item_group_get_n_items">
+<function name="gtk_action_get_name">
<description>
-Gets the number of tool items in @group.
+Returns the name of the action.
-Since: 2.20
+Since: 2.4
</description>
<parameters>
-<parameter name="group">
-<parameter_description> a #GtkToolItemGroup
+<parameter name="action">
+<parameter_description> the action object
</parameter_description>
</parameter>
</parameters>
-<return> the number of tool items in @group
+<return> the name of the action. The string belongs to GTK+ and should not
+be freed.
</return>
</function>
-<function name="gtk_test_find_widget">
+<function name="gtk_action_get_proxies">
<description>
-This function will search the descendants of @widget for a widget
-of type @widget_type that has a label matching @label_pattern next
-to it. This is most useful for automated GUI testing, e.g. to find
-the "OK" button in a dialog and synthesize clicks on it.
-However see gtk_test_find_label(), gtk_test_find_sibling() and
-gtk_test_widget_click() for possible caveats involving the search of
-such widgets and synthesizing widget events.
+Returns the proxy widgets for an action.
+See also gtk_widget_get_action().
-Since: 2.14
+Since: 2.4
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> Container widget, usually a GtkWindow.
-</parameter_description>
-</parameter>
-<parameter name="label_pattern">
-<parameter_description> Shell-glob pattern to match a label string.
-</parameter_description>
-</parameter>
-<parameter name="widget_type">
-<parameter_description> Type of a aearched for label sibling widget.
+<parameter name="action">
+<parameter_description> the action object
</parameter_description>
</parameter>
</parameters>
-<return> a valid widget if any is found or %NULL.
+<return> a #GSList of proxy widgets. The list is owned by GTK+
+and must not be modified.
</return>
</function>
-<function name="gtk_entry_buffer_new">
+<function name="gtk_action_get_sensitive">
<description>
-Create a new GtkEntryBuffer object.
-
-Optionally, specify initial text to set in the buffer.
+Returns whether the action itself is sensitive. Note that this doesn't
+necessarily mean effective sensitivity. See gtk_action_is_sensitive()
+for that.
-Since: 2.18
+Since: 2.4
</description>
<parameters>
-<parameter name="initial_chars">
-<parameter_description> initial buffer text, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="n_initial_chars">
-<parameter_description> number of characters in @initial_chars, or -1
+<parameter name="action">
+<parameter_description> the action object
</parameter_description>
</parameter>
</parameters>
-<return> A new GtkEntryBuffer object.
+<return> %TRUE if the action itself is sensitive.
</return>
</function>
-<function name="gtk_selection_data_get_target">
+<function name="gtk_action_get_short_label">
<description>
-Retrieves the target of the selection.
+Gets the short label text of @action.
-Since: 2.14
+Since: 2.16
</description>
<parameters>
-<parameter name="selection_data">
-<parameter_description> a pointer to a #GtkSelectionData structure.
+<parameter name="action">
+<parameter_description> a #GtkAction
</parameter_description>
</parameter>
</parameters>
-<return> the target of the selection.
+<return> the short label text.
</return>
</function>
-<function name="gtk_widget_unmap">
+<function name="gtk_action_get_stock_id">
<description>
-This function is only for use in widget implementations. Causes
-a widget to be unmapped if it's currently mapped.
+Gets the stock id of @action.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="action">
+<parameter_description> a #GtkAction
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the stock id
+
+</return>
</function>
-<function name="gtk_toggle_button_new_with_mnemonic">
+<function name="gtk_action_get_tooltip">
<description>
-Creates a new #GtkToggleButton containing a label. The label
-will be created using gtk_label_new_with_mnemonic(), so underscores
-in @label indicate the mnemonic for the button.
+Gets the tooltip text of @action.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="label">
-<parameter_description> the text of the button, with an underscore in front of the
-mnemonic character
+<parameter name="action">
+<parameter_description> a #GtkAction
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkToggleButton
+<return> the tooltip text
+
</return>
</function>
-<function name="gtk_print_settings_set_number_up">
+<function name="gtk_action_get_visible">
<description>
-Sets the value of %GTK_PRINT_SETTINGS_NUMBER_UP.
+Returns whether the action itself is visible. Note that this doesn't
+necessarily mean effective visibility. See gtk_action_is_sensitive()
+for that.
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
-</parameter_description>
-</parameter>
-<parameter name="number_up">
-<parameter_description> the number of pages per sheet
+<parameter name="action">
+<parameter_description> the action object
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the action itself is visible.
+
+</return>
</function>
-<function name="gtk_paint_arrow">
+<function name="gtk_action_get_visible_horizontal">
<description>
-Draws an arrow in the given rectangle on @window using the given
-parameters. @arrow_type determines the direction of the arrow.
+Checks whether @action is visible when horizontal
+
+Since: 2.16
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
-</parameter_description>
-</parameter>
-<parameter name="shadow_type">
-<parameter_description> the type of shadow to draw
-</parameter_description>
-</parameter>
-<parameter name="area">
-<parameter_description> clip rectangle, or %NULL if the
-output should not be clipped
-</parameter_description>
-</parameter>
-<parameter name="widget">
-<parameter_description> the widget
-</parameter_description>
-</parameter>
-<parameter name="detail">
-<parameter_description> a style detail
-</parameter_description>
-</parameter>
-<parameter name="arrow_type">
-<parameter_description> the type of arrow to draw
-</parameter_description>
-</parameter>
-<parameter name="fill">
-<parameter_description> %TRUE if the arrow tip should be filled
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> x origin of the rectangle to draw the arrow in
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> y origin of the rectangle to draw the arrow in
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> width of the rectangle to draw the arrow in
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> height of the rectangle to draw the arrow in
+<parameter name="action">
+<parameter_description> a #GtkAction
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether @action is visible when horizontal
+
+</return>
</function>
-<function name="gtk_action_unblock_activate">
+<function name="gtk_action_get_visible_vertical">
<description>
-Reenable activation signals from the action
+Checks whether @action is visible when horizontal
Since: 2.16
@@ -2256,393 +2220,475 @@ Since: 2.16
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether @action is visible when horizontal
+
+</return>
</function>
-<function name="gtk_tree_row_reference_deleted">
+<function name="gtk_action_group_add_action">
<description>
-Lets a set of row reference created by gtk_tree_row_reference_new_proxy()
-know that the model emitted the "row_deleted" signal.
+Adds an action object to the action group. Note that this function
+does not set up the accel path of the action, which can lead to problems
+if a user tries to modify the accelerator of a menuitem associated with
+the action. Therefore you must either set the accel path yourself with
+gtk_action_set_accel_path(), or use
+<literal>gtk_action_group_add_action_with_accel (..., NULL)</literal>.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="proxy">
-<parameter_description> A #GObject
+<parameter name="action_group">
+<parameter_description> the action group
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> The path position that was deleted
+<parameter name="action">
+<parameter_description> an action
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_binding_entry_add_signal">
+<function name="gtk_action_group_add_action_with_accel">
<description>
-Override or install a new key binding for @keyval with @modifiers on
- binding_set When the binding is activated, @signal_name will be
-emitted on the target widget, with @n_args @Varargs used as
-arguments.
+Adds an action object to the action group and sets up the accelerator.
+
+If @accelerator is %NULL, attempts to use the accelerator associated
+with the stock_id of the action.
+
+Accel paths are set to
+<literal><Actions>/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="binding_set">
-<parameter_description> a #GtkBindingSet to install an entry for
+<parameter name="action_group">
+<parameter_description> the action group
</parameter_description>
</parameter>
-<parameter name="keyval">
-<parameter_description> key value of binding to install
+<parameter name="action">
+<parameter_description> the action to add
</parameter_description>
</parameter>
-<parameter name="modifiers">
-<parameter_description> key modifier of binding to install
+<parameter name="accelerator">
+<parameter_description> the accelerator for the action, in
+the format understood by gtk_accelerator_parse(), or "" for no accelerator, or
+%NULL to use the stock accelerator
</parameter_description>
</parameter>
-<parameter name="signal_name">
-<parameter_description> signal to execute upon activation
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_action_group_add_actions">
+<description>
+This is a convenience function to create a number of actions and add them
+to the action group.
+
+The "activate" signals of the actions are connected to the callbacks and
+their accel paths are set to
+<literal><Actions>/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="action_group">
+<parameter_description> the action group
</parameter_description>
</parameter>
-<parameter name="n_args">
-<parameter_description> number of arguments to @signal_name
+<parameter name="entries">
+<parameter_description> an array of action descriptions
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> arguments to @signal_name
+<parameter name="n_entries">
+<parameter_description> the number of entries
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> data to pass to the action callbacks
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_set_enable_search">
+<function name="gtk_action_group_add_actions_full">
<description>
-If @enable_search is set, then the user can type in text to search through
-the tree interactively (this is sometimes called "typeahead find").
+This variant of gtk_action_group_add_actions() adds a #GDestroyNotify
+callback for @user_data.
-Note that even if this is %FALSE, the user can still initiate a search
-using the "start-interactive-search" key binding.
+Since: 2.4
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView
+<parameter name="action_group">
+<parameter_description> the action group
</parameter_description>
</parameter>
-<parameter name="enable_search">
-<parameter_description> %TRUE, if the user can search interactively
+<parameter name="entries">
+<parameter_description> an array of action descriptions
+</parameter_description>
+</parameter>
+<parameter name="n_entries">
+<parameter_description> the number of entries
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> data to pass to the action callbacks
+</parameter_description>
+</parameter>
+<parameter name="destroy">
+<parameter_description> destroy notification callback for @user_data
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_set_tooltip_window">
+<function name="gtk_action_group_add_radio_actions">
<description>
-Replaces the default, usually yellow, window used for displaying
-tooltips with @custom_window. GTK+ will take care of showing and
-hiding @custom_window at the right moment, to behave likewise as
-the default tooltip window. If @custom_window is %NULL, the default
-tooltip window will be used.
+This is a convenience routine to create a group of radio actions and
+add them to the action group.
-If the custom window should have the default theming it needs to
-have the name "gtk-tooltip", see gtk_widget_set_name().
+The "changed" signal of the first radio action is connected to the
+ on_change callback and the accel paths of the actions are set to
+<literal><Actions>/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.
-Since: 2.12
+Since: 2.4
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="action_group">
+<parameter_description> the action group
</parameter_description>
</parameter>
-<parameter name="custom_window">
-<parameter_description> a #GtkWindow, or %NULL
+<parameter name="entries">
+<parameter_description> an array of radio action descriptions
+</parameter_description>
+</parameter>
+<parameter name="n_entries">
+<parameter_description> the number of entries
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> the value of the action to activate initially, or -1 if
+no action should be activated
+</parameter_description>
+</parameter>
+<parameter name="on_change">
+<parameter_description> the callback to connect to the changed signal
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> data to pass to the action callbacks
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_rc_reparse_all_for_settings">
+<function name="gtk_action_group_add_radio_actions_full">
<description>
-If the modification time on any previously read file
-for the given #GtkSettings has changed, discard all style information
-and then reread all previously read RC files.
+This variant of gtk_action_group_add_radio_actions() adds a
+#GDestroyNotify callback for @user_data.
+Since: 2.4
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkSettings
+<parameter name="action_group">
+<parameter_description> the action group
</parameter_description>
</parameter>
-<parameter name="force_load">
-<parameter_description> load whether or not anything changed
+<parameter name="entries">
+<parameter_description> an array of radio action descriptions
+</parameter_description>
+</parameter>
+<parameter name="n_entries">
+<parameter_description> the number of entries
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> the value of the action to activate initially, or -1 if
+no action should be activated
+</parameter_description>
+</parameter>
+<parameter name="on_change">
+<parameter_description> the callback to connect to the changed signal
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> data to pass to the action callbacks
+</parameter_description>
+</parameter>
+<parameter name="destroy">
+<parameter_description> destroy notification callback for @user_data
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the files were reread.
-</return>
+<return></return>
</function>
-<function name="gtk_toolbar_set_show_arrow">
+<function name="gtk_action_group_add_toggle_actions">
<description>
-Sets whether to show an overflow menu when
- toolbar doesn't have room for all items on it. If %TRUE,
-items that there are not room are available through an
-overflow menu.
+This is a convenience function to create a number of toggle actions and add them
+to the action group.
+
+The "activate" signals of the actions are connected to the callbacks and
+their accel paths are set to
+<literal><Actions>/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.
Since: 2.4
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar
+<parameter name="action_group">
+<parameter_description> the action group
</parameter_description>
</parameter>
-<parameter name="show_arrow">
-<parameter_description> Whether to show an overflow menu
+<parameter name="entries">
+<parameter_description> an array of toggle action descriptions
+</parameter_description>
+</parameter>
+<parameter name="n_entries">
+<parameter_description> the number of entries
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> data to pass to the action callbacks
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_sortable_set_sort_func">
+<function name="gtk_action_group_add_toggle_actions_full">
<description>
-Sets the comparison function used when sorting to be @sort_func. If the
-current sort column id of @sortable is the same as @sort_column_id, then
-the model will sort using this function.
+This variant of gtk_action_group_add_toggle_actions() adds a
+#GDestroyNotify callback for @user_data.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="sortable">
-<parameter_description> A #GtkTreeSortable
+<parameter name="action_group">
+<parameter_description> the action group
</parameter_description>
</parameter>
-<parameter name="sort_column_id">
-<parameter_description> the sort column id to set the function for
+<parameter name="entries">
+<parameter_description> an array of toggle action descriptions
</parameter_description>
</parameter>
-<parameter name="sort_func">
-<parameter_description> The comparison function
+<parameter name="n_entries">
+<parameter_description> the number of entries
</parameter_description>
</parameter>
<parameter name="user_data">
-<parameter_description> User data to pass to @sort_func, or %NULL
+<parameter_description> data to pass to the action callbacks
</parameter_description>
</parameter>
<parameter name="destroy">
-<parameter_description> Destroy notifier of @user_data, or %NULL
+<parameter_description> destroy notification callback for @user_data
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_notebook_get_menu_label">
+<function name="gtk_action_group_get_action">
<description>
-Retrieves the menu label widget of the page containing @child.
+Looks up an action in the action group by name.
+Since: 2.4
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="action_group">
+<parameter_description> the action group
</parameter_description>
</parameter>
-<parameter name="child">
-<parameter_description> a widget contained in a page of @notebook
+<parameter name="action_name">
+<parameter_description> the name of the action
</parameter_description>
</parameter>
</parameters>
-<return> the menu label, or %NULL if the
-notebook page does not have a menu label other
-than the default (the tab label).
+<return> the action, or %NULL if no action by that name exists
+
</return>
</function>
-<function name="gtk_drag_source_add_image_targets">
+<function name="gtk_action_group_get_name">
<description>
-Add the writable image targets supported by #GtkSelection to
-the target list of the drag source. The targets
-are added with @info = 0. If you need another value,
-use gtk_target_list_add_image_targets() and
-gtk_drag_source_set_target_list().
+Gets the name of the action group.
-Since: 2.6
+Since: 2.4
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget that's is a drag source
+<parameter name="action_group">
+<parameter_description> the action group
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the name of the action group.
+
+</return>
</function>
-<function name="gtk_expander_new_with_mnemonic">
+<function name="gtk_action_group_get_sensitive">
<description>
-Creates a new expander using @label as the text of the label.
-If characters in @label are preceded by an underscore, they are underlined.
-If you need a literal underscore character in a label, use '__' (two
-underscores). The first underlined character represents a keyboard
-accelerator called a mnemonic.
-Pressing Alt and that key activates the button.
+Returns %TRUE if the group is sensitive. The constituent actions
+can only be logically sensitive (see gtk_action_is_sensitive()) if
+they are sensitive (see gtk_action_get_sensitive()) and their group
+is sensitive.
Since: 2.4
</description>
<parameters>
-<parameter name="label">
-<parameter_description> the text of the label with an underscore in front of the
-mnemonic character
+<parameter name="action_group">
+<parameter_description> the action group
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkExpander widget.
+<return> %TRUE if the group is sensitive.
</return>
</function>
-<function name="gtk_image_menu_item_new_with_mnemonic">
+<function name="gtk_action_group_get_visible">
<description>
-Creates a new #GtkImageMenuItem containing a label. The label
-will be created using gtk_label_new_with_mnemonic(), so underscores
-in @label indicate the mnemonic for the menu item.
+Returns %TRUE if the group is visible. The constituent actions
+can only be logically visible (see gtk_action_is_visible()) if
+they are visible (see gtk_action_get_visible()) and their group
+is visible.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="label">
-<parameter_description> the text of the menu item, with an underscore in front of the
-mnemonic character
+<parameter name="action_group">
+<parameter_description> the action group
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkImageMenuItem
+<return> %TRUE if the group is visible.
+
</return>
</function>
-<function name="gtk_style_get_valist">
+<function name="gtk_action_group_list_actions">
<description>
-Non-vararg variant of gtk_style_get().
-Used primarily by language bindings.
+Lists the actions in the action group.
-Since: 2.16
+Since: 2.4
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="widget_type">
-<parameter_description> the #GType of a descendant of #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="first_property_name">
-<parameter_description> the name of the first style property to get
-</parameter_description>
-</parameter>
-<parameter name="var_args">
-<parameter_description> a <type>va_list</type> of pairs of property names and
-locations to return the property values, starting with the
-location for @first_property_name.
+<parameter name="action_group">
+<parameter_description> the action group
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> an allocated list of the action objects in the action group
+
+</return>
</function>
-<function name="gtk_label_get_attributes">
+<function name="gtk_action_group_new">
<description>
-Gets the attribute list that was set on the label using
-gtk_label_set_attributes(), if any. This function does
-not reflect attributes that come from the labels markup
-(see gtk_label_set_markup()). If you want to get the
-effective attributes for the label, use
-pango_layout_get_attribute (gtk_label_get_layout (label)).
+Creates a new #GtkActionGroup object. The name of the action group
+is used when associating <link linkend="Action-Accel">keybindings</link>
+with the actions.
+Since: 2.4
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="name">
+<parameter_description> the name of the action group.
</parameter_description>
</parameter>
</parameters>
-<return> the attribute list, or %NULL if none was set.
+<return> the new #GtkActionGroup
+
</return>
</function>
-<function name="gtk_about_dialog_set_website_label">
+<function name="gtk_action_group_remove_action">
<description>
-Sets the label to be used for the website link.
-It defaults to the website URL.
+Removes an action object from the action group.
-Since: 2.6
+Since: 2.4
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter name="action_group">
+<parameter_description> the action group
</parameter_description>
</parameter>
-<parameter name="website_label">
-<parameter_description> the label used for the website link
+<parameter name="action">
+<parameter_description> an action
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_item_factory_create_item">
+<function name="gtk_action_group_set_sensitive">
<description>
-Creates an item for @entry.
+Changes the sensitivity of @action_group
-Deprecated: 2.4: Use #GtkUIManager instead.
+Since: 2.4
</description>
<parameters>
-<parameter name="ifactory">
-<parameter_description> a #GtkItemFactory
-</parameter_description>
-</parameter>
-<parameter name="entry">
-<parameter_description> the #GtkItemFactoryEntry to create an item for
-</parameter_description>
-</parameter>
-<parameter name="callback_data">
-<parameter_description> data passed to the callback function of @entry
+<parameter name="action_group">
+<parameter_description> the action group
</parameter_description>
</parameter>
-<parameter name="callback_type">
-<parameter_description> 1 if the callback function of @entry is of type
-#GtkItemFactoryCallback1, 2 if it is of type #GtkItemFactoryCallback2
+<parameter name="sensitive">
+<parameter_description> new sensitivity
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_menu_get_accel_path">
+<function name="gtk_action_group_set_translate_func">
<description>
-Retrieves the accelerator path set on the menu.
+Sets a function to be used for translating the @label and @tooltip of
+#GtkActionGroupEntry<!-- -->s added by gtk_action_group_add_actions().
-Since: 2.14
+If you're using gettext(), it is enough to set the translation domain
+with gtk_action_group_set_translation_domain().
+
+Since: 2.4
</description>
<parameters>
-<parameter name="menu">
-<parameter_description> a valid #GtkMenu
+<parameter name="action_group">
+<parameter_description> a #GtkActionGroup
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> a #GtkTranslateFunc
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to be passed to @func and @notify
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> a #GDestroyNotify function to be called when @action_group is
+destroyed and when the translation function is changed again
</parameter_description>
</parameter>
</parameters>
-<return> the accelerator path set on the menu.
-
-</return>
+<return></return>
</function>
<function name="gtk_action_group_set_translation_domain">
@@ -2670,2138 +2716,2130 @@ Since: 2.4
<return></return>
</function>
-<function name="gtk_entry_get_completion">
+<function name="gtk_action_group_set_visible">
<description>
-Returns the auxiliary completion object currently in use by @entry.
+Changes the visible of @action_group.
Since: 2.4
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> A #GtkEntry
+<parameter name="action_group">
+<parameter_description> the action group
+</parameter_description>
+</parameter>
+<parameter name="visible">
+<parameter_description> new visiblity
</parameter_description>
</parameter>
</parameters>
-<return> The auxiliary completion object currently in use by @entry.
-
-</return>
+<return></return>
</function>
-<function name="gtk_tree_view_get_vadjustment">
+<function name="gtk_action_group_translate_string">
<description>
-Gets the #GtkAdjustment currently being used for the vertical aspect.
+Translates a string using the specified translate_func(). This
+is mainly intended for language bindings.
+Since: 2.6
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView
+<parameter name="action_group">
+<parameter_description> a #GtkActionGroup
+</parameter_description>
+</parameter>
+<parameter name="string">
+<parameter_description> a string
</parameter_description>
</parameter>
</parameters>
-<return> A #GtkAdjustment object, or %NULL if none is currently being
-used.
+<return> the translation of @string
+
</return>
</function>
-<function name="gtk_fixed_set_has_window">
+<function name="gtk_action_is_sensitive">
<description>
-Sets whether a #GtkFixed widget is created with a separate
-#GdkWindow for @widget->window or not. (By default, it will be
-created with no separate #GdkWindow). This function must be called
-while the #GtkFixed is not realized, for instance, immediately after the
-window is created.
-
-This function was added to provide an easy migration path for
-older applications which may expect #GtkFixed to have a separate window.
+Returns whether the action is effectively sensitive.
-Deprecated: 2.20: Use gtk_widget_set_has_window() instead.
+Since: 2.4
</description>
<parameters>
-<parameter name="fixed">
-<parameter_description> a #GtkFixed
-</parameter_description>
-</parameter>
-<parameter name="has_window">
-<parameter_description> %TRUE if a separate window should be created
+<parameter name="action">
+<parameter_description> the action object
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the action and its associated action group
+are both sensitive.
+
+</return>
</function>
-<function name="gtk_color_selection_get_current_alpha">
+<function name="gtk_action_is_visible">
<description>
-Returns the current alpha value.
+Returns whether the action is effectively visible.
+Since: 2.4
</description>
<parameters>
-<parameter name="colorsel">
-<parameter_description> a #GtkColorSelection.
+<parameter name="action">
+<parameter_description> the action object
</parameter_description>
</parameter>
</parameters>
-<return> an integer between 0 and 65535.
+<return> %TRUE if the action and its associated action group
+are both visible.
+
</return>
</function>
-<function name="gtk_window_get_default_icon_list">
+<function name="gtk_action_new">
<description>
-Gets the value set by gtk_window_set_default_icon_list().
-The list is a copy and should be freed with g_list_free(),
-but the pixbufs in the list have not had their reference count
-incremented.
+Creates a new #GtkAction object. To add the action to a
+#GtkActionGroup and set the accelerator for the action,
+call gtk_action_group_add_action_with_accel().
+See <xref linkend="XML-UI"/> for information on allowed action
+names.
+Since: 2.4
</description>
<parameters>
+<parameter name="name">
+<parameter_description> A unique name for the action
+</parameter_description>
+</parameter>
+<parameter name="label">
+<parameter_description> the label displayed in menu items and on buttons, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="tooltip">
+<parameter_description> a tooltip for the action, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="stock_id">
+<parameter_description> the stock icon to display in widgets representing the
+action, or %NULL
+</parameter_description>
+</parameter>
</parameters>
-<return> copy of default icon list
+<return> a new #GtkAction
+
</return>
</function>
-<function name="gtk_label_set_use_markup">
+<function name="gtk_action_set_accel_group">
<description>
-Sets whether the text of the label contains markup in <link
-linkend="PangoMarkupFormat">Pango's text markup
-language</link>. See gtk_label_set_markup().
+Sets the #GtkAccelGroup in which the accelerator for this action
+will be installed.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="action">
+<parameter_description> the action object
</parameter_description>
</parameter>
-<parameter name="setting">
-<parameter_description> %TRUE if the label's text should be parsed for markup.
+<parameter name="accel_group">
+<parameter_description> a #GtkAccelGroup or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_get_enable_tree_lines">
+<function name="gtk_action_set_accel_path">
<description>
-Returns whether or not tree lines are drawn in @tree_view.
+Sets the accel path for this action. All proxy widgets associated
+with the action will have this accel path, so that their
+accelerators are consistent.
-Since: 2.10
+Note that @accel_path string will be stored in a #GQuark. Therefore, if you
+pass a static string, you can save some memory by interning it first with
+g_intern_static_string().
+
+Since: 2.4
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView.
+<parameter name="action">
+<parameter_description> the action object
+</parameter_description>
+</parameter>
+<parameter name="accel_path">
+<parameter_description> the accelerator path
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if tree lines are drawn in @tree_view, %FALSE
-otherwise.
-
-</return>
+<return></return>
</function>
-<function name="gtk_widget_set_events">
+<function name="gtk_action_set_always_show_image">
<description>
-Sets the event mask (see #GdkEventMask) for a widget. The event
-mask determines which events a widget will receive. Keep in mind
-that different widgets have different default event masks, and by
-changing the event mask you may disrupt a widget's functionality,
-so be careful. This function must be called while a widget is
-unrealized. Consider gtk_widget_add_events() for widgets that are
-already realized, or if you want to preserve the existing event
-mask. This function can't be used with #GTK_NO_WINDOW widgets;
-to get events on those widgets, place them inside a #GtkEventBox
-and receive events on the event box.
+Sets whether @action<!-- -->'s menu item proxies will ignore the
+#GtkSettings:gtk-menu-images setting and always show their image, if available.
+
+Use this if the menu item would be useless or hard to use
+without their image.
+
+Since: 2.20
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="action">
+<parameter_description> a #GtkAction
</parameter_description>
</parameter>
-<parameter name="events">
-<parameter_description> event mask
+<parameter name="always_show">
+<parameter_description> %TRUE if menuitem proxies should always show their image
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_delete_selection">
+<function name="gtk_action_set_gicon">
<description>
-Deletes the range between the "insert" and "selection_bound" marks,
-that is, the currently-selected text. If @interactive is %TRUE,
-the editability of the selection will be considered (users can't delete
-uneditable text).
+Sets the icon of @action.
+Since: 2.16
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="interactive">
-<parameter_description> whether the deletion is caused by user interaction
+<parameter name="action">
+<parameter_description> a #GtkAction
</parameter_description>
</parameter>
-<parameter name="default_editable">
-<parameter_description> whether the buffer is editable by default
+<parameter name="icon">
+<parameter_description> the #GIcon to set
</parameter_description>
</parameter>
</parameters>
-<return> whether there was a non-empty selection to delete
-</return>
+<return></return>
</function>
-<function name="gtk_print_settings_get_int_with_default">
+<function name="gtk_action_set_icon_name">
<description>
-Returns the value of @key, interpreted as
-an integer, or the default value.
+Sets the icon name on @action
-Since: 2.10
+Since: 2.16
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
+<parameter name="action">
+<parameter_description> a #GtkAction
</parameter_description>
</parameter>
-<parameter name="def">
-<parameter_description> the default value
+<parameter name="icon_name">
+<parameter_description> the icon name to set
</parameter_description>
</parameter>
</parameters>
-<return> the integer value of @key
-
-</return>
+<return></return>
</function>
-<function name="gtk_text_iter_starts_word">
+<function name="gtk_action_set_is_important">
<description>
-Determines whether @iter begins a natural-language word. Word
-breaks are determined by Pango and should be correct for nearly any
-language (if not, the correct fix would be to the Pango word break
-algorithms).
+Sets whether the action is important, this attribute is used
+primarily by toolbar items to decide whether to show a label
+or not.
+Since: 2.16
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="action">
+<parameter_description> the action object
+</parameter_description>
+</parameter>
+<parameter name="is_important">
+<parameter_description> %TRUE to make the action important
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter is at the start of a word
-</return>
+<return></return>
</function>
-<function name="gtk_tree_view_column_set_sizing">
+<function name="gtk_action_set_label">
<description>
-Sets the growth behavior of @tree_column to @type.
+Sets the label of @action.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn.
+<parameter name="action">
+<parameter_description> a #GtkAction
</parameter_description>
</parameter>
-<parameter name="type">
-<parameter_description> The #GtkTreeViewColumnSizing.
+<parameter name="label">
+<parameter_description> the label text to set
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_drag_set_icon_widget">
+<function name="gtk_action_set_sensitive">
<description>
-Changes the icon for a widget to a given widget. GTK+
-will not destroy the icon, so if you don't want
-it to persist, you should connect to the "drag-end"
-signal and destroy it yourself.
+Sets the ::sensitive property of the action to @sensitive. Note that
+this doesn't necessarily mean effective sensitivity. See
+gtk_action_is_sensitive()
+for that.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="context">
-<parameter_description> the context for a drag. (This must be called
- with a context for the source side of a drag)
-</parameter_description>
-</parameter>
-<parameter name="widget">
-<parameter_description> a toplevel window to use as an icon.
-</parameter_description>
-</parameter>
-<parameter name="hot_x">
-<parameter_description> the X offset within @widget of the hotspot.
+<parameter name="action">
+<parameter_description> the action object
</parameter_description>
</parameter>
-<parameter name="hot_y">
-<parameter_description> the Y offset within @widget of the hotspot.
+<parameter name="sensitive">
+<parameter_description> %TRUE to make the action sensitive
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_vruler_new">
+<function name="gtk_action_set_short_label">
<description>
-Creates a new vertical ruler
+Sets a shorter label text on @action.
+Since: 2.16
</description>
<parameters>
+<parameter name="action">
+<parameter_description> a #GtkAction
+</parameter_description>
+</parameter>
+<parameter name="short_label">
+<parameter_description> the label text to set
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GtkVRuler.
-</return>
+<return></return>
</function>
-<function name="gtk_binding_entry_add">
+<function name="gtk_action_set_stock_id">
<description>
-Adds a binding entry.
+Sets the stock id on @action
-Deprecated: 2.12: Use gtk_binding_entry_add_signal() instead.
+Since: 2.16
</description>
<parameters>
-<parameter name="binding_set">
-<parameter_description> #a GtkBindingSet to clear an entry of
-</parameter_description>
-</parameter>
-<parameter name="keyval">
-<parameter_description> key value of binding to clear
+<parameter name="action">
+<parameter_description> a #GtkAction
</parameter_description>
</parameter>
-<parameter name="modifiers">
-<parameter_description> key modifier of binding to clear
+<parameter name="stock_id">
+<parameter_description> the stock id
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_buildable_custom_tag_start">
+<function name="gtk_action_set_tooltip">
<description>
-This is called for each unknown element under <child>.
+Sets the tooltip text on @action
-Since: 2.12
+Since: 2.16
</description>
<parameters>
-<parameter name="buildable">
-<parameter_description> a #GtkBuildable
-</parameter_description>
-</parameter>
-<parameter name="builder">
-<parameter_description> a #GtkBuilder used to construct this object
-</parameter_description>
-</parameter>
-<parameter name="child">
-<parameter_description> child object or %NULL for non-child tags
-</parameter_description>
-</parameter>
-<parameter name="tagname">
-<parameter_description> name of tag
-</parameter_description>
-</parameter>
-<parameter name="parser">
-<parameter_description> a #GMarkupParser structure to fill in
+<parameter name="action">
+<parameter_description> a #GtkAction
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> return location for user data that will be passed in
-to parser functions
+<parameter name="tooltip">
+<parameter_description> the tooltip text
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if a object has a custom implementation, %FALSE
-if it doesn't.
-
-</return>
+<return></return>
</function>
-<function name="gtk_widget_set_has_tooltip">
+<function name="gtk_action_set_visible">
<description>
-Sets the has-tooltip property on @widget to @has_tooltip. See
-GtkWidget:has-tooltip for more information.
+Sets the ::visible property of the action to @visible. Note that
+this doesn't necessarily mean effective visibility. See
+gtk_action_is_visible()
+for that.
-Since: 2.12
+Since: 2.6
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="action">
+<parameter_description> the action object
</parameter_description>
</parameter>
-<parameter name="has_tooltip">
-<parameter_description> whether or not @widget has a tooltip.
+<parameter name="visible">
+<parameter_description> %TRUE to make the action visible
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tooltips_set_tip">
+<function name="gtk_action_set_visible_horizontal">
<description>
-Adds a tooltip containing the message @tip_text to the specified #GtkWidget.
-Deprecated: 2.12:
+Sets whether @action is visible when horizontal
+
+Since: 2.16
</description>
<parameters>
-<parameter name="tooltips">
-<parameter_description> a #GtkTooltips.
-</parameter_description>
-</parameter>
-<parameter name="widget">
-<parameter_description> the #GtkWidget you wish to associate the tip with.
-</parameter_description>
-</parameter>
-<parameter name="tip_text">
-<parameter_description> a string containing the tip itself.
+<parameter name="action">
+<parameter_description> a #GtkAction
</parameter_description>
</parameter>
-<parameter name="tip_private">
-<parameter_description> a string of any further information that may be useful if the user gets stuck.
+<parameter name="visible_horizontal">
+<parameter_description> whether the action is visible horizontally
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_menu_item_get_label">
+<function name="gtk_action_set_visible_vertical">
<description>
-Sets @text on the @menu_item label
+Sets whether @action is visible when vertical
Since: 2.16
</description>
<parameters>
-<parameter name="menu_item">
-<parameter_description> a #GtkMenuItem
+<parameter name="action">
+<parameter_description> a #GtkAction
+</parameter_description>
+</parameter>
+<parameter name="visible_vertical">
+<parameter_description> whether the action is visible vertically
</parameter_description>
</parameter>
</parameters>
-<return> The text in the @menu_item label. This is the internal
-string used by the label, and must not be modified.
-
-</return>
+<return></return>
</function>
-<function name="gtk_window_remove_mnemonic">
+<function name="gtk_action_unblock_activate">
<description>
-Removes a mnemonic from this window.
+Reenable activation signals from the action
+
+Since: 2.16
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
-</parameter_description>
-</parameter>
-<parameter name="keyval">
-<parameter_description> the mnemonic
-</parameter_description>
-</parameter>
-<parameter name="target">
-<parameter_description> the widget that gets activated by the mnemonic
+<parameter name="action">
+<parameter_description> a #GtkAction
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_set_accel_path">
+<function name="gtk_action_unblock_activate_from">
<description>
-Given an accelerator group, @accel_group, and an accelerator path,
- accel_path, sets up an accelerator in @accel_group so whenever the
-key binding that is defined for @accel_path is pressed, @widget
-will be activated. This removes any accelerators (for any
-accelerator group) installed by previous calls to
-gtk_widget_set_accel_path(). Associating accelerators with
-paths allows them to be modified by the user and the modifications
-to be saved for future use. (See gtk_accel_map_save().)
+Re-enables calls to the gtk_action_activate()
+function by signals on the given proxy widget. This undoes the
+blocking done by gtk_action_block_activate_from().
-This function is a low level function that would most likely
-be used by a menu creation system like #GtkUIManager. If you
-use #GtkUIManager, setting up accelerator paths will be done
-automatically.
+This function is intended for use by action implementations.
-Even when you you aren't using #GtkUIManager, if you only want to
-set up accelerators on menu items gtk_menu_item_set_accel_path()
-provides a somewhat more convenient interface.
+Since: 2.4
-Note that @accel_path string will be stored in a #GQuark. Therefore, if you
-pass a static string, you can save some memory by interning it first with
-g_intern_static_string().
+Deprecated: 2.16: activatables are now responsible for activating the
+action directly so this doesnt apply anymore.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="accel_path">
-<parameter_description> path used to look up the accelerator
+<parameter name="action">
+<parameter_description> the action object
</parameter_description>
</parameter>
-<parameter name="accel_group">
-<parameter_description> a #GtkAccelGroup.
+<parameter name="proxy">
+<parameter_description> a proxy widget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_theme_set_screen">
+<function name="gtk_activatable_do_set_related_action">
<description>
-Sets the screen for an icon theme; the screen is used
-to track the user's currently configured icon theme,
-which might be different for different screens.
+This is a utility function for #GtkActivatable implementors.
-Since: 2.4
+When implementing #GtkActivatable you must call this when
+handling changes of the #GtkActivatable:related-action, and
+you must also use this to break references in #GObject->dispose().
+
+This function adds a reference to the currently set related
+action for you, it also makes sure the #GtkActivatable->update()
+method is called when the related #GtkAction properties change
+and registers to the action's proxy list.
+
+<note><para>Be careful to call this before setting the local
+copy of the #GtkAction property, since this function uses
+gtk_activatable_get_action() to retrieve the previous action</para></note>
+
+Since: 2.16
</description>
<parameters>
-<parameter name="icon_theme">
-<parameter_description> a #GtkIconTheme
+<parameter name="activatable">
+<parameter_description> a #GtkActivatable
</parameter_description>
</parameter>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="action">
+<parameter_description> the #GtkAction to set
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_action_create_icon">
+<function name="gtk_activatable_get_related_action">
<description>
-This function is intended for use by action implementations to
-create icons displayed in the proxy widgets.
+Gets the related #GtkAction for @activatable.
-Since: 2.4
+Since: 2.16
</description>
<parameters>
-<parameter name="action">
-<parameter_description> the action object
-</parameter_description>
-</parameter>
-<parameter name="icon_size">
-<parameter_description> the size of the icon that should be created.
+<parameter name="activatable">
+<parameter_description> a #GtkActivatable
</parameter_description>
</parameter>
</parameters>
-<return> a widget that displays the icon for this action.
+<return> the related #GtkAction if one is set.
</return>
</function>
-<function name="gtk_tree_view_column_set_reorderable">
+<function name="gtk_activatable_get_use_action_appearance">
<description>
-If @reorderable is %TRUE, then the column can be reordered by the end user
-dragging the header.
+Gets whether this activatable should reset its layout
+and appearance when setting the related action or when
+the action changes appearance.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn
-</parameter_description>
-</parameter>
-<parameter name="reorderable">
-<parameter_description> %TRUE, if the column can be reordered.
+<parameter name="activatable">
+<parameter_description> a #GtkActivatable
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether @activatable uses its actions appearance.
+
+</return>
</function>
-<function name="gtk_entry_set_icon_sensitive">
+<function name="gtk_activatable_set_related_action">
<description>
-Sets the sensitivity for the specified icon.
+Sets the related action on the @activatable object.
+
+<note><para>#GtkActivatable implementors need to handle the #GtkActivatable:related-action
+property and call gtk_activatable_do_set_related_action() when it changes.</para></note>
Since: 2.16
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> A #GtkEntry
-</parameter_description>
-</parameter>
-<parameter name="icon_pos">
-<parameter_description> Icon position
+<parameter name="activatable">
+<parameter_description> a #GtkActivatable
</parameter_description>
</parameter>
-<parameter name="sensitive">
-<parameter_description> Specifies whether the icon should appear
-sensitive or insensitive
+<parameter name="action">
+<parameter_description> the #GtkAction to set
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_menu_item_get_submenu">
+<function name="gtk_activatable_set_use_action_appearance">
<description>
-Gets the submenu underneath this menu item, if any. See
-gtk_menu_item_set_submenu().
+Sets whether this activatable should reset its layout and appearance
+when setting the related action or when the action changes appearance
+<note><para>#GtkActivatable implementors need to handle the
+#GtkActivatable:use-action-appearance property and call
+gtk_activatable_sync_action_properties() to update @activatable
+if needed.</para></note>
+
+Since: 2.16
</description>
<parameters>
-<parameter name="menu_item">
-<parameter_description> a #GtkMenuItem
+<parameter name="activatable">
+<parameter_description> a #GtkActivatable
+</parameter_description>
+</parameter>
+<parameter name="use_appearance">
+<parameter_description> whether to use the actions appearance
</parameter_description>
</parameter>
</parameters>
-<return> submenu for this menu item, or %NULL if none.
-</return>
+<return></return>
</function>
-<function name="gtk_print_operation_get_n_pages_to_print">
+<function name="gtk_activatable_sync_action_properties">
<description>
-Returns the number of pages that will be printed.
-
-Note that this value is set during print preparation phase
-(%GTK_PRINT_STATUS_PREPARING), so this function should never be
-called before the data generation phase (%GTK_PRINT_STATUS_GENERATING_DATA).
-You can connect to the #GtkPrintOperation::status-changed signal
-and call gtk_print_operation_get_n_pages_to_print() when
-print status is %GTK_PRINT_STATUS_GENERATING_DATA.
-This is typically used to track the progress of print operation.
+This is called to update the activatable completely, this is called
+internally when the #GtkActivatable::related-action property is set
+or unset and by the implementing class when
+#GtkActivatable::use-action-appearance changes.
-Since: 2.18
+Since: 2.16
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter name="activatable">
+<parameter_description> a #GtkActivatable
+</parameter_description>
+</parameter>
+<parameter name="action">
+<parameter_description> the related #GtkAction or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the number of pages that will be printed
-
-</return>
+<return></return>
</function>
-<function name="gtk_draw_extension">
+<function name="gtk_adjustment_configure">
<description>
-Draws an extension, i.e. a notebook tab.
+Sets all properties of the adjustment at once.
-Deprecated: 2.0: Use gtk_paint_extension() instead.
+Use this function to avoid multiple emissions of the "changed"
+signal. See gtk_adjustment_set_lower() for an alternative way
+of compressing multiple emissions of "changed" into one.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
+<parameter name="adjustment">
+<parameter_description> a #GtkAdjustment
</parameter_description>
</parameter>
-<parameter name="shadow_type">
-<parameter_description> type of shadow to draw
+<parameter name="value">
+<parameter_description> the new value
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> x origin of the extension
+<parameter name="lower">
+<parameter_description> the new minimum value
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> y origin of the extension
+<parameter name="upper">
+<parameter_description> the new maximum value
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> width of the extension
+<parameter name="step_increment">
+<parameter_description> the new step increment
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> width of the extension
+<parameter name="page_increment">
+<parameter_description> the new page increment
</parameter_description>
</parameter>
-<parameter name="gap_side">
-<parameter_description> the side on to which the extension is attached
+<parameter name="page_size">
+<parameter_description> the new page size
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_source_set_state">
+<function name="gtk_adjustment_get_lower">
<description>
-Sets the widget state this icon source is intended to be used
-with.
+Retrieves the minimum value of the adjustment.
-Setting the widget state on an icon source makes no difference
-if the state is wildcarded. Therefore, you should usually
-call gtk_icon_source_set_state_wildcarded() to un-wildcard it
-in addition to calling this function.
+Since: 2.14
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GtkIconSource
-</parameter_description>
-</parameter>
-<parameter name="state">
-<parameter_description> widget state this source applies to
+<parameter name="adjustment">
+<parameter_description> a #GtkAdjustment
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The current minimum value of the adjustment.
+
+</return>
</function>
-<function name="gtk_text_iter_is_start">
+<function name="gtk_adjustment_get_page_increment">
<description>
-Returns %TRUE if @iter is the first iterator in the buffer, that is
-if @iter has a character offset of 0.
+Retrieves the page increment of the adjustment.
+Since: 2.14
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
+<parameter name="adjustment">
+<parameter_description> a #GtkAdjustment
</parameter_description>
</parameter>
</parameters>
-<return> whether @iter is the first in the buffer
+<return> The current page increment of the adjustment.
+
</return>
</function>
-<function name="gtk_text_view_set_justification">
+<function name="gtk_adjustment_get_page_size">
<description>
-Sets the default justification of text in @text_view.
-Tags in the view's buffer may override the default.
+Retrieves the page size of the adjustment.
+Since: 2.14
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
-</parameter_description>
-</parameter>
-<parameter name="justification">
-<parameter_description> justification
+<parameter name="adjustment">
+<parameter_description> a #GtkAdjustment
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The current page size of the adjustment.
+
+</return>
</function>
-<function name="gtk_entry_layout_index_to_text_index">
+<function name="gtk_adjustment_get_step_increment">
<description>
-Converts from a position in the entry contents (returned
-by gtk_entry_get_text()) to a position in the
-entry's #PangoLayout (returned by gtk_entry_get_layout(),
-with text retrieved via pango_layout_get_text()).
+Retrieves the step increment of the adjustment.
+Since: 2.14
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
-</parameter_description>
-</parameter>
-<parameter name="layout_index">
-<parameter_description> byte index into the entry layout text
+<parameter name="adjustment">
+<parameter_description> a #GtkAdjustment
</parameter_description>
</parameter>
</parameters>
-<return> byte index into the entry contents
+<return> The current step increment of the adjustment.
+
</return>
</function>
-<function name="gtk_color_selection_new">
+<function name="gtk_adjustment_get_upper">
<description>
-Creates a new GtkColorSelection.
+Retrieves the maximum value of the adjustment.
+Since: 2.14
</description>
<parameters>
+<parameter name="adjustment">
+<parameter_description> a #GtkAdjustment
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GtkColorSelection
+<return> The current maximum value of the adjustment.
+
</return>
</function>
-<function name="gtk_message_dialog_get_image">
+<function name="gtk_adjustment_get_value">
<description>
-Gets the dialog's image.
+Gets the current value of the adjustment. See
+gtk_adjustment_set_value ().
-Since: 2.14
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkMessageDialog
+<parameter name="adjustment">
+<parameter_description> a #GtkAdjustment
</parameter_description>
</parameter>
</parameters>
-<return> the dialog's image
-
+<return> The current value of the adjustment.
</return>
</function>
-<function name="gtk_window_unmaximize">
+<function name="gtk_adjustment_set_lower">
<description>
-Asks to unmaximize @window. Note that you shouldn't assume the
-window is definitely unmaximized afterward, because other entities
-(e.g. the user or <link linkend="gtk-X11-arch">window
-manager</link>) could maximize it again, and not all window
-managers honor requests to unmaximize. But normally the window will
-end up unmaximized. Just don't write code that crashes if not.
+Sets the minimum value of the adjustment.
-You can track maximization via the "window-state-event" signal
-on #GtkWidget.
+When setting multiple adjustment properties via their individual
+setters, multiple "changed" signals will be emitted. However, since
+the emission of the "changed" signal is tied to the emission of the
+"GObject::notify" signals of the changed properties, it's possible
+to compress the "changed" signals into one by calling
+g_object_freeze_notify() and g_object_thaw_notify() around the
+calls to the individual setters.
+
+Alternatively, using a single g_object_set() for all the properties
+to change, or using gtk_adjustment_configure() has the same effect
+of compressing "changed" emissions.
+Since: 2.14
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="adjustment">
+<parameter_description> a #GtkAdjustment
+</parameter_description>
+</parameter>
+<parameter name="lower">
+<parameter_description> the new minimum value
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_selection_select_iter">
+<function name="gtk_adjustment_set_page_increment">
<description>
-Selects the specified iterator.
+Sets the page increment of the adjustment.
+
+See gtk_adjustment_set_lower() about how to compress multiple
+emissions of the "changed" signal when setting multiple adjustment
+properties.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="selection">
-<parameter_description> A #GtkTreeSelection.
+<parameter name="adjustment">
+<parameter_description> a #GtkAdjustment
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> The #GtkTreeIter to be selected.
+<parameter name="page_increment">
+<parameter_description> the new page increment
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_progress_bar_get_fraction">
+<function name="gtk_adjustment_set_page_size">
<description>
-Returns the current fraction of the task that's been completed.
+Sets the page size of the adjustment.
+
+See gtk_adjustment_set_lower() about how to compress multiple
+emissions of the "changed" signal when setting multiple adjustment
+properties.
+Since: 2.14
</description>
<parameters>
-<parameter name="pbar">
-<parameter_description> a #GtkProgressBar
+<parameter name="adjustment">
+<parameter_description> a #GtkAdjustment
+</parameter_description>
+</parameter>
+<parameter name="page_size">
+<parameter_description> the new page size
</parameter_description>
</parameter>
</parameters>
-<return> a fraction from 0.0 to 1.0
-</return>
+<return></return>
</function>
-<function name="gtk_text_buffer_get_end_iter">
+<function name="gtk_adjustment_set_step_increment">
<description>
-Initializes @iter with the "end iterator," one past the last valid
-character in the text buffer. If dereferenced with
-gtk_text_iter_get_char(), the end iterator has a character value of
-0. The entire buffer lies in the range from the first position in
-the buffer (call gtk_text_buffer_get_start_iter() to get
-character position 0) to the end iterator.
+Sets the step increment of the adjustment.
+
+See gtk_adjustment_set_lower() about how to compress multiple
+emissions of the "changed" signal when setting multiple adjustment
+properties.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="adjustment">
+<parameter_description> a #GtkAdjustment
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> iterator to initialize
+<parameter name="step_increment">
+<parameter_description> the new step increment
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_dialog_get_widget_for_response">
+<function name="gtk_adjustment_set_upper">
<description>
-Gets the widget button that uses the given response ID in the action area
-of a dialog.
+Sets the maximum value of the adjustment.
-Since: 2.20
+Note that values will be restricted by
+<literal>upper - page-size</literal> if the page-size
+property is nonzero.
+
+See gtk_adjustment_set_lower() about how to compress multiple
+emissions of the "changed" signal when setting multiple adjustment
+properties.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkDialog
+<parameter name="adjustment">
+<parameter_description> a #GtkAdjustment
</parameter_description>
</parameter>
-<parameter name="response_id">
-<parameter_description> the response ID used by the @dialog widget
+<parameter name="upper">
+<parameter_description> the new maximum value
</parameter_description>
</parameter>
</parameters>
-<return> the @widget button that uses the given @response_id, or %NULL.
-
-</return>
+<return></return>
</function>
-<function name="gtk_vscrollbar_new">
+<function name="gtk_alignment_get_padding">
<description>
-Creates a new vertical scrollbar.
+Gets the padding on the different sides of the widget.
+See gtk_alignment_set_padding ().
+Since: 2.4
</description>
<parameters>
-<parameter name="adjustment">
-<parameter_description> the #GtkAdjustment to use, or %NULL to create a new adjustment
+<parameter name="alignment">
+<parameter_description> a #GtkAlignment
+</parameter_description>
+</parameter>
+<parameter name="padding_top">
+<parameter_description> location to store the padding for the top of the widget, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="padding_bottom">
+<parameter_description> location to store the padding for the bottom of the widget, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="padding_left">
+<parameter_description> location to store the padding for the left of the widget, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="padding_right">
+<parameter_description> location to store the padding for the right of the widget, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the new #GtkVScrollbar
-</return>
+<return></return>
</function>
-<function name="gtk_invisible_new_for_screen">
+<function name="gtk_alignment_new">
<description>
-Creates a new #GtkInvisible object for a specified screen
+Creates a new #GtkAlignment.
-Since: 2.2
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen which identifies on which
-the new #GtkInvisible will be created.
+<parameter name="xalign">
+<parameter_description> the horizontal alignment of the child widget, from 0 (left) to 1
+(right).
+</parameter_description>
+</parameter>
+<parameter name="yalign">
+<parameter_description> the vertical alignment of the child widget, from 0 (top) to 1
+(bottom).
+</parameter_description>
+</parameter>
+<parameter name="xscale">
+<parameter_description> the amount that the child widget expands horizontally to fill up
+unused space, from 0 to 1.
+A value of 0 indicates that the child widget should never expand.
+A value of 1 indicates that the child widget will expand to fill all of the
+space allocated for the #GtkAlignment.
+</parameter_description>
+</parameter>
+<parameter name="yscale">
+<parameter_description> the amount that the child widget expands vertically to fill up
+unused space, from 0 to 1. The values are similar to @xscale.
</parameter_description>
</parameter>
</parameters>
-<return> a newly created #GtkInvisible object
-
+<return> the new #GtkAlignment.
</return>
</function>
-<function name="gtk_calendar_set_detail_width_chars">
+<function name="gtk_alignment_set">
<description>
-Updates the width of detail cells.
-See #GtkCalendar:detail-width-chars.
-
-Since: 2.14
+Sets the #GtkAlignment values.
</description>
<parameters>
-<parameter name="calendar">
-<parameter_description> a #GtkCalendar.
+<parameter name="alignment">
+<parameter_description> a #GtkAlignment.
</parameter_description>
</parameter>
-<parameter name="chars">
-<parameter_description> detail width in characters.
+<parameter name="xalign">
+<parameter_description> the horizontal alignment of the child widget, from 0 (left) to 1
+(right).
+</parameter_description>
+</parameter>
+<parameter name="yalign">
+<parameter_description> the vertical alignment of the child widget, from 0 (top) to 1
+(bottom).
+</parameter_description>
+</parameter>
+<parameter name="xscale">
+<parameter_description> the amount that the child widget expands horizontally to fill up
+unused space, from 0 to 1.
+A value of 0 indicates that the child widget should never expand.
+A value of 1 indicates that the child widget will expand to fill all of the
+space allocated for the #GtkAlignment.
+</parameter_description>
+</parameter>
+<parameter name="yscale">
+<parameter_description> the amount that the child widget expands vertically to fill up
+unused space, from 0 to 1. The values are similar to @xscale.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_convert_bin_window_to_widget_coords">
+<function name="gtk_alignment_set_padding">
<description>
-Converts bin_window coordinates (see gtk_tree_view_get_bin_window())
-to widget relative coordinates.
+Sets the padding on the different sides of the widget.
+The padding adds blank space to the sides of the widget. For instance,
+this can be used to indent the child widget towards the right by adding
+padding on the left.
-Since: 2.12
+Since: 2.4
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
+<parameter name="alignment">
+<parameter_description> a #GtkAlignment
</parameter_description>
</parameter>
-<parameter name="bx">
-<parameter_description> bin_window X coordinate
+<parameter name="padding_top">
+<parameter_description> the padding at the top of the widget
</parameter_description>
</parameter>
-<parameter name="by">
-<parameter_description> bin_window Y coordinate
+<parameter name="padding_bottom">
+<parameter_description> the padding at the bottom of the widget
</parameter_description>
</parameter>
-<parameter name="wx">
-<parameter_description> return location for widget X coordinate
+<parameter name="padding_left">
+<parameter_description> the padding at the left of the widget
</parameter_description>
</parameter>
-<parameter name="wy">
-<parameter_description> return location for widget Y coordinate
+<parameter name="padding_right">
+<parameter_description> the padding at the right of the widget.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_selection_data_get_format">
+<function name="gtk_alternative_dialog_button_order">
<description>
-Retrieves the format of the selection.
+Returns %TRUE if dialogs are expected to use an alternative
+button order on the screen @screen. See
+gtk_dialog_set_alternative_button_order() for more details
+about alternative button order.
-Since: 2.14
+If you need to use this function, you should probably connect
+to the ::notify:gtk-alternative-button-order signal on the
+#GtkSettings object associated to @screen, in order to be
+notified if the button order setting changes.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="selection_data">
-<parameter_description> a pointer to a #GtkSelectionData structure.
+<parameter name="screen">
+<parameter_description> a #GdkScreen, or %NULL to use the default screen
</parameter_description>
</parameter>
</parameters>
-<return> the format of the selection.
+<return> Whether the alternative button order should be used
</return>
</function>
-<function name="gtk_check_menu_item_set_inconsistent">
+<function name="gtk_arrow_new">
<description>
-If the user has selected a range of elements (such as some text or
-spreadsheet cells) that are affected by a boolean setting, and the
-current values in that range are inconsistent, you may want to
-display the check in an "in between" state. This function turns on
-"in between" display. Normally you would turn off the inconsistent
-state again if the user explicitly selects a setting. This has to be
-done manually, gtk_check_menu_item_set_inconsistent() only affects
-visual appearance, it doesn't affect the semantics of the widget.
+Creates a new #GtkArrow widget.
</description>
<parameters>
-<parameter name="check_menu_item">
-<parameter_description> a #GtkCheckMenuItem
+<parameter name="arrow_type">
+<parameter_description> a valid #GtkArrowType.
</parameter_description>
</parameter>
-<parameter name="setting">
-<parameter_description> %TRUE to display an "inconsistent" third state check
+<parameter name="shadow_type">
+<parameter_description> a valid #GtkShadowType.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the new #GtkArrow widget.
+</return>
</function>
-<function name="gtk_adjustment_configure">
+<function name="gtk_arrow_set">
<description>
-Sets all properties of the adjustment at once.
-
-Use this function to avoid multiple emissions of the "changed"
-signal. See gtk_adjustment_set_lower() for an alternative way
-of compressing multiple emissions of "changed" into one.
-
-Since: 2.14
+Sets the direction and style of the #GtkArrow, @arrow.
</description>
<parameters>
-<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
+<parameter name="arrow">
+<parameter_description> a widget of type #GtkArrow.
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> the new value
+<parameter name="arrow_type">
+<parameter_description> a valid #GtkArrowType.
</parameter_description>
</parameter>
-<parameter name="lower">
-<parameter_description> the new minimum value
+<parameter name="shadow_type">
+<parameter_description> a valid #GtkShadowType.
</parameter_description>
</parameter>
-<parameter name="upper">
-<parameter_description> the new maximum value
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_aspect_frame_new">
+<description>
+Create a new #GtkAspectFrame.
+
+
+</description>
+<parameters>
+<parameter name="label">
+<parameter_description> Label text.
</parameter_description>
</parameter>
-<parameter name="step_increment">
-<parameter_description> the new step increment
+<parameter name="xalign">
+<parameter_description> Horizontal alignment of the child within the allocation of
+the #GtkAspectFrame. This ranges from 0.0 (left aligned)
+to 1.0 (right aligned)
</parameter_description>
</parameter>
-<parameter name="page_increment">
-<parameter_description> the new page increment
+<parameter name="yalign">
+<parameter_description> Vertical alignment of the child within the allocation of
+the #GtkAspectFrame. This ranges from 0.0 (left aligned)
+to 1.0 (right aligned)
</parameter_description>
</parameter>
-<parameter name="page_size">
-<parameter_description> the new page size
+<parameter name="ratio">
+<parameter_description> The desired aspect ratio.
+</parameter_description>
+</parameter>
+<parameter name="obey_child">
+<parameter_description> If %TRUE, @ratio is ignored, and the aspect
+ratio is taken from the requistion of the child.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the new #GtkAspectFrame.
+</return>
</function>
-<function name="gtk_entry_completion_set_match_func">
+<function name="gtk_aspect_frame_set">
<description>
-Sets the match function for @completion to be @func. The match function
-is used to determine if a row should or should not be in the completion
-list.
-
-Since: 2.4
+Set parameters for an existing #GtkAspectFrame.
</description>
<parameters>
-<parameter name="completion">
-<parameter_description> A #GtkEntryCompletion.
+<parameter name="aspect_frame">
+<parameter_description> a #GtkAspectFrame
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> The #GtkEntryCompletionMatchFunc to use.
+<parameter name="xalign">
+<parameter_description> Horizontal alignment of the child within the allocation of
+the #GtkAspectFrame. This ranges from 0.0 (left aligned)
+to 1.0 (right aligned)
</parameter_description>
</parameter>
-<parameter name="func_data">
-<parameter_description> The user data for @func.
+<parameter name="yalign">
+<parameter_description> Vertical alignment of the child within the allocation of
+the #GtkAspectFrame. This ranges from 0.0 (left aligned)
+to 1.0 (right aligned)
</parameter_description>
</parameter>
-<parameter name="func_notify">
-<parameter_description> Destroy notifier for @func_data.
+<parameter name="ratio">
+<parameter_description> The desired aspect ratio.
+</parameter_description>
+</parameter>
+<parameter name="obey_child">
+<parameter_description> If %TRUE, @ratio is ignored, and the aspect
+ratio is taken from the requistion of the child.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_set_ref">
+<function name="gtk_assistant_add_action_widget">
<description>
-Increments the reference count on @icon_set.
+Adds a widget to the action area of a #GtkAssistant.
+Since: 2.10
</description>
<parameters>
-<parameter name="icon_set">
-<parameter_description> a #GtkIconSet.
+<parameter name="assistant">
+<parameter_description> a #GtkAssistant
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> @icon_set.
-</return>
+<return></return>
</function>
-<function name="gtk_tool_palette_get_drop_item">
+<function name="gtk_assistant_append_page">
<description>
-Gets the item at position (x, y).
-See gtk_tool_palette_get_drop_group().
+Appends a page to the @assistant.
-Since: 2.20
+Since: 2.10
</description>
<parameters>
-<parameter name="palette">
-<parameter_description> a #GtkToolPalette
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> the x position
+<parameter name="assistant">
+<parameter_description> a #GtkAssistant
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> the y position
+<parameter name="page">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkToolItem at position or %NULL if there is no such item
+<return> the index (starting at 0) of the inserted page
</return>
</function>
-<function name="gtk_recent_info_get_mime_type">
+<function name="gtk_assistant_commit">
<description>
-Gets the MIME type of the resource.
+Erases the visited page history so the back button is not
+shown on the current page, and removes the cancel button
+from subsequent pages.
-Since: 2.10
+Use this when the information provided up to the current
+page is hereafter deemed permanent and cannot be modified
+or undone. For example, showing a progress page to track
+a long-running, unreversible operation after the user has
+clicked apply on a confirmation page.
+
+Since: 2.22
</description>
<parameters>
-<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter name="assistant">
+<parameter_description> a #GtkAssistant
</parameter_description>
</parameter>
</parameters>
-<return> the MIME type of the resource. The returned string
-is owned by the recent manager, and should not be freed.
-
-</return>
+<return></return>
</function>
-<function name="gtk_test_widget_click">
+<function name="gtk_assistant_get_current_page">
<description>
-This function will generate a @button click (button press and button
-release event) in the middle of the first GdkWindow found that belongs
-to @widget.
-For %GTK_NO_WINDOW widgets like GtkButton, this will often be an
-input-only event window. For other widgets, this is usually widget->window.
-Certain caveats should be considered when using this function, in
-particular because the mouse pointer is warped to the button click
-location, see gdk_test_simulate_button() for details.
+Returns the page number of the current page
-Since: 2.14
+Since: 2.10
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> Widget to generate a button click on.
-</parameter_description>
-</parameter>
-<parameter name="button">
-<parameter_description> Number of the pointer button for the event, usually 1, 2 or 3.
-</parameter_description>
-</parameter>
-<parameter name="modifiers">
-<parameter_description> Keyboard modifiers the event is setup with.
+<parameter name="assistant">
+<parameter_description> a #GtkAssistant
</parameter_description>
</parameter>
</parameters>
-<return> wether all actions neccessary for the button click simulation were carried out successfully.
+<return> The index (starting from 0) of the current page in
+the @assistant, if the @assistant has no pages, -1 will be returned
</return>
</function>
-<function name="gtk_button_get_use_underline">
+<function name="gtk_assistant_get_n_pages">
<description>
-Returns whether an embedded underline in the button label indicates a
-mnemonic. See gtk_button_set_use_underline ().
+Returns the number of pages in the @assistant
+Since: 2.10
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkButton
+<parameter name="assistant">
+<parameter_description> a #GtkAssistant
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if an embedded underline in the button label
-indicates the mnemonic accelerator keys.
+<return> The number of pages in the @assistant.
+
</return>
</function>
-<function name="gtk_text_layout_validate_yrange">
+<function name="gtk_assistant_get_nth_page">
<description>
-Ensure that a region of a #GtkTextLayout is valid. The ::changed
-signal will be emitted if any lines are validated.
+Returns the child widget contained in page number @page_num.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #GtkTextLayout
-</parameter_description>
-</parameter>
-<parameter name="anchor">
-<parameter_description> iter pointing into a line that will be used as the
-coordinate origin
-</parameter_description>
-</parameter>
-<parameter name="y0_">
-<parameter_description> offset from the top of the line pointed to by @anchor at
-which to begin validation. (The offset here is in pixels
-after validation.)
+<parameter name="assistant">
+<parameter_description> a #GtkAssistant
</parameter_description>
</parameter>
-<parameter name="y1_">
-<parameter_description> offset from the top of the line pointed to by @anchor at
-which to end validation. (The offset here is in pixels
-after validation.)
+<parameter name="page_num">
+<parameter_description> The index of a page in the @assistant, or -1 to get the last page;
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The child widget, or %NULL
+if @page_num is out of bounds.
+
+</return>
</function>
-<function name="gtk_text_iter_get_line_offset">
+<function name="gtk_assistant_get_page_complete">
<description>
-Returns the character offset of the iterator,
-counting from the start of a newline-terminated line.
-The first character on the line has offset 0.
+Gets whether @page is complete.
+Since: 2.10
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
+<parameter name="assistant">
+<parameter_description> a #GtkAssistant
+</parameter_description>
+</parameter>
+<parameter name="page">
+<parameter_description> a page of @assistant
</parameter_description>
</parameter>
</parameters>
-<return> offset from start of line
+<return> %TRUE if @page is complete.
+
</return>
</function>
-<function name="gtk_target_list_find">
+<function name="gtk_assistant_get_page_header_image">
<description>
-Looks up a given target in a #GtkTargetList.
+Gets the header image for @page.
+Since: 2.10
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GtkTargetList
-</parameter_description>
-</parameter>
-<parameter name="target">
-<parameter_description> an interned atom representing the target to search for
+<parameter name="assistant">
+<parameter_description> a #GtkAssistant
</parameter_description>
</parameter>
-<parameter name="info">
-<parameter_description> a pointer to the location to store application info for target,
-or %NULL
+<parameter name="page">
+<parameter_description> a page of @assistant
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the target was found, otherwise %FALSE
+<return> the header image for @page, or %NULL
+if there's no header image for the page.
+
</return>
</function>
-<function name="gtk_widget_freeze_child_notify">
+<function name="gtk_assistant_get_page_side_image">
<description>
-Stops emission of #GtkWidget::child-notify signals on @widget. The
-signals are queued until gtk_widget_thaw_child_notify() is called
-on @widget.
+Gets the header image for @page.
-This is the analogue of g_object_freeze_notify() for child properties.
+Since: 2.10
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="assistant">
+<parameter_description> a #GtkAssistant
+</parameter_description>
+</parameter>
+<parameter name="page">
+<parameter_description> a page of @assistant
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the side image for @page, or %NULL
+if there's no side image for the page.
+
+</return>
</function>
-<function name="gtk_action_group_remove_action">
+<function name="gtk_assistant_get_page_title">
<description>
-Removes an action object from the action group.
+Gets the title for @page.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="action_group">
-<parameter_description> the action group
+<parameter name="assistant">
+<parameter_description> a #GtkAssistant
</parameter_description>
</parameter>
-<parameter name="action">
-<parameter_description> an action
+<parameter name="page">
+<parameter_description> a page of @assistant
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the title for @page.
+
+</return>
</function>
-<function name="gtk_about_dialog_set_wrap_license">
+<function name="gtk_assistant_get_page_type">
<description>
-Sets whether the license text in @about is
-automatically wrapped.
+Gets the page type of @page.
-Since: 2.8
+Since: 2.10
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter name="assistant">
+<parameter_description> a #GtkAssistant
</parameter_description>
</parameter>
-<parameter name="wrap_license">
-<parameter_description> whether to wrap the license
+<parameter name="page">
+<parameter_description> a page of @assistant
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the page type of @page.
+
+</return>
</function>
-<function name="gtk_window_set_default_size">
+<function name="gtk_assistant_insert_page">
<description>
-Sets the default size of a window. If the window's "natural" size
-(its size request) is larger than the default, the default will be
-ignored. More generally, if the default size does not obey the
-geometry hints for the window (gtk_window_set_geometry_hints() can
-be used to set these explicitly), the default size will be clamped
-to the nearest permitted size.
-
-Unlike gtk_widget_set_size_request(), which sets a size request for
-a widget and thus would keep users from shrinking the window, this
-function only sets the initial size, just as if the user had
-resized the window themselves. Users can still shrink the window
-again as they normally would. Setting a default size of -1 means to
-use the "natural" default size (the size request of the window).
-
-For more control over a window's initial size and how resizing works,
-investigate gtk_window_set_geometry_hints().
-
-For some uses, gtk_window_resize() is a more appropriate function.
-gtk_window_resize() changes the current size of the window, rather
-than the size to be used on initial display. gtk_window_resize() always
-affects the window itself, not the geometry widget.
-
-The default size of a window only affects the first time a window is
-shown; if a window is hidden and re-shown, it will remember the size
-it had prior to hiding, rather than using the default size.
+Inserts a page in the @assistant at a given position.
-Windows can't actually be 0x0 in size, they must be at least 1x1, but
-passing 0 for @width and @height is OK, resulting in a 1x1 default size.
+Since: 2.10
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="assistant">
+<parameter_description> a #GtkAssistant
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> width in pixels, or -1 to unset the default width
+<parameter name="page">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> height in pixels, or -1 to unset the default height
+<parameter name="position">
+<parameter_description> the index (starting at 0) at which to insert the page,
+or -1 to append the page to the @assistant
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the index (starting from 0) of the inserted page
+
+</return>
</function>
-<function name="gtk_action_group_add_radio_actions_full">
+<function name="gtk_assistant_new">
<description>
-This variant of gtk_action_group_add_radio_actions() adds a
-#GDestroyNotify callback for @user_data.
+Creates a new #GtkAssistant.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="action_group">
-<parameter_description> the action group
-</parameter_description>
-</parameter>
-<parameter name="entries">
-<parameter_description> an array of radio action descriptions
-</parameter_description>
-</parameter>
-<parameter name="n_entries">
-<parameter_description> the number of entries
-</parameter_description>
-</parameter>
-<parameter name="value">
-<parameter_description> the value of the action to activate initially, or -1 if
-no action should be activated
-</parameter_description>
-</parameter>
-<parameter name="on_change">
-<parameter_description> the callback to connect to the changed signal
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> data to pass to the action callbacks
-</parameter_description>
-</parameter>
-<parameter name="destroy">
-<parameter_description> destroy notification callback for @user_data
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> a newly created #GtkAssistant
+
+</return>
</function>
-<function name="gtk_entry_set_overwrite_mode">
+<function name="gtk_assistant_prepend_page">
<description>
-Sets whether the text is overwritten when typing in the #GtkEntry.
+Prepends a page to the @assistant.
-Since: 2.14
+Since: 2.10
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="assistant">
+<parameter_description> a #GtkAssistant
</parameter_description>
</parameter>
-<parameter name="overwrite">
-<parameter_description> new value
+<parameter name="page">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the index (starting at 0) of the inserted page
+
+</return>
</function>
-<function name="gtk_window_get_type_hint">
+<function name="gtk_assistant_remove_action_widget">
<description>
-Gets the type hint for this window. See gtk_window_set_type_hint().
+Removes a widget from the action area of a #GtkAssistant.
+Since: 2.10
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="assistant">
+<parameter_description> a #GtkAssistant
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> the type hint for @window.
-</return>
+<return></return>
</function>
-<function name="gtk_tree_view_column_get_widget">
+<function name="gtk_assistant_set_current_page">
<description>
-Returns the #GtkWidget in the button on the column header. If a custom
-widget has not been set then %NULL is returned.
+Switches the page to @page_num. Note that this will only be necessary
+in custom buttons, as the @assistant flow can be set with
+gtk_assistant_set_forward_page_func().
+Since: 2.10
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn.
+<parameter name="assistant">
+<parameter_description> a #GtkAssistant
+</parameter_description>
+</parameter>
+<parameter name="page_num">
+<parameter_description> index of the page to switch to, starting from 0.
+If negative, the last page will be used. If greater
+than the number of pages in the @assistant, nothing
+will be done.
</parameter_description>
</parameter>
</parameters>
-<return> The #GtkWidget in the column header, or %NULL
-</return>
+<return></return>
</function>
-<function name="gtk_paper_size_new_custom">
+<function name="gtk_assistant_set_forward_page_func">
<description>
-Creates a new #GtkPaperSize object with the
-given parameters.
+Sets the page forwarding function to be @page_func, this function will
+be used to determine what will be the next page when the user presses
+the forward button. Setting @page_func to %NULL will make the assistant
+to use the default forward function, which just goes to the next visible
+page.
Since: 2.10
</description>
<parameters>
-<parameter name="name">
-<parameter_description> the paper name
-</parameter_description>
-</parameter>
-<parameter name="display_name">
-<parameter_description> the human-readable name
+<parameter name="assistant">
+<parameter_description> a #GtkAssistant
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> the paper width, in units of @unit
+<parameter name="page_func">
+<parameter_description> the #GtkAssistantPageFunc, or %NULL to use the default one
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> the paper height, in units of @unit
+<parameter name="data">
+<parameter_description> user data for @page_func
</parameter_description>
</parameter>
-<parameter name="unit">
-<parameter_description> the unit for @width and @height
+<parameter name="destroy">
+<parameter_description> destroy notifier for @data
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPaperSize object, use gtk_paper_size_free()
-to free it
-
-</return>
+<return></return>
</function>
-<function name="gtk_status_icon_is_embedded">
+<function name="gtk_assistant_set_page_complete">
<description>
-Returns whether the status icon is embedded in a notification
-area.
+Sets whether @page contents are complete. This will make
+ assistant update the buttons state to be able to continue the task.
Since: 2.10
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
+<parameter name="assistant">
+<parameter_description> a #GtkAssistant
+</parameter_description>
+</parameter>
+<parameter name="page">
+<parameter_description> a page of @assistant
+</parameter_description>
+</parameter>
+<parameter name="complete">
+<parameter_description> the completeness status of the page
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the status icon is embedded in
-a notification area.
-
-</return>
+<return></return>
</function>
-<function name="gtk_cell_renderer_text_set_fixed_height_from_font">
+<function name="gtk_assistant_set_page_header_image">
<description>
-Sets the height of a renderer to explicitly be determined by the "font" and
-"y_pad" property set on it. Further changes in these properties do not
-affect the height, so they must be accompanied by a subsequent call to this
-function. Using this function is unflexible, and should really only be used
-if calculating the size of a cell is too slow (ie, a massive number of cells
-displayed). If @number_of_rows is -1, then the fixed height is unset, and
-the height is determined by the properties again.
+Sets a header image for @page. This image is displayed in the header
+area of the assistant when @page is the current page.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="renderer">
-<parameter_description> A #GtkCellRendererText
+<parameter name="assistant">
+<parameter_description> a #GtkAssistant
</parameter_description>
</parameter>
-<parameter name="number_of_rows">
-<parameter_description> Number of rows of text each cell renderer is allocated, or -1
+<parameter name="page">
+<parameter_description> a page of @assistant
+</parameter_description>
+</parameter>
+<parameter name="pixbuf">
+<parameter_description> the new header image @page
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_drag_dest_find_target">
+<function name="gtk_assistant_set_page_side_image">
<description>
-Looks for a match between @context->targets and the
- dest_target_list, returning the first matching target, otherwise
-returning %GDK_NONE. @dest_target_list should usually be the return
-value from gtk_drag_dest_get_target_list(), but some widgets may
-have different valid targets for different parts of the widget; in
-that case, they will have to implement a drag_motion handler that
-passes the correct target list to this function.
+Sets a header image for @page. This image is displayed in the side
+area of the assistant when @page is the current page.
+Since: 2.10
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> drag destination widget
+<parameter name="assistant">
+<parameter_description> a #GtkAssistant
</parameter_description>
</parameter>
-<parameter name="context">
-<parameter_description> drag context
+<parameter name="page">
+<parameter_description> a page of @assistant
</parameter_description>
</parameter>
-<parameter name="target_list">
-<parameter_description> list of droppable targets, or %NULL to use
-gtk_drag_dest_get_target_list (@widget).
+<parameter name="pixbuf">
+<parameter_description> the new header image @page
</parameter_description>
</parameter>
</parameters>
-<return> first target that the source offers and the dest can accept, or %GDK_NONE
-</return>
+<return></return>
</function>
-<function name="gtk_entry_set_has_frame">
+<function name="gtk_assistant_set_page_title">
<description>
-Sets whether the entry has a beveled frame around it.
+Sets a title for @page. The title is displayed in the header
+area of the assistant when @page is the current page.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="assistant">
+<parameter_description> a #GtkAssistant
</parameter_description>
</parameter>
-<parameter name="setting">
-<parameter_description> new value
+<parameter name="page">
+<parameter_description> a page of @assistant
+</parameter_description>
+</parameter>
+<parameter name="title">
+<parameter_description> the new title for @page
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_dialog_run">
+<function name="gtk_assistant_set_page_type">
<description>
-Blocks in a recursive main loop until the @dialog either emits the
-#GtkDialog::response signal, or is destroyed. If the dialog is
-destroyed during the call to gtk_dialog_run(), gtk_dialog_run() returns
-#GTK_RESPONSE_NONE. Otherwise, it returns the response ID from the
-::response signal emission.
-
-Before entering the recursive main loop, gtk_dialog_run() calls
-gtk_widget_show() on the dialog for you. Note that you still
-need to show any children of the dialog yourself.
-
-During gtk_dialog_run(), the default behavior of #GtkWidget::delete-event
-is disabled; if the dialog receives ::delete_event, it will not be
-destroyed as windows usually are, and gtk_dialog_run() will return
-#GTK_RESPONSE_DELETE_EVENT. Also, during gtk_dialog_run() the dialog
-will be modal. You can force gtk_dialog_run() to return at any time by
-calling gtk_dialog_response() to emit the ::response signal. Destroying
-the dialog during gtk_dialog_run() is a very bad idea, because your
-post-run code won't know whether the dialog was destroyed or not.
-
-After gtk_dialog_run() returns, you are responsible for hiding or
-destroying the dialog if you wish to do so.
-
-Typical usage of this function might be:
-|[
-gint result = gtk_dialog_run (GTK_DIALOG (dialog));
-switch (result)
-{
-case GTK_RESPONSE_ACCEPT:
-do_application_specific_something ();
-break;
-default:
-do_nothing_since_dialog_was_cancelled ();
-break;
-}
-gtk_widget_destroy (dialog);
-]|
-
-Note that even though the recursive main loop gives the effect of a
-modal dialog (it prevents the user from interacting with other
-windows in the same window group while the dialog is run), callbacks
-such as timeouts, IO channel watches, DND drops, etc, <emphasis>will</emphasis>
-be triggered during a gtk_dialog_run() call.
+Sets the page type for @page. The page type determines the page
+behavior in the @assistant.
+Since: 2.10
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkDialog
+<parameter name="assistant">
+<parameter_description> a #GtkAssistant
+</parameter_description>
+</parameter>
+<parameter name="page">
+<parameter_description> a page of @assistant
+</parameter_description>
+</parameter>
+<parameter name="type">
+<parameter_description> the new type for @page
</parameter_description>
</parameter>
</parameters>
-<return> response ID
-</return>
+<return></return>
</function>
-<function name="gtk_tree_model_filter_refilter">
+<function name="gtk_assistant_update_buttons_state">
<description>
-Emits ::row_changed for each row in the child model, which causes
-the filter to re-evaluate whether a row is visible or not.
+Forces @assistant to recompute the buttons state.
-Since: 2.4
+GTK+ automatically takes care of this in most situations,
+e.g. when the user goes to a different page, or when the
+visibility or completeness of a page changes.
+
+One situation where it can be necessary to call this
+function is when changing a value on the current page
+affects the future page flow of the assistant.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="filter">
-<parameter_description> A #GtkTreeModelFilter.
+<parameter name="assistant">
+<parameter_description> a #GtkAssistant
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_spin_button_set_adjustment">
+<function name="gtk_bin_get_child">
<description>
-Replaces the #GtkAdjustment associated with @spin_button.
+Gets the child of the #GtkBin, or %NULL if the bin contains
+no child widget. The returned widget does not have a reference
+added, so you do not need to unref it.
+
</description>
<parameters>
-<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
-</parameter_description>
-</parameter>
-<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment to replace the existing adjustment
+<parameter name="bin">
+<parameter_description> a #GtkBin
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> pointer to child of the #GtkBin
+</return>
</function>
-<function name="gtk_container_forall">
+<function name="gtk_binding_entry_add">
<description>
-Invokes @callback on each child of @container, including children
-that are considered "internal" (implementation details of the
-container). "Internal" children generally weren't added by the user
-of the container, but were added by the container implementation
-itself. Most applications should use gtk_container_foreach(),
-rather than gtk_container_forall().
+Adds a binding entry.
+
+Deprecated: 2.12: Use gtk_binding_entry_add_signal() instead.
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
+<parameter name="binding_set">
+<parameter_description> #a GtkBindingSet to clear an entry of
</parameter_description>
</parameter>
-<parameter name="callback">
-<parameter_description> a callback
+<parameter name="keyval">
+<parameter_description> key value of binding to clear
</parameter_description>
</parameter>
-<parameter name="callback_data">
-<parameter_description> callback user data
+<parameter name="modifiers">
+<parameter_description> key modifier of binding to clear
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_get_slice">
+<function name="gtk_binding_entry_add_signal">
<description>
-Returns the text in the range [ start,@end). Excludes undisplayed
-text (text marked with tags that set the invisibility attribute) if
- include_hidden_chars is %FALSE. The returned string includes a
-0xFFFC character whenever the buffer contains
-embedded images, so byte and character indexes into
-the returned string <emphasis>do</emphasis> correspond to byte
-and character indexes into the buffer. Contrast with
-gtk_text_buffer_get_text(). Note that 0xFFFC can occur in normal
-text as well, so it is not a reliable indicator that a pixbuf or
-widget is in the buffer.
-
+Override or install a new key binding for @keyval with @modifiers on
+ binding_set When the binding is activated, @signal_name will be
+emitted on the target widget, with @n_args @Varargs used as
+arguments.
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="binding_set">
+<parameter_description> a #GtkBindingSet to install an entry for
</parameter_description>
</parameter>
-<parameter name="start">
-<parameter_description> start of a range
+<parameter name="keyval">
+<parameter_description> key value of binding to install
</parameter_description>
</parameter>
-<parameter name="end">
-<parameter_description> end of a range
+<parameter name="modifiers">
+<parameter_description> key modifier of binding to install
</parameter_description>
</parameter>
-<parameter name="include_hidden_chars">
-<parameter_description> whether to include invisible text
+<parameter name="signal_name">
+<parameter_description> signal to execute upon activation
</parameter_description>
</parameter>
-</parameters>
-<return> an allocated UTF-8 string
-</return>
-</function>
-
-<function name="gtk_entry_get_max_length">
-<description>
-Retrieves the maximum allowed length of the text in
- entry See gtk_entry_set_max_length().
-
-This is equivalent to:
-
-<informalexample><programlisting>
-gtk_entry_buffer_get_max_length (gtk_entry_get_buffer (entry));
-</programlisting></informalexample>
-
-
-</description>
-<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="n_args">
+<parameter_description> number of arguments to @signal_name
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> arguments to @signal_name
</parameter_description>
</parameter>
</parameters>
-<return> the maximum allowed number of characters
-in #GtkEntry, or 0 if there is no maximum.
-</return>
+<return></return>
</function>
-<function name="gtk_action_set_visible_horizontal">
+<function name="gtk_binding_entry_add_signall">
<description>
-Sets whether @action is visible when horizontal
-
-Since: 2.16
+Override or install a new key binding for @keyval with @modifiers on
+ binding_set
</description>
<parameters>
-<parameter name="action">
-<parameter_description> a #GtkAction
+<parameter name="binding_set">
+<parameter_description> a #GtkBindingSet to add a signal to
</parameter_description>
</parameter>
-<parameter name="visible_horizontal">
-<parameter_description> whether the action is visible horizontally
+<parameter name="keyval">
+<parameter_description> key value
+</parameter_description>
+</parameter>
+<parameter name="modifiers">
+<parameter_description> key modifier
+</parameter_description>
+</parameter>
+<parameter name="signal_name">
+<parameter_description> signal name to be bound
+</parameter_description>
+</parameter>
+<parameter name="binding_args">
+<parameter_description>
+list of #GtkBindingArg signal arguments
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_combo_box_entry_set_text_column">
+<function name="gtk_binding_entry_clear">
<description>
-Sets the model column which @entry_box should use to get strings from
-to be @text_column.
+Clears a binding entry.
-Since: 2.4
+Deprecated: 2.12: Use gtk_binding_entry_remove() instead.
</description>
<parameters>
-<parameter name="entry_box">
-<parameter_description> A #GtkComboBoxEntry.
+<parameter name="binding_set">
+<parameter_description> binding set to clear an entry of
</parameter_description>
</parameter>
-<parameter name="text_column">
-<parameter_description> A column in @model to get the strings from.
+<parameter name="keyval">
+<parameter_description> key value of binding to clear
+</parameter_description>
+</parameter>
+<parameter name="modifiers">
+<parameter_description> key modifier of binding to clear
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tool_item_group_get_drop_item">
+<function name="gtk_binding_entry_remove">
<description>
-Gets the tool item at position (x, y).
-
-Since: 2.20
+Remove a binding previously installed via
+gtk_binding_entry_add_signal() on @binding_set.
</description>
<parameters>
-<parameter name="group">
-<parameter_description> a #GtkToolItemGroup
+<parameter name="binding_set">
+<parameter_description> a #GtkBindingSet to remove an entry of
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> the x position
+<parameter name="keyval">
+<parameter_description> key value of binding to remove
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> the y position
+<parameter name="modifiers">
+<parameter_description> key modifier of binding to remove
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkToolItem at position (x, y)
-
-</return>
+<return></return>
</function>
-<function name="gtk_entry_completion_set_popup_set_width">
+<function name="gtk_binding_entry_skip">
<description>
-Sets whether the completion popup window will be resized to be the same
-width as the entry.
+Install a binding on @binding_set which causes key lookups
+to be aborted, to prevent bindings from lower priority sets
+to be activated.
-Since: 2.8
+Since: 2.12
</description>
<parameters>
-<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter name="binding_set">
+<parameter_description> a #GtkBindingSet to skip an entry of
</parameter_description>
</parameter>
-<parameter name="popup_set_width">
-<parameter_description> %TRUE to make the width of the popup the same as the entry
+<parameter name="keyval">
+<parameter_description> key value of binding to skip
+</parameter_description>
+</parameter>
+<parameter name="modifiers">
+<parameter_description> key modifier of binding to skip
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_scrolled_window_set_shadow_type">
+<function name="gtk_binding_parse_binding">
<description>
-Changes the type of shadow drawn around the contents of
- scrolled_window
+Parse a binding entry from a gtkrc file.
+Deprecated: 2.12: There should be no need to call this function outside GTK+.
</description>
<parameters>
-<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
-</parameter_description>
-</parameter>
-<parameter name="type">
-<parameter_description> kind of shadow to draw around scrolled window contents
+<parameter name="scanner">
+<parameter_description> GtkRC scanner
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> expected token upon errors, %G_TOKEN_NONE on success.
+
+</return>
</function>
-<function name="gtk_tree_model_iter_has_child">
+<function name="gtk_binding_set_activate">
<description>
-Returns %TRUE if @iter has children, %FALSE otherwise.
+Find a key binding matching @keyval and @modifiers within
+ binding_set and activate the binding on @object.
</description>
<parameters>
-<parameter name="tree_model">
-<parameter_description> A #GtkTreeModel.
+<parameter name="binding_set">
+<parameter_description> a #GtkBindingSet set to activate
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> The #GtkTreeIter to test for children.
+<parameter name="keyval">
+<parameter_description> key value of the binding
+</parameter_description>
+</parameter>
+<parameter name="modifiers">
+<parameter_description> key modifier of the binding
+</parameter_description>
+</parameter>
+<parameter name="object">
+<parameter_description> object to activate when binding found
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter has children.
+<return> %TRUE if a binding was found and activated
</return>
</function>
-<function name="gtk_stock_add">
+<function name="gtk_binding_set_add_path">
<description>
-Registers each of the stock items in @items. If an item already
-exists with the same stock ID as one of the @items, the old item
-gets replaced. The stock items are copied, so GTK+ does not hold
-any pointer into @items and @items can be freed. Use
-gtk_stock_add_static() if @items is persistent and GTK+ need not
-copy the array.
-
+This function is used internally by the GtkRC parsing mechanism to
+assign match patterns to #GtkBindingSet structures.
</description>
<parameters>
-<parameter name="items">
-<parameter_description> a #GtkStockItem or array of items
+<parameter name="binding_set">
+<parameter_description> a #GtkBindingSet to add a path to
</parameter_description>
</parameter>
-<parameter name="n_items">
-<parameter_description> number of #GtkStockItem in @items
+<parameter name="path_type">
+<parameter_description> path type the pattern applies to
+</parameter_description>
+</parameter>
+<parameter name="path_pattern">
+<parameter_description> the actual match pattern
+</parameter_description>
+</parameter>
+<parameter name="priority">
+<parameter_description> binding priority
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_color_selection_set_has_palette">
+<function name="gtk_binding_set_by_class">
<description>
-Shows and hides the palette based upon the value of @has_palette.
+This function returns the binding set named after the type name of
+the passed in class structure. New binding sets are created on
+demand by this function.
</description>
<parameters>
-<parameter name="colorsel">
-<parameter_description> a #GtkColorSelection.
-</parameter_description>
-</parameter>
-<parameter name="has_palette">
-<parameter_description> %TRUE if palette is to be visible, %FALSE otherwise.
+<parameter name="object_class">
+<parameter_description> a valid #GtkObject class
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the binding set corresponding to @object_class
+</return>
</function>
-<function name="gtk_file_chooser_widget_new_with_backend">
+<function name="gtk_binding_set_find">
<description>
-Creates a new #GtkFileChooserWidget with a specified backend. This is
-especially useful if you use gtk_file_chooser_set_local_only() to allow
-non-local files. This is a file chooser widget that can be embedded in
-custom windows and it is the same widget that is used by
-#GtkFileChooserDialog.
+Find a binding set by its globally unique name. The @set_name can
+either be a name used for gtk_binding_set_new() or the type name of
+a class used in gtk_binding_set_by_class().
-Since: 2.4
-Deprecated: 2.14: Use gtk_file_chooser_widget_new() instead.
</description>
<parameters>
-<parameter name="action">
-<parameter_description> Open or save mode for the widget
-</parameter_description>
-</parameter>
-<parameter name="backend">
-<parameter_description> The name of the specific filesystem backend to use.
+<parameter name="set_name">
+<parameter_description> unique binding set name
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkFileChooserWidget
-
+<return> %NULL or the specified binding set
</return>
</function>
-<function name="gtk_print_settings_get_output_bin">
+<function name="gtk_binding_set_new">
<description>
-Gets the value of %GTK_PRINT_SETTINGS_OUTPUT_BIN.
+GTK+ maintains a global list of binding sets. Each binding set has
+a unique name which needs to be specified upon creation.
-Since: 2.10
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="set_name">
+<parameter_description> unique name of this binding set
</parameter_description>
</parameter>
</parameters>
-<return> the output bin
-
+<return> new binding set
</return>
</function>
-<function name="gtk_file_chooser_dialog_new">
+<function name="gtk_bindings_activate">
<description>
-Creates a new #GtkFileChooserDialog. This function is analogous to
-gtk_dialog_new_with_buttons().
+Find a key binding matching @keyval and @modifiers and activate the
+binding on @object.
-Since: 2.4
</description>
<parameters>
-<parameter name="title">
-<parameter_description> Title of the dialog, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="parent">
-<parameter_description> Transient parent of the dialog, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="action">
-<parameter_description> Open or save mode for the dialog
+<parameter name="object">
+<parameter_description> object to activate when binding found
</parameter_description>
</parameter>
-<parameter name="first_button_text">
-<parameter_description> stock ID or text to go in the first button, or %NULL
+<parameter name="keyval">
+<parameter_description> key value of the binding
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> response ID for the first button, then additional (button, id) pairs, ending with %NULL
+<parameter name="modifiers">
+<parameter_description> key modifier of the binding
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkFileChooserDialog
-
+<return> %TRUE if a binding was found and activated
</return>
</function>
-<function name="gtk_settings_get_for_screen">
+<function name="gtk_bindings_activate_event">
<description>
-Gets the #GtkSettings object for @screen, creating it if necessary.
+Looks up key bindings for @object to find one matching
+ event, and if one was found, activate it.
-Since: 2.2
+Since: 2.4
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen.
+<parameter name="object">
+<parameter_description> a #GtkObject (generally must be a widget)
+</parameter_description>
+</parameter>
+<parameter name="event">
+<parameter_description> a #GdkEventKey
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkSettings object.
+<return> %TRUE if a matching key binding was found
</return>
</function>
-<function name="gtk_progress_bar_new_with_adjustment">
+<function name="gtk_border_copy">
<description>
-Creates a new #GtkProgressBar with an associated #GtkAdjustment.
-
+Copies a #GtkBorder structure.
</description>
<parameters>
-<parameter name="adjustment">
-<parameter_description>
+<parameter name="border_">
+<parameter_description> a #GtkBorder.
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkProgressBar.
+<return> a copy of @border_.
</return>
</function>
-<function name="gtk_label_set_attributes">
+<function name="gtk_border_free">
<description>
-Sets a #PangoAttrList; the attributes in the list are applied to the
-label text.
-
-<note><para>The attributes set with this function will be applied
-and merged with any other attributes previously effected by way
-of the #GtkLabel:use-underline or #GtkLabel:use-markup properties.
-While it is not recommended to mix markup strings with manually set
-attributes, if you must; know that the attributes will be applied
-to the label after the markup string is parsed.</para></note>
+Frees a #GtkBorder structure.
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
-</parameter_description>
-</parameter>
-<parameter name="attrs">
-<parameter_description> a #PangoAttrList
+<parameter name="border_">
+<parameter_description> a #GtkBorder.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_get_event_widget">
+<function name="gtk_border_new">
<description>
-If @event is %NULL or the event was not associated with any widget,
-returns %NULL, otherwise returns the widget that received the event
-originally.
+Allocates a new #GtkBorder structure and initializes its elements to zero.
+Since: 2.14
</description>
<parameters>
-<parameter name="event">
-<parameter_description> a #GdkEvent
+</parameters>
+<return> a new empty #GtkBorder. The newly allocated #GtkBorder should be
+freed with gtk_border_free()
+
+</return>
+</function>
+
+<function name="gtk_box_get_homogeneous">
+<description>
+Returns whether the box is homogeneous (all children are the
+same size). See gtk_box_set_homogeneous().
+
+
+</description>
+<parameters>
+<parameter name="box">
+<parameter_description> a #GtkBox
</parameter_description>
</parameter>
</parameters>
-<return> the widget that originally received @event, or %NULL
+<return> %TRUE if the box is homogeneous.
</return>
</function>
-<function name="gtk_rc_get_default_files">
+<function name="gtk_box_get_spacing">
<description>
-Retrieves the current list of RC files that will be parsed
-at the end of gtk_init().
+Gets the value set by gtk_box_set_spacing().
</description>
<parameters>
+<parameter name="box">
+<parameter_description> a #GtkBox
+</parameter_description>
+</parameter>
</parameters>
-<return> A %NULL-terminated array of filenames. This memory
-is owned by GTK+ and must not be freed by the application.
-If you want to store this information, you should make a copy.
+<return> spacing between children
</return>
</function>
@@ -4831,3601 +4869,3787 @@ Since: 2.16
</return>
</function>
-<function name="gtk_print_settings_load_key_file">
+<function name="gtk_box_pack_end">
<description>
-Reads the print settings from the group @group_name in @key_file. If the
-file could not be loaded then error is set to either a #GFileError or
-#GKeyFileError.
-
-Since: 2.14
+Adds @child to @box, packed with reference to the end of @box.
+The @child is packed after (away from end of) any other child
+packed with reference to the end of @box.
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="box">
+<parameter_description> a #GtkBox
</parameter_description>
</parameter>
-<parameter name="key_file">
-<parameter_description> the #GKeyFile to retrieve the settings from
+<parameter name="child">
+<parameter_description> the #GtkWidget to be added to @box
</parameter_description>
</parameter>
-<parameter name="group_name">
-<parameter_description> the name of the group to use, or %NULL to use the default
-"Print Settings"
+<parameter name="expand">
+<parameter_description> %TRUE if the new child is to be given extra space allocated
+to @box. The extra space will be divided evenly between all children
+of @box that use this option
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for errors, or %NULL
+<parameter name="fill">
+<parameter_description> %TRUE if space given to @child by the @expand option is
+actually allocated to @child, rather than just padding it. This
+parameter has no effect if @expand is set to %FALSE. A child is
+always allocated the full height of a #GtkHBox and the full width
+of a #GtkVBox. This option affects the other dimension
+</parameter_description>
+</parameter>
+<parameter name="padding">
+<parameter_description> extra space in pixels to put between this child and its
+neighbors, over and above the global amount specified by
+#GtkBox:spacing property. If @child is a widget at one of the
+reference ends of @box, then @padding pixels are also put between
+ child and the reference edge of @box
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success
+<return></return>
+</function>
-</return>
+<function name="gtk_box_pack_end_defaults">
+<description>
+Adds @widget to @box, packed with reference to the end of @box.
+The child is packed after any other child packed with reference
+to the start of @box.
+
+Parameters for how to pack the child @widget, #GtkBox:expand,
+#GtkBox:fill and #GtkBox:padding, are given their default
+values, %TRUE, %TRUE, and 0, respectively.
+
+Deprecated: 2.14: Use gtk_box_pack_end()
+
+</description>
+<parameters>
+<parameter name="box">
+<parameter_description> a #GtkBox
+</parameter_description>
+</parameter>
+<parameter name="widget">
+<parameter_description> the #GtkWidget to be added to @box
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="gtk_notebook_set_tab_pos">
+<function name="gtk_box_pack_start">
<description>
-Sets the edge at which the tabs for switching pages in the
-notebook are drawn.
+Adds @child to @box, packed with reference to the start of @box.
+The @child is packed after any other child packed with reference
+to the start of @box.
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook.
+<parameter name="box">
+<parameter_description> a #GtkBox
</parameter_description>
</parameter>
-<parameter name="pos">
-<parameter_description> the edge to draw the tabs at.
+<parameter name="child">
+<parameter_description> the #GtkWidget to be added to @box
+</parameter_description>
+</parameter>
+<parameter name="expand">
+<parameter_description> %TRUE if the new child is to be given extra space allocated to
+ box The extra space will be divided evenly between all children of
+ box that use this option
+</parameter_description>
+</parameter>
+<parameter name="fill">
+<parameter_description> %TRUE if space given to @child by the @expand option is
+actually allocated to @child, rather than just padding it. This
+parameter has no effect if @expand is set to %FALSE. A child is
+always allocated the full height of a #GtkHBox and the full width
+of a #GtkVBox. This option affects the other dimension
+</parameter_description>
+</parameter>
+<parameter name="padding">
+<parameter_description> extra space in pixels to put between this child and its
+neighbors, over and above the global amount specified by
+#GtkBox:spacing property. If @child is a widget at one of the
+reference ends of @box, then @padding pixels are also put between
+ child and the reference edge of @box
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_menu_item_set_use_underline">
+<function name="gtk_box_pack_start_defaults">
<description>
-If true, an underline in the text indicates the next character should be
-used for the mnemonic accelerator key.
+Adds @widget to @box, packed with reference to the start of @box.
+The child is packed after any other child packed with reference
+to the start of @box.
-Since: 2.16
+Parameters for how to pack the child @widget, #GtkBox:expand,
+#GtkBox:fill and #GtkBox:padding, are given their default
+values, %TRUE, %TRUE, and 0, respectively.
+
+Deprecated: 2.14: Use gtk_box_pack_start()
</description>
<parameters>
-<parameter name="menu_item">
-<parameter_description> a #GtkMenuItem
+<parameter name="box">
+<parameter_description> a #GtkBox
</parameter_description>
</parameter>
-<parameter name="setting">
-<parameter_description> %TRUE if underlines in the text indicate mnemonics
+<parameter name="widget">
+<parameter_description> the #GtkWidget to be added to @box
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_paper_size_to_key_file">
+<function name="gtk_box_query_child_packing">
<description>
-This function adds the paper size from @size to @key_file.
-
-Since: 2.12
+Obtains information about how @child is packed into @box.
</description>
<parameters>
-<parameter name="size">
-<parameter_description> a #GtkPaperSize
+<parameter name="box">
+<parameter_description> a #GtkBox
</parameter_description>
</parameter>
-<parameter name="key_file">
-<parameter_description> the #GKeyFile to save the paper size to
+<parameter name="child">
+<parameter_description> the #GtkWidget of the child to query
</parameter_description>
</parameter>
-<parameter name="group_name">
-<parameter_description> the group to add the settings to in @key_file
+<parameter name="expand">
+<parameter_description> pointer to return location for #GtkBox:expand child property
+</parameter_description>
+</parameter>
+<parameter name="fill">
+<parameter_description> pointer to return location for #GtkBox:fill child property
+</parameter_description>
+</parameter>
+<parameter name="padding">
+<parameter_description> pointer to return location for #GtkBox:padding child property
+</parameter_description>
+</parameter>
+<parameter name="pack_type">
+<parameter_description> pointer to return location for #GtkBox:pack-type child property
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_set_app_paintable">
+<function name="gtk_box_reorder_child">
<description>
-Sets whether the application intends to draw on the widget in
-an #GtkWidget::expose-event handler.
-
-This is a hint to the widget and does not affect the behavior of
-the GTK+ core; many widgets ignore this flag entirely. For widgets
-that do pay attention to the flag, such as #GtkEventBox and #GtkWindow,
-the effect is to suppress default themed drawing of the widget's
-background. (Children of the widget will still be drawn.) The application
-is then entirely responsible for drawing the widget background.
+Moves @child to a new @position in the list of @box children.
+The list is the <structfield>children</structfield> field of
+#GtkBox-struct, and contains both widgets packed #GTK_PACK_START
+as well as widgets packed #GTK_PACK_END, in the order that these
+widgets were added to @box.
-Note that the background is still drawn when the widget is mapped.
-If this is not suitable (e.g. because you want to make a transparent
-window using an RGBA visual), you can work around this by doing:
-|[
-gtk_widget_realize (window);
-gdk_window_set_back_pixmap (window->window, NULL, FALSE);
-gtk_widget_show (window);
-]|
+A widget's position in the @box children list determines where
+the widget is packed into @box. A child widget at some position
+in the list will be packed just after all other widgets of the
+same packing type that appear earlier in the list.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="box">
+<parameter_description> a #GtkBox
</parameter_description>
</parameter>
-<parameter name="app_paintable">
-<parameter_description> %TRUE if the application will paint on the widget
+<parameter name="child">
+<parameter_description> the #GtkWidget to move
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> the new position for @child in the list of children
+of @box, starting from 0. If negative, indicates the end of
+the list
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_move_mark_by_name">
+<function name="gtk_box_set_child_packing">
<description>
-Moves the mark named @name (which must exist) to location @where.
-See gtk_text_buffer_move_mark() for details.
+Sets the way @child is packed into @box.
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="box">
+<parameter_description> a #GtkBox
</parameter_description>
</parameter>
-<parameter name="name">
-<parameter_description> name of a mark
+<parameter name="child">
+<parameter_description> the #GtkWidget of the child to set
</parameter_description>
</parameter>
-<parameter name="where">
-<parameter_description> new location for mark
+<parameter name="expand">
+<parameter_description> the new value of the #GtkBox:expand child property
+</parameter_description>
+</parameter>
+<parameter name="fill">
+<parameter_description> the new value of the #GtkBox:fill child property
+</parameter_description>
+</parameter>
+<parameter name="padding">
+<parameter_description> the new value of the #GtkBox:padding child property
+</parameter_description>
+</parameter>
+<parameter name="pack_type">
+<parameter_description> the new value of the #GtkBox:pack-type child property
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_file_chooser_button_set_title">
+<function name="gtk_box_set_homogeneous">
<description>
-Modifies the @title of the browse dialog used by @button.
-
-Since: 2.6
+Sets the #GtkBox:homogeneous property of @box, controlling
+whether or not all children of @box are given equal space
+in the box.
</description>
<parameters>
-<parameter name="button">
-<parameter_description> the button widget to modify.
+<parameter name="box">
+<parameter_description> a #GtkBox
</parameter_description>
</parameter>
-<parameter name="title">
-<parameter_description> the new browse dialog title.
+<parameter name="homogeneous">
+<parameter_description> a boolean value, %TRUE to create equal allotments,
+%FALSE for variable allotments
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_theme_new">
+<function name="gtk_box_set_spacing">
<description>
-Creates a new icon theme object. Icon theme objects are used
-to lookup up an icon by name in a particular icon theme.
-Usually, you'll want to use gtk_icon_theme_get_default()
-or gtk_icon_theme_get_for_screen() rather than creating
-a new icon theme object for scratch.
-
-Since: 2.4
+Sets the #GtkBox:spacing property of @box, which is the
+number of pixels to place between children of @box.
</description>
<parameters>
+<parameter name="box">
+<parameter_description> a #GtkBox
+</parameter_description>
+</parameter>
+<parameter name="spacing">
+<parameter_description> the number of pixels to put between children
+</parameter_description>
+</parameter>
</parameters>
-<return> the newly created #GtkIconTheme object.
-
-</return>
+<return></return>
</function>
-<function name="gtk_style_get">
+<function name="gtk_buildable_add_child">
<description>
-Gets the values of a multiple style properties for @widget_type
-from @style.
+Adds a child to @buildable. @type is an optional string
+describing how the child should be added.
-Since: 2.16
+Since: 2.12
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
+<parameter name="buildable">
+<parameter_description> a #GtkBuildable
</parameter_description>
</parameter>
-<parameter name="widget_type">
-<parameter_description> the #GType of a descendant of #GtkWidget
+<parameter name="builder">
+<parameter_description> a #GtkBuilder
</parameter_description>
</parameter>
-<parameter name="first_property_name">
-<parameter_description> the name of the first style property to get
+<parameter name="child">
+<parameter_description> child to add
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> pairs of property names and locations to
-return the property values, starting with the location for
- first_property_name, terminated by %NULL.
+<parameter name="type">
+<parameter_description> kind of child or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_hsv_set_color">
+<function name="gtk_buildable_construct_child">
<description>
-Sets the current color in an HSV color selector.
-Color component values must be in the [0.0, 1.0] range.
+Constructs a child of @buildable with the name @name.
-Since: 2.14
+#GtkBuilder calls this function if a "constructor" has been
+specified in the UI definition.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="hsv">
-<parameter_description> An HSV color selector
-</parameter_description>
-</parameter>
-<parameter name="h">
-<parameter_description> Hue
+<parameter name="buildable">
+<parameter_description> A #GtkBuildable
</parameter_description>
</parameter>
-<parameter name="s">
-<parameter_description> Saturation
+<parameter name="builder">
+<parameter_description> #GtkBuilder used to construct this object
</parameter_description>
</parameter>
-<parameter name="v">
-<parameter_description> Value
+<parameter name="name">
+<parameter_description> name of child to construct
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the constructed child
+
+</return>
</function>
-<function name="gtk_calendar_thaw">
+<function name="gtk_buildable_custom_finished">
<description>
-Does nothing. Previously defrosted a calendar; all the changes made
-since the last gtk_calendar_freeze() were displayed.
+This is similar to gtk_buildable_parser_finished() but is
+called once for each custom tag handled by the @buildable.
-Deprecated: 2.8:
+Since: 2.12
</description>
<parameters>
-<parameter name="calendar">
-<parameter_description> a #GtkCalendar
+<parameter name="buildable">
+<parameter_description> a #GtkBuildable
+</parameter_description>
+</parameter>
+<parameter name="builder">
+<parameter_description> a #GtkBuilder
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> child object or %NULL for non-child tags
+</parameter_description>
+</parameter>
+<parameter name="tagname">
+<parameter_description> the name of the tag
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> user data created in custom_tag_start
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_mount_operation_is_showing">
+<function name="gtk_buildable_custom_tag_end">
<description>
-Returns whether the #GtkMountOperation is currently displaying
-a window.
+This is called at the end of each custom element handled by
+the buildable.
-Since: 2.14
+Since: 2.12
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkMountOperation
+<parameter name="buildable">
+<parameter_description> A #GtkBuildable
+</parameter_description>
+</parameter>
+<parameter name="builder">
+<parameter_description> #GtkBuilder used to construct this object
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> child object or %NULL for non-child tags
+</parameter_description>
+</parameter>
+<parameter name="tagname">
+<parameter_description> name of tag
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> user data that will be passed in to parser functions
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @op is currently displaying a window
-
-</return>
+<return></return>
</function>
-<function name="gtk_tooltip_set_markup">
+<function name="gtk_buildable_custom_tag_start">
<description>
-Sets the text of the tooltip to be @markup, which is marked up
-with the <link
-linkend="PangoMarkupFormat">Pango text markup language</link>.
-If @markup is %NULL, the label will be hidden.
+This is called for each unknown element under <child>.
Since: 2.12
</description>
<parameters>
-<parameter name="tooltip">
-<parameter_description> a #GtkTooltip
+<parameter name="buildable">
+<parameter_description> a #GtkBuildable
</parameter_description>
</parameter>
-<parameter name="markup">
-<parameter_description> a markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>) or %NULL
+<parameter name="builder">
+<parameter_description> a #GtkBuilder used to construct this object
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> child object or %NULL for non-child tags
+</parameter_description>
+</parameter>
+<parameter name="tagname">
+<parameter_description> name of tag
+</parameter_description>
+</parameter>
+<parameter name="parser">
+<parameter_description> a #GMarkupParser structure to fill in
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> return location for user data that will be passed in
+to parser functions
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if a object has a custom implementation, %FALSE
+if it doesn't.
+
+</return>
</function>
-<function name="gtk_style_get_font">
+<function name="gtk_buildable_get_internal_child">
<description>
-Gets the #GdkFont to use for the given style. This is
-meant only as a replacement for direct access to @style->font
-and should not be used in new code. New code should
-use @style->font_desc instead.
+Get the internal child called @childname of the @buildable object.
+Since: 2.12
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
+<parameter name="buildable">
+<parameter_description> a #GtkBuildable
+</parameter_description>
+</parameter>
+<parameter name="builder">
+<parameter_description> a #GtkBuilder
+</parameter_description>
+</parameter>
+<parameter name="childname">
+<parameter_description> name of child
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkFont for the style. This font is owned
-by the style; if you want to keep around a copy, you must
-call gdk_font_ref().
+<return> the internal child of the buildable object
+
</return>
</function>
-<function name="gtk_recent_chooser_get_items">
+<function name="gtk_buildable_get_name">
<description>
-Gets the list of recently used resources in form of #GtkRecentInfo objects.
+Gets the name of the @buildable object.
-The return value of this function is affected by the "sort-type" and
-"limit" properties of @chooser.
+#GtkBuilder sets the name based on the the
+<link linkend="BUILDER-UI">GtkBuilder UI definition</link>
+used to construct the @buildable.
-Since: 2.10
+Since: 2.12
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
+<parameter name="buildable">
+<parameter_description> a #GtkBuildable
</parameter_description>
</parameter>
</parameters>
-<return> A newly allocated
-list of #GtkRecentInfo objects. You should
-use gtk_recent_info_unref() on every item of the list, and then free
-the list itself using g_list_free().
+<return> the name set with gtk_buildable_set_name()
</return>
</function>
-<function name="gtk_font_selection_dialog_get_font">
+<function name="gtk_buildable_parser_finished">
<description>
-Gets the currently-selected font.
+Called when the builder finishes the parsing of a
+<link linkend="BUILDER-UI">GtkBuilder UI definition</link>.
+Note that this will be called once for each time
+gtk_builder_add_from_file() or gtk_builder_add_from_string()
+is called on a builder.
-Deprecated: 2.0: Use gtk_font_selection_dialog_get_font_name() instead.
+Since: 2.12
</description>
<parameters>
-<parameter name="fsd">
-<parameter_description> a #GtkFontSelectionDialog
+<parameter name="buildable">
+<parameter_description> a #GtkBuildable
+</parameter_description>
+</parameter>
+<parameter name="builder">
+<parameter_description> a #GtkBuilder
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkFont from the #GtkFontSelection for the
-currently selected font in the dialog, or %NULL if no font is selected
-
-</return>
+<return></return>
</function>
-<function name="gtk_check_version">
+<function name="gtk_buildable_set_buildable_property">
<description>
-Checks that the GTK+ library in use is compatible with the
-given version. Generally you would pass in the constants
-#GTK_MAJOR_VERSION, #GTK_MINOR_VERSION, #GTK_MICRO_VERSION
-as the three arguments to this function; that produces
-a check that the library in use is compatible with
-the version of GTK+ the application or module was compiled
-against.
-
-Compatibility is defined by two things: first the version
-of the running library is newer than the version
- required_major required_minor @required_micro. Second
-the running library must be binary compatible with the
-version @required_major required_minor required_micro
-(same major version.)
-
-This function is primarily for GTK+ modules; the module
-can call this function to check that it wasn't loaded
-into an incompatible version of GTK+. However, such a
-a check isn't completely reliable, since the module may be
-linked against an old version of GTK+ and calling the
-old version of gtk_check_version(), but still get loaded
-into an application using a newer version of GTK+.
+Sets the property name @name to @value on the @buildable object.
+Since: 2.12
</description>
<parameters>
-<parameter name="required_major">
-<parameter_description> the required major version.
+<parameter name="buildable">
+<parameter_description> a #GtkBuildable
</parameter_description>
</parameter>
-<parameter name="required_minor">
-<parameter_description> the required minor version.
+<parameter name="builder">
+<parameter_description> a #GtkBuilder
</parameter_description>
</parameter>
-<parameter name="required_micro">
-<parameter_description> the required micro version.
+<parameter name="name">
+<parameter_description> name of property
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> value of property
</parameter_description>
</parameter>
</parameters>
-<return> %NULL if the GTK+ library is compatible with the
-given version, or a string describing the version mismatch.
-The returned string is owned by GTK+ and should not be modified
-or freed.
-</return>
+<return></return>
</function>
-<function name="gtk_drag_dest_get_track_motion">
+<function name="gtk_buildable_set_name">
<description>
-Returns whether the widget has been configured to always
-emit ::drag-motion signals.
+Sets the name of the @buildable object.
-Since: 2.10
+Since: 2.12
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget that's a drag destination
+<parameter name="buildable">
+<parameter_description> a #GtkBuildable
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> name to set
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the widget always emits ::drag-motion events
-
-</return>
+<return></return>
</function>
-<function name="gtk_ui_manager_get_ui">
+<function name="gtk_builder_add_from_file">
<description>
-Creates a <link linkend="XML-UI">UI definition</link> of the merged UI.
+Parses a file containing a <link linkend="BUILDER-UI">GtkBuilder
+UI definition</link> and merges it with the current contents of @builder.
-Since: 2.4
+Upon errors 0 will be returned and @error will be assigned a
+#GError from the #GTK_BUILDER_ERROR, #G_MARKUP_ERROR or #G_FILE_ERROR
+domain.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #GtkUIManager
+<parameter name="builder">
+<parameter_description> a #GtkBuilder
+</parameter_description>
+</parameter>
+<parameter name="filename">
+<parameter_description> the name of the file to parse
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for an error, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> A newly allocated string containing an XML representation of
-the merged UI.
+<return> A positive value on success, 0 if an error occurred
</return>
</function>
-<function name="gtk_entry_get_text_length">
+<function name="gtk_builder_add_from_string">
<description>
-Retrieves the current length of the text in
- entry
-
-This is equivalent to:
+Parses a string containing a <link linkend="BUILDER-UI">GtkBuilder
+UI definition</link> and merges it with the current contents of @builder.
-<informalexample><programlisting>
-gtk_entry_buffer_get_length (gtk_entry_get_buffer (entry));
-</programlisting></informalexample>
+Upon errors 0 will be returned and @error will be assigned a
+#GError from the #GTK_BUILDER_ERROR or #G_MARKUP_ERROR domain.
-Since: 2.14
+Since: 2.12
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="builder">
+<parameter_description> a #GtkBuilder
+</parameter_description>
+</parameter>
+<parameter name="buffer">
+<parameter_description> the string to parse
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> the length of @buffer (may be -1 if @buffer is nul-terminated)
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for an error, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the current number of characters
-in #GtkEntry, or 0 if there are none.
+<return> A positive value on success, 0 if an error occurred
</return>
</function>
-<function name="gtk_selection_data_get_data">
+<function name="gtk_builder_add_objects_from_file">
<description>
-Retrieves the raw data of the selection.
+Parses a file containing a <link linkend="BUILDER-UI">GtkBuilder
+UI definition</link> building only the requested objects and merges
+them with the current contents of @builder.
+
+Upon errors 0 will be returned and @error will be assigned a
+#GError from the #GTK_BUILDER_ERROR, #G_MARKUP_ERROR or #G_FILE_ERROR
+domain.
+
+<note><para>
+If you are adding an object that depends on an object that is not
+its child (for instance a #GtkTreeView that depends on its
+#GtkTreeModel), you have to explicitely list all of them in @object_ids.
+</para></note>
Since: 2.14
</description>
<parameters>
-<parameter name="selection_data">
-<parameter_description> a pointer to a #GtkSelectionData structure.
+<parameter name="builder">
+<parameter_description> a #GtkBuilder
+</parameter_description>
+</parameter>
+<parameter name="filename">
+<parameter_description> the name of the file to parse
+</parameter_description>
+</parameter>
+<parameter name="object_ids">
+<parameter_description> nul-terminated array of objects to build
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for an error, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the raw data of the selection.
+<return> A positive value on success, 0 if an error occurred
</return>
</function>
-<function name="gtk_toolbar_insert">
+<function name="gtk_builder_add_objects_from_string">
<description>
-Insert a #GtkToolItem into the toolbar at position @pos. If @pos is
-0 the item is prepended to the start of the toolbar. If @pos is
-negative, the item is appended to the end of the toolbar.
+Parses a string containing a <link linkend="BUILDER-UI">GtkBuilder
+UI definition</link> building only the requested objects and merges
+them with the current contents of @builder.
-Since: 2.4
+Upon errors 0 will be returned and @error will be assigned a
+#GError from the #GTK_BUILDER_ERROR or #G_MARKUP_ERROR domain.
+
+<note><para>
+If you are adding an object that depends on an object that is not
+its child (for instance a #GtkTreeView that depends on its
+#GtkTreeModel), you have to explicitely list all of them in @object_ids.
+</para></note>
+
+Since: 2.14
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar
+<parameter name="builder">
+<parameter_description> a #GtkBuilder
</parameter_description>
</parameter>
-<parameter name="item">
-<parameter_description> a #GtkToolItem
+<parameter name="buffer">
+<parameter_description> the string to parse
</parameter_description>
</parameter>
-<parameter name="pos">
-<parameter_description> the position of the new item
+<parameter name="length">
+<parameter_description> the length of @buffer (may be -1 if @buffer is nul-terminated)
+</parameter_description>
+</parameter>
+<parameter name="object_ids">
+<parameter_description> nul-terminated array of objects to build
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for an error, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A positive value on success, 0 if an error occurred
+
+</return>
</function>
-<function name="gtk_icon_view_set_orientation">
+<function name="gtk_builder_connect_signals">
<description>
-Sets the ::orientation property which determines whether the labels
-are drawn beside the icons instead of below.
+This method is a simpler variation of gtk_builder_connect_signals_full().
+It uses #GModule's introspective features (by opening the module %NULL)
+to look at the application's symbol table. From here it tries to match
+the signal handler names given in the interface description with
+symbols in the application and connects the signals.
-Since: 2.6
+Note that this function will not work correctly if #GModule is not
+supported on the platform.
-Deprecated: 2.22: Use gtk_icon_view_set_item_orientation()
+When compiling applications for Windows, you must declare signal callbacks
+with #G_MODULE_EXPORT, or they will not be put in the symbol table.
+On Linux and Unices, this is not necessary; applications should instead
+be compiled with the -Wl,--export-dynamic CFLAGS, and linked against
+gmodule-export-2.0.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
+<parameter name="builder">
+<parameter_description> a #GtkBuilder
</parameter_description>
</parameter>
-<parameter name="orientation">
-<parameter_description> the relative position of texts and icons
+<parameter name="user_data">
+<parameter_description> a pointer to a structure sent in as user data to all signals
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_remove_selection_clipboard">
+<function name="gtk_builder_connect_signals_full">
<description>
-Removes a #GtkClipboard added with
-gtk_text_buffer_add_selection_clipboard().
+This function can be thought of the interpreted language binding
+version of gtk_builder_connect_signals(), except that it does not
+require GModule to function correctly.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="builder">
+<parameter_description> a #GtkBuilder
</parameter_description>
</parameter>
-<parameter name="clipboard">
-<parameter_description> a #GtkClipboard added to @buffer by
-gtk_text_buffer_add_selection_clipboard()
+<parameter name="func">
+<parameter_description> the function used to connect the signals
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> arbitrary data that will be passed to the connection function
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_store_insert_with_valuesv">
+<function name="gtk_builder_get_object">
<description>
-A variant of gtk_tree_store_insert_with_values() which takes
-the columns and values as two arrays, instead of varargs. This
-function is mainly intended for language bindings.
+Gets the object named @name. Note that this function does not
+increment the reference count of the returned object.
-Since: 2.10
+Since: 2.12
</description>
<parameters>
-<parameter name="tree_store">
-<parameter_description> A #GtkTreeStore
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> An unset #GtkTreeIter to set the new row, or %NULL.
-</parameter_description>
-</parameter>
-<parameter name="parent">
-<parameter_description> A valid #GtkTreeIter, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="position">
-<parameter_description> position to insert the new row
-</parameter_description>
-</parameter>
-<parameter name="columns">
-<parameter_description> an array of column numbers
-</parameter_description>
-</parameter>
-<parameter name="values">
-<parameter_description> an array of GValues
+<parameter name="builder">
+<parameter_description> a #GtkBuilder
</parameter_description>
</parameter>
-<parameter name="n_values">
-<parameter_description> the length of the @columns and @values arrays
+<parameter name="name">
+<parameter_description> name of object to get
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the object named @name or %NULL if
+it could not be found in the object tree.
+
+</return>
</function>
-<function name="gtk_widget_size_allocate">
+<function name="gtk_builder_get_objects">
<description>
-This function is only used by #GtkContainer subclasses, to assign a size
-and position to their child widgets.
+Gets all objects that have been constructed by @builder. Note that
+this function does not increment the reference counts of the returned
+objects.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="allocation">
-<parameter_description> position and size to be allocated to @widget
+<parameter name="builder">
+<parameter_description> a #GtkBuilder
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a newly-allocated #GSList containing all the objects
+constructed by the #GtkBuilder instance. It should be freed by
+g_slist_free()
+
+</return>
</function>
-<function name="gtk_tree_store_prepend">
+<function name="gtk_builder_get_translation_domain">
<description>
-Prepends a new row to @tree_store. If @parent is non-%NULL, then it will prepend
-the new row before the first child of @parent, otherwise it will prepend a row
-to the top level. @iter will be changed to point to this new row. The row
-will be empty after this function is called. To fill in values, you need to
-call gtk_tree_store_set() or gtk_tree_store_set_value().
+Gets the translation domain of @builder.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="tree_store">
-<parameter_description> A #GtkTreeStore
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> An unset #GtkTreeIter to set to the prepended row
-</parameter_description>
-</parameter>
-<parameter name="parent">
-<parameter_description> A valid #GtkTreeIter, or %NULL
+<parameter name="builder">
+<parameter_description> a #GtkBuilder
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the translation domain. This string is owned
+by the builder object and must not be modified or freed.
+
+</return>
</function>
-<function name="gtk_toggle_action_set_draw_as_radio">
+<function name="gtk_builder_get_type_from_name">
<description>
-Sets whether the action should have proxies like a radio action.
+Looks up a type by name, using the virtual function that
+#GtkBuilder has for that purpose. This is mainly used when
+implementing the #GtkBuildable interface on a type.
-Since: 2.4
+Since: 2.12
</description>
<parameters>
-<parameter name="action">
-<parameter_description> the action object
+<parameter name="builder">
+<parameter_description> a #GtkBuilder
</parameter_description>
</parameter>
-<parameter name="draw_as_radio">
-<parameter_description> whether the action should have proxies like a radio
-action
+<parameter name="type_name">
+<parameter_description> type name to lookup
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GType found for @type_name or #G_TYPE_INVALID
+if no type was found
+
+</return>
</function>
-<function name="gtk_binding_set_add_path">
+<function name="gtk_builder_new">
<description>
-This function is used internally by the GtkRC parsing mechanism to
-assign match patterns to #GtkBindingSet structures.
+Creates a new builder object.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="binding_set">
-<parameter_description> a #GtkBindingSet to add a path to
-</parameter_description>
-</parameter>
-<parameter name="path_type">
-<parameter_description> path type the pattern applies to
-</parameter_description>
-</parameter>
-<parameter name="path_pattern">
-<parameter_description> the actual match pattern
-</parameter_description>
-</parameter>
-<parameter name="priority">
-<parameter_description> binding priority
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> a new #GtkBuilder object
+
+</return>
</function>
-<function name="gtk_spinner_stop">
+<function name="gtk_builder_set_translation_domain">
<description>
-Stops the animation of the spinner.
+Sets the translation domain of @builder.
+See #GtkBuilder:translation-domain.
-Since: 2.20
+Since: 2.12
</description>
<parameters>
-<parameter name="spinner">
-<parameter_description> a #GtkSpinner
+<parameter name="builder">
+<parameter_description> a #GtkBuilder
+</parameter_description>
+</parameter>
+<parameter name="domain">
+<parameter_description> the translation domain or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_get_iter_at_mark">
+<function name="gtk_builder_value_from_string">
<description>
-Initializes @iter with the current position of @mark.
+This function demarshals a value from a string. This function
+calls g_value_init() on the @value argument, so it need not be
+initialised beforehand.
+
+This function can handle char, uchar, boolean, int, uint, long,
+ulong, enum, flags, float, double, string, #GdkColor and
+#GtkAdjustment type values. Support for #GtkWidget type values is
+still to come.
+
+Upon errors %FALSE will be returned and @error will be assigned a
+#GError from the #GTK_BUILDER_ERROR domain.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="builder">
+<parameter_description> a #GtkBuilder
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> iterator to initialize
+<parameter name="pspec">
+<parameter_description> the #GParamSpec for the property
</parameter_description>
</parameter>
-<parameter name="mark">
-<parameter_description> a #GtkTextMark in @buffer
+<parameter name="string">
+<parameter_description> the string representation of the value
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> the #GValue to store the result in
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for an error, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE on success
+
+</return>
</function>
-<function name="gtk_entry_get_overwrite_mode">
+<function name="gtk_builder_value_from_string_type">
<description>
-Gets the value set by gtk_entry_set_overwrite_mode().
+Like gtk_builder_value_from_string(), this function demarshals
+a value from a string, but takes a #GType instead of #GParamSpec.
+This function calls g_value_init() on the @value argument, so it
+need not be initialised beforehand.
-Since: 2.14
+Upon errors %FALSE will be returned and @error will be assigned a
+#GError from the #GTK_BUILDER_ERROR domain.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="builder">
+<parameter_description> a #GtkBuilder
+</parameter_description>
+</parameter>
+<parameter name="type">
+<parameter_description> the #GType of the value
+</parameter_description>
+</parameter>
+<parameter name="string">
+<parameter_description> the string representation of the value
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> the #GValue to store the result in
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for an error, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> whether the text is overwritten when typing.
+<return> %TRUE on success
</return>
</function>
-<function name="gtk_window_get_icon_list">
+<function name="gtk_button_box_get_child_secondary">
<description>
-Retrieves the list of icons set by gtk_window_set_icon_list().
-The list is copied, but the reference count on each
-member won't be incremented.
+Returns whether @child should appear in a secondary group of children.
+Since: 2.4
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="widget">
+<parameter_description> a #GtkButtonBox
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> a child of @widget
</parameter_description>
</parameter>
</parameters>
-<return> copy of window's icon list
+<return> whether @child should appear in a secondary group of children.
+
</return>
</function>
-<function name="gtk_show_about_dialog">
+<function name="gtk_button_box_set_child_secondary">
<description>
-This is a convenience function for showing an application's about box.
-The constructed dialog is associated with the parent window and
-reused for future invocations of this function.
+Sets whether @child should appear in a secondary group of children.
+A typical use of a secondary child is the help button in a dialog.
-Since: 2.6
+This group appears after the other children if the style
+is %GTK_BUTTONBOX_START, %GTK_BUTTONBOX_SPREAD or
+%GTK_BUTTONBOX_EDGE, and before the other children if the style
+is %GTK_BUTTONBOX_END. For horizontal button boxes, the definition
+of before/after depends on direction of the widget (see
+gtk_widget_set_direction()). If the style is %GTK_BUTTONBOX_START
+or %GTK_BUTTONBOX_END, then the secondary children are aligned at
+the other end of the button box from the main children. For the
+other styles, they appear immediately next to the main children.
</description>
<parameters>
-<parameter name="parent">
-<parameter_description> transient parent, or %NULL for none
+<parameter name="widget">
+<parameter_description> a #GtkButtonBox
</parameter_description>
</parameter>
-<parameter name="first_property_name">
-<parameter_description> the name of the first property
+<parameter name="child">
+<parameter_description> a child of @widget
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> value of first property, followed by more properties, %NULL-terminated
+<parameter name="is_secondary">
+<parameter_description> if %TRUE, the @child appears in a secondary group of the
+button box.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_selection_unselect_range">
+<function name="gtk_button_get_alignment">
<description>
-Unselects a range of nodes, determined by @start_path and @end_path
-inclusive.
+Gets the alignment of the child in the button.
-Since: 2.2
+Since: 2.4
</description>
<parameters>
-<parameter name="selection">
-<parameter_description> A #GtkTreeSelection.
+<parameter name="button">
+<parameter_description> a #GtkButton
</parameter_description>
</parameter>
-<parameter name="start_path">
-<parameter_description> The initial node of the range.
+<parameter name="xalign">
+<parameter_description> return location for horizontal alignment
</parameter_description>
</parameter>
-<parameter name="end_path">
-<parameter_description> The initial node of the range.
+<parameter name="yalign">
+<parameter_description> return location for vertical alignment
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_rc_parse_color">
+<function name="gtk_button_get_event_window">
<description>
-Parses a color in the <link linkend="color=format">format</link> expected
-in a RC file.
-
-Note that theme engines should use gtk_rc_parse_color_full() in
-order to support symbolic colors.
+Returns the button's event window if it is realized, %NULL otherwise.
+This function should be rarely needed.
+Since: 2.22
</description>
<parameters>
-<parameter name="scanner">
-<parameter_description> a #GScanner
-</parameter_description>
-</parameter>
-<parameter name="color">
-<parameter_description> a pointer to a #GdkColor structure in which to store the result
+<parameter name="button">
+<parameter_description> a #GtkButton
</parameter_description>
</parameter>
</parameters>
-<return> %G_TOKEN_NONE if parsing succeeded, otherwise the token
-that was expected but not found
+<return> @button's event window.
+
</return>
</function>
-<function name="gtk_tree_view_get_grid_lines">
+<function name="gtk_button_get_focus_on_click">
<description>
-Returns which grid lines are enabled in @tree_view.
+Returns whether the button grabs focus when it is clicked with the mouse.
+See gtk_button_set_focus_on_click().
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
+<parameter name="button">
+<parameter_description> a #GtkButton
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkTreeViewGridLines value indicating which grid lines
-are enabled.
+<return> %TRUE if the button grabs focus when it is clicked with
+the mouse.
</return>
</function>
-<function name="gtk_action_set_tooltip">
+<function name="gtk_button_get_image">
<description>
-Sets the tooltip text on @action
+Gets the widget that is currenty set as the image of @button.
+This may have been explicitly set by gtk_button_set_image()
+or constructed by gtk_button_new_from_stock().
-Since: 2.16
+Since: 2.6
</description>
<parameters>
-<parameter name="action">
-<parameter_description> a #GtkAction
-</parameter_description>
-</parameter>
-<parameter name="tooltip">
-<parameter_description> the tooltip text
+<parameter name="button">
+<parameter_description> a #GtkButton
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #GtkWidget or %NULL in case there is no image
+
+</return>
</function>
-<function name="gtk_print_settings_get_printer">
+<function name="gtk_button_get_image_position">
<description>
-Convenience function to obtain the value of
-%GTK_PRINT_SETTINGS_PRINTER.
+Gets the position of the image relative to the text
+inside the button.
Since: 2.10
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="button">
+<parameter_description> a #GtkButton
</parameter_description>
</parameter>
</parameters>
-<return> the printer name
+<return> the position
</return>
</function>
-<function name="gtk_print_operation_set_embed_page_setup">
+<function name="gtk_button_get_label">
<description>
-Embed page size combo box and orientation combo box into page setup page.
-Selected page setup is stored as default page setup in #GtkPrintOperation.
+Fetches the text from the label of the button, as set by
+gtk_button_set_label(). If the label text has not
+been set the return value will be %NULL. This will be the
+case if you create an empty button with gtk_button_new() to
+use as a container.
-Since: 2.18
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkPrintOperation
-</parameter_description>
-</parameter>
-<parameter name="embed">
-<parameter_description> %TRUE to embed page setup selection in the #GtkPrintDialog
+<parameter name="button">
+<parameter_description> a #GtkButton
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The text of the label widget. This string is owned
+by the widget and must not be modified or freed.
+</return>
</function>
-<function name="gtk_tree_store_insert_after">
+<function name="gtk_button_get_use_stock">
<description>
-Inserts a new row after @sibling. If @sibling is %NULL, then the row will be
-prepended to @parent 's children. If @parent and @sibling are %NULL, then
-the row will be prepended to the toplevel. If both @sibling and @parent are
-set, then @parent must be the parent of @sibling. When @sibling is set,
- parent is optional.
-
- iter will be changed to point to this new row. The row will be empty after
-this function is called. To fill in values, you need to call
-gtk_tree_store_set() or gtk_tree_store_set_value().
+Returns whether the button label is a stock item.
</description>
<parameters>
-<parameter name="tree_store">
-<parameter_description> A #GtkTreeStore
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> An unset #GtkTreeIter to set to the new row
-</parameter_description>
-</parameter>
-<parameter name="parent">
-<parameter_description> A valid #GtkTreeIter, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="sibling">
-<parameter_description> A valid #GtkTreeIter, or %NULL
+<parameter name="button">
+<parameter_description> a #GtkButton
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the button label is used to
+select a stock item instead of being
+used directly as the label text.
+</return>
</function>
-<function name="gtk_text_iter_backward_visible_word_start">
+<function name="gtk_button_get_use_underline">
<description>
-Moves backward to the previous visible word start. (If @iter is currently
-on a word start, moves backward to the next one after that.) Word breaks
-are determined by Pango and should be correct for nearly any
-language (if not, the correct fix would be to the Pango word break
-algorithms).
+Returns whether an embedded underline in the button label indicates a
+mnemonic. See gtk_button_set_use_underline ().
-Since: 2.4
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="button">
+<parameter_description> a #GtkButton
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter moved and is not the end iterator
-
+<return> %TRUE if an embedded underline in the button label
+indicates the mnemonic accelerator keys.
</return>
</function>
-<function name="gtk_image_set_pixel_size">
+<function name="gtk_button_new_from_stock">
<description>
-Sets the pixel size to use for named icons. If the pixel size is set
-to a value != -1, it is used instead of the icon size set by
-gtk_image_set_from_icon_name().
+Creates a new #GtkButton containing the image and text from a stock item.
+Some stock ids have preprocessor macros like #GTK_STOCK_OK and
+#GTK_STOCK_APPLY.
+
+If @stock_id is unknown, then it will be treated as a mnemonic
+label (as for gtk_button_new_with_mnemonic()).
-Since: 2.6
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GtkImage
+<parameter name="stock_id">
+<parameter_description> the name of the stock item
</parameter_description>
</parameter>
-<parameter name="pixel_size">
-<parameter_description> the new pixel size
+</parameters>
+<return> a new #GtkButton
+</return>
+</function>
+
+<function name="gtk_button_new_with_mnemonic">
+<description>
+Creates a new #GtkButton containing a label.
+If characters in @label are preceded by an underscore, they are underlined.
+If you need a literal underscore character in a label, use '__' (two
+underscores). The first underlined character represents a keyboard
+accelerator called a mnemonic.
+Pressing Alt and that key activates the button.
+
+</description>
+<parameters>
+<parameter name="label">
+<parameter_description> The text of the button, with an underscore in front of the
+mnemonic character
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GtkButton
+</return>
</function>
-<function name="gtk_dialog_add_buttons">
+<function name="gtk_button_set_alignment">
<description>
-Adds more buttons, same as calling gtk_dialog_add_button()
-repeatedly. The variable argument list should be %NULL-terminated
-as with gtk_dialog_new_with_buttons(). Each button must have both
-text and response ID.
+Sets the alignment of the child. This property has no effect unless
+the child is a #GtkMisc or a #GtkAligment.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkDialog
+<parameter name="button">
+<parameter_description> a #GtkButton
</parameter_description>
</parameter>
-<parameter name="first_button_text">
-<parameter_description> button text or stock ID
+<parameter name="xalign">
+<parameter_description> the horizontal position of the child, 0.0 is left aligned,
+1.0 is right aligned
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> response ID for first button, then more text-response_id pairs
+<parameter name="yalign">
+<parameter_description> the vertical position of the child, 0.0 is top aligned,
+1.0 is bottom aligned
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_paned_get_child2">
+<function name="gtk_button_set_focus_on_click">
<description>
-Obtains the second child of the paned widget.
+Sets whether the button will grab focus when it is clicked with the mouse.
+Making mouse clicks not grab focus is useful in places like toolbars where
+you don't want the keyboard focus removed from the main area of the
+application.
Since: 2.4
</description>
<parameters>
-<parameter name="paned">
-<parameter_description> a #GtkPaned widget
+<parameter name="button">
+<parameter_description> a #GtkButton
+</parameter_description>
+</parameter>
+<parameter name="focus_on_click">
+<parameter_description> whether the button grabs focus when clicked with the mouse
</parameter_description>
</parameter>
</parameters>
-<return> second child, or %NULL if it is not set.
-
-</return>
+<return></return>
</function>
-<function name="gtk_paned_get_child1">
+<function name="gtk_button_set_image">
<description>
-Obtains the first child of the paned widget.
+Set the image of @button to the given widget. Note that
+it depends on the #GtkSettings:gtk-button-images setting whether the
+image will be displayed or not, you don't have to call
+gtk_widget_show() on @image yourself.
-Since: 2.4
+Since: 2.6
</description>
<parameters>
-<parameter name="paned">
-<parameter_description> a #GtkPaned widget
+<parameter name="button">
+<parameter_description> a #GtkButton
+</parameter_description>
+</parameter>
+<parameter name="image">
+<parameter_description> a widget to set as the image for the button
</parameter_description>
</parameter>
</parameters>
-<return> first child, or %NULL if it is not set.
-
-</return>
+<return></return>
</function>
-<function name="gtk_text_layout_get_lines">
+<function name="gtk_button_set_image_position">
<description>
+Sets the position of the image relative to the text
+inside the button.
+
+Since: 2.10
</description>
<parameters>
+<parameter name="button">
+<parameter_description> a #GtkButton
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> the position
+</parameter_description>
+</parameter>
</parameters>
-<return>
-</return>
+<return></return>
</function>
-<function name="gtk_tree_store_new">
+<function name="gtk_button_set_label">
<description>
-Creates a new tree store as with @n_columns columns each of the types passed
-in. Note that only types derived from standard GObject fundamental types
-are supported.
-
-As an example, <literal>gtk_tree_store_new (3, G_TYPE_INT, G_TYPE_STRING,
-GDK_TYPE_PIXBUF);</literal> will create a new #GtkTreeStore with three columns, of type
-<type>int</type>, <type>string</type> and #GdkPixbuf respectively.
+Sets the text of the label of the button to @str. This text is
+also used to select the stock item if gtk_button_set_use_stock()
+is used.
+This will also clear any previously set labels.
</description>
<parameters>
-<parameter name="n_columns">
-<parameter_description> number of columns in the tree store
+<parameter name="button">
+<parameter_description> a #GtkButton
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> all #GType types for the columns, from first to last
+<parameter name="label">
+<parameter_description> a string
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkTreeStore
-</return>
+<return></return>
</function>
-<function name="gtk_clipboard_get_owner">
+<function name="gtk_button_set_use_stock">
<description>
-If the clipboard contents callbacks were set with
-gtk_clipboard_set_with_owner(), and the gtk_clipboard_set_with_data() or
-gtk_clipboard_clear() has not subsequently called, returns the owner set
-by gtk_clipboard_set_with_owner().
-
+If %TRUE, the label set on the button is used as a
+stock id to select the stock item for the button.
</description>
<parameters>
-<parameter name="clipboard">
-<parameter_description> a #GtkClipboard
+<parameter name="button">
+<parameter_description> a #GtkButton
+</parameter_description>
+</parameter>
+<parameter name="use_stock">
+<parameter_description> %TRUE if the button should use a stock item
</parameter_description>
</parameter>
</parameters>
-<return> the owner of the clipboard, if any; otherwise %NULL.
-</return>
+<return></return>
</function>
-<function name="gtk_window_begin_move_drag">
+<function name="gtk_button_set_use_underline">
<description>
-Starts moving a window. This function is used if an application has
-window movement grips. When GDK can support it, the window movement
-will be done using the standard mechanism for the <link
-linkend="gtk-X11-arch">window manager</link> or windowing
-system. Otherwise, GDK will try to emulate window movement,
-potentially not all that well, depending on the windowing system.
-
+If true, an underline in the text of the button label indicates
+the next character should be used for the mnemonic accelerator key.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
-</parameter_description>
-</parameter>
<parameter name="button">
-<parameter_description> mouse button that initiated the drag
-</parameter_description>
-</parameter>
-<parameter name="root_x">
-<parameter_description> X position where the user clicked to initiate the drag, in root window coordinates
-</parameter_description>
-</parameter>
-<parameter name="root_y">
-<parameter_description> Y position where the user clicked to initiate the drag
+<parameter_description> a #GtkButton
</parameter_description>
</parameter>
-<parameter name="timestamp">
-<parameter_description> timestamp from the click event that initiated the drag
+<parameter name="use_underline">
+<parameter_description> %TRUE if underlines in the text indicate mnemonics
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_printer_option_set_get_groups">
+<function name="gtk_calendar_clear_marks">
<description>
+Remove all visual markers.
</description>
<parameters>
+<parameter name="calendar">
+<parameter_description> a #GtkCalendar
+</parameter_description>
+</parameter>
</parameters>
-<return>
-</return>
+<return></return>
</function>
-<function name="gtk_tree_view_get_path_at_pos">
+<function name="gtk_calendar_display_options">
<description>
-Finds the path at the point (@x, @y), relative to bin_window coordinates
-(please see gtk_tree_view_get_bin_window()).
-That is, @x and @y are relative to an events coordinates. @x and @y must
-come from an event on the @tree_view only where <literal>event->window ==
-gtk_tree_view_get_bin_window (<!-- -->)</literal>. It is primarily for
-things like popup menus. If @path is non-%NULL, then it will be filled
-with the #GtkTreePath at that point. This path should be freed with
-gtk_tree_path_free(). If @column is non-%NULL, then it will be filled
-with the column at that point. @cell_x and @cell_y return the coordinates
-relative to the cell background (i.e. the @background_area passed to
-gtk_cell_renderer_render()). This function is only meaningful if
- tree_view is realized. Therefore this function will always return %FALSE
-if @tree_view is not realized or does not have a model.
-
-For converting widget coordinates (eg. the ones you get from
-GtkWidget::query-tooltip), please see
-gtk_tree_view_convert_widget_to_bin_window_coords().
+Sets display options (whether to display the heading and the month headings).
+Deprecated: 2.4: Use gtk_calendar_set_display_options() instead
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView.
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> The x position to be identified (relative to bin_window).
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> The y position to be identified (relative to bin_window).
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> A pointer to a #GtkTreePath pointer to be filled in, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="column">
-<parameter_description> A pointer to a #GtkTreeViewColumn pointer to be filled in, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="cell_x">
-<parameter_description> A pointer where the X coordinate relative to the cell can be placed, or %NULL
+<parameter name="calendar">
+<parameter_description> a #GtkCalendar.
</parameter_description>
</parameter>
-<parameter name="cell_y">
-<parameter_description> A pointer where the Y coordinate relative to the cell can be placed, or %NULL
+<parameter name="flags">
+<parameter_description> the display options to set.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if a row exists at that coordinate.
-</return>
+<return></return>
</function>
-<function name="gtk_tree_view_set_search_entry">
+<function name="gtk_calendar_freeze">
<description>
-Sets the entry which the interactive search code will use for this
- tree_view This is useful when you want to provide a search entry
-in our interface at all time at a fixed position. Passing %NULL for
- entry will make the interactive search code use the built-in popup
-entry again.
+Does nothing. Previously locked the display of the calendar until
+it was thawed with gtk_calendar_thaw().
-Since: 2.10
+Deprecated: 2.8:
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView
-</parameter_description>
-</parameter>
-<parameter name="entry">
-<parameter_description> the entry the interactive search code of @tree_view should use or %NULL
+<parameter name="calendar">
+<parameter_description> a #GtkCalendar
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_file_chooser_set_current_folder_uri">
+<function name="gtk_calendar_get_date">
<description>
-Sets the current folder for @chooser from an URI.
-The user will be shown the full contents of the current folder,
-plus user interface elements for navigating to other folders.
-
-Since: 2.4
+Obtains the selected date from a #GtkCalendar.
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="calendar">
+<parameter_description> a #GtkCalendar
</parameter_description>
</parameter>
-<parameter name="uri">
-<parameter_description> the URI for the new current folder
+<parameter name="year">
+<parameter_description> location to store the year number, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="month">
+<parameter_description> location to store the month number (between 0 and 11), or %NULL
+</parameter_description>
+</parameter>
+<parameter name="day">
+<parameter_description> location to store the day number (between 1 and 31), or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the folder could be changed successfully, %FALSE
-otherwise.
-
-</return>
+<return></return>
</function>
-<function name="gtk_tool_shell_get_relief_style">
+<function name="gtk_calendar_get_detail_height_rows">
<description>
-Returns the relief style of buttons on @shell. Tool items must not call this
-function directly, but rely on gtk_tool_item_get_relief_style() instead.
+Queries the height of detail cells, in rows.
+See #GtkCalendar:detail-width-chars.
Since: 2.14
+
</description>
<parameters>
-<parameter name="shell">
-<parameter_description> a #GtkToolShell
+<parameter name="calendar">
+<parameter_description> a #GtkCalendar.
</parameter_description>
</parameter>
</parameters>
-<return> The relief style of buttons on @shell.
-
+<return> The height of detail cells, in rows.
</return>
</function>
-<function name="gtk_drag_source_set_icon_name">
+<function name="gtk_calendar_get_detail_width_chars">
<description>
-Sets the icon that will be used for drags from a particular source
-to a themed icon. See the docs for #GtkIconTheme for more details.
+Queries the width of detail cells, in characters.
+See #GtkCalendar:detail-width-chars.
+
+Since: 2.14
-Since: 2.8
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="icon_name">
-<parameter_description> name of icon to use
+<parameter name="calendar">
+<parameter_description> a #GtkCalendar.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The width of detail cells, in characters.
+</return>
</function>
-<function name="gtk_recent_info_get_description">
+<function name="gtk_calendar_get_display_options">
<description>
-Gets the (short) description of the resource.
+Returns the current display options of @calendar.
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter name="calendar">
+<parameter_description> a #GtkCalendar
</parameter_description>
</parameter>
</parameters>
-<return> the description of the resource. The returned string
-is owned by the recent manager, and should not be freed.
+<return> the display options.
</return>
</function>
-<function name="gtk_font_selection_get_size_list">
+<function name="gtk_calendar_mark_day">
<description>
-This returns the #GtkTreeeView used to list font sizes.
+Places a visual marker on a particular day.
+
+Note that this function always returns %TRUE, and you should
+ignore the return value. In GTK+ 3, this function will not
+return a value.
-Since: 2.14
</description>
<parameters>
-<parameter name="fontsel">
-<parameter_description> a #GtkFontSelection
+<parameter name="calendar">
+<parameter_description> a #GtkCalendar
+</parameter_description>
+</parameter>
+<parameter name="day">
+<parameter_description> the day number to mark between 1 and 31.
</parameter_description>
</parameter>
</parameters>
-<return> A #GtkWidget that is part of @fontsel
-
+<return> %TRUE, always
</return>
</function>
-<function name="gtk_rc_find_pixmap_in_path">
+<function name="gtk_calendar_new">
<description>
-Looks up a file in pixmap path for the specified #GtkSettings.
-If the file is not found, it outputs a warning message using
-g_warning() and returns %NULL.
+Creates a new calendar, with the current date being selected.
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkSettings
-</parameter_description>
-</parameter>
-<parameter name="scanner">
-<parameter_description> Scanner used to get line number information for the
-warning message, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="pixmap_file">
-<parameter_description> name of the pixmap file to locate.
-</parameter_description>
-</parameter>
</parameters>
-<return> the filename.
+<return> a newly #GtkCalendar widget
</return>
</function>
-<function name="gtk_icon_view_get_spacing">
+<function name="gtk_calendar_select_day">
<description>
-Returns the value of the ::spacing property.
-
-Since: 2.6
+Selects a day from the current month.
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
+<parameter name="calendar">
+<parameter_description> a #GtkCalendar.
+</parameter_description>
+</parameter>
+<parameter name="day">
+<parameter_description> the day number between 1 and 31, or 0 to unselect
+the currently selected day.
</parameter_description>
</parameter>
</parameters>
-<return> the space between cells
-
-</return>
+<return></return>
</function>
-<function name="gtk_page_setup_load_file">
+<function name="gtk_calendar_select_month">
<description>
-Reads the page setup from the file @file_name.
-See gtk_page_setup_to_file().
+Shifts the calendar to a different month.
+
+Note that this function always returns %TRUE, and you should
+ignore the return value. In GTK+ 3, this function will not
+return a value.
-Since: 2.14
</description>
<parameters>
-<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter name="calendar">
+<parameter_description> a #GtkCalendar
</parameter_description>
</parameter>
-<parameter name="file_name">
-<parameter_description> the filename to read the page setup from
+<parameter name="month">
+<parameter_description> a month number between 0 and 11.
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for an error, or %NULL
+<parameter name="year">
+<parameter_description> the year the month is in.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success
-
+<return> %TRUE, always
</return>
</function>
-<function name="gtk_cell_renderer_set_alignment">
+<function name="gtk_calendar_set_detail_func">
<description>
-Sets the renderer's alignment within its available space.
+Installs a function which provides Pango markup with detail information
+for each day. Examples for such details are holidays or appointments. That
+information is shown below each day when #GtkCalendar:show-details is set.
+A tooltip containing with full detail information is provided, if the entire
+text should not fit into the details area, or if #GtkCalendar:show-details
+is not set.
-Since: 2.18
+The size of the details area can be restricted by setting the
+#GtkCalendar:detail-width-chars and #GtkCalendar:detail-height-rows
+properties.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="cell">
-<parameter_description> A #GtkCellRenderer
+<parameter name="calendar">
+<parameter_description> a #GtkCalendar.
</parameter_description>
</parameter>
-<parameter name="xalign">
-<parameter_description> the x alignment of the cell renderer
+<parameter name="func">
+<parameter_description> a function providing details for each day.
</parameter_description>
</parameter>
-<parameter name="yalign">
-<parameter_description> the y alignment of the cell renderer
+<parameter name="data">
+<parameter_description> data to pass to @func invokations.
+</parameter_description>
+</parameter>
+<parameter name="destroy">
+<parameter_description> a function for releasing @data.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_status_icon_get_screen">
+<function name="gtk_calendar_set_detail_height_rows">
<description>
-Returns the #GdkScreen associated with @status_icon.
+Updates the height of detail cells.
+See #GtkCalendar:detail-height-rows.
-Since: 2.12
+Since: 2.14
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
+<parameter name="calendar">
+<parameter_description> a #GtkCalendar.
+</parameter_description>
+</parameter>
+<parameter name="rows">
+<parameter_description> detail height in rows.
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkScreen.
-
-</return>
+<return></return>
</function>
-<function name="gtk_paint_box_gap">
+<function name="gtk_calendar_set_detail_width_chars">
<description>
-Draws a box in @window using the given style and state and shadow type,
-leaving a gap in one side.
+Updates the width of detail cells.
+See #GtkCalendar:detail-width-chars.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
-</parameter_description>
-</parameter>
-<parameter name="shadow_type">
-<parameter_description> type of shadow to draw
-</parameter_description>
-</parameter>
-<parameter name="area">
-<parameter_description> clip rectangle, or %NULL if the
-output should not be clipped
-</parameter_description>
-</parameter>
-<parameter name="widget">
-<parameter_description> the widget
-</parameter_description>
-</parameter>
-<parameter name="detail">
-<parameter_description> a style detail
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> x origin of the rectangle
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> y origin of the rectangle
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> width of the rectangle
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> width of the rectangle
+<parameter name="calendar">
+<parameter_description> a #GtkCalendar.
</parameter_description>
</parameter>
-<parameter name="gap_side">
-<parameter_description> side in which to leave the gap
+<parameter name="chars">
+<parameter_description> detail width in characters.
</parameter_description>
</parameter>
-<parameter name="gap_x">
-<parameter_description> starting position of the gap
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_calendar_set_display_options">
+<description>
+Sets display options (whether to display the heading and the month
+headings).
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="calendar">
+<parameter_description> a #GtkCalendar
</parameter_description>
</parameter>
-<parameter name="gap_width">
-<parameter_description> width of the gap
+<parameter name="flags">
+<parameter_description> the display options to set
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_drag_dest_add_text_targets">
+<function name="gtk_calendar_thaw">
<description>
-Add the text targets supported by #GtkSelection to
-the target list of the drag destination. The targets
-are added with @info = 0. If you need another value,
-use gtk_target_list_add_text_targets() and
-gtk_drag_dest_set_target_list().
+Does nothing. Previously defrosted a calendar; all the changes made
+since the last gtk_calendar_freeze() were displayed.
-Since: 2.6
+Deprecated: 2.8:
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget that's a drag destination
+<parameter name="calendar">
+<parameter_description> a #GtkCalendar
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_entry_completion_set_text_column">
+<function name="gtk_calendar_unmark_day">
<description>
-Convenience function for setting up the most used case of this code: a
-completion list with just strings. This function will set up @completion
-to have a list displaying all (and just) strings in the completion list,
-and to get those strings from @column in the model of @completion.
+Removes the visual marker from a particular day.
-This functions creates and adds a #GtkCellRendererText for the selected
-column. If you need to set the text column, but don't want the cell
-renderer, use g_object_set() to set the ::text_column property directly.
+Note that this function always returns %TRUE, and you should
+ignore the return value. In GTK+ 3, this function will not
+return a value.
-Since: 2.4
</description>
<parameters>
-<parameter name="completion">
-<parameter_description> A #GtkEntryCompletion.
+<parameter name="calendar">
+<parameter_description> a #GtkCalendar.
</parameter_description>
</parameter>
-<parameter name="column">
-<parameter_description> The column in the model of @completion to get strings from.
+<parameter name="day">
+<parameter_description> the day number to unmark between 1 and 31.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE, always
+</return>
</function>
-<function name="gtk_status_icon_new_from_file">
+<function name="gtk_cell_editable_editing_done">
<description>
-Creates a status icon displaying the file @filename.
+Emits the #GtkCellEditable::editing-done signal.
-The image will be scaled down to fit in the available
-space in the notification area, if necessary.
+</description>
+<parameters>
+<parameter name="cell_editable">
+<parameter_description> A #GtkTreeEditable
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-Since: 2.10
+<function name="gtk_cell_editable_remove_widget">
+<description>
+Emits the #GtkCellEditable::remove-widget signal.
</description>
<parameters>
-<parameter name="filename">
-<parameter_description> a filename
+<parameter name="cell_editable">
+<parameter_description> A #GtkTreeEditable
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkStatusIcon
-
-</return>
+<return></return>
</function>
-<function name="gtk_icon_view_set_model">
+<function name="gtk_cell_editable_start_editing">
<description>
-Sets the model for a #GtkIconView.
-If the @icon_view already has a model set, it will remove
-it before setting the new model. If @model is %NULL, then
-it will unset the old model.
-
-Since: 2.6
+Begins editing on a @cell_editable. @event is the #GdkEvent that began
+the editing process. It may be %NULL, in the instance that editing was
+initiated through programatic means.
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> A #GtkIconView.
+<parameter name="cell_editable">
+<parameter_description> A #GtkCellEditable
</parameter_description>
</parameter>
-<parameter name="model">
-<parameter_description> The model.
+<parameter name="event">
+<parameter_description> A #GdkEvent, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_assistant_get_current_page">
+<function name="gtk_cell_layout_add_attribute">
<description>
-Returns the page number of the current page
+Adds an attribute mapping to the list in @cell_layout. The @column is the
+column of the model to get a value from, and the @attribute is the
+parameter on @cell to be set from the value. So for example if column 2
+of the model contains strings, you could have the "text" attribute of a
+#GtkCellRendererText get its values from column 2.
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter name="cell_layout">
+<parameter_description> A #GtkCellLayout.
+</parameter_description>
+</parameter>
+<parameter name="cell">
+<parameter_description> A #GtkCellRenderer.
+</parameter_description>
+</parameter>
+<parameter name="attribute">
+<parameter_description> An attribute on the renderer.
+</parameter_description>
+</parameter>
+<parameter name="column">
+<parameter_description> The column position on the model to get the attribute from.
</parameter_description>
</parameter>
</parameters>
-<return> The index (starting from 0) of the current page in
-the @assistant, if the @assistant has no pages, -1 will be returned
-
-</return>
+<return></return>
</function>
-<function name="gtk_widget_send_focus_change">
+<function name="gtk_cell_layout_clear">
<description>
-Sends the focus change @event to @widget
-
-This function is not meant to be used by applications. The only time it
-should be used is when it is necessary for a #GtkWidget to assign focus
-to a widget that is semantically owned by the first widget even though
-it's not a direct child - for instance, a search entry in a floating
-window similar to the quick search in #GtkTreeView.
-
-An example of its usage is:
-
-|[
-GdkEvent *fevent = gdk_event_new (GDK_FOCUS_CHANGE);
-
-fevent->focus_change.type = GDK_FOCUS_CHANGE;
-fevent->focus_change.in = TRUE;
-fevent->focus_change.window = gtk_widget_get_window (widget);
-if (fevent->focus_change.window != NULL)
-g_object_ref (fevent->focus_change.window);
-
-gtk_widget_send_focus_change (widget, fevent);
-
-gdk_event_free (event);
-]|
+Unsets all the mappings on all renderers on @cell_layout and
+removes all renderers from @cell_layout.
-Since: 2.22
+Since: 2.4
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="event">
-<parameter_description> a #GdkEvent of type GDK_FOCUS_CHANGE
+<parameter name="cell_layout">
+<parameter_description> A #GtkCellLayout.
</parameter_description>
</parameter>
</parameters>
-<return> the return value from the event signal emission: %TRUE
-if the event was handled, and %FALSE otherwise
-
-</return>
+<return></return>
</function>
-<function name="gtk_combo_box_append_text">
+<function name="gtk_cell_layout_clear_attributes">
<description>
-Appends @string to the list of strings stored in @combo_box. Note that
-you can only use this function with combo boxes constructed with
-gtk_combo_box_new_text().
+Clears all existing attributes previously set with
+gtk_cell_layout_set_attributes().
Since: 2.4
</description>
<parameters>
-<parameter name="combo_box">
-<parameter_description> A #GtkComboBox constructed using gtk_combo_box_new_text()
+<parameter name="cell_layout">
+<parameter_description> A #GtkCellLayout.
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> A string
+<parameter name="cell">
+<parameter_description> A #GtkCellRenderer to clear the attribute mapping on.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_recent_manager_get_items">
+<function name="gtk_cell_layout_get_cells">
<description>
-Gets the list of recently used resources.
+Returns the cell renderers which have been added to @cell_layout.
-Since: 2.10
+Since: 2.12
</description>
<parameters>
-<parameter name="manager">
-<parameter_description> a #GtkRecentManager
+<parameter name="cell_layout">
+<parameter_description> a #GtkCellLayout
</parameter_description>
</parameter>
</parameters>
-<return> a list of
-newly allocated #GtkRecentInfo objects. Use
-gtk_recent_info_unref() on each item inside the list, and then
-free the list itself using g_list_free().
+<return> a list of cell renderers. The list, but not the
+renderers has been newly allocated and should be freed with
+g_list_free() when no longer needed.
</return>
</function>
-<function name="gtk_cell_renderer_toggle_get_radio">
+<function name="gtk_cell_layout_pack_end">
<description>
-Returns whether we're rendering radio toggles rather than checkboxes.
+Adds the @cell to the end of @cell_layout. If @expand is %FALSE, then the
+ cell is allocated no more space than it needs. Any unused space is
+divided evenly between cells for which @expand is %TRUE.
+Note that reusing the same cell renderer is not supported.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="toggle">
-<parameter_description> a #GtkCellRendererToggle
+<parameter name="cell_layout">
+<parameter_description> A #GtkCellLayout.
+</parameter_description>
+</parameter>
+<parameter name="cell">
+<parameter_description> A #GtkCellRenderer.
+</parameter_description>
+</parameter>
+<parameter name="expand">
+<parameter_description> %TRUE if @cell is to be given extra space allocated to @cell_layout.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if we're rendering radio toggles rather than checkboxes
-</return>
+<return></return>
</function>
-<function name="gtk_style_attach">
+<function name="gtk_cell_layout_pack_start">
<description>
-Attaches a style to a window; this process allocates the
-colors and creates the GC's for the style - it specializes
-it to a particular visual and colormap. The process may
-involve the creation of a new style if the style has already
-been attached to a window with a different style and colormap.
+Packs the @cell into the beginning of @cell_layout. If @expand is %FALSE,
+then the @cell is allocated no more space than it needs. Any unused space
+is divided evenly between cells for which @expand is %TRUE.
-Since this function may return a new object, you have to use it
-in the following way:
-<literal>style = gtk_style_attach (style, window)</literal>
+Note that reusing the same cell renderer is not supported.
+Since: 2.4
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle.
+<parameter name="cell_layout">
+<parameter_description> A #GtkCellLayout.
</parameter_description>
</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow.
+<parameter name="cell">
+<parameter_description> A #GtkCellRenderer.
+</parameter_description>
+</parameter>
+<parameter name="expand">
+<parameter_description> %TRUE if @cell is to be given extra space allocated to @cell_layout.
</parameter_description>
</parameter>
</parameters>
-<return> Either @style, or a newly-created #GtkStyle.
-If the style is newly created, the style parameter
-will be unref'ed, and the new style will have
-a reference count belonging to the caller.
-</return>
+<return></return>
</function>
-<function name="gtk_tree_model_filter_new">
+<function name="gtk_cell_layout_reorder">
<description>
-Creates a new #GtkTreeModel, with @child_model as the child_model
-and @root as the virtual root.
+Re-inserts @cell at @position. Note that @cell has already to be packed
+into @cell_layout for this to function properly.
Since: 2.4
</description>
<parameters>
-<parameter name="child_model">
-<parameter_description> A #GtkTreeModel.
+<parameter name="cell_layout">
+<parameter_description> A #GtkCellLayout.
</parameter_description>
</parameter>
-<parameter name="root">
-<parameter_description> A #GtkTreePath or %NULL.
+<parameter name="cell">
+<parameter_description> A #GtkCellRenderer to reorder.
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> New position to insert @cell at.
</parameter_description>
</parameter>
</parameters>
-<return> A new #GtkTreeModel.
-
-</return>
+<return></return>
</function>
-<function name="gtk_test_text_set">
+<function name="gtk_cell_layout_set_attributes">
<description>
-Set the text string of @widget to @string if it is a GtkLabel,
-GtkEditable (entry and text widgets) or GtkTextView.
+Sets the attributes in list as the attributes of @cell_layout. The
+attributes should be in attribute/column order, as in
+gtk_cell_layout_add_attribute(). All existing attributes are removed, and
+replaced with the new attributes.
-Since: 2.14
+Since: 2.4
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> valid widget pointer.
+<parameter name="cell_layout">
+<parameter_description> A #GtkCellLayout.
</parameter_description>
</parameter>
-<parameter name="string">
-<parameter_description> a 0-terminated C string
+<parameter name="cell">
+<parameter_description> A #GtkCellRenderer.
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> A %NULL-terminated list of attributes.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_notebook_insert_page">
+<function name="gtk_cell_layout_set_cell_data_func">
<description>
-Insert a page into @notebook at the given position.
+Sets the #GtkCellLayoutDataFunc to use for @cell_layout. This function
+is used instead of the standard attributes mapping for setting the
+column value, and should set the value of @cell_layout's cell renderer(s)
+as appropriate. @func may be %NULL to remove and older one.
+Since: 2.4
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="cell_layout">
+<parameter_description> A #GtkCellLayout.
</parameter_description>
</parameter>
-<parameter name="child">
-<parameter_description> the #GtkWidget to use as the contents of the page.
+<parameter name="cell">
+<parameter_description> A #GtkCellRenderer.
</parameter_description>
</parameter>
-<parameter name="tab_label">
-<parameter_description> the #GtkWidget to be used as the label for the page,
-or %NULL to use the default label, 'page N'.
+<parameter name="func">
+<parameter_description> The #GtkCellLayoutDataFunc to use.
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> the index (starting at 0) at which to insert the page,
-or -1 to append the page after all other pages.
+<parameter name="func_data">
+<parameter_description> The user data for @func.
+</parameter_description>
+</parameter>
+<parameter name="destroy">
+<parameter_description> The destroy notification for @func_data.
</parameter_description>
</parameter>
</parameters>
-<return> the index (starting from 0) of the inserted
-page in the notebook, or -1 if function fails
+<return></return>
+</function>
+
+<function name="gtk_cell_renderer_accel_new">
+<description>
+Creates a new #GtkCellRendererAccel.
+
+Since: 2.10
+
+</description>
+<parameters>
+</parameters>
+<return> the new cell renderer
+
</return>
</function>
-<function name="gtk_widget_style_get_property">
+<function name="gtk_cell_renderer_activate">
<description>
-Gets the value of a style property of @widget.
+Passes an activate event to the cell renderer for possible processing.
+Some cell renderers may use events; for example, #GtkCellRendererToggle
+toggles when it gets a mouse click.
+
</description>
<parameters>
+<parameter name="cell">
+<parameter_description> a #GtkCellRenderer
+</parameter_description>
+</parameter>
+<parameter name="event">
+<parameter_description> a #GdkEvent
+</parameter_description>
+</parameter>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> widget that received the event
</parameter_description>
</parameter>
-<parameter name="property_name">
-<parameter_description> the name of a style property
+<parameter name="path">
+<parameter_description> widget-dependent string representation of the event location;
+e.g. for #GtkTreeView, a string representation of #GtkTreePath
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> location to return the property value
+<parameter name="background_area">
+<parameter_description> background area as passed to gtk_cell_renderer_render()
+</parameter_description>
+</parameter>
+<parameter name="cell_area">
+<parameter_description> cell area as passed to gtk_cell_renderer_render()
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> render flags
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the event was consumed/handled
+</return>
</function>
-<function name="gtk_tree_row_reference_inserted">
+<function name="gtk_cell_renderer_combo_new">
<description>
-Lets a set of row reference created by gtk_tree_row_reference_new_proxy()
-know that the model emitted the "row_inserted" signal.
+Creates a new #GtkCellRendererCombo.
+Adjust how text is drawn using object properties.
+Object properties can be set globally (with g_object_set()).
+Also, with #GtkTreeViewColumn, you can bind a property to a value
+in a #GtkTreeModel. For example, you can bind the "text" property
+on the cell renderer to a string value in the model, thus rendering
+a different string in each row of the #GtkTreeView.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="proxy">
-<parameter_description> A #GObject
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> The row position that was inserted
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> the new cell renderer
+
+</return>
</function>
-<function name="gtk_print_operation_cancel">
+<function name="gtk_cell_renderer_editing_canceled">
<description>
-Cancels a running print operation. This function may
-be called from a #GtkPrintOperation::begin-print,
-#GtkPrintOperation::paginate or #GtkPrintOperation::draw-page
-signal handler to stop the currently running print
-operation.
+Causes the cell renderer to emit the #GtkCellRenderer::editing-canceled
+signal.
-Since: 2.10
+This function is for use only by implementations of cell renderers that
+need to notify the client program that an editing process was canceled
+and the changes were not committed.
+
+Since: 2.4
+Deprecated: 2.6: Use gtk_cell_renderer_stop_editing() instead
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter name="cell">
+<parameter_description> A #GtkCellRenderer
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_clipboard_wait_for_text">
+<function name="gtk_cell_renderer_get_alignment">
<description>
-Requests the contents of the clipboard as text and converts
-the result to UTF-8 if necessary. This function waits for
-the data to be received using the main loop, so events,
-timeouts, etc, may be dispatched during the wait.
+Fills in @xalign and @yalign with the appropriate values of @cell.
+Since: 2.18
</description>
<parameters>
-<parameter name="clipboard">
-<parameter_description> a #GtkClipboard
+<parameter name="cell">
+<parameter_description> A #GtkCellRenderer
+</parameter_description>
+</parameter>
+<parameter name="xalign">
+<parameter_description> location to fill in with the x alignment of the cell, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="yalign">
+<parameter_description> location to fill in with the y alignment of the cell, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated UTF-8 string which must
-be freed with g_free(), or %NULL if retrieving
-the selection data failed. (This could happen
-for various reasons, in particular if the
-clipboard was empty or if the contents of the
-clipboard could not be converted into text form.)
-</return>
+<return></return>
</function>
-<function name="gtk_text_layout_set_overwrite_mode">
+<function name="gtk_cell_renderer_get_fixed_size">
<description>
-Sets overwrite mode
+Fills in @width and @height with the appropriate size of @cell.
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #GtkTextLayout
+<parameter name="cell">
+<parameter_description> A #GtkCellRenderer
</parameter_description>
</parameter>
-<parameter name="overwrite">
-<parameter_description> overwrite mode
+<parameter name="width">
+<parameter_description> location to fill in with the fixed width of the cell, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> location to fill in with the fixed height of the cell, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_operation_preview_render_page">
+<function name="gtk_cell_renderer_get_padding">
<description>
-Renders a page to the preview, using the print context that
-was passed to the #GtkPrintOperation::preview handler together
-with @preview.
-
-A custom iprint preview should use this function in its ::expose
-handler to render the currently selected page.
-
-Note that this function requires a suitable cairo context to
-be associated with the print context.
+Fills in @xpad and @ypad with the appropriate values of @cell.
-Since: 2.10
+Since: 2.18
</description>
<parameters>
-<parameter name="preview">
-<parameter_description> a #GtkPrintOperationPreview
+<parameter name="cell">
+<parameter_description> A #GtkCellRenderer
</parameter_description>
</parameter>
-<parameter name="page_nr">
-<parameter_description> the page to render
+<parameter name="xpad">
+<parameter_description> location to fill in with the x padding of the cell, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="ypad">
+<parameter_description> location to fill in with the y padding of the cell, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_toggle_action_toggled">
+<function name="gtk_cell_renderer_get_sensitive">
<description>
-Emits the "toggled" signal on the toggle action.
+Returns the cell renderer's sensitivity.
-Since: 2.4
+Since: 2.18
</description>
<parameters>
-<parameter name="action">
-<parameter_description> the action object
+<parameter name="cell">
+<parameter_description> A #GtkCellRenderer
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the cell renderer is sensitive
+
+</return>
</function>
-<function name="gtk_paint_extension">
+<function name="gtk_cell_renderer_get_size">
<description>
-Draws an extension, i.e. a notebook tab.
+Obtains the width and height needed to render the cell. Used by view
+widgets to determine the appropriate size for the cell_area passed to
+gtk_cell_renderer_render(). If @cell_area is not %NULL, fills in the
+x and y offsets (if set) of the cell relative to this location.
+
+Please note that the values set in @width and @height, as well as those
+in @x_offset and @y_offset are inclusive of the xpad and ypad properties.
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
-</parameter_description>
-</parameter>
-<parameter name="shadow_type">
-<parameter_description> type of shadow to draw
-</parameter_description>
-</parameter>
-<parameter name="area">
-<parameter_description> clip rectangle, or %NULL if the
-output should not be clipped
+<parameter name="cell">
+<parameter_description> a #GtkCellRenderer
</parameter_description>
</parameter>
<parameter name="widget">
-<parameter_description> the widget
+<parameter_description> the widget the renderer is rendering to
</parameter_description>
</parameter>
-<parameter name="detail">
-<parameter_description> a style detail
+<parameter name="cell_area">
+<parameter_description> The area a cell will be allocated, or %NULL
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> x origin of the extension
+<parameter name="x_offset">
+<parameter_description> location to return x offset of cell relative to @cell_area, or %NULL
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> y origin of the extension
+<parameter name="y_offset">
+<parameter_description> location to return y offset of cell relative to @cell_area, or %NULL
</parameter_description>
</parameter>
<parameter name="width">
-<parameter_description> width of the extension
+<parameter_description> location to return width needed to render a cell, or %NULL
</parameter_description>
</parameter>
<parameter name="height">
-<parameter_description> width of the extension
-</parameter_description>
-</parameter>
-<parameter name="gap_side">
-<parameter_description> the side on to which the extension is attached
+<parameter_description> location to return height needed to render a cell, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_binding_entry_remove">
+<function name="gtk_cell_renderer_get_visible">
<description>
-Remove a binding previously installed via
-gtk_binding_entry_add_signal() on @binding_set.
+Returns the cell renderer's visibility.
+
+Since: 2.18
</description>
<parameters>
-<parameter name="binding_set">
-<parameter_description> a #GtkBindingSet to remove an entry of
-</parameter_description>
-</parameter>
-<parameter name="keyval">
-<parameter_description> key value of binding to remove
-</parameter_description>
-</parameter>
-<parameter name="modifiers">
-<parameter_description> key modifier of binding to remove
+<parameter name="cell">
+<parameter_description> A #GtkCellRenderer
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the cell renderer is visible
+
+</return>
</function>
-<function name="gtk_tool_palette_get_drag_target_group">
+<function name="gtk_cell_renderer_pixbuf_new">
<description>
-Get the target entry for a dragged #GtkToolItemGroup.
+Creates a new #GtkCellRendererPixbuf. Adjust rendering
+parameters using object properties. Object properties can be set
+globally (with g_object_set()). Also, with #GtkTreeViewColumn, you
+can bind a property to a value in a #GtkTreeModel. For example, you
+can bind the "pixbuf" property on the cell renderer to a pixbuf value
+in the model, thus rendering a different image in each row of the
+#GtkTreeView.
-Since: 2.20
</description>
<parameters>
</parameters>
-<return> the #GtkTargetEntry for a dragged group
-
+<return> the new cell renderer
</return>
</function>
-<function name="gtk_viewport_get_view_window">
+<function name="gtk_cell_renderer_progress_new">
<description>
-Gets the view window of the #GtkViewport.
+Creates a new #GtkCellRendererProgress.
-Since: 2.22
+Since: 2.6
</description>
<parameters>
-<parameter name="viewport">
-<parameter_description> a #GtkViewport
-</parameter_description>
-</parameter>
</parameters>
-<return> a #GdkWindow
+<return> the new cell renderer
</return>
</function>
-<function name="gtk_text_buffer_register_serialize_tagset">
+<function name="gtk_cell_renderer_render">
<description>
-This function registers GTK+'s internal rich text serialization
-format with the passed @buffer. The internal format does not comply
-to any standard rich text format and only works between #GtkTextBuffer
-instances. It is capable of serializing all of a text buffer's tags
-and embedded pixbufs.
-
-This function is just a wrapper around
-gtk_text_buffer_register_serialize_format(). The mime type used
-for registering is "application/x-gtk-text-buffer-rich-text", or
-"application/x-gtk-text-buffer-rich-text;format= tagset_name" if a
- tagset_name was passed.
-
-The @tagset_name can be used to restrict the transfer of rich text
-to buffers with compatible sets of tags, in order to avoid unknown
-tags from being pasted. It is probably the common case to pass an
-identifier != %NULL here, since the %NULL tagset requires the
-receiving buffer to deal with with pasting of arbitrary tags.
-
-Since: 2.10
+Invokes the virtual render function of the #GtkCellRenderer. The three
+passed-in rectangles are areas of @window. Most renderers will draw within
+ cell_area; the xalign, yalign, xpad, and ypad fields of the #GtkCellRenderer
+should be honored with respect to @cell_area. @background_area includes the
+blank space around the cell, and also the area containing the tree expander;
+so the @background_area rectangles for all cells tile to cover the entire
+ window @expose_area is a clip rectangle.
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="cell">
+<parameter_description> a #GtkCellRenderer
</parameter_description>
</parameter>
-<parameter name="tagset_name">
-<parameter_description> an optional tagset name, on %NULL
+<parameter name="window">
+<parameter_description> a #GdkDrawable to draw to
+</parameter_description>
+</parameter>
+<parameter name="widget">
+<parameter_description> the widget owning @window
+</parameter_description>
+</parameter>
+<parameter name="background_area">
+<parameter_description> entire cell area (including tree expanders and maybe
+padding on the sides)
+</parameter_description>
+</parameter>
+<parameter name="cell_area">
+<parameter_description> area normally rendered by a cell renderer
+</parameter_description>
+</parameter>
+<parameter name="expose_area">
+<parameter_description> area that actually needs updating
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags that affect rendering
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkAtom that corresponds to the newly registered
-format's mime-type.
-
-</return>
+<return></return>
</function>
-<function name="gtk_action_get_proxies">
+<function name="gtk_cell_renderer_set_alignment">
<description>
-Returns the proxy widgets for an action.
-See also gtk_widget_get_action().
+Sets the renderer's alignment within its available space.
-Since: 2.4
+Since: 2.18
</description>
<parameters>
-<parameter name="action">
-<parameter_description> the action object
+<parameter name="cell">
+<parameter_description> A #GtkCellRenderer
+</parameter_description>
+</parameter>
+<parameter name="xalign">
+<parameter_description> the x alignment of the cell renderer
+</parameter_description>
+</parameter>
+<parameter name="yalign">
+<parameter_description> the y alignment of the cell renderer
</parameter_description>
</parameter>
</parameters>
-<return> a #GSList of proxy widgets. The list is owned by GTK+
-and must not be modified.
-
-</return>
+<return></return>
</function>
-<function name="gtk_recent_chooser_remove_filter">
+<function name="gtk_cell_renderer_set_fixed_size">
<description>
-Removes @filter from the list of #GtkRecentFilter objects held by @chooser.
-
-Since: 2.10
+Sets the renderer size to be explicit, independent of the properties set.
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
+<parameter name="cell">
+<parameter_description> A #GtkCellRenderer
</parameter_description>
</parameter>
-<parameter name="filter">
-<parameter_description> a #GtkRecentFilter
+<parameter name="width">
+<parameter_description> the width of the cell renderer, or -1
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the height of the cell renderer, or -1
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_item_factory_construct">
+<function name="gtk_cell_renderer_set_padding">
<description>
-Initializes an item factory.
+Sets the renderer's padding.
-Deprecated: 2.4: Use #GtkUIManager instead.
+Since: 2.18
</description>
<parameters>
-<parameter name="ifactory">
-<parameter_description> a #GtkItemFactory
-</parameter_description>
-</parameter>
-<parameter name="container_type">
-<parameter_description> the kind of menu to create; can be
-#GTK_TYPE_MENU_BAR, #GTK_TYPE_MENU or #GTK_TYPE_OPTION_MENU
+<parameter name="cell">
+<parameter_description> A #GtkCellRenderer
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> the factory path of @ifactory, a string of the form
-<literal>"<name>"</literal>
+<parameter name="xpad">
+<parameter_description> the x padding of the cell renderer
</parameter_description>
</parameter>
-<parameter name="accel_group">
-<parameter_description> a #GtkAccelGroup to which the accelerators for the
-menu items will be added, or %NULL to create a new one
+<parameter name="ypad">
+<parameter_description> the y padding of the cell renderer
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_unix_dialog_new">
+<function name="gtk_cell_renderer_set_sensitive">
<description>
-Creates a new #GtkPrintUnixDialog.
+Sets the cell renderer's sensitivity.
-Since: 2.10
+Since: 2.18
</description>
<parameters>
-<parameter name="title">
-<parameter_description> Title of the dialog, or %NULL
+<parameter name="cell">
+<parameter_description> A #GtkCellRenderer
</parameter_description>
</parameter>
-<parameter name="parent">
-<parameter_description> Transient parent of the dialog, or %NULL
+<parameter name="sensitive">
+<parameter_description> the sensitivity of the cell
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPrintUnixDialog
-
-</return>
+<return></return>
</function>
-<function name="gtk_link_button_set_visited">
+<function name="gtk_cell_renderer_set_visible">
<description>
-Sets the 'visited' state of the URI where the #GtkLinkButton
-points. See gtk_link_button_get_visited() for more details.
+Sets the cell renderer's visibility.
-Since: 2.14
+Since: 2.18
</description>
<parameters>
-<parameter name="link_button">
-<parameter_description> a #GtkLinkButton
+<parameter name="cell">
+<parameter_description> A #GtkCellRenderer
</parameter_description>
</parameter>
-<parameter name="visited">
-<parameter_description> the new 'visited' state
+<parameter name="visible">
+<parameter_description> the visibility of the cell
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_info_get_filename">
+<function name="gtk_cell_renderer_spin_new">
<description>
-Gets the filename for the icon. If the
-%GTK_ICON_LOOKUP_USE_BUILTIN flag was passed
-to gtk_icon_theme_lookup_icon(), there may be
-no filename if a builtin icon is returned; in this
-case, you should use gtk_icon_info_get_builtin_pixbuf().
+Creates a new #GtkCellRendererSpin.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="icon_info">
-<parameter_description> a #GtkIconInfo
-</parameter_description>
-</parameter>
</parameters>
-<return> the filename for the icon, or %NULL
-if gtk_icon_info_get_builtin_pixbuf() should
-be used instead. The return value is owned by
-GTK+ and should not be modified or freed.
+<return> a new #GtkCellRendererSpin
</return>
</function>
-<function name="gtk_widget_class_find_style_property">
+<function name="gtk_cell_renderer_spinner_new">
<description>
-Finds a style property of a widget class by name.
+Returns a new cell renderer which will show a spinner to indicate
+activity.
-Since: 2.2
+Since: 2.20
</description>
<parameters>
-<parameter name="klass">
-<parameter_description> a #GtkWidgetClass
-</parameter_description>
-</parameter>
-<parameter name="property_name">
-<parameter_description> the name of the style property to find
-</parameter_description>
-</parameter>
</parameters>
-<return> the #GParamSpec of the style property or %NULL if @class has no
-style property with that name.
+<return> a new #GtkCellRenderer
+
</return>
</function>
-<function name="gtk_text_layout_get_line_yrange">
+<function name="gtk_cell_renderer_start_editing">
<description>
-Find the range of y coordinates for the paragraph containing
-the given iter.
+Passes an activate event to the cell renderer for possible processing.
+
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #GtkTextLayout
+<parameter name="cell">
+<parameter_description> a #GtkCellRenderer
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="event">
+<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> location to store the top of the paragraph in pixels,
-or %NULL.
- height location to store the height of the paragraph in pixels,
-or %NULL.
+<parameter name="widget">
+<parameter_description> widget that received the event
+</parameter_description>
+</parameter>
+<parameter name="path">
+<parameter_description> widget-dependent string representation of the event location;
+e.g. for #GtkTreeView, a string representation of #GtkTreePath
+</parameter_description>
+</parameter>
+<parameter name="background_area">
+<parameter_description> background area as passed to gtk_cell_renderer_render()
+</parameter_description>
+</parameter>
+<parameter name="cell_area">
+<parameter_description> cell area as passed to gtk_cell_renderer_render()
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> render flags
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A new #GtkCellEditable, or %NULL
+</return>
</function>
-<function name="gtk_combo_box_popup">
+<function name="gtk_cell_renderer_stop_editing">
<description>
-Pops up the menu or dropdown list of @combo_box.
+Informs the cell renderer that the editing is stopped.
+If @canceled is %TRUE, the cell renderer will emit the
+#GtkCellRenderer::editing-canceled signal.
-This function is mostly intended for use by accessibility technologies;
-applications should have little use for it.
+This function should be called by cell renderer implementations
+in response to the #GtkCellEditable::editing-done signal of
+#GtkCellEditable.
-Since: 2.4
+Since: 2.6
</description>
<parameters>
-<parameter name="combo_box">
-<parameter_description> a #GtkComboBox
+<parameter name="cell">
+<parameter_description> A #GtkCellRenderer
+</parameter_description>
+</parameter>
+<parameter name="canceled">
+<parameter_description> %TRUE if the editing has been canceled
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_mark_get_deleted">
+<function name="gtk_cell_renderer_text_new">
<description>
-Returns %TRUE if the mark has been removed from its buffer
-with gtk_text_buffer_delete_mark(). See gtk_text_buffer_add_mark()
-for a way to add it to a buffer again.
+Creates a new #GtkCellRendererText. Adjust how text is drawn using
+object properties. Object properties can be
+set globally (with g_object_set()). Also, with #GtkTreeViewColumn,
+you can bind a property to a value in a #GtkTreeModel. For example,
+you can bind the "text" property on the cell renderer to a string
+value in the model, thus rendering a different string in each row
+of the #GtkTreeView
</description>
<parameters>
-<parameter name="mark">
-<parameter_description> a #GtkTextMark
-</parameter_description>
-</parameter>
</parameters>
-<return> whether the mark is deleted
+<return> the new cell renderer
</return>
</function>
-<function name="gtk_cell_renderer_editing_canceled">
+<function name="gtk_cell_renderer_text_set_fixed_height_from_font">
<description>
-Causes the cell renderer to emit the #GtkCellRenderer::editing-canceled
-signal.
-
-This function is for use only by implementations of cell renderers that
-need to notify the client program that an editing process was canceled
-and the changes were not committed.
-
-Since: 2.4
-Deprecated: 2.6: Use gtk_cell_renderer_stop_editing() instead
+Sets the height of a renderer to explicitly be determined by the "font" and
+"y_pad" property set on it. Further changes in these properties do not
+affect the height, so they must be accompanied by a subsequent call to this
+function. Using this function is unflexible, and should really only be used
+if calculating the size of a cell is too slow (ie, a massive number of cells
+displayed). If @number_of_rows is -1, then the fixed height is unset, and
+the height is determined by the properties again.
</description>
<parameters>
-<parameter name="cell">
-<parameter_description> A #GtkCellRenderer
+<parameter name="renderer">
+<parameter_description> A #GtkCellRendererText
+</parameter_description>
+</parameter>
+<parameter name="number_of_rows">
+<parameter_description> Number of rows of text each cell renderer is allocated, or -1
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_label_get_line_wrap">
+<function name="gtk_cell_renderer_toggle_get_activatable">
<description>
-Returns whether lines in the label are automatically wrapped.
-See gtk_label_set_line_wrap().
+Returns whether the cell renderer is activatable. See
+gtk_cell_renderer_toggle_set_activatable().
+Since: 2.18
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="toggle">
+<parameter_description> a #GtkCellRendererToggle
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the lines of the label are automatically wrapped.
+<return> %TRUE if the cell renderer is activatable.
+
</return>
</function>
-<function name="gtk_tool_palette_get_hadjustment">
+<function name="gtk_cell_renderer_toggle_get_active">
<description>
-Gets the horizontal adjustment of the tool palette.
+Returns whether the cell renderer is active. See
+gtk_cell_renderer_toggle_set_active().
-Since: 2.20
</description>
<parameters>
-<parameter name="palette">
-<parameter_description> a #GtkToolPalette
+<parameter name="toggle">
+<parameter_description> a #GtkCellRendererToggle
</parameter_description>
</parameter>
</parameters>
-<return> the horizontal adjustment of @palette
-
+<return> %TRUE if the cell renderer is active.
</return>
</function>
-<function name="gtk_toolbar_prepend_item">
+<function name="gtk_cell_renderer_toggle_get_radio">
<description>
-Adds a new button to the beginning (top or left edges) of the given toolbar.
+Returns whether we're rendering radio toggles rather than checkboxes.
- callback must be a pointer to a function taking a #GtkWidget and a gpointer as
-arguments. Use G_CALLBACK() to cast the function to #GCallback.
-
-Deprecated: 2.4: Use gtk_toolbar_insert() instead.
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar.
-</parameter_description>
-</parameter>
-<parameter name="text">
-<parameter_description> give your toolbar button a label.
-</parameter_description>
-</parameter>
-<parameter name="tooltip_text">
-<parameter_description> a string that appears when the user holds the mouse over this item.
-</parameter_description>
-</parameter>
-<parameter name="tooltip_private_text">
-<parameter_description> use with #GtkTipsQuery.
-</parameter_description>
-</parameter>
-<parameter name="icon">
-<parameter_description> a #GtkWidget that should be used as the button's icon.
-</parameter_description>
-</parameter>
-<parameter name="callback">
-<parameter_description> the function to be executed when the button is pressed.
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> a pointer to any data you wish to be passed to the callback.
+<parameter name="toggle">
+<parameter_description> a #GtkCellRendererToggle
</parameter_description>
</parameter>
</parameters>
-<return> the new toolbar item as a #GtkWidget.
-
+<return> %TRUE if we're rendering radio toggles rather than checkboxes
</return>
</function>
-<function name="gtk_statusbar_new">
+<function name="gtk_cell_renderer_toggle_new">
<description>
-Creates a new #GtkStatusbar ready for messages.
+Creates a new #GtkCellRendererToggle. Adjust rendering
+parameters using object properties. Object properties can be set
+globally (with g_object_set()). Also, with #GtkTreeViewColumn, you
+can bind a property to a value in a #GtkTreeModel. For example, you
+can bind the "active" property on the cell renderer to a boolean value
+in the model, thus causing the check button to reflect the state of
+the model.
</description>
<parameters>
</parameters>
-<return> the new #GtkStatusbar
+<return> the new cell renderer
</return>
</function>
-<function name="gtk_about_dialog_get_website_label">
+<function name="gtk_cell_renderer_toggle_set_activatable">
<description>
-Returns the label used for the website link.
+Makes the cell renderer activatable.
-Since: 2.6
+Since: 2.18
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter name="toggle">
+<parameter_description> a #GtkCellRendererToggle.
+</parameter_description>
+</parameter>
+<parameter name="setting">
+<parameter_description> the value to set.
</parameter_description>
</parameter>
</parameters>
-<return> The label used for the website link. The string is
-owned by the about dialog and must not be modified.
-
-</return>
+<return></return>
</function>
-<function name="gtk_text_view_buffer_to_window_coords">
+<function name="gtk_cell_renderer_toggle_set_active">
<description>
-Converts coordinate (@buffer_x, @buffer_y) to coordinates for the window
- win, and stores the result in (@window_x, @window_y).
-
-Note that you can't convert coordinates for a nonexisting window (see
-gtk_text_view_set_border_window_size()).
+Activates or deactivates a cell renderer.
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
-</parameter_description>
-</parameter>
-<parameter name="win">
-<parameter_description> a #GtkTextWindowType except #GTK_TEXT_WINDOW_PRIVATE
-</parameter_description>
-</parameter>
-<parameter name="buffer_x">
-<parameter_description> buffer x coordinate
+<parameter name="toggle">
+<parameter_description> a #GtkCellRendererToggle.
</parameter_description>
</parameter>
-<parameter name="buffer_y">
-<parameter_description> buffer y coordinate
+<parameter name="setting">
+<parameter_description> the value to set.
</parameter_description>
</parameter>
-<parameter name="window_x">
-<parameter_description> window x coordinate return location or %NULL
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_cell_renderer_toggle_set_radio">
+<description>
+If @radio is %TRUE, the cell renderer renders a radio toggle
+(i.e. a toggle in a group of mutually-exclusive toggles).
+If %FALSE, it renders a check toggle (a standalone boolean option).
+This can be set globally for the cell renderer, or changed just
+before rendering each cell in the model (for #GtkTreeView, you set
+up a per-row setting using #GtkTreeViewColumn to associate model
+columns with cell renderer properties).
+
+</description>
+<parameters>
+<parameter name="toggle">
+<parameter_description> a #GtkCellRendererToggle
</parameter_description>
</parameter>
-<parameter name="window_y">
-<parameter_description> window y coordinate return location or %NULL
+<parameter name="radio">
+<parameter_description> %TRUE to make the toggle look like a radio button
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_paper_size_get_height">
+<function name="gtk_cell_view_get_cell_renderers">
<description>
-Gets the paper height of the #GtkPaperSize, in
-units of @unit.
+Returns the cell renderers which have been added to @cell_view.
-Since: 2.10
+Since: 2.6
+
+Deprecated: 2.18: use gtk_cell_layout_get_cells() instead.
</description>
<parameters>
-<parameter name="size">
-<parameter_description> a #GtkPaperSize object
-</parameter_description>
-</parameter>
-<parameter name="unit">
-<parameter_description> the unit for the return value
+<parameter name="cell_view">
+<parameter_description> a #GtkCellView
</parameter_description>
</parameter>
</parameters>
-<return> the paper height
+<return> a list of cell renderers. The list, but not the
+renderers has been newly allocated and should be freed with
+g_list_free() when no longer needed.
</return>
</function>
-<function name="gtk_window_set_title">
+<function name="gtk_cell_view_get_displayed_row">
<description>
-Sets the title of the #GtkWindow. The title of a window will be
-displayed in its title bar; on the X Window System, the title bar
-is rendered by the <link linkend="gtk-X11-arch">window
-manager</link>, so exactly how the title appears to users may vary
-according to a user's exact configuration. The title should help a
-user distinguish this window from other windows they may have
-open. A good title might include the application name and current
-document filename, for example.
+Returns a #GtkTreePath referring to the currently
+displayed row. If no row is currently displayed,
+%NULL is returned.
+Since: 2.6
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
-</parameter_description>
-</parameter>
-<parameter name="title">
-<parameter_description> title of the window
+<parameter name="cell_view">
+<parameter_description> a #GtkCellView
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the currently displayed row or %NULL
+
+</return>
</function>
-<function name="gtk_font_selection_get_preview_text">
+<function name="gtk_cell_view_get_model">
<description>
-Gets the text displayed in the preview area.
+Returns the model for @cell_view. If no model is used %NULL is
+returned.
+Since: 2.16
</description>
<parameters>
-<parameter name="fontsel">
-<parameter_description> a #GtkFontSelection
+<parameter name="cell_view">
+<parameter_description> a #GtkCellView
</parameter_description>
</parameter>
</parameters>
-<return> the text displayed in the preview area.
-This string is owned by the widget and should not be
-modified or freed
+<return> a #GtkTreeModel used or %NULL
+
</return>
</function>
-<function name="gtk_paint_shadow_gap">
+<function name="gtk_cell_view_get_size_of_row">
<description>
-Draws a shadow around the given rectangle in @window
-using the given style and state and shadow type, leaving a
-gap in one side.
+Sets @requisition to the size needed by @cell_view to display
+the model row pointed to by @path.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
-</parameter_description>
-</parameter>
-<parameter name="shadow_type">
-<parameter_description> type of shadow to draw
-</parameter_description>
-</parameter>
-<parameter name="area">
-<parameter_description> clip rectangle, or %NULL if the
-output should not be clipped
-</parameter_description>
-</parameter>
-<parameter name="widget">
-<parameter_description> the widget
-</parameter_description>
-</parameter>
-<parameter name="detail">
-<parameter_description> a style detail
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> x origin of the rectangle
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> y origin of the rectangle
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> width of the rectangle
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> width of the rectangle
-</parameter_description>
-</parameter>
-<parameter name="gap_side">
-<parameter_description> side in which to leave the gap
+<parameter name="cell_view">
+<parameter_description> a #GtkCellView
</parameter_description>
</parameter>
-<parameter name="gap_x">
-<parameter_description> starting position of the gap
+<parameter name="path">
+<parameter_description> a #GtkTreePath
</parameter_description>
</parameter>
-<parameter name="gap_width">
-<parameter_description> width of the gap
+<parameter name="requisition">
+<parameter_description> return location for the size
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE
+
+</return>
</function>
-<function name="gtk_button_get_image_position">
+<function name="gtk_cell_view_new">
<description>
-Gets the position of the image relative to the text
-inside the button.
+Creates a new #GtkCellView widget.
-Since: 2.10
+Since: 2.6
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkButton
-</parameter_description>
-</parameter>
</parameters>
-<return> the position
+<return> A newly created #GtkCellView widget.
</return>
</function>
-<function name="gtk_file_chooser_get_create_folders">
+<function name="gtk_cell_view_new_with_markup">
<description>
-Gets whether file choser will offer to create new folders.
-See gtk_file_chooser_set_create_folders().
+Creates a new #GtkCellView widget, adds a #GtkCellRendererText
+to it, and makes it show @markup. The text can be
+marked up with the <link linkend="PangoMarkupFormat">Pango text
+markup language</link>.
-Since: 2.18
+Since: 2.6
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="markup">
+<parameter_description> the text to display in the cell view
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the New Folder button should be displayed.
+<return> A newly created #GtkCellView widget.
</return>
</function>
-<function name="gtk_tree_model_sort_clear_cache">
+<function name="gtk_cell_view_new_with_pixbuf">
<description>
-This function should almost never be called. It clears the @tree_model_sort
-of any cached iterators that haven't been reffed with
-gtk_tree_model_ref_node(). This might be useful if the child model being
-sorted is static (and doesn't change often) and there has been a lot of
-unreffed access to nodes. As a side effect of this function, all unreffed
-iters will be invalid.
+Creates a new #GtkCellView widget, adds a #GtkCellRendererPixbuf
+to it, and makes its show @pixbuf.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="tree_model_sort">
-<parameter_description> A #GtkTreeModelSort
+<parameter name="pixbuf">
+<parameter_description> the image to display in the cell view
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A newly created #GtkCellView widget.
+
+</return>
</function>
-<function name="gtk_container_set_border_width">
+<function name="gtk_cell_view_new_with_text">
<description>
-Sets the border width of the container.
+Creates a new #GtkCellView widget, adds a #GtkCellRendererText
+to it, and makes its show @text.
-The border width of a container is the amount of space to leave
-around the outside of the container. The only exception to this is
-#GtkWindow; because toplevel windows can't leave space outside,
-they leave the space inside. The border is added on all sides of
-the container. To add space to only one side, one approach is to
-create a #GtkAlignment widget, call gtk_widget_set_size_request()
-to give it a size, and place it on the side of the container as
-a spacer.
+Since: 2.6
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
-</parameter_description>
-</parameter>
-<parameter name="border_width">
-<parameter_description> amount of blank space to leave <emphasis>outside</emphasis>
-the container. Valid values are in the range 0-65535 pixels.
+<parameter name="text">
+<parameter_description> the text to display in the cell view
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A newly created #GtkCellView widget.
+
+</return>
</function>
-<function name="gtk_about_dialog_set_website">
+<function name="gtk_cell_view_set_background_color">
<description>
-Sets the URL to use for the website link.
-
-Note that that the hook functions need to be set up
-before calling this function.
+Sets the background color of @view.
Since: 2.6
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter name="cell_view">
+<parameter_description> a #GtkCellView
</parameter_description>
</parameter>
-<parameter name="website">
-<parameter_description> a URL string starting with "http://"
+<parameter name="color">
+<parameter_description> the new background color
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_file_filter_set_name">
+<function name="gtk_cell_view_set_displayed_row">
<description>
-Sets the human-readable name of the filter; this is the string
-that will be displayed in the file selector user interface if
-there is a selectable list of filters.
+Sets the row of the model that is currently displayed
+by the #GtkCellView. If the path is unset, then the
+contents of the cellview "stick" at their last value;
+this is not normally a desired result, but may be
+a needed intermediate state if say, the model for
+the #GtkCellView becomes temporarily empty.
-Since: 2.4
+Since: 2.6
</description>
<parameters>
-<parameter name="filter">
-<parameter_description> a #GtkFileFilter
+<parameter name="cell_view">
+<parameter_description> a #GtkCellView
</parameter_description>
</parameter>
-<parameter name="name">
-<parameter_description> the human-readable-name for the filter, or %NULL
-to remove any existing name.
+<parameter name="path">
+<parameter_description> a #GtkTreePath or %NULL to unset.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_socket_steal">
+<function name="gtk_cell_view_set_model">
<description>
-Reparents a pre-existing toplevel window into a #GtkSocket. This is
-meant to embed clients that do not know about embedding into a
-#GtkSocket, however doing so is inherently unreliable, and using
-this function is not recommended.
+Sets the model for @cell_view. If @cell_view already has a model
+set, it will remove it before setting the new model. If @model is
+%NULL, then it will unset the old model.
-The #GtkSocket must have already be added into a toplevel window
-before you can make this call.
+Since: 2.6
</description>
<parameters>
-<parameter name="socket_">
-<parameter_description> a #GtkSocket
+<parameter name="cell_view">
+<parameter_description> a #GtkCellView
</parameter_description>
</parameter>
-<parameter name="wid">
-<parameter_description> the window ID of an existing toplevel window.
+<parameter name="model">
+<parameter_description> a #GtkTreeModel
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_operation_set_allow_async">
+<function name="gtk_cell_view_set_value">
<description>
-Sets whether the gtk_print_operation_run() may return
-before the print operation is completed. Note that
-some platforms may not allow asynchronous operation.
+Sets a property of a cell renderer of @cell_view, and
+makes sure the display of @cell_view is updated.
-Since: 2.10
+Since: 2.6
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter name="cell_view">
+<parameter_description> a #GtkCellView widget
</parameter_description>
</parameter>
-<parameter name="allow_async">
-<parameter_description> %TRUE to allow asynchronous operation
+<parameter name="renderer">
+<parameter_description> one of the renderers of @cell_view
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_selection_data_targets_include_text">
-<description>
-Given a #GtkSelectionData object holding a list of targets,
-determines if any of the targets in @targets can be used to
-provide text.
-
-
-</description>
-<parameters>
-<parameter name="selection_data">
-<parameter_description> a #GtkSelectionData object
+<parameter name="property">
+<parameter_description> the name of the property of @renderer to set
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> the new value to set the property to
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @selection_data holds a list of targets,
-and a suitable target for text is included, otherwise %FALSE.
-</return>
+<return></return>
</function>
-<function name="gtk_action_get_visible_vertical">
+<function name="gtk_check_button_new_with_mnemonic">
<description>
-Checks whether @action is visible when horizontal
-
-Since: 2.16
+Creates a new #GtkCheckButton containing a label. The label
+will be created using gtk_label_new_with_mnemonic(), so underscores
+in @label indicate the mnemonic for the check button.
</description>
<parameters>
-<parameter name="action">
-<parameter_description> a #GtkAction
+<parameter name="label">
+<parameter_description> The text of the button, with an underscore in front of the
+mnemonic character
</parameter_description>
</parameter>
</parameters>
-<return> whether @action is visible when horizontal
-
+<return> a new #GtkCheckButton
</return>
</function>
-<function name="gtk_container_set_focus_chain">
+<function name="gtk_check_menu_item_get_active">
<description>
-Sets a focus chain, overriding the one computed automatically by GTK+.
+Returns whether the check menu item is active. See
+gtk_check_menu_item_set_active ().
-In principle each widget in the chain should be a descendant of the
-container, but this is not enforced by this method, since it's allowed
-to set the focus chain before you pack the widgets, or have a widget
-in the chain that isn't always packed. The necessary checks are done
-when the focus chain is actually traversed.
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
-</parameter_description>
-</parameter>
-<parameter name="focusable_widgets">
-<parameter_description> the new focus chain
+<parameter name="check_menu_item">
+<parameter_description> a #GtkCheckMenuItem
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the menu item is checked.
+</return>
</function>
-<function name="gtk_tool_item_set_homogeneous">
+<function name="gtk_check_menu_item_get_draw_as_radio">
<description>
-Sets whether @tool_item is to be allocated the same size as other
-homogeneous items. The effect is that all homogeneous items will have
-the same width as the widest of the items.
+Returns whether @check_menu_item looks like a #GtkRadioMenuItem
Since: 2.4
</description>
<parameters>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem
-</parameter_description>
-</parameter>
-<parameter name="homogeneous">
-<parameter_description> whether @tool_item is the same size as other homogeneous items
+<parameter name="check_menu_item">
+<parameter_description> a #GtkCheckMenuItem
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> Whether @check_menu_item looks like a #GtkRadioMenuItem
+
+</return>
</function>
-<function name="gtk_toolbar_get_style">
+<function name="gtk_check_menu_item_get_inconsistent">
<description>
-Retrieves whether the toolbar has text, icons, or both . See
-gtk_toolbar_set_style().
-
+Retrieves the value set by gtk_check_menu_item_set_inconsistent().
+
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar
+<parameter name="check_menu_item">
+<parameter_description> a #GtkCheckMenuItem
</parameter_description>
</parameter>
</parameters>
-<return> the current style of @toolbar
+<return> %TRUE if inconsistent
</return>
</function>
-<function name="gtk_font_selection_dialog_get_ok_button">
+<function name="gtk_check_menu_item_new_with_mnemonic">
<description>
-Gets the 'OK' button.
-
-Since: 2.14
+Creates a new #GtkCheckMenuItem containing a label. The label
+will be created using gtk_label_new_with_mnemonic(), so underscores
+in @label indicate the mnemonic for the menu item.
</description>
<parameters>
-<parameter name="fsd">
-<parameter_description> a #GtkFontSelectionDialog
+<parameter name="label">
+<parameter_description> The text of the button, with an underscore in front of the
+mnemonic character
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkWidget used in the dialog for the 'OK' button.
-
+<return> a new #GtkCheckMenuItem
</return>
</function>
-<function name="gtk_scrolled_window_set_policy">
+<function name="gtk_check_menu_item_set_draw_as_radio">
<description>
-Sets the scrollbar policy for the horizontal and vertical scrollbars.
+Sets whether @check_menu_item is drawn like a #GtkRadioMenuItem
-The policy determines when the scrollbar should appear; it is a value
-from the #GtkPolicyType enumeration. If %GTK_POLICY_ALWAYS, the
-scrollbar is always present; if %GTK_POLICY_NEVER, the scrollbar is
-never present; if %GTK_POLICY_AUTOMATIC, the scrollbar is present only
-if needed (that is, if the slider part of the bar would be smaller
-than the trough - the display is larger than the page size).
+Since: 2.4
</description>
<parameters>
-<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
-</parameter_description>
-</parameter>
-<parameter name="hscrollbar_policy">
-<parameter_description> policy for horizontal bar
+<parameter name="check_menu_item">
+<parameter_description> a #GtkCheckMenuItem
</parameter_description>
</parameter>
-<parameter name="vscrollbar_policy">
-<parameter_description> policy for vertical bar
+<parameter name="draw_as_radio">
+<parameter_description> whether @check_menu_item is drawn like a #GtkRadioMenuItem
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_toggle_button_set_mode">
+<function name="gtk_check_menu_item_set_inconsistent">
<description>
-Sets whether the button is displayed as a separate indicator and label.
-You can call this function on a checkbutton or a radiobutton with
- draw_indicator = %FALSE to make the button look like a normal button
+If the user has selected a range of elements (such as some text or
+spreadsheet cells) that are affected by a boolean setting, and the
+current values in that range are inconsistent, you may want to
+display the check in an "in between" state. This function turns on
+"in between" display. Normally you would turn off the inconsistent
+state again if the user explicitly selects a setting. This has to be
+done manually, gtk_check_menu_item_set_inconsistent() only affects
+visual appearance, it doesn't affect the semantics of the widget.
-This function only affects instances of classes like #GtkCheckButton
-and #GtkRadioButton that derive from #GtkToggleButton,
-not instances of #GtkToggleButton itself.
</description>
<parameters>
-<parameter name="toggle_button">
-<parameter_description> a #GtkToggleButton
+<parameter name="check_menu_item">
+<parameter_description> a #GtkCheckMenuItem
</parameter_description>
</parameter>
-<parameter name="draw_indicator">
-<parameter_description> if %TRUE, draw the button as a separate indicator
-and label; if %FALSE, draw the button like a normal button
+<parameter name="setting">
+<parameter_description> %TRUE to display an "inconsistent" third state check
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_modify_base">
+<function name="gtk_check_version">
<description>
-Sets the base color for a widget in a particular state.
-All other style values are left untouched. The base color
-is the background color used along with the text color
-(see gtk_widget_modify_text()) for widgets such as #GtkEntry
-and #GtkTextView. See also gtk_widget_modify_style().
+Checks that the GTK+ library in use is compatible with the
+given version. Generally you would pass in the constants
+#GTK_MAJOR_VERSION, #GTK_MINOR_VERSION, #GTK_MICRO_VERSION
+as the three arguments to this function; that produces
+a check that the library in use is compatible with
+the version of GTK+ the application or module was compiled
+against.
+
+Compatibility is defined by two things: first the version
+of the running library is newer than the version
+ required_major required_minor @required_micro. Second
+the running library must be binary compatible with the
+version @required_major required_minor required_micro
+(same major version.)
+
+This function is primarily for GTK+ modules; the module
+can call this function to check that it wasn't loaded
+into an incompatible version of GTK+. However, such a
+a check isn't completely reliable, since the module may be
+linked against an old version of GTK+ and calling the
+old version of gtk_check_version(), but still get loaded
+into an application using a newer version of GTK+.
-Note that "no window" widgets (which have the %GTK_NO_WINDOW flag set)
-draw on their parent container's window and thus may not draw any
-background themselves. This is the case for e.g. #GtkLabel. To modify
-the background of such widgets, you have to set the base color on their
-parent; if you want to set the background of a rectangular area around
-a label, try placing the label in a #GtkEventBox widget and setting
-the base color on that.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="required_major">
+<parameter_description> the required major version.
</parameter_description>
</parameter>
-<parameter name="state">
-<parameter_description> the state for which to set the base color
+<parameter name="required_minor">
+<parameter_description> the required minor version.
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> the color to assign (does not need to be allocated),
-or %NULL to undo the effect of previous calls to
-of gtk_widget_modify_base().
+<parameter name="required_micro">
+<parameter_description> the required micro version.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %NULL if the GTK+ library is compatible with the
+given version, or a string describing the version mismatch.
+The returned string is owned by GTK+ and should not be modified
+or freed.
+</return>
</function>
-<function name="gtk_file_chooser_list_shortcut_folders">
+<function name="gtk_clipboard_clear">
<description>
-Queries the list of shortcut folders in the file chooser, as set by
-gtk_file_chooser_add_shortcut_folder().
-
-Since: 2.4
+Clears the contents of the clipboard. Generally this should only
+be called between the time you call gtk_clipboard_set_with_owner()
+or gtk_clipboard_set_with_data(),
+and when the @clear_func you supplied is called. Otherwise, the
+clipboard may be owned by someone else.
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="clipboard">
+<parameter_description> a #GtkClipboard
</parameter_description>
</parameter>
</parameters>
-<return> A list of folder filenames, or %NULL if there are no shortcut
-folders. Free the returned list with g_slist_free(), and the filenames with
-g_free().
-
-</return>
+<return></return>
</function>
-<function name="gtk_window_get_transient_for">
+<function name="gtk_clipboard_get">
<description>
-Fetches the transient parent for this window. See
-gtk_window_set_transient_for().
+Returns the clipboard object for the given selection.
+See gtk_clipboard_get_for_display() for complete details.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="selection">
+<parameter_description> a #GdkAtom which identifies the clipboard to use
</parameter_description>
</parameter>
</parameters>
-<return> the transient parent for this window, or %NULL
-if no transient parent has been set.
+<return> the appropriate clipboard object. If no clipboard
+already exists, a new one will be created. Once a clipboard
+object has been created, it is persistent and, since it is
+owned by GTK+, must not be freed or unreffed.
</return>
</function>
-<function name="gtk_tree_view_convert_widget_to_bin_window_coords">
+<function name="gtk_clipboard_get_display">
<description>
-Converts widget coordinates to coordinates for the bin_window
-(see gtk_tree_view_get_bin_window()).
+Gets the #GdkDisplay associated with @clipboard
-Since: 2.12
+Since: 2.2
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
-</parameter_description>
-</parameter>
-<parameter name="wx">
-<parameter_description> X coordinate relative to the widget
-</parameter_description>
-</parameter>
-<parameter name="wy">
-<parameter_description> Y coordinate relative to the widget
-</parameter_description>
-</parameter>
-<parameter name="bx">
-<parameter_description> return location for bin_window X coordinate
-</parameter_description>
-</parameter>
-<parameter name="by">
-<parameter_description> return location for bin_window Y coordinate
+<parameter name="clipboard">
+<parameter_description> a #GtkClipboard
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GdkDisplay associated with @clipboard
+
+</return>
</function>
-<function name="gtk_printer_new">
+<function name="gtk_clipboard_get_for_display">
<description>
-Creates a new #GtkPrinter.
+Returns the clipboard object for the given selection.
+Cut/copy/paste menu items and keyboard shortcuts should use
+the default clipboard, returned by passing %GDK_SELECTION_CLIPBOARD for @selection.
+(%GDK_NONE is supported as a synonym for GDK_SELECTION_CLIPBOARD
+for backwards compatibility reasons.)
+The currently-selected object or text should be provided on the clipboard
+identified by #GDK_SELECTION_PRIMARY. Cut/copy/paste menu items
+conceptually copy the contents of the #GDK_SELECTION_PRIMARY clipboard
+to the default clipboard, i.e. they copy the selection to what the
+user sees as the clipboard.
-Since: 2.10
+(Passing #GDK_NONE is the same as using <literal>gdk_atom_intern
+("CLIPBOARD", FALSE)</literal>. See <ulink
+url="http://www.freedesktop.org/Standards/clipboards-spec">
+http://www.freedesktop.org/Standards/clipboards-spec</ulink>
+for a detailed discussion of the "CLIPBOARD" vs. "PRIMARY"
+selections under the X window system. On Win32 the
+#GDK_SELECTION_PRIMARY clipboard is essentially ignored.)
+
+It's possible to have arbitrary named clipboards; if you do invent
+new clipboards, you should prefix the selection name with an
+underscore (because the ICCCM requires that nonstandard atoms are
+underscore-prefixed), and namespace it as well. For example,
+if your application called "Foo" has a special-purpose
+clipboard, you might call it "_FOO_SPECIAL_CLIPBOARD".
+
+Since: 2.2
</description>
<parameters>
-<parameter name="name">
-<parameter_description> the name of the printer
-</parameter_description>
-</parameter>
-<parameter name="backend">
-<parameter_description> a #GtkPrintBackend
+<parameter name="display">
+<parameter_description> the display for which the clipboard is to be retrieved or created
</parameter_description>
</parameter>
-<parameter name="virtual_">
-<parameter_description> whether the printer is virtual
+<parameter name="selection">
+<parameter_description> a #GdkAtom which identifies the clipboard
+to use.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPrinter
+<return> the appropriate clipboard object. If no
+clipboard already exists, a new one will
+be created. Once a clipboard object has
+been created, it is persistent and, since
+it is owned by GTK+, must not be freed or
+unrefd.
</return>
</function>
-<function name="gtk_window_group_new">
+<function name="gtk_clipboard_get_owner">
<description>
-Creates a new #GtkWindowGroup object. Grabs added with
-gtk_grab_add() only affect windows within the same #GtkWindowGroup.
+If the clipboard contents callbacks were set with
+gtk_clipboard_set_with_owner(), and the gtk_clipboard_set_with_data() or
+gtk_clipboard_clear() has not subsequently called, returns the owner set
+by gtk_clipboard_set_with_owner().
</description>
<parameters>
+<parameter name="clipboard">
+<parameter_description> a #GtkClipboard
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GtkWindowGroup.
+<return> the owner of the clipboard, if any; otherwise %NULL.
</return>
</function>
-<function name="gtk_tree_view_column_set_expand">
+<function name="gtk_clipboard_request_contents">
<description>
-Sets the column to take available extra space. This space is shared equally
-amongst all columns that have the expand set to %TRUE. If no column has this
-option set, then the last column gets all extra space. By default, every
-column is created with this %FALSE.
-
-Since: 2.4
+Requests the contents of clipboard as the given target.
+When the results of the result are later received the supplied callback
+will be called.
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn
+<parameter name="clipboard">
+<parameter_description> a #GtkClipboard
</parameter_description>
</parameter>
-<parameter name="expand">
-<parameter_description> %TRUE if the column should take available extra space, %FALSE if not
+<parameter name="target">
+<parameter_description> an atom representing the form into which the clipboard
+owner should convert the selection.
+</parameter_description>
+</parameter>
+<parameter name="callback">
+<parameter_description> A function to call when the results are received
+(or the retrieval fails). If the retrieval fails
+the length field of @selection_data will be
+negative.
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data to pass to @callback
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_status_icon_set_tooltip_markup">
+<function name="gtk_clipboard_request_image">
<description>
-Sets @markup as the contents of the tooltip, which is marked up with
-the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
-
-This function will take care of setting #GtkStatusIcon:has-tooltip to %TRUE
-and of the default handler for the #GtkStatusIcon::query-tooltip signal.
+Requests the contents of the clipboard as image. When the image is
+later received, it will be converted to a #GdkPixbuf, and
+ callback will be called.
-See also the #GtkStatusIcon:tooltip-markup property and
-gtk_tooltip_set_markup().
+The @pixbuf parameter to @callback will contain the resulting
+#GdkPixbuf if the request succeeded, or %NULL if it failed. This
+could happen for various reasons, in particular if the clipboard
+was empty or if the contents of the clipboard could not be
+converted into an image.
-Since: 2.16
+Since: 2.6
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
+<parameter name="clipboard">
+<parameter_description> a #GtkClipboard
</parameter_description>
</parameter>
-<parameter name="markup">
-<parameter_description> the contents of the tooltip for @status_icon, or %NULL
+<parameter name="callback">
+<parameter_description> a function to call when the image is received,
+or the retrieval fails. (It will always be called
+one way or the other.)
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data to pass to @callback.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_column_new_with_attributes">
+<function name="gtk_clipboard_request_rich_text">
<description>
-Creates a new #GtkTreeViewColumn with a number of default values. This is
-equivalent to calling gtk_tree_view_column_set_title(),
-gtk_tree_view_column_pack_start(), and
-gtk_tree_view_column_set_attributes() on the newly created #GtkTreeViewColumn.
-
-Here's a simple example:
-|[
-enum { TEXT_COLUMN, COLOR_COLUMN, N_COLUMNS };
-...
-{
-GtkTreeViewColumn *column;
-GtkCellRenderer *renderer = gtk_cell_renderer_text_new ();
+Requests the contents of the clipboard as rich text. When the rich
+text is later received, @callback will be called.
-column = gtk_tree_view_column_new_with_attributes ("Title",
-renderer,
-"text", TEXT_COLUMN,
-"foreground", COLOR_COLUMN,
-NULL);
-}
-]|
+The @text parameter to @callback will contain the resulting rich
+text if the request succeeded, or %NULL if it failed. The @length
+parameter will contain @text's length. This function can fail for
+various reasons, in particular if the clipboard was empty or if the
+contents of the clipboard could not be converted into rich text form.
+Since: 2.10
</description>
<parameters>
-<parameter name="title">
-<parameter_description> The title to set the header to.
+<parameter name="clipboard">
+<parameter_description> a #GtkClipboard
</parameter_description>
</parameter>
-<parameter name="cell">
-<parameter_description> The #GtkCellRenderer.
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> A %NULL-terminated list of attributes.
+<parameter name="callback">
+<parameter_description> a function to call when the text is received,
+or the retrieval fails. (It will always be called
+one way or the other.)
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data to pass to @callback.
</parameter_description>
</parameter>
</parameters>
-<return> A newly created #GtkTreeViewColumn.
-</return>
+<return></return>
</function>
-<function name="gtk_color_selection_set_palette_color">
+<function name="gtk_clipboard_request_targets">
<description>
-Sets the palette located at @index to have @color as its color.
+Requests the contents of the clipboard as list of supported targets.
+When the list is later received, @callback will be called.
+The @targets parameter to @callback will contain the resulting targets if
+the request succeeded, or %NULL if it failed.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="colorsel">
-<parameter_description> a #GtkColorSelection.
+<parameter name="clipboard">
+<parameter_description> a #GtkClipboard
</parameter_description>
</parameter>
-<parameter name="index">
-<parameter_description> the color index of the palette.
+<parameter name="callback">
+<parameter_description> a function to call when the targets are received,
+or the retrieval fails. (It will always be called
+one way or the other.)
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> A #GdkColor to set the palette with.
+<parameter name="user_data">
+<parameter_description> user data to pass to @callback.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_list_store_set_column_types">
+<function name="gtk_clipboard_request_text">
<description>
-This function is meant primarily for #GObjects that inherit from #GtkListStore,
-and should only be used when constructing a new #GtkListStore. It will not
-function after a row has been added, or a method on the #GtkTreeModel
-interface is called.
+Requests the contents of the clipboard as text. When the text is
+later received, it will be converted to UTF-8 if necessary, and
+ callback will be called.
+
+The @text parameter to @callback will contain the resulting text if
+the request succeeded, or %NULL if it failed. This could happen for
+various reasons, in particular if the clipboard was empty or if the
+contents of the clipboard could not be converted into text form.
</description>
<parameters>
-<parameter name="list_store">
-<parameter_description> A #GtkListStore
+<parameter name="clipboard">
+<parameter_description> a #GtkClipboard
</parameter_description>
</parameter>
-<parameter name="n_columns">
-<parameter_description> Number of columns for the list store
+<parameter name="callback">
+<parameter_description> a function to call when the text is received,
+or the retrieval fails. (It will always be called
+one way or the other.)
</parameter_description>
</parameter>
-<parameter name="types">
-<parameter_description> An array length n of #GTypes
+<parameter name="user_data">
+<parameter_description> user data to pass to @callback.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_label_set_mnemonic_widget">
+<function name="gtk_clipboard_request_uris">
<description>
-If the label has been set so that it has an mnemonic key (using
-i.e. gtk_label_set_markup_with_mnemonic(),
-gtk_label_set_text_with_mnemonic(), gtk_label_new_with_mnemonic()
-or the "use_underline" property) the label can be associated with a
-widget that is the target of the mnemonic. When the label is inside
-a widget (like a #GtkButton or a #GtkNotebook tab) it is
-automatically associated with the correct widget, but sometimes
-(i.e. when the target is a #GtkEntry next to the label) you need to
-set it explicitly using this function.
+Requests the contents of the clipboard as URIs. When the URIs are
+later received @callback will be called.
-The target widget will be accelerated by emitting the
-GtkWidget::mnemonic-activate signal on it. The default handler for
-this signal will activate the widget if there are no mnemonic collisions
-and toggle focus between the colliding widgets otherwise.
+The @uris parameter to @callback will contain the resulting array of
+URIs if the request succeeded, or %NULL if it failed. This could happen
+for various reasons, in particular if the clipboard was empty or if the
+contents of the clipboard could not be converted into URI form.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="clipboard">
+<parameter_description> a #GtkClipboard
</parameter_description>
</parameter>
-<parameter name="widget">
-<parameter_description> the target #GtkWidget
+<parameter name="callback">
+<parameter_description> a function to call when the URIs are received,
+or the retrieval fails. (It will always be called
+one way or the other.)
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data to pass to @callback.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_size_group_new">
+<function name="gtk_clipboard_set_can_store">
<description>
-Create a new #GtkSizeGroup.
-
+Hints that the clipboard data should be stored somewhere when the
+application exits or when gtk_clipboard_store () is called.
+
+This value is reset when the clipboard owner changes.
+Where the clipboard data is stored is platform dependent,
+see gdk_display_store_clipboard () for more information.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="mode">
-<parameter_description> the mode for the new size group.
+<parameter name="clipboard">
+<parameter_description> a #GtkClipboard
+</parameter_description>
+</parameter>
+<parameter name="targets">
+<parameter_description> array containing information about which forms
+should be stored or %NULL to indicate that all forms should
+be stored.
+</parameter_description>
+</parameter>
+<parameter name="n_targets">
+<parameter_description> number of elements in @targets
</parameter_description>
</parameter>
</parameters>
-<return> a newly created #GtkSizeGroup
-</return>
+<return></return>
</function>
-<function name="gtk_button_get_image">
+<function name="gtk_clipboard_set_image">
<description>
-Gets the widget that is currenty set as the image of @button.
-This may have been explicitly set by gtk_button_set_image()
-or constructed by gtk_button_new_from_stock().
+Sets the contents of the clipboard to the given #GdkPixbuf.
+GTK+ will take responsibility for responding for requests
+for the image, and for converting the image into the
+requested format.
Since: 2.6
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkButton
+<parameter name="clipboard">
+<parameter_description> a #GtkClipboard object
+</parameter_description>
+</parameter>
+<parameter name="pixbuf">
+<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkWidget or %NULL in case there is no image
-
-</return>
+<return></return>
</function>
-<function name="gtk_page_setup_unix_dialog_set_page_setup">
+<function name="gtk_clipboard_set_text">
<description>
-Sets the #GtkPageSetup from which the page setup
-dialog takes its values.
-
-Since: 2.10
+Sets the contents of the clipboard to the given UTF-8 string. GTK+ will
+make a copy of the text and take responsibility for responding
+for requests for the text, and for converting the text into
+the requested format.
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkPageSetupUnixDialog
+<parameter name="clipboard">
+<parameter_description> a #GtkClipboard object
</parameter_description>
</parameter>
-<parameter name="page_setup">
-<parameter_description> a #GtkPageSetup
+<parameter name="text">
+<parameter_description> a UTF-8 string.
+</parameter_description>
+</parameter>
+<parameter name="len">
+<parameter_description> length of @text, in bytes, or -1, in which case
+the length will be determined with <function>strlen()</function>.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_context_get_dpi_x">
+<function name="gtk_clipboard_set_with_data">
<description>
-Obtains the horizontal resolution of the #GtkPrintContext,
-in dots per inch.
+Virtually sets the contents of the specified clipboard by providing
+a list of supported formats for the clipboard data and a function
+to call to get the actual data when it is requested.
-Since: 2.10
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GtkPrintContext
+<parameter name="clipboard">
+<parameter_description> a #GtkClipboard
+</parameter_description>
+</parameter>
+<parameter name="targets">
+<parameter_description> array containing information about the available forms for the
+clipboard data
+</parameter_description>
+</parameter>
+<parameter name="n_targets">
+<parameter_description> number of elements in @targets
+</parameter_description>
+</parameter>
+<parameter name="get_func">
+<parameter_description> function to call to get the actual clipboard data
+</parameter_description>
+</parameter>
+<parameter name="clear_func">
+<parameter_description> when the clipboard contents are set again, this function will
+be called, and @get_func will not be subsequently called.
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data to pass to @get_func and @clear_func.
</parameter_description>
</parameter>
</parameters>
-<return> the horizontal resolution of @context
-
+<return> %TRUE if setting the clipboard data succeeded. If setting
+the clipboard data failed the provided callback functions
+will be ignored.
</return>
</function>
-<function name="gtk_radio_action_set_group">
+<function name="gtk_clipboard_set_with_owner">
<description>
-Sets the radio group for the radio action object.
+Virtually sets the contents of the specified clipboard by providing
+a list of supported formats for the clipboard data and a function
+to call to get the actual data when it is requested.
+
+The difference between this function and gtk_clipboard_set_with_data()
+is that instead of an generic @user_data pointer, a #GObject is passed
+in.
-Since: 2.4
</description>
<parameters>
-<parameter name="action">
-<parameter_description> the action object
+<parameter name="clipboard">
+<parameter_description> a #GtkClipboard
</parameter_description>
</parameter>
-<parameter name="group">
-<parameter_description> a list representing a radio group
+<parameter name="targets">
+<parameter_description> array containing information about the available forms for the
+clipboard data
+</parameter_description>
+</parameter>
+<parameter name="n_targets">
+<parameter_description> number of elements in @targets
+</parameter_description>
+</parameter>
+<parameter name="get_func">
+<parameter_description> function to call to get the actual clipboard data
+</parameter_description>
+</parameter>
+<parameter name="clear_func">
+<parameter_description> when the clipboard contents are set again, this function will
+be called, and @get_func will not be subsequently called.
+</parameter_description>
+</parameter>
+<parameter name="owner">
+<parameter_description> an object that "owns" the data. This object will be passed
+to the callbacks when called.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if setting the clipboard data succeeded. If setting
+the clipboard data failed the provided callback functions
+will be ignored.
+</return>
</function>
-<function name="gtk_label_set_markup">
+<function name="gtk_clipboard_store">
<description>
-Parses @str which is marked up with the <link
-linkend="PangoMarkupFormat">Pango text markup language</link>, setting the
-label's text and attribute list based on the parse results. If the @str is
-external data, you may need to escape it with g_markup_escape_text() or
-g_markup_printf_escaped()<!-- -->:
-|[
-char *markup;
+Stores the current clipboard data somewhere so that it will stay
+around after the application has quit.
-markup = g_markup_printf_escaped ("<span style=\"italic\">%s</span>", str);
-gtk_label_set_markup (GTK_LABEL (label), markup);
-g_free (markup);
-]|
+Since: 2.6
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
-</parameter_description>
-</parameter>
-<parameter name="str">
-<parameter_description> a markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>)
+<parameter name="clipboard">
+<parameter_description> a #GtkClipboard
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_operation_get_default_page_setup">
+<function name="gtk_clipboard_wait_for_contents">
<description>
-Returns the default page setup, see
-gtk_print_operation_set_default_page_setup().
+Requests the contents of the clipboard using the given target.
+This function waits for the data to be received using the main
+loop, so events, timeouts, etc, may be dispatched during the wait.
-Since: 2.10
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter name="clipboard">
+<parameter_description> a #GtkClipboard
+</parameter_description>
+</parameter>
+<parameter name="target">
+<parameter_description> an atom representing the form into which the clipboard
+owner should convert the selection.
</parameter_description>
</parameter>
</parameters>
-<return> the default page setup
-
+<return> a newly-allocated #GtkSelectionData object or %NULL
+if retrieving the given target failed. If non-%NULL,
+this value must be freed with gtk_selection_data_free()
+when you are finished with it.
</return>
</function>
-<function name="gtk_page_setup_get_paper_width">
+<function name="gtk_clipboard_wait_for_image">
<description>
-Returns the paper width in units of @unit.
-
-Note that this function takes orientation, but
-not margins into consideration.
-See gtk_page_setup_get_page_width().
+Requests the contents of the clipboard as image and converts
+the result to a #GdkPixbuf. This function waits for
+the data to be received using the main loop, so events,
+timeouts, etc, may be dispatched during the wait.
-Since: 2.10
+Since: 2.6
</description>
<parameters>
-<parameter name="setup">
-<parameter_description> a #GtkPageSetup
-</parameter_description>
-</parameter>
-<parameter name="unit">
-<parameter_description> the unit for the return value
+<parameter name="clipboard">
+<parameter_description> a #GtkClipboard
</parameter_description>
</parameter>
</parameters>
-<return> the paper width.
+<return> a newly-allocated #GdkPixbuf object which must
+be disposed with g_object_unref(), or %NULL if
+retrieving the selection data failed. (This
+could happen for various reasons, in particular
+if the clipboard was empty or if the contents of
+the clipboard could not be converted into an image.)
</return>
</function>
-<function name="gtk_toolbar_set_drop_highlight_item">
+<function name="gtk_clipboard_wait_for_rich_text">
<description>
-Highlights @toolbar to give an idea of what it would look like
-if @item was added to @toolbar at the position indicated by @index_.
-If @item is %NULL, highlighting is turned off. In that case @index_
-is ignored.
-
-The @tool_item passed to this function must not be part of any widget
-hierarchy. When an item is set as drop highlight item it can not
-added to any widget hierarchy or used as highlight item for another
-toolbar.
+Requests the contents of the clipboard as rich text. This function
+waits for the data to be received using the main loop, so events,
+timeouts, etc, may be dispatched during the wait.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar
+<parameter name="clipboard">
+<parameter_description> a #GtkClipboard
</parameter_description>
</parameter>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem, or %NULL to turn of highlighting
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="index_">
-<parameter_description> a position on @toolbar
+<parameter name="format">
+<parameter_description> return location for the format of the returned data
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_recent_chooser_get_show_private">
-<description>
-Returns whether @chooser should display recently used resources
-registered as private.
-
-Since: 2.10
-
-</description>
-<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
+<parameter name="length">
+<parameter_description> return location for the length of the returned data
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the recent chooser should show private items,
-%FALSE otherwise.
+<return> a newly-allocated binary block of data which must
+be freed with g_free(), or %NULL if retrieving
+the selection data failed. (This could happen
+for various reasons, in particular if the
+clipboard was empty or if the contents of the
+clipboard could not be converted into text form.)
</return>
</function>
-<function name="gtk_clipboard_wait_is_target_available">
+<function name="gtk_clipboard_wait_for_targets">
<description>
-Checks if a clipboard supports pasting data of a given type. This
-function can be used to determine if a "Paste" menu item should be
-insensitive or not.
-
-If you want to see if there's text available on the clipboard, use
-gtk_clipboard_wait_is_text_available () instead.
+Returns a list of targets that are present on the clipboard, or %NULL
+if there aren't any targets available. The returned list must be
+freed with g_free().
+This function waits for the data to be received using the main
+loop, so events, timeouts, etc, may be dispatched during the wait.
-Since: 2.6
+Since: 2.4
</description>
<parameters>
@@ -8433,2885 +8657,2770 @@ Since: 2.6
<parameter_description> a #GtkClipboard
</parameter_description>
</parameter>
-<parameter name="target">
-<parameter_description> A #GdkAtom indicating which target to look for.
+<parameter name="targets">
+<parameter_description> location to store an array of targets. The result
+stored here must be freed with g_free().
+</parameter_description>
+</parameter>
+<parameter name="n_targets">
+<parameter_description> location to store number of items in @targets.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the target is available, %FALSE otherwise.
+<return> %TRUE if any targets are present on the clipboard,
+otherwise %FALSE.
</return>
</function>
-<function name="gtk_drag_set_icon_default">
+<function name="gtk_clipboard_wait_for_text">
<description>
-Sets the icon for a particular drag to the default
-icon.
+Requests the contents of the clipboard as text and converts
+the result to UTF-8 if necessary. This function waits for
+the data to be received using the main loop, so events,
+timeouts, etc, may be dispatched during the wait.
+
</description>
<parameters>
-<parameter name="context">
-<parameter_description> the context for a drag. (This must be called
- with a context for the source side of a drag)
+<parameter name="clipboard">
+<parameter_description> a #GtkClipboard
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a newly-allocated UTF-8 string which must
+be freed with g_free(), or %NULL if retrieving
+the selection data failed. (This could happen
+for various reasons, in particular if the
+clipboard was empty or if the contents of the
+clipboard could not be converted into text form.)
+</return>
</function>
-<function name="gtk_icon_source_copy">
+<function name="gtk_clipboard_wait_for_uris">
<description>
-Creates a copy of @source; mostly useful for language bindings.
+Requests the contents of the clipboard as URIs. This function waits
+for the data to be received using the main loop, so events,
+timeouts, etc, may be dispatched during the wait.
+Since: 2.14
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GtkIconSource
+<parameter name="clipboard">
+<parameter_description> a #GtkClipboard
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkIconSource
+<return> a newly-allocated
+%NULL-terminated array of strings which must
+be freed with g_strfreev(), or %NULL if
+retrieving the selection data failed. (This
+could happen for various reasons, in particular
+if the clipboard was empty or if the contents of
+the clipboard could not be converted into URI form.)
+
</return>
</function>
-<function name="gtk_print_settings_get_paper_size">
+<function name="gtk_clipboard_wait_is_image_available">
<description>
-Gets the value of %GTK_PRINT_SETTINGS_PAPER_FORMAT,
-converted to a #GtkPaperSize.
+Test to see if there is an image available to be pasted
+This is done by requesting the TARGETS atom and checking
+if it contains any of the supported image targets. This function
+waits for the data to be received using the main loop, so events,
+timeouts, etc, may be dispatched during the wait.
-Since: 2.10
+This function is a little faster than calling
+gtk_clipboard_wait_for_image() since it doesn't need to retrieve
+the actual image data.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="clipboard">
+<parameter_description> a #GtkClipboard
</parameter_description>
</parameter>
</parameters>
-<return> the paper size
+<return> %TRUE is there is an image available, %FALSE otherwise.
</return>
</function>
-<function name="gtk_widget_render_icon">
+<function name="gtk_clipboard_wait_is_rich_text_available">
<description>
-A convenience function that uses the theme engine and RC file
-settings for @widget to look up @stock_id and render it to
-a pixbuf. @stock_id should be a stock icon ID such as
-#GTK_STOCK_OPEN or #GTK_STOCK_OK. @size should be a size
-such as #GTK_ICON_SIZE_MENU. @detail should be a string that
-identifies the widget or code doing the rendering, so that
-theme engines can special-case rendering for that widget or code.
+Test to see if there is rich text available to be pasted
+This is done by requesting the TARGETS atom and checking
+if it contains any of the supported rich text targets. This function
+waits for the data to be received using the main loop, so events,
+timeouts, etc, may be dispatched during the wait.
-The pixels in the returned #GdkPixbuf are shared with the rest of
-the application and should not be modified. The pixbuf should be freed
-after use with g_object_unref().
+This function is a little faster than calling
+gtk_clipboard_wait_for_rich_text() since it doesn't need to retrieve
+the actual text.
+Since: 2.10
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="stock_id">
-<parameter_description> a stock ID
-</parameter_description>
-</parameter>
-<parameter name="size">
-<parameter_description> (type int) a stock size. A size of (GtkIconSize)-1 means
-render at the size of the source and don't scale (if there are
-multiple source sizes, GTK+ picks one of the available sizes).
+<parameter name="clipboard">
+<parameter_description> a #GtkClipboard
</parameter_description>
</parameter>
-<parameter name="detail">
-<parameter_description> render detail to pass to theme engine
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
</parameters>
-<return> a new pixbuf, or %NULL if the stock ID wasn't known
+<return> %TRUE is there is rich text available, %FALSE otherwise.
+
</return>
</function>
-<function name="gtk_selection_data_set_pixbuf">
+<function name="gtk_clipboard_wait_is_target_available">
<description>
-Sets the contents of the selection from a #GdkPixbuf
-The pixbuf is converted to the form determined by
- selection_data->target.
+Checks if a clipboard supports pasting data of a given type. This
+function can be used to determine if a "Paste" menu item should be
+insensitive or not.
+
+If you want to see if there's text available on the clipboard, use
+gtk_clipboard_wait_is_text_available () instead.
Since: 2.6
</description>
<parameters>
-<parameter name="selection_data">
-<parameter_description> a #GtkSelectionData
+<parameter name="clipboard">
+<parameter_description> a #GtkClipboard
</parameter_description>
</parameter>
-<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf
+<parameter name="target">
+<parameter_description> A #GdkAtom indicating which target to look for.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the selection was successfully set,
-otherwise %FALSE.
+<return> %TRUE if the target is available, %FALSE otherwise.
</return>
</function>
-<function name="gtk_widget_set_mapped">
+<function name="gtk_clipboard_wait_is_text_available">
<description>
-Marks the widget as being realized.
+Test to see if there is text available to be pasted
+This is done by requesting the TARGETS atom and checking
+if it contains any of the supported text targets. This function
+waits for the data to be received using the main loop, so events,
+timeouts, etc, may be dispatched during the wait.
-This function should only ever be called in a derived widget's
-"map" or "unmap" implementation.
+This function is a little faster than calling
+gtk_clipboard_wait_for_text() since it doesn't need to retrieve
+the actual text.
-Since: 2.20
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="mapped">
-<parameter_description> %TRUE to mark the widget as mapped
+<parameter name="clipboard">
+<parameter_description> a #GtkClipboard
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE is there is text available, %FALSE otherwise.
+</return>
</function>
-<function name="gtk_tree_row_reference_get_model">
+<function name="gtk_clipboard_wait_is_uris_available">
<description>
-Returns the model that the row reference is monitoring.
+Test to see if there is a list of URIs available to be pasted
+This is done by requesting the TARGETS atom and checking
+if it contains the URI targets. This function
+waits for the data to be received using the main loop, so events,
+timeouts, etc, may be dispatched during the wait.
-Since: 2.8
+This function is a little faster than calling
+gtk_clipboard_wait_for_uris() since it doesn't need to retrieve
+the actual URI data.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="reference">
-<parameter_description> A #GtkTreeRowReference
+<parameter name="clipboard">
+<parameter_description> a #GtkClipboard
</parameter_description>
</parameter>
</parameters>
-<return> the model
+<return> %TRUE is there is an URI list available, %FALSE otherwise.
</return>
</function>
-<function name="gtk_combo_box_popdown">
+<function name="gtk_clist_set_pixmap">
<description>
-Hides the menu or dropdown list of @combo_box.
-
-This function is mostly intended for use by accessibility technologies;
-applications should have little use for it.
-
-Since: 2.4
</description>
<parameters>
-<parameter name="combo_box">
-<parameter_description> a #GtkComboBox
+<parameter name="mask">
+<parameter_description>
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_set_icon_from_file">
+<function name="gtk_color_button_get_alpha">
<description>
-Sets the icon for @window.
-Warns on failure if @err is %NULL.
-
-This function is equivalent to calling gtk_window_set_icon()
-with a pixbuf created by loading the image from @filename.
+Returns the current alpha value.
-Since: 2.2
+Since: 2.4
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
-</parameter_description>
-</parameter>
-<parameter name="filename">
-<parameter_description> location of icon file
-</parameter_description>
-</parameter>
-<parameter name="err">
-<parameter_description> location to store error, or %NULL.
+<parameter name="color_button">
+<parameter_description> a #GtkColorButton.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if setting the icon succeeded.
+<return> an integer between 0 and 65535.
</return>
</function>
-<function name="gtk_text_layout_set_cursor_visible">
+<function name="gtk_color_button_get_color">
<description>
-Sets whether the insertion cursor should be shown. Generally,
-widgets using #GtkTextLayout will hide the cursor when the
-widget does not have the input focus.
+Sets @color to be the current color in the #GtkColorButton widget.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #GtkTextLayout
+<parameter name="color_button">
+<parameter_description> a #GtkColorButton.
</parameter_description>
</parameter>
-<parameter name="cursor_visible">
-<parameter_description> If %FALSE, then the insertion cursor will not
-be shown, even if the text is editable.
+<parameter name="color">
+<parameter_description> a #GdkColor to fill in with the current color.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_store_set_column_types">
+<function name="gtk_color_button_get_title">
<description>
-This function is meant primarily for #GObjects that inherit from
-#GtkTreeStore, and should only be used when constructing a new
-#GtkTreeStore. It will not function after a row has been added,
-or a method on the #GtkTreeModel interface is called.
+Gets the title of the color selection dialog.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="tree_store">
-<parameter_description> A #GtkTreeStore
-</parameter_description>
-</parameter>
-<parameter name="n_columns">
-<parameter_description> Number of columns for the tree store
-</parameter_description>
-</parameter>
-<parameter name="types">
-<parameter_description> An array of #GType types, one for each column
+<parameter name="color_button">
+<parameter_description> a #GtkColorButton
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> An internal string, do not free the return value
+
+</return>
</function>
-<function name="gtk_scale_new">
+<function name="gtk_color_button_get_use_alpha">
<description>
-Creates a new #GtkScale.
+Does the color selection dialog use the alpha channel?
-Since: 2.16
+Since: 2.4
</description>
<parameters>
-<parameter name="orientation">
-<parameter_description> the scale's orientation.
-</parameter_description>
-</parameter>
-<parameter name="adjustment">
-<parameter_description> the #GtkAdjustment which sets the range of the scale, or
-%NULL to create a new adjustment.
+<parameter name="color_button">
+<parameter_description> a #GtkColorButton.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkScale
+<return> %TRUE if the color sample uses alpha channel, %FALSE if not.
</return>
</function>
-<function name="gtk_notebook_get_tab_hborder">
+<function name="gtk_color_button_new">
<description>
-Returns the horizontal width of a tab border.
+Creates a new color button. This returns a widget in the form of
+a small button containing a swatch representing the current selected
+color. When the button is clicked, a color-selection dialog will open,
+allowing the user to select a color. The swatch will be updated to reflect
+the new color when the user finishes.
-Since: 2.22
+Since: 2.4
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
-</parameter_description>
-</parameter>
</parameters>
-<return> horizontal width of a tab border
+<return> a new color button.
</return>
</function>
-<function name="gtk_selection_convert">
+<function name="gtk_color_button_new_with_color">
<description>
-Requests the contents of a selection. When received,
-a "selection-received" signal will be generated.
+Creates a new color button.
+Since: 2.4
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> The widget which acts as requestor
-</parameter_description>
-</parameter>
-<parameter name="selection">
-<parameter_description> Which selection to get
-</parameter_description>
-</parameter>
-<parameter name="target">
-<parameter_description> Form of information desired (e.g., STRING)
-</parameter_description>
-</parameter>
-<parameter name="time_">
-<parameter_description> Time of request (usually of triggering event)
- In emergency, you could use #GDK_CURRENT_TIME
+<parameter name="color">
+<parameter_description> A #GdkColor to set the current color with.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if requested succeeded. %FALSE if we could not process
-request. (e.g., there was already a request in process for
-this widget).
+<return> a new color button.
+
</return>
</function>
-<function name="gtk_tree_view_set_reorderable">
+<function name="gtk_color_button_set_alpha">
<description>
-This function is a convenience function to allow you to reorder
-models that support the #GtkDragSourceIface and the
-#GtkDragDestIface. Both #GtkTreeStore and #GtkListStore support
-these. If @reorderable is %TRUE, then the user can reorder the
-model by dragging and dropping rows. The developer can listen to
-these changes by connecting to the model's row_inserted and
-row_deleted signals. The reordering is implemented by setting up
-the tree view as a drag source and destination. Therefore, drag and
-drop can not be used in a reorderable view for any other purpose.
+Sets the current opacity to be @alpha.
-This function does not give you any degree of control over the order -- any
-reordering is allowed. If more control is needed, you should probably
-handle drag and drop manually.
+Since: 2.4
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView.
+<parameter name="color_button">
+<parameter_description> a #GtkColorButton.
</parameter_description>
</parameter>
-<parameter name="reorderable">
-<parameter_description> %TRUE, if the tree can be reordered.
+<parameter name="alpha">
+<parameter_description> an integer between 0 and 65535.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_page_setup_to_file">
+<function name="gtk_color_button_set_color">
<description>
-This function saves the information from @setup to @file_name.
+Sets the current color to be @color.
-Since: 2.12
+Since: 2.4
</description>
<parameters>
-<parameter name="setup">
-<parameter_description> a #GtkPageSetup
-</parameter_description>
-</parameter>
-<parameter name="file_name">
-<parameter_description> the file to save to
+<parameter name="color_button">
+<parameter_description> a #GtkColorButton.
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for errors, or %NULL
+<parameter name="color">
+<parameter_description> A #GdkColor to set the current color with.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success
-
-</return>
+<return></return>
</function>
-<function name="gtk_combo_box_set_column_span_column">
+<function name="gtk_color_button_set_title">
<description>
-Sets the column with column span information for @combo_box to be
- column_span The column span column contains integers which indicate
-how many columns an item should span.
+Sets the title for the color selection dialog.
Since: 2.4
</description>
<parameters>
-<parameter name="combo_box">
-<parameter_description> A #GtkComboBox
+<parameter name="color_button">
+<parameter_description> a #GtkColorButton
</parameter_description>
</parameter>
-<parameter name="column_span">
-<parameter_description> A column in the model passed during construction
+<parameter name="title">
+<parameter_description> String containing new window title.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_set_scroll_adjustments">
+<function name="gtk_color_button_set_use_alpha">
<description>
-For widgets that support scrolling, sets the scroll adjustments and
-returns %TRUE. For widgets that don't support scrolling, does
-nothing and returns %FALSE. Widgets that don't support scrolling
-can be scrolled by placing them in a #GtkViewport, which does
-support scrolling.
+Sets whether or not the color button should use the alpha channel.
+Since: 2.4
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="color_button">
+<parameter_description> a #GtkColorButton.
</parameter_description>
</parameter>
-<parameter name="hadjustment">
-<parameter_description> an adjustment for horizontal scrolling, or %NULL
+<parameter name="use_alpha">
+<parameter_description> %TRUE if color button should use alpha channel, %FALSE if not.
</parameter_description>
</parameter>
-<parameter name="vadjustment">
-<parameter_description> an adjustment for vertical scrolling, or %NULL
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_color_selection_dialog_get_color_selection">
+<description>
+Retrieves the #GtkColorSelection widget embedded in the dialog.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="colorsel">
+<parameter_description> a #GtkColorSelectionDialog
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the widget supports scrolling
+<return> the embedded #GtkColorSelection
+
</return>
</function>
-<function name="gtk_text_buffer_unregister_serialize_format">
+<function name="gtk_color_selection_get_color">
<description>
-This function unregisters a rich text format that was previously
-registered using gtk_text_buffer_register_serialize_format() or
-gtk_text_buffer_register_serialize_tagset()
+Sets @color to be the current color in the GtkColorSelection widget.
-Since: 2.10
+Deprecated: 2.0: Use gtk_color_selection_get_current_color() instead.
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="colorsel">
+<parameter_description> a #GtkColorSelection.
</parameter_description>
</parameter>
-<parameter name="format">
-<parameter_description> a #GdkAtom representing a registered rich text format.
+<parameter name="color">
+<parameter_description> an array of 4 #gdouble to fill in with the current color.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_range_get_flippable">
+<function name="gtk_color_selection_get_current_alpha">
<description>
-Gets the value set by gtk_range_set_flippable().
+Returns the current alpha value.
-Since: 2.18
</description>
<parameters>
-<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter name="colorsel">
+<parameter_description> a #GtkColorSelection.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the range is flippable
-
+<return> an integer between 0 and 65535.
</return>
</function>
-<function name="gtk_window_set_icon_list">
+<function name="gtk_color_selection_get_current_color">
<description>
-Sets up the icon representing a #GtkWindow. The icon is used when
-the window is minimized (also known as iconified). Some window
-managers or desktop environments may also place it in the window
-frame, or display it in other contexts.
-
-gtk_window_set_icon_list() allows you to pass in the same icon in
-several hand-drawn sizes. The list should contain the natural sizes
-your icon is available in; that is, don't scale the image before
-passing it to GTK+. Scaling is postponed until the last minute,
-when the desired final size is known, to allow best quality.
-
-By passing several sizes, you may improve the final image quality
-of the icon, by reducing or eliminating automatic image scaling.
-
-Recommended sizes to provide: 16x16, 32x32, 48x48 at minimum, and
-larger images (64x64, 128x128) if you have them.
-
-See also gtk_window_set_default_icon_list() to set the icon
-for all windows in your application in one go.
-
-Note that transient windows (those who have been set transient for another
-window using gtk_window_set_transient_for()) will inherit their
-icon from their transient parent. So there's no need to explicitly
-set the icon on transient windows.
+Sets @color to be the current color in the GtkColorSelection widget.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="colorsel">
+<parameter_description> a #GtkColorSelection.
</parameter_description>
</parameter>
-<parameter name="list">
-<parameter_description> list of #GdkPixbuf
+<parameter name="color">
+<parameter_description> a #GdkColor to fill in with the current color.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_entry_set_position">
+<function name="gtk_color_selection_get_has_opacity_control">
<description>
-Sets the cursor position in an entry to the given value.
+Determines whether the colorsel has an opacity control.
-Deprecated: 2.0: Use gtk_editable_set_position() instead.
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
-</parameter_description>
-</parameter>
-<parameter name="position">
-<parameter_description> the position of the cursor. The cursor is displayed
-before the character with the given (base 0) index in the widget.
-The value must be less than or equal to the number of characters
-in the widget. A value of -1 indicates that the position should
-be set after the last character in the entry. Note that this
-position is in characters, not in bytes.
+<parameter name="colorsel">
+<parameter_description> a #GtkColorSelection.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the @colorsel has an opacity control. %FALSE if it does't.
+</return>
</function>
-<function name="gtk_tool_button_get_label_widget">
+<function name="gtk_color_selection_get_has_palette">
<description>
-Returns the widget used as label on @button. See
-gtk_tool_button_set_label_widget().
+Determines whether the color selector has a color palette.
-Since: 2.4
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkToolButton
+<parameter name="colorsel">
+<parameter_description> a #GtkColorSelection.
</parameter_description>
</parameter>
</parameters>
-<return> The widget used as label on @button, or %NULL.
-
+<return> %TRUE if the selector has a palette. %FALSE if it hasn't.
</return>
</function>
-<function name="gtk_widget_get_window">
+<function name="gtk_color_selection_get_previous_alpha">
<description>
-Returns the widget's window if it is realized, %NULL otherwise
+Returns the previous alpha value.
-Since: 2.14
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="colorsel">
+<parameter_description> a #GtkColorSelection.
</parameter_description>
</parameter>
</parameters>
-<return> @widget's window.
-
+<return> an integer between 0 and 65535.
</return>
</function>
-<function name="gtk_scale_get_draw_value">
+<function name="gtk_color_selection_get_previous_color">
<description>
-Returns whether the current value is displayed as a string
-next to the slider.
-
+Fills @color in with the original color value.
</description>
<parameters>
-<parameter name="scale">
-<parameter_description> a #GtkScale
+<parameter name="colorsel">
+<parameter_description> a #GtkColorSelection.
+</parameter_description>
+</parameter>
+<parameter name="color">
+<parameter_description> a #GdkColor to fill in with the original color value.
</parameter_description>
</parameter>
</parameters>
-<return> whether the current value is displayed as a string
-</return>
+<return></return>
</function>
-<function name="gtk_scale_button_get_orientation">
+<function name="gtk_color_selection_is_adjusting">
<description>
-Gets the orientation of the #GtkScaleButton's popup window.
+Gets the current state of the @colorsel.
-Since: 2.14
-
-Deprecated: 2.16: Use gtk_orientable_get_orientation() instead.
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkScaleButton
+<parameter name="colorsel">
+<parameter_description> a #GtkColorSelection.
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkScaleButton's orientation.
-
+<return> %TRUE if the user is currently dragging a color around, and %FALSE
+if the selection has stopped.
</return>
</function>
-<function name="gtk_hsv_to_rgb">
+<function name="gtk_color_selection_new">
<description>
-Converts a color from HSV space to RGB.
-Input values must be in the [0.0, 1.0] range;
-output values will be in the same range.
+Creates a new GtkColorSelection.
-Since: 2.14
</description>
<parameters>
-<parameter name="h">
-<parameter_description> Hue
-</parameter_description>
-</parameter>
-<parameter name="s">
-<parameter_description> Saturation
-</parameter_description>
-</parameter>
-<parameter name="v">
-<parameter_description> Value
-</parameter_description>
-</parameter>
-<parameter name="r">
-<parameter_description> Return value for the red component
-</parameter_description>
-</parameter>
-<parameter name="g">
-<parameter_description> Return value for the green component
-</parameter_description>
-</parameter>
-<parameter name="b">
-<parameter_description> Return value for the blue component
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> a new #GtkColorSelection
+</return>
</function>
-<function name="gtk_text_buffer_serialize">
+<function name="gtk_color_selection_palette_from_string">
<description>
-This function serializes the portion of text between @start
-and @end in the rich text format represented by @format.
+Parses a color palette string; the string is a colon-separated
+list of color names readable by gdk_color_parse().
- format<!-- -->s to be used must be registered using
-gtk_text_buffer_register_serialize_format() or
-gtk_text_buffer_register_serialize_tagset() beforehand.
-
-Since: 2.10
</description>
<parameters>
-<parameter name="register_buffer">
-<parameter_description> the #GtkTextBuffer @format is registered with
-</parameter_description>
-</parameter>
-<parameter name="content_buffer">
-<parameter_description> the #GtkTextBuffer to serialize
-</parameter_description>
-</parameter>
-<parameter name="format">
-<parameter_description> the rich text format to use for serializing
-</parameter_description>
-</parameter>
-<parameter name="start">
-<parameter_description> start of block of text to serialize
+<parameter name="str">
+<parameter_description> a string encoding a color palette.
</parameter_description>
</parameter>
-<parameter name="end">
-<parameter_description> end of block of test to serialize
+<parameter name="colors">
+<parameter_description> return location for allocated array of #GdkColor.
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> return location for the length of the serialized data
+<parameter name="n_colors">
+<parameter_description> return location for length of array.
</parameter_description>
</parameter>
</parameters>
-<return> the serialized data, encoded as @format
-
+<return> %TRUE if a palette was successfully parsed.
</return>
</function>
-<function name="gtk_combo_box_get_active_iter">
+<function name="gtk_color_selection_palette_to_string">
<description>
-Sets @iter to point to the current active item, if it exists.
+Encodes a palette as a string, useful for persistent storage.
-Since: 2.4
</description>
<parameters>
-<parameter name="combo_box">
-<parameter_description> A #GtkComboBox
+<parameter name="colors">
+<parameter_description> an array of colors.
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> The uninitialized #GtkTreeIter
+<parameter name="n_colors">
+<parameter_description> length of the array.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE, if @iter was set
-
+<return> allocated string encoding the palette.
</return>
</function>
-<function name="gtk_tree_view_new_with_model">
+<function name="gtk_color_selection_set_change_palette_hook">
<description>
-Creates a new #GtkTreeView widget with the model initialized to @model.
+Installs a global function to be called whenever the user tries to
+modify the palette in a color selection. This function should save
+the new palette contents, and update the GtkSettings property
+"gtk-color-palette" so all GtkColorSelection widgets will be modified.
+
+Deprecated: 2.4: This function does not work in multihead environments.
+Use gtk_color_selection_set_change_palette_with_screen_hook() instead.
</description>
<parameters>
-<parameter name="model">
-<parameter_description> the model.
+<parameter name="func">
+<parameter_description> a function to call when the custom palette needs saving.
</parameter_description>
</parameter>
</parameters>
-<return> A newly created #GtkTreeView widget.
+<return> the previous change palette hook (that was replaced).
+
</return>
</function>
-<function name="gtk_accessible_get_widget">
+<function name="gtk_color_selection_set_change_palette_with_screen_hook">
<description>
-Gets the #GtkWidget corresponding to the #GtkAccessible. The returned widget
-does not have a reference added, so you do not need to unref it.
+Installs a global function to be called whenever the user tries to
+modify the palette in a color selection. This function should save
+the new palette contents, and update the GtkSettings property
+"gtk-color-palette" so all GtkColorSelection widgets will be modified.
-Since: 2.22
+Since: 2.2
</description>
<parameters>
-<parameter name="accessible">
-<parameter_description> a #GtkAccessible
+<parameter name="func">
+<parameter_description> a function to call when the custom palette needs saving.
</parameter_description>
</parameter>
</parameters>
-<return> pointer to the #GtkWidget corresponding to
-the #GtkAccessible, or %NULL.
+<return> the previous change palette hook (that was replaced).
</return>
</function>
-<function name="gtk_cell_layout_clear">
+<function name="gtk_color_selection_set_color">
<description>
-Unsets all the mappings on all renderers on @cell_layout and
-removes all renderers from @cell_layout.
+Sets the current color to be @color. The first time this is called, it will
+also set the original color to be @color too.
-Since: 2.4
+Deprecated: 2.0: Use gtk_color_selection_set_current_color() instead.
</description>
<parameters>
-<parameter name="cell_layout">
-<parameter_description> A #GtkCellLayout.
+<parameter name="colorsel">
+<parameter_description> a #GtkColorSelection.
+</parameter_description>
+</parameter>
+<parameter name="color">
+<parameter_description> an array of 4 doubles specifying the red, green, blue and opacity
+to set the current color to.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_layout_get_bin_window">
+<function name="gtk_color_selection_set_current_alpha">
<description>
-Retrieve the bin window of the layout used for drawing operations.
-
-Since: 2.14
+Sets the current opacity to be @alpha. The first time this is called, it will
+also set the original opacity to be @alpha too.
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #GtkLayout
+<parameter name="colorsel">
+<parameter_description> a #GtkColorSelection.
+</parameter_description>
+</parameter>
+<parameter name="alpha">
+<parameter_description> an integer between 0 and 65535.
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkWindow
-
-</return>
+<return></return>
</function>
-<function name="gtk_tool_palette_get_drag_item">
+<function name="gtk_color_selection_set_current_color">
<description>
-Get the dragged item from the selection.
-This could be a #GtkToolItem or a #GtkToolItemGroup.
-
-Since: 2.20
+Sets the current color to be @color. The first time this is called, it will
+also set the original color to be @color too.
</description>
<parameters>
-<parameter name="palette">
-<parameter_description> a #GtkToolPalette
+<parameter name="colorsel">
+<parameter_description> a #GtkColorSelection.
</parameter_description>
</parameter>
-<parameter name="selection">
-<parameter_description> a #GtkSelectionData
+<parameter name="color">
+<parameter_description> A #GdkColor to set the current color with.
</parameter_description>
</parameter>
</parameters>
-<return> the dragged item in selection
-
-</return>
+<return></return>
</function>
-<function name="gtk_icon_source_set_size_wildcarded">
+<function name="gtk_color_selection_set_has_opacity_control">
<description>
-If the icon size is wildcarded, this source can be used as the base
-image for an icon of any size. If the size is not wildcarded, then
-the size the source applies to should be set with
-gtk_icon_source_set_size() and the icon source will only be used
-with that specific size.
+Sets the @colorsel to use or not use opacity.
-#GtkIconSet prefers non-wildcarded sources (exact matches) over
-wildcarded sources, and will use an exact match when possible.
-
-#GtkIconSet will normally scale wildcarded source images to produce
-an appropriate icon at a given size, but will not change the size
-of source images that match exactly.
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GtkIconSource
+<parameter name="colorsel">
+<parameter_description> a #GtkColorSelection.
</parameter_description>
</parameter>
-<parameter name="setting">
-<parameter_description> %TRUE to wildcard the widget state
+<parameter name="has_opacity">
+<parameter_description> %TRUE if @colorsel can set the opacity, %FALSE otherwise.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_draw_tab">
+<function name="gtk_color_selection_set_has_palette">
<description>
-Draws an option menu tab (i.e. the up and down pointing arrows)
-in the given rectangle on @window using the given parameters.
+Shows and hides the palette based upon the value of @has_palette.
-Deprecated: 2.0: Use gtk_paint_tab() instead.
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="colorsel">
+<parameter_description> a #GtkColorSelection.
</parameter_description>
</parameter>
-<parameter name="state_type">
-<parameter_description> a state
+<parameter name="has_palette">
+<parameter_description> %TRUE if palette is to be visible, %FALSE otherwise.
</parameter_description>
</parameter>
-<parameter name="shadow_type">
-<parameter_description> the type of shadow to draw
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_color_selection_set_palette_color">
+<description>
+Sets the palette located at @index to have @color as its color.
+
+
+</description>
+<parameters>
+<parameter name="colorsel">
+<parameter_description> a #GtkColorSelection.
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> x origin of the rectangle to draw the tab in
+<parameter name="index">
+<parameter_description> the color index of the palette.
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> y origin of the rectangle to draw the tab in
+<parameter name="color">
+<parameter_description> A #GdkColor to set the palette with.
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> the width of the rectangle to draw the tab in
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_color_selection_set_previous_alpha">
+<description>
+Sets the 'previous' alpha to be @alpha. This function should be called with
+some hesitations, as it might seem confusing to have that alpha change.
+
+</description>
+<parameters>
+<parameter name="colorsel">
+<parameter_description> a #GtkColorSelection.
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> the height of the rectangle to draw the tab in
+<parameter name="alpha">
+<parameter_description> an integer between 0 and 65535.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_info_bar_set_message_type">
+<function name="gtk_color_selection_set_previous_color">
<description>
-Sets the message type of the message area.
-GTK+ uses this type to determine what color to use
-when drawing the message area.
-
-Since: 2.18
+Sets the 'previous' color to be @color. This function should be called with
+some hesitations, as it might seem confusing to have that color change.
+Calling gtk_color_selection_set_current_color() will also set this color the first
+time it is called.
</description>
<parameters>
-<parameter name="info_bar">
-<parameter_description> a #GtkInfoBar
+<parameter name="colorsel">
+<parameter_description> a #GtkColorSelection.
</parameter_description>
</parameter>
-<parameter name="message_type">
-<parameter_description> a #GtkMessageType
+<parameter name="color">
+<parameter_description> a #GdkColor to set the previous color with.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_ensure_style">
+<function name="gtk_combo_box_append_text">
<description>
-Ensures that @widget has a style (@widget->style). Not a very useful
-function; most of the time, if you want the style, the widget is
-realized, and realized widgets are guaranteed to have a style
-already.
+Appends @string to the list of strings stored in @combo_box. Note that
+you can only use this function with combo boxes constructed with
+gtk_combo_box_new_text().
+
+Since: 2.4
+
+Deprecated: 2.24: Use #GtkComboBoxText
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="combo_box">
+<parameter_description> A #GtkComboBox constructed using gtk_combo_box_new_text()
+</parameter_description>
+</parameter>
+<parameter name="text">
+<parameter_description> A string
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_font_selection_get_size">
+<function name="gtk_combo_box_entry_get_text_column">
<description>
-The selected font size.
+Returns the column which @entry_box is using to get the strings from.
-Since: 2.14
+Since: 2.4
+
+Deprecated: 2.24: Use gtk_combo_box_get_entry_text_column() instead
</description>
<parameters>
-<parameter name="fontsel">
-<parameter_description> a #GtkFontSelection
+<parameter name="entry_box">
+<parameter_description> A #GtkComboBoxEntry.
</parameter_description>
</parameter>
</parameters>
-<return> A n integer representing the selected font size,
-or -1 if no font size is selected.
+<return> A column in the data source model of @entry_box.
</return>
</function>
-<function name="gtk_target_list_ref">
+<function name="gtk_combo_box_entry_new">
<description>
-Increases the reference count of a #GtkTargetList by one.
+Creates a new #GtkComboBoxEntry which has a #GtkEntry as child. After
+construction, you should set a model using gtk_combo_box_set_model() and a
+text column using gtk_combo_box_entry_set_text_column().
+Since: 2.4
+
+Deprecated: 2.24: Use gtk_combo_box_new_with_entry() instead
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GtkTargetList
-</parameter_description>
-</parameter>
</parameters>
-<return> the passed in #GtkTargetList.
+<return> A new #GtkComboBoxEntry.
+
</return>
</function>
-<function name="gtk_adjustment_get_value">
+<function name="gtk_combo_box_entry_new_text">
<description>
-Gets the current value of the adjustment. See
-gtk_adjustment_set_value ().
+Convenience function which constructs a new editable text combo box, which
+is a #GtkComboBoxEntry just displaying strings. If you use this function to
+create a text combo box, you should only manipulate its data source with
+the following convenience functions: gtk_combo_box_append_text(),
+gtk_combo_box_insert_text(), gtk_combo_box_prepend_text() and
+gtk_combo_box_remove_text().
+Since: 2.4
</description>
<parameters>
-<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
-</parameter_description>
-</parameter>
</parameters>
-<return> The current value of the adjustment.
+<return> A new text #GtkComboBoxEntry.
+
</return>
</function>
-<function name="gtk_tool_item_set_visible_horizontal">
+<function name="gtk_combo_box_entry_new_with_model">
<description>
-Sets whether @tool_item is visible when the toolbar is docked horizontally.
+Creates a new #GtkComboBoxEntry which has a #GtkEntry as child and a list
+of strings as popup. You can get the #GtkEntry from a #GtkComboBoxEntry
+using GTK_ENTRY (GTK_BIN (combo_box_entry)->child). To add and remove
+strings from the list, just modify @model using its data manipulation
+API.
Since: 2.4
+Deprecated: 2.24: Use gtk_combo_box_new_with_entry() instead
+
</description>
<parameters>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem
+<parameter name="model">
+<parameter_description> A #GtkTreeModel.
</parameter_description>
</parameter>
-<parameter name="visible_horizontal">
-<parameter_description> Whether @tool_item is visible when in horizontal mode
+<parameter name="text_column">
+<parameter_description> A column in @model to get the strings from.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A new #GtkComboBoxEntry.
+
+</return>
</function>
-<function name="gtk_image_set_from_animation">
+<function name="gtk_combo_box_entry_set_text_column">
<description>
-Causes the #GtkImage to display the given animation (or display
-nothing, if you set the animation to %NULL).
+Sets the model column which @entry_box should use to get strings from
+to be @text_column.
+
+Since: 2.4
+
+Deprecated: 2.24: Use gtk_combo_box_set_entry_text_column() instead
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GtkImage
+<parameter name="entry_box">
+<parameter_description> A #GtkComboBoxEntry.
</parameter_description>
</parameter>
-<parameter name="animation">
-<parameter_description> the #GdkPixbufAnimation
+<parameter name="text_column">
+<parameter_description> A column in @model to get the strings from.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_get_parent_window">
+<function name="gtk_combo_box_get_active">
<description>
-Gets @widget's parent window.
+Returns the index of the currently active item, or -1 if there's no
+active item. If the model is a non-flat treemodel, and the active item
+is not an immediate child of the root of the tree, this function returns
+<literal>gtk_tree_path_get_indices (path)[0]</literal>, where
+<literal>path</literal> is the #GtkTreePath of the active item.
+Since: 2.4
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget.
+<parameter name="combo_box">
+<parameter_description> A #GtkComboBox
</parameter_description>
</parameter>
</parameters>
-<return> the parent window of @widget.
+<return> An integer which is the index of the currently active item,
+or -1 if there's no active item.
+
</return>
</function>
-<function name="gtk_tree_drag_source_row_draggable">
+<function name="gtk_combo_box_get_active_iter">
<description>
-Asks the #GtkTreeDragSource whether a particular row can be used as
-the source of a DND operation. If the source doesn't implement
-this interface, the row is assumed draggable.
+Sets @iter to point to the current active item, if it exists.
+Since: 2.4
</description>
<parameters>
-<parameter name="drag_source">
-<parameter_description> a #GtkTreeDragSource
+<parameter name="combo_box">
+<parameter_description> A #GtkComboBox
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> row on which user is initiating a drag
+<parameter name="iter">
+<parameter_description> The uninitialized #GtkTreeIter
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the row can be dragged
+<return> %TRUE, if @iter was set
+
</return>
</function>
-<function name="gtk_window_move">
+<function name="gtk_combo_box_get_active_text">
<description>
-Asks the <link linkend="gtk-X11-arch">window manager</link> to move
- window to the given position. Window managers are free to ignore
-this; most window managers ignore requests for initial window
-positions (instead using a user-defined placement algorithm) and
-honor requests after the window has already been shown.
-
-Note: the position is the position of the gravity-determined
-reference point for the window. The gravity determines two things:
-first, the location of the reference point in root window
-coordinates; and second, which point on the window is positioned at
-the reference point.
-
-By default the gravity is #GDK_GRAVITY_NORTH_WEST, so the reference
-point is simply the @x, @y supplied to gtk_window_move(). The
-top-left corner of the window decorations (aka window frame or
-border) will be placed at @x, @y. Therefore, to position a window
-at the top left of the screen, you want to use the default gravity
-(which is #GDK_GRAVITY_NORTH_WEST) and move the window to 0,0.
-
-To position a window at the bottom right corner of the screen, you
-would set #GDK_GRAVITY_SOUTH_EAST, which means that the reference
-point is at @x + the window width and @y + the window height, and
-the bottom-right corner of the window border will be placed at that
-reference point. So, to place a window in the bottom right corner
-you would first set gravity to south east, then write:
-<literal>gtk_window_move (window, gdk_screen_width () - window_width,
-gdk_screen_height () - window_height)</literal> (note that this
-example does not take multi-head scenarios into account).
+Returns the currently active string in @combo_box or %NULL if none
+is selected. Note that you can only use this function with combo
+boxes constructed with gtk_combo_box_new_text() and with
+#GtkComboBoxEntry<!-- -->s.
-The Extended Window Manager Hints specification at <ulink
-url="http://www.freedesktop.org/Standards/wm-spec">
-http://www.freedesktop.org/Standards/wm-spec</ulink> has a
-nice table of gravities in the "implementation notes" section.
+Since: 2.6
-The gtk_window_get_position() documentation may also be relevant.
+Deprecated: 2.24: If you used this with a #GtkComboBox constructed with
+gtk_combo_box_new_text() then you should now use #GtkComboBoxText and
+gtk_combo_box_text_get_active_text() instead. Or if you used this with a
+#GtkComboBoxEntry then you should now use #GtkComboBox with
+#GtkComboBox:has-entry as %TRUE and use
+gtk_entry_get_text (GTK_ENTRY (gtk_bin_get_child (GTK_BIN (combobox))).
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> X coordinate to move window to
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> Y coordinate to move window to
+<parameter name="combo_box">
+<parameter_description> A #GtkComboBox constructed with gtk_combo_box_new_text()
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a newly allocated string containing the currently active text.
+Must be freed with g_free().
+
+</return>
</function>
-<function name="gtk_tree_view_column_set_title">
+<function name="gtk_combo_box_get_add_tearoffs">
<description>
-Sets the title of the @tree_column. If a custom widget has been set, then
-this value is ignored.
+Gets the current value of the :add-tearoffs property.
+
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn.
-</parameter_description>
-</parameter>
-<parameter name="title">
-<parameter_description> The title of the @tree_column.
+<parameter name="combo_box">
+<parameter_description> a #GtkComboBox
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the current value of the :add-tearoffs property.
+</return>
</function>
-<function name="gtk_entry_get_inner_border">
+<function name="gtk_combo_box_get_button_sensitivity">
<description>
-This function returns the entry's #GtkEntry:inner-border property. See
-gtk_entry_set_inner_border() for more information.
+Returns whether the combo box sets the dropdown button
+sensitive or not when there are no items in the model.
-Since: 2.10
+Since: 2.14
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="combo_box">
+<parameter_description> a #GtkComboBox
</parameter_description>
</parameter>
</parameters>
-<return> the entry's #GtkBorder, or %NULL if none was set.
+<return> %GTK_SENSITIVITY_ON if the dropdown button
+is sensitive when the model is empty, %GTK_SENSITIVITY_OFF
+if the button is always insensitive or
+%GTK_SENSITIVITY_AUTO if it is only sensitive as long as
+the model has one item to be selected.
</return>
</function>
-<function name="gtk_text_iter_get_child_anchor">
+<function name="gtk_combo_box_get_column_span_column">
<description>
-If the location at @iter contains a child anchor, the
-anchor is returned (with no new reference count added). Otherwise,
-%NULL is returned.
+Returns the column with column span information for @combo_box.
+Since: 2.6
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
+<parameter name="combo_box">
+<parameter_description> A #GtkComboBox
</parameter_description>
</parameter>
</parameters>
-<return> the anchor at @iter
+<return> the column span column.
+
</return>
</function>
-<function name="gtk_binding_set_new">
+<function name="gtk_combo_box_get_entry_text_column">
<description>
-GTK+ maintains a global list of binding sets. Each binding set has
-a unique name which needs to be specified upon creation.
+Returns the column which @combo_box is using to get the strings
+from to display in the internal entry.
+Since: 2.24
</description>
<parameters>
-<parameter name="set_name">
-<parameter_description> unique name of this binding set
+<parameter name="combo_box">
+<parameter_description> A #GtkComboBox.
</parameter_description>
</parameter>
</parameters>
-<return> new binding set
+<return> A column in the data source model of @combo_box.
+
</return>
</function>
-<function name="gtk_icon_size_register_alias">
+<function name="gtk_combo_box_get_focus_on_click">
<description>
-Registers @alias as another name for @target.
-So calling gtk_icon_size_from_name() with @alias as argument
-will return @target.
+Returns whether the combo box grabs focus when it is clicked
+with the mouse. See gtk_combo_box_set_focus_on_click().
+
+Since: 2.6
</description>
<parameters>
-<parameter name="alias">
-<parameter_description> an alias for @target
-</parameter_description>
-</parameter>
-<parameter name="target">
-<parameter_description> an existing icon size
+<parameter name="combo">
+<parameter_description> a #GtkComboBox
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the combo box grabs focus when it is
+clicked with the mouse.
+
+</return>
</function>
-<function name="gtk_offscreen_window_get_pixmap">
+<function name="gtk_combo_box_get_has_entry">
<description>
-Retrieves a snapshot of the contained widget in the form of
-a #GdkPixmap. If you need to keep this around over window
-resizes then you should add a reference to it.
+Returns whether the combo box has an entry.
-Since: 2.20
+Since: 2.24
</description>
<parameters>
-<parameter name="offscreen">
-<parameter_description> the #GtkOffscreenWindow contained widget.
+<parameter name="combo_box">
+<parameter_description> a #GtkComboBox
</parameter_description>
</parameter>
</parameters>
-<return> A #GdkPixmap pointer to the offscreen pixmap, or %NULL.
+<return> whether there is an entry in @combo_box.
</return>
</function>
-<function name="gtk_radio_button_new_with_mnemonic">
+<function name="gtk_combo_box_get_model">
<description>
-Creates a new #GtkRadioButton containing a label, adding it to the same
-group as @group. The label will be created using
-gtk_label_new_with_mnemonic(), so underscores in @label indicate the
-mnemonic for the button.
+Returns the #GtkTreeModel which is acting as data source for @combo_box.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="group">
-<parameter_description> the radio button group
-</parameter_description>
-</parameter>
-<parameter name="label">
-<parameter_description> the text of the button, with an underscore in front of the
-mnemonic character
+<parameter name="combo_box">
+<parameter_description> A #GtkComboBox
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkRadioButton
+<return> A #GtkTreeModel which was passed
+during construction.
+
</return>
</function>
-<function name="gtk_notebook_get_group">
+<function name="gtk_combo_box_get_popup_accessible">
<description>
-Gets the current group identificator pointer for @notebook.
+Gets the accessible object corresponding to the combo box's popup.
-Since: 2.12
+This function is mostly intended for use by accessibility technologies;
+applications should have little use for it.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="combo_box">
+<parameter_description> a #GtkComboBox
</parameter_description>
</parameter>
</parameters>
-<return> the group identificator, or %NULL if none is set.
+<return> the accessible object corresponding
+to the combo box's popup.
</return>
</function>
-<function name="gtk_recent_filter_new">
+<function name="gtk_combo_box_get_row_separator_func">
<description>
-Creates a new #GtkRecentFilter with no rules added to it.
-Such filter does not accept any recently used resources, so is not
-particularly useful until you add rules with
-gtk_recent_filter_add_pattern(), gtk_recent_filter_add_mime_type(),
-gtk_recent_filter_add_application(), gtk_recent_filter_add_age().
-To create a filter that accepts any recently used resource, use:
-|[
-GtkRecentFilter *filter = gtk_recent_filter_new ();
-gtk_recent_filter_add_pattern (filter, "*");
-]|
+Returns the current row separator function.
-Since: 2.10
+Since: 2.6
</description>
<parameters>
+<parameter name="combo_box">
+<parameter_description> a #GtkComboBox
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GtkRecentFilter
+<return> the current row separator function.
</return>
</function>
-<function name="gtk_tree_view_set_hover_expand">
+<function name="gtk_combo_box_get_row_span_column">
<description>
-Enables of disables the hover expansion mode of @tree_view.
-Hover expansion makes rows expand or collapse if the pointer
-moves over them.
+Returns the column with row span information for @combo_box.
Since: 2.6
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
-</parameter_description>
-</parameter>
-<parameter name="expand">
-<parameter_description> %TRUE to enable hover selection mode
+<parameter name="combo_box">
+<parameter_description> A #GtkComboBox
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the row span column.
+
+</return>
</function>
-<function name="gtk_color_button_new">
+<function name="gtk_combo_box_get_title">
<description>
-Creates a new color button. This returns a widget in the form of
-a small button containing a swatch representing the current selected
-color. When the button is clicked, a color-selection dialog will open,
-allowing the user to select a color. The swatch will be updated to reflect
-the new color when the user finishes.
+Gets the current title of the menu in tearoff mode. See
+gtk_combo_box_set_add_tearoffs().
-Since: 2.4
+Since: 2.10
</description>
<parameters>
+<parameter name="combo_box">
+<parameter_description> a #GtkComboBox
+</parameter_description>
+</parameter>
</parameters>
-<return> a new color button.
+<return> the menu's title in tearoff mode. This is an internal copy of the
+string which must not be freed.
</return>
</function>
-<function name="gtk_tree_set_row_drag_data">
+<function name="gtk_combo_box_get_wrap_width">
<description>
-Sets selection data of target type %GTK_TREE_MODEL_ROW. Normally used
-in a drag_data_get handler.
+Returns the wrap width which is used to determine the number of columns
+for the popup menu. If the wrap width is larger than 1, the combo box
+is in table mode.
+Since: 2.6
</description>
<parameters>
-<parameter name="selection_data">
-<parameter_description> some #GtkSelectionData
-</parameter_description>
-</parameter>
-<parameter name="tree_model">
-<parameter_description> a #GtkTreeModel
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> a row in @tree_model
+<parameter name="combo_box">
+<parameter_description> A #GtkComboBox
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the #GtkSelectionData had the proper target type to allow us to set a tree row
+<return> the wrap width.
+
</return>
</function>
-<function name="gtk_text_view_get_visible_rect">
+<function name="gtk_combo_box_insert_text">
<description>
-Fills @visible_rect with the currently-visible
-region of the buffer, in buffer coordinates. Convert to window coordinates
-with gtk_text_view_buffer_to_window_coords().
+Inserts @string at @position in the list of strings stored in @combo_box.
+Note that you can only use this function with combo boxes constructed
+with gtk_combo_box_new_text().
+
+Since: 2.4
+
+Deprecated: 2.24: Use #GtkComboBoxText
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="combo_box">
+<parameter_description> A #GtkComboBox constructed using gtk_combo_box_new_text()
</parameter_description>
</parameter>
-<parameter name="visible_rect">
-<parameter_description> rectangle to fill
+<parameter name="position">
+<parameter_description> An index to insert @text
+</parameter_description>
+</parameter>
+<parameter name="text">
+<parameter_description> A string
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_action_set_accel_path">
+<function name="gtk_combo_box_new">
<description>
-Sets the accel path for this action. All proxy widgets associated
-with the action will have this accel path, so that their
-accelerators are consistent.
+Creates a new empty #GtkComboBox.
-Note that @accel_path string will be stored in a #GQuark. Therefore, if you
-pass a static string, you can save some memory by interning it first with
-g_intern_static_string().
+Since: 2.4
+
+</description>
+<parameters>
+</parameters>
+<return> A new #GtkComboBox.
+
+</return>
+</function>
+
+<function name="gtk_combo_box_new_text">
+<description>
+Convenience function which constructs a new text combo box, which is a
+#GtkComboBox just displaying strings. If you use this function to create
+a text combo box, you should only manipulate its data source with the
+following convenience functions: gtk_combo_box_append_text(),
+gtk_combo_box_insert_text(), gtk_combo_box_prepend_text() and
+gtk_combo_box_remove_text().
Since: 2.4
+Deprecated: 2.24: Use #GtkComboBoxText
+
</description>
<parameters>
-<parameter name="action">
-<parameter_description> the action object
-</parameter_description>
-</parameter>
-<parameter name="accel_path">
-<parameter_description> the accelerator path
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> A new text combo box.
+
+</return>
</function>
-<function name="gtk_text_view_backward_display_line">
+<function name="gtk_combo_box_new_with_entry">
<description>
-Moves the given @iter backward by one display (wrapped) line.
-A display line is different from a paragraph. Paragraphs are
-separated by newlines or other paragraph separator characters.
-Display lines are created by line-wrapping a paragraph. If
-wrapping is turned off, display lines and paragraphs will be the
-same. Display lines are divided differently for each view, since
-they depend on the view's width; paragraphs are the same in all
-views, since they depend on the contents of the #GtkTextBuffer.
+Creates a new empty #GtkComboBox with an entry.
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
-</parameter_description>
-</parameter>
</parameters>
-<return> %TRUE if @iter was moved and is not on the end iterator
+<return> A new #GtkComboBox.
</return>
</function>
-<function name="gtk_radio_action_new">
+<function name="gtk_combo_box_new_with_model">
<description>
-Creates a new #GtkRadioAction object. To add the action to
-a #GtkActionGroup and set the accelerator for the action,
-call gtk_action_group_add_action_with_accel().
+Creates a new #GtkComboBox with the model initialized to @model.
Since: 2.4
</description>
<parameters>
-<parameter name="name">
-<parameter_description> A unique name for the action
-</parameter_description>
-</parameter>
-<parameter name="label">
-<parameter_description> The label displayed in menu items and on buttons, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="tooltip">
-<parameter_description> A tooltip for this action, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="stock_id">
-<parameter_description> The stock icon to display in widgets representing this
-action, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="value">
-<parameter_description> The value which gtk_radio_action_get_current_value() should
-return if this action is selected.
+<parameter name="model">
+<parameter_description> A #GtkTreeModel.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkRadioAction
+<return> A new #GtkComboBox.
</return>
</function>
-<function name="gtk_widget_add_events">
+<function name="gtk_combo_box_new_with_model_and_entry">
<description>
-Adds the events in the bitfield @events to the event mask for
- widget See gtk_widget_set_events() for details.
+Creates a new empty #GtkComboBox with an entry
+and with the model initialized to @model.
+
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="events">
-<parameter_description> an event mask, see #GdkEventMask
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> A new #GtkComboBox
+</return>
</function>
-<function name="gtk_text_layout_set_buffer">
+<function name="gtk_combo_box_popdown">
<description>
+Hides the menu or dropdown list of @combo_box.
+
+This function is mostly intended for use by accessibility technologies;
+applications should have little use for it.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description>
+<parameter name="combo_box">
+<parameter_description> a #GtkComboBox
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_color_selection_get_has_palette">
+<function name="gtk_combo_box_popup">
<description>
-Determines whether the color selector has a color palette.
+Pops up the menu or dropdown list of @combo_box.
+This function is mostly intended for use by accessibility technologies;
+applications should have little use for it.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="colorsel">
-<parameter_description> a #GtkColorSelection.
+<parameter name="combo_box">
+<parameter_description> a #GtkComboBox
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the selector has a palette. %FALSE if it hasn't.
-</return>
+<return></return>
</function>
-<function name="gtk_rc_get_im_module_path">
+<function name="gtk_combo_box_prepend_text">
<description>
-Obtains the path in which to look for IM modules. See the documentation
-of the <link linkend="im-module-path"><envar>GTK_PATH</envar></link>
-environment variable for more details about looking up modules. This
-function is useful solely for utilities supplied with GTK+ and should
-not be used by applications under normal circumstances.
+Prepends @string to the list of strings stored in @combo_box. Note that
+you can only use this function with combo boxes constructed with
+gtk_combo_box_new_text().
+
+Since: 2.4
+
+Deprecated: 2.24: Use #GtkComboBoxText
</description>
<parameters>
+<parameter name="combo_box">
+<parameter_description> A #GtkComboBox constructed with gtk_combo_box_new_text()
+</parameter_description>
+</parameter>
+<parameter name="text">
+<parameter_description> A string
+</parameter_description>
+</parameter>
</parameters>
-<return> a newly-allocated string containing the path in which to
-look for IM modules.
-</return>
+<return></return>
</function>
-<function name="gtk_text_buffer_get_iter_at_offset">
+<function name="gtk_combo_box_remove_text">
<description>
-Initializes @iter to a position @char_offset chars from the start
-of the entire buffer. If @char_offset is -1 or greater than the number
-of characters in the buffer, @iter is initialized to the end iterator,
-the iterator one past the last valid character in the buffer.
+Removes the string at @position from @combo_box. Note that you can only use
+this function with combo boxes constructed with gtk_combo_box_new_text().
+
+Since: 2.4
+
+Deprecated: 2.24: Use #GtkComboBoxText
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> iterator to initialize
+<parameter name="combo_box">
+<parameter_description> A #GtkComboBox constructed with gtk_combo_box_new_text()
</parameter_description>
</parameter>
-<parameter name="char_offset">
-<parameter_description> char offset from start of buffer, counting from 0, or -1
+<parameter name="position">
+<parameter_description> Index of the item to remove
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_size_group_get_ignore_hidden">
+<function name="gtk_combo_box_set_active">
<description>
-Returns if invisible widgets are ignored when calculating the size.
+Sets the active item of @combo_box to be the item at @index.
-Since: 2.8
+Since: 2.4
</description>
<parameters>
-<parameter name="size_group">
-<parameter_description> a #GtkSizeGroup
+<parameter name="combo_box">
+<parameter_description> A #GtkComboBox
+</parameter_description>
+</parameter>
+<parameter name="index_">
+<parameter_description> An index in the model passed during construction, or -1 to have
+no active item
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if invisible widgets are ignored.
-
-</return>
+<return></return>
</function>
-<function name="gtk_tree_model_sort_iter_is_valid">
+<function name="gtk_combo_box_set_active_iter">
<description>
-<warning><para>
-This function is slow. Only use it for debugging and/or testing purposes.
-</para></warning>
-
-Checks if the given iter is a valid iter for this #GtkTreeModelSort.
+Sets the current active item to be the one referenced by @iter, or
+unsets the active item if @iter is %NULL.
-Since: 2.2
+Since: 2.4
</description>
<parameters>
-<parameter name="tree_model_sort">
-<parameter_description> A #GtkTreeModelSort.
+<parameter name="combo_box">
+<parameter_description> A #GtkComboBox
</parameter_description>
</parameter>
<parameter name="iter">
-<parameter_description> A #GtkTreeIter.
+<parameter_description> The #GtkTreeIter, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the iter is valid, %FALSE if the iter is invalid.
-
-</return>
+<return></return>
</function>
-<function name="gtk_spin_button_get_update_policy">
+<function name="gtk_combo_box_set_add_tearoffs">
<description>
-Gets the update behavior of a spin button. See
-gtk_spin_button_set_update_policy().
+Sets whether the popup menu should have a tearoff
+menu item.
+Since: 2.6
</description>
<parameters>
-<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter name="combo_box">
+<parameter_description> a #GtkComboBox
+</parameter_description>
+</parameter>
+<parameter name="add_tearoffs">
+<parameter_description> %TRUE to add tearoff menu items
</parameter_description>
</parameter>
</parameters>
-<return> the current update policy
-</return>
+<return></return>
</function>
-<function name="gtk_status_icon_get_geometry">
+<function name="gtk_combo_box_set_button_sensitivity">
<description>
-Obtains information about the location of the status icon
-on screen. This information can be used to e.g. position
-popups like notification bubbles.
-
-See gtk_status_icon_position_menu() for a more convenient
-alternative for positioning menus.
-
-Note that some platforms do not allow GTK+ to provide
-this information, and even on platforms that do allow it,
-the information is not reliable unless the status icon
-is embedded in a notification area, see
-gtk_status_icon_is_embedded().
+Sets whether the dropdown button of the combo box should be
+always sensitive (%GTK_SENSITIVITY_ON), never sensitive (%GTK_SENSITIVITY_OFF)
+or only if there is at least one item to display (%GTK_SENSITIVITY_AUTO).
-Since: 2.10
+Since: 2.14
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
+<parameter name="combo_box">
+<parameter_description> a #GtkComboBox
</parameter_description>
</parameter>
-<parameter name="screen">
-<parameter_description> return location for the screen, or %NULL if the
-information is not needed
+<parameter name="sensitivity">
+<parameter_description> specify the sensitivity of the dropdown button
</parameter_description>
</parameter>
-<parameter name="area">
-<parameter_description> return location for the area occupied by the status
-icon, or %NULL
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_combo_box_set_column_span_column">
+<description>
+Sets the column with column span information for @combo_box to be
+ column_span The column span column contains integers which indicate
+how many columns an item should span.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="combo_box">
+<parameter_description> A #GtkComboBox
</parameter_description>
</parameter>
-<parameter name="orientation">
-<parameter_description> return location for the orientation of the panel
-in which the status icon is embedded, or %NULL. A panel
-at the top or bottom of the screen is horizontal, a panel
-at the left or right is vertical.
+<parameter name="column_span">
+<parameter_description> A column in the model passed during construction
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the location information has
-been filled in
-
-</return>
+<return></return>
</function>
-<function name="gtk_image_get_pixel_size">
+<function name="gtk_combo_box_set_entry_text_column">
<description>
-Gets the pixel size used for named icons.
+Sets the model column which @combo_box should use to get strings from
+to be @text_column. The column @text_column in the model of @combo_box
+must be of type %G_TYPE_STRING.
-Since: 2.6
+This is only relevant if @combo_box has been created with
+#GtkComboBox:has-entry as %TRUE.
+
+Since: 2.24
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GtkImage
+<parameter name="combo_box">
+<parameter_description> A #GtkComboBox
+</parameter_description>
+</parameter>
+<parameter name="text_column">
+<parameter_description> A column in @model to get the strings from for
+the internal entry
</parameter_description>
</parameter>
</parameters>
-<return> the pixel size used for named icons.
-
-</return>
+<return></return>
</function>
-<function name="gtk_icon_view_set_tooltip_item">
+<function name="gtk_combo_box_set_focus_on_click">
<description>
-Sets the tip area of @tooltip to be the area covered by the item at @path.
-See also gtk_icon_view_set_tooltip_column() for a simpler alternative.
-See also gtk_tooltip_set_tip_area().
+Sets whether the combo box will grab focus when it is clicked with
+the mouse. Making mouse clicks not grab focus is useful in places
+like toolbars where you don't want the keyboard focus removed from
+the main area of the application.
-Since: 2.12
+Since: 2.6
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
-</parameter_description>
-</parameter>
-<parameter name="tooltip">
-<parameter_description> a #GtkTooltip
+<parameter name="combo">
+<parameter_description> a #GtkComboBox
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> a #GtkTreePath
+<parameter name="focus_on_click">
+<parameter_description> whether the combo box grabs focus when clicked
+with the mouse
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_view_get_border_window_size">
+<function name="gtk_combo_box_set_model">
<description>
-Gets the width of the specified border window. See
-gtk_text_view_set_border_window_size().
+Sets the model used by @combo_box to be @model. Will unset a previously set
+model (if applicable). If model is %NULL, then it will unset the model.
+
+Note that this function does not clear the cell renderers, you have to
+call gtk_cell_layout_clear() yourself if you need to set up different
+cell renderers for the new model.
+Since: 2.4
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="combo_box">
+<parameter_description> A #GtkComboBox
</parameter_description>
</parameter>
-<parameter name="type">
-<parameter_description> window to return size from
+<parameter name="model">
+<parameter_description> A #GtkTreeModel
</parameter_description>
</parameter>
</parameters>
-<return> width of window
-</return>
+<return></return>
</function>
-<function name="gtk_cell_renderer_toggle_set_active">
+<function name="gtk_combo_box_set_row_separator_func">
<description>
-Activates or deactivates a cell renderer.
+Sets the row separator function, which is used to determine
+whether a row should be drawn as a separator. If the row separator
+function is %NULL, no separators are drawn. This is the default value.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="toggle">
-<parameter_description> a #GtkCellRendererToggle.
+<parameter name="combo_box">
+<parameter_description> a #GtkComboBox
</parameter_description>
</parameter>
-<parameter name="setting">
-<parameter_description> the value to set.
+<parameter name="func">
+<parameter_description> a #GtkTreeViewRowSeparatorFunc
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> user data to pass to @func, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="destroy">
+<parameter_description> destroy notifier for @data, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_get_decorated">
+<function name="gtk_combo_box_set_row_span_column">
<description>
-Returns whether the window has been set to have decorations
-such as a title bar via gtk_window_set_decorated().
+Sets the column with row span information for @combo_box to be @row_span.
+The row span column contains integers which indicate how many rows
+an item should span.
+Since: 2.4
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="combo_box">
+<parameter_description> A #GtkComboBox.
+</parameter_description>
+</parameter>
+<parameter name="row_span">
+<parameter_description> A column in the model passed during construction.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the window has been set to have decorations
-</return>
+<return></return>
</function>
-<function name="gtk_entry_prepend_text">
+<function name="gtk_combo_box_set_title">
<description>
-Prepends the given text to the contents of the widget.
+Sets the menu's title in tearoff mode.
-Deprecated: 2.0: Use gtk_editable_insert_text() instead.
+Since: 2.10
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="combo_box">
+<parameter_description> a #GtkComboBox
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> the text to prepend
+<parameter name="title">
+<parameter_description> a title for the menu in tearoff mode
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_modify_font">
+<function name="gtk_combo_box_set_wrap_width">
<description>
-Sets the font to use for a widget. All other style values are left
-untouched. See also gtk_widget_modify_style().
+Sets the wrap width of @combo_box to be @width. The wrap width is basically
+the preferred number of columns when you want the popup to be layed out
+in a table.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="combo_box">
+<parameter_description> A #GtkComboBox
</parameter_description>
</parameter>
-<parameter name="font_desc">
-<parameter_description> the font description to use, or %NULL to undo
-the effect of previous calls to gtk_widget_modify_font().
+<parameter name="width">
+<parameter_description> Preferred number of columns
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_statusbar_remove">
+<function name="gtk_combo_box_text_append_text">
<description>
-Forces the removal of a message from a statusbar's stack.
-The exact @context_id and @message_id must be specified.
+Appends @string to the list of strings stored in @combo_box.
+
+Since: 2.24
</description>
<parameters>
-<parameter name="statusbar">
-<parameter_description> a #GtkStatusBar
+<parameter name="combo_box">
+<parameter_description> A #GtkComboBoxText
</parameter_description>
</parameter>
-<parameter name="context_id">
-<parameter_description> a context identifier
+<parameter name="text">
+<parameter_description> A string
</parameter_description>
</parameter>
-<parameter name="message_id">
-<parameter_description> a message identifier, as returned by gtk_statusbar_push()
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_combo_box_text_get_active_text">
+<description>
+Returns the currently active string in @combo_box or %NULL if none
+is selected. If @combo_box contains an entry, this function will return
+its contents (which will not necessarily be an item from the list).
+
+Since: 2.24
+
+</description>
+<parameters>
+<parameter name="combo_box">
+<parameter_description> A #GtkComboBoxText
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a newly allocated string containing the currently active text.
+Must be freed with g_free().
+
+</return>
</function>
-<function name="gtk_menu_tool_button_set_arrow_tooltip_text">
+<function name="gtk_combo_box_text_insert_text">
<description>
-Sets the tooltip text to be used as tooltip for the arrow button which
-pops up the menu. See gtk_tool_item_set_tooltip() for setting a tooltip
-on the whole #GtkMenuToolButton.
+Inserts @string at @position in the list of strings stored in @combo_box.
-Since: 2.12
+Since: 2.24
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkMenuToolButton
+<parameter name="combo_box">
+<parameter_description> A #GtkComboBoxText
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> An index to insert @text
</parameter_description>
</parameter>
<parameter name="text">
-<parameter_description> text to be used as tooltip text for button's arrow button
+<parameter_description> A string
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tool_shell_get_icon_size">
+<function name="gtk_combo_box_text_new">
<description>
-Retrieves the icon size for the tool shell. Tool items must not call this
-function directly, but rely on gtk_tool_item_get_icon_size() instead.
+Creates a new #GtkComboBoxText, which is a #GtkComboBox just displaying
+strings. See gtk_combo_box_entry_new_with_text().
-Since: 2.14
+Since: 2.24
</description>
<parameters>
-<parameter name="shell">
-<parameter_description> a #GtkToolShell
-</parameter_description>
-</parameter>
</parameters>
-<return> the current size for icons of @shell
+<return> A new #GtkComboBoxText
</return>
</function>
-<function name="gtk_style_copy">
+<function name="gtk_combo_box_text_new_with_entry">
<description>
-Creates a copy of the passed in #GtkStyle object.
+Creates a new #GtkComboBoxText, which is a #GtkComboBox just displaying
+strings. The combo box created by this function has an entry.
+Since: 2.24
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
</parameters>
-<return> a copy of @style
+<return> a new #GtkComboBoxText
+
</return>
</function>
-<function name="gtk_widget_set_sensitive">
+<function name="gtk_combo_box_text_prepend_text">
<description>
-Sets the sensitivity of a widget. A widget is sensitive if the user
-can interact with it. Insensitive widgets are "grayed out" and the
-user can't interact with them. Insensitive widgets are known as
-"inactive", "disabled", or "ghosted" in some other toolkits.
+Prepends @string to the list of strings stored in @combo_box.
+
+Since: 2.24
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="combo_box">
+<parameter_description> A #GtkComboBox
</parameter_description>
</parameter>
-<parameter name="sensitive">
-<parameter_description> %TRUE to make the widget sensitive
+<parameter name="text">
+<parameter_description> A string
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_spin_button_set_increments">
+<function name="gtk_combo_box_text_remove">
<description>
-Sets the step and page increments for spin_button. This affects how
-quickly the value changes when the spin button's arrows are activated.
+Removes the string at @position from @combo_box.
+
+Since: 2.24
</description>
<parameters>
-<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
-</parameter_description>
-</parameter>
-<parameter name="step">
-<parameter_description> increment applied for a button 1 press.
+<parameter name="combo_box">
+<parameter_description> A #GtkComboBox
</parameter_description>
</parameter>
-<parameter name="page">
-<parameter_description> increment applied for a button 2 press.
+<parameter name="position">
+<parameter_description> Index of the item to remove
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_target_list_new">
+<function name="gtk_container_add">
<description>
-Creates a new #GtkTargetList from an array of #GtkTargetEntry.
-
+Adds @widget to @container. Typically used for simple containers
+such as #GtkWindow, #GtkFrame, or #GtkButton; for more complicated
+layout containers such as #GtkBox or #GtkTable, this function will
+pick default packing parameters that may not be correct. So
+consider functions such as gtk_box_pack_start() and
+gtk_table_attach() as an alternative to gtk_container_add() in
+those cases. A widget may be added to only one container at a time;
+you can't place the same widget inside two different containers.
</description>
<parameters>
-<parameter name="targets">
-<parameter_description> Pointer to an array of #GtkTargetEntry
+<parameter name="container">
+<parameter_description> a #GtkContainer
</parameter_description>
</parameter>
-<parameter name="ntargets">
-<parameter_description> number of entries in @targets.
+<parameter name="widget">
+<parameter_description> a widget to be placed inside @container
</parameter_description>
</parameter>
</parameters>
-<return> the new #GtkTargetList.
-</return>
+<return></return>
</function>
-<function name="gtk_scale_add_mark">
+<function name="gtk_container_add_with_properties">
<description>
-Adds a mark at @value.
-
-A mark is indicated visually by drawing a tick mark next to the scale,
-and GTK+ makes it easy for the user to position the scale exactly at the
-marks value.
-
-If @markup is not %NULL, text is shown next to the tick mark.
-
-To remove marks from a scale, use gtk_scale_clear_marks().
-
-Since: 2.16
+Adds @widget to @container, setting child properties at the same time.
+See gtk_container_add() and gtk_container_child_set() for more details.
</description>
<parameters>
-<parameter name="scale">
-<parameter_description> a #GtkScale
+<parameter name="container">
+<parameter_description> a #GtkContainer
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> the value at which the mark is placed, must be between
-the lower and upper limits of the scales' adjustment
+<parameter name="widget">
+<parameter_description> a widget to be placed inside @container
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> where to draw the mark. For a horizontal scale, #GTK_POS_TOP
-is drawn above the scale, anything else below. For a vertical scale,
-#GTK_POS_LEFT is drawn to the left of the scale, anything else to the
-right.
+<parameter name="first_prop_name">
+<parameter_description> the name of the first child property to set
</parameter_description>
</parameter>
-<parameter name="markup">
-<parameter_description> Text to be shown at the mark, using <link linkend="PangoMarkupFormat">Pango markup</link>, or %NULL
+<parameter name="Varargs">
+<parameter_description> a %NULL-terminated list of property names and values, starting
+with @first_prop_name
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_view_set_pixels_above_lines">
+<function name="gtk_container_child_get">
<description>
-Sets the default number of blank pixels above paragraphs in @text_view.
-Tags in the buffer for @text_view may override the defaults.
+Gets the values of one or more child properties for @child and @container.
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="container">
+<parameter_description> a #GtkContainer
</parameter_description>
</parameter>
-<parameter name="pixels_above_lines">
-<parameter_description> pixels above paragraphs
+<parameter name="child">
+<parameter_description> a widget which is a child of @container
+</parameter_description>
+</parameter>
+<parameter name="first_prop_name">
+<parameter_description> the name of the first property to get
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> return location for the first property, followed
+optionally by more name/return location pairs, followed by %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_expander_get_label_fill">
+<function name="gtk_container_child_get_property">
<description>
-Returns whether the label widget will fill all available horizontal
-space allocated to @expander.
-
-Since: 2.22
+Gets the value of a child property for @child and @container.
</description>
<parameters>
-<parameter name="expander">
-<parameter_description> a #GtkExpander
+<parameter name="container">
+<parameter_description> a #GtkContainer
</parameter_description>
</parameter>
-</parameters>
-<return> %TRUE if the label widget will fill all available horizontal
-space
-
-</return>
-</function>
-
-<function name="gtk_print_operation_set_print_settings">
-<description>
-Sets the print settings for @op. This is typically used to
-re-establish print settings from a previous print operation,
-see gtk_print_operation_run().
-
-Since: 2.10
-
-</description>
-<parameters>
-<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter name="child">
+<parameter_description> a widget which is a child of @container
</parameter_description>
</parameter>
-<parameter name="print_settings">
-<parameter_description> #GtkPrintSettings
+<parameter name="property_name">
+<parameter_description> the name of the property to get
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> a location to return the value
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_menu_tool_button_set_arrow_tooltip_markup">
+<function name="gtk_container_child_get_valist">
<description>
-Sets the tooltip markup text to be used as tooltip for the arrow button
-which pops up the menu. See gtk_tool_item_set_tooltip() for setting a
-tooltip on the whole #GtkMenuToolButton.
-
-Since: 2.12
+Gets the values of one or more child properties for @child and @container.
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkMenuToolButton
+<parameter name="container">
+<parameter_description> a #GtkContainer
</parameter_description>
</parameter>
-<parameter name="markup">
-<parameter_description> markup text to be used as tooltip text for button's arrow button
+<parameter name="child">
+<parameter_description> a widget which is a child of @container
+</parameter_description>
+</parameter>
+<parameter name="first_property_name">
+<parameter_description> the name of the first property to get
+</parameter_description>
+</parameter>
+<parameter name="var_args">
+<parameter_description> return location for the first property, followed
+optionally by more name/return location pairs, followed by %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tool_item_set_is_important">
+<function name="gtk_container_child_set">
<description>
-Sets whether @tool_item should be considered important. The #GtkToolButton
-class uses this property to determine whether to show or hide its label
-when the toolbar style is %GTK_TOOLBAR_BOTH_HORIZ. The result is that
-only tool buttons with the "is_important" property set have labels, an
-effect known as "priority text"
-
-Since: 2.4
+Sets one or more child properties for @child and @container.
</description>
<parameters>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem
+<parameter name="container">
+<parameter_description> a #GtkContainer
</parameter_description>
</parameter>
-<parameter name="is_important">
-<parameter_description> whether the tool item should be considered important
+<parameter name="child">
+<parameter_description> a widget which is a child of @container
+</parameter_description>
+</parameter>
+<parameter name="first_prop_name">
+<parameter_description> the name of the first property to set
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> a %NULL-terminated list of property names and values, starting
+with @first_prop_name
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_store_set_column_type">
+<function name="gtk_container_child_set_property">
<description>
-Supported types include: %G_TYPE_UINT, %G_TYPE_INT, %G_TYPE_UCHAR,
-%G_TYPE_CHAR, %G_TYPE_BOOLEAN, %G_TYPE_POINTER, %G_TYPE_FLOAT,
-%G_TYPE_DOUBLE, %G_TYPE_STRING, %G_TYPE_OBJECT, and %G_TYPE_BOXED, along with
-subclasses of those types such as %GDK_TYPE_PIXBUF.
-
+Sets a child property for @child and @container.
</description>
<parameters>
-<parameter name="tree_store">
-<parameter_description> a #GtkTreeStore
+<parameter name="container">
+<parameter_description> a #GtkContainer
</parameter_description>
</parameter>
-<parameter name="column">
-<parameter_description> column number
+<parameter name="child">
+<parameter_description> a widget which is a child of @container
</parameter_description>
</parameter>
-<parameter name="type">
-<parameter_description> type of the data to be stored in @column
+<parameter name="property_name">
+<parameter_description> the name of the property to set
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> the value to set the property to
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_model_iter_nth_child">
+<function name="gtk_container_child_set_valist">
<description>
-Sets @iter to be the child of @parent, using the given index. The first
-index is 0. If @n is too big, or @parent has no children, @iter is set
-to an invalid iterator and %FALSE is returned. @parent will remain a valid
-node after this function has been called. As a special case, if @parent is
-%NULL, then the @n<!-- -->th root node is set.
-
+Sets one or more child properties for @child and @container.
</description>
<parameters>
-<parameter name="tree_model">
-<parameter_description> A #GtkTreeModel.
+<parameter name="container">
+<parameter_description> a #GtkContainer
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> The #GtkTreeIter to set to the nth child.
+<parameter name="child">
+<parameter_description> a widget which is a child of @container
</parameter_description>
</parameter>
-<parameter name="parent">
-<parameter_description> The #GtkTreeIter to get the child from, or %NULL.
+<parameter name="first_property_name">
+<parameter_description> the name of the first property to set
</parameter_description>
</parameter>
-<parameter name="n">
-<parameter_description> Then index of the desired child.
+<parameter name="var_args">
+<parameter_description> a %NULL-terminated list of property names and values, starting
+with @first_prop_name
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE, if @parent has an @n<!-- -->th child.
-</return>
+<return></return>
</function>
-<function name="gtk_entry_buffer_insert_text">
+<function name="gtk_container_child_type">
<description>
-Inserts @n_chars characters of @chars into the contents of the
-buffer, at position @position.
-
-If @n_chars is negative, then characters from chars will be inserted
-until a null-terminator is found. If @position or @n_chars are out of
-bounds, or the maximum buffer text length is exceeded, then they are
-coerced to sane values.
+Returns the type of the children supported by the container.
-Note that the position and length are in characters, not in bytes.
+Note that this may return %G_TYPE_NONE to indicate that no more
+children can be added, e.g. for a #GtkPaned which already has two
+children.
-Since: 2.18
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkEntryBuffer
-</parameter_description>
-</parameter>
-<parameter name="position">
-<parameter_description> the position at which to insert text.
-</parameter_description>
-</parameter>
-<parameter name="chars">
-<parameter_description> the text to insert into the buffer.
-</parameter_description>
-</parameter>
-<parameter name="n_chars">
-<parameter_description> the length of the text in characters, or -1
+<parameter name="container">
+<parameter_description> a #GtkContainer
</parameter_description>
</parameter>
</parameters>
-<return> The number of characters actually inserted.
-
+<return> a #GType.
</return>
</function>
-<function name="gtk_recent_filter_set_name">
+<function name="gtk_container_class_find_child_property">
<description>
-Sets the human-readable name of the filter; this is the string
-that will be displayed in the recently used resources selector
-user interface if there is a selectable list of filters.
-
-Since: 2.10
+Finds a child property of a container class by name.
</description>
<parameters>
-<parameter name="filter">
-<parameter_description> a #GtkRecentFilter
+<parameter name="cclass">
+<parameter_description> a #GtkContainerClass
</parameter_description>
</parameter>
-<parameter name="name">
-<parameter_description> then human readable name of @filter
+<parameter name="property_name">
+<parameter_description> the name of the child property to find
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GParamSpec of the child property or %NULL if @class has no
+child property with that name.
+</return>
</function>
-<function name="gtk_window_set_has_frame">
+<function name="gtk_container_class_install_child_property">
<description>
-(Note: this is a special-purpose function for the framebuffer port,
-that causes GTK+ to draw its own window border. For most applications,
-you want gtk_window_set_decorated() instead, which tells the window
-manager whether to draw the window border.)
-
-If this function is called on a window with setting of %TRUE, before
-it is realized or showed, it will have a "frame" window around
- window->window, accessible in @window->frame. Using the signal
-frame_event you can receive all events targeted at the frame.
-
-This function is used by the linux-fb port to implement managed
-windows, but it could conceivably be used by X-programs that
-want to do their own window decorations.
-
+Installs a child property on a container class.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="cclass">
+<parameter_description> a #GtkContainerClass
</parameter_description>
</parameter>
-<parameter name="setting">
-<parameter_description> a boolean
+<parameter name="property_id">
+<parameter_description> the id for the property
+</parameter_description>
+</parameter>
+<parameter name="pspec">
+<parameter_description> the #GParamSpec for the property
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tool_item_toolbar_reconfigured">
+<function name="gtk_container_class_list_child_properties">
<description>
-Emits the signal #GtkToolItem::toolbar_reconfigured on @tool_item.
-#GtkToolbar and other #GtkToolShell implementations use this function
-to notify children, when some aspect of their configuration changes.
-
-Since: 2.14
+Returns all child properties of a container class.
</description>
<parameters>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem
+<parameter name="cclass">
+<parameter_description> a #GtkContainerClass
+</parameter_description>
+</parameter>
+<parameter name="n_properties">
+<parameter_description> location to return the number of child properties found
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a newly allocated %NULL-terminated array of #GParamSpec*.
+The array must be freed with g_free().
+</return>
</function>
-<function name="gtk_tree_view_column_set_sort_order">
+<function name="gtk_container_focus_sort">
<description>
-Changes the appearance of the sort indicator.
-
-This <emphasis>does not</emphasis> actually sort the model. Use
-gtk_tree_view_column_set_sort_column_id() if you want automatic sorting
-support. This function is primarily for custom sorting behavior, and should
-be used in conjunction with gtk_tree_sortable_set_sort_column() to do
-that. For custom models, the mechanism will vary.
+Sorts @children in the correct order for focusing with
+direction type @direction.
-The sort indicator changes direction to indicate normal sort or reverse sort.
-Note that you must have the sort indicator enabled to see anything when
-calling this function; see gtk_tree_view_column_set_sort_indicator().
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> a #GtkTreeViewColumn
+<parameter name="container">
+<parameter_description> a #GtkContainer
</parameter_description>
</parameter>
-<parameter name="order">
-<parameter_description> sort order that the sort indicator should indicate
+<parameter name="children">
+<parameter_description> a list of descendents of @container (they don't
+have to be direct children)
+</parameter_description>
+</parameter>
+<parameter name="direction">
+<parameter_description> focus direction
+</parameter_description>
+</parameter>
+<parameter name="old_focus">
+<parameter_description> widget to use for the starting position, or %NULL
+to determine this automatically.
+(Note, this argument isn't used for GTK_DIR_TAB_*,
+which is the only @direction we use currently,
+so perhaps this argument should be removed)
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a copy of @children, sorted in correct focusing order,
+with children that aren't suitable for focusing in this direction
+removed.
+</return>
</function>
-<function name="gtk_widget_queue_draw">
+<function name="gtk_container_forall">
<description>
-Equivalent to calling gtk_widget_queue_draw_area() for the
-entire area of a widget.
+Invokes @callback on each child of @container, including children
+that are considered "internal" (implementation details of the
+container). "Internal" children generally weren't added by the user
+of the container, but were added by the container implementation
+itself. Most applications should use gtk_container_foreach(),
+rather than gtk_container_forall().
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="container">
+<parameter_description> a #GtkContainer
+</parameter_description>
+</parameter>
+<parameter name="callback">
+<parameter_description> a callback
+</parameter_description>
+</parameter>
+<parameter name="callback_data">
+<parameter_description> callback user data
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_set_mnemonic_modifier">
+<function name="gtk_container_foreach">
<description>
-Sets the mnemonic modifier for this window.
+Invokes @callback on each non-internal child of @container. See
+gtk_container_forall() for details on what constitutes an
+"internal" child. Most applications should use
+gtk_container_foreach(), rather than gtk_container_forall().
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="container">
+<parameter_description> a #GtkContainer
</parameter_description>
</parameter>
-<parameter name="modifier">
-<parameter_description> the modifier mask used to activate
-mnemonics on this window.
+<parameter name="callback">
+<parameter_description> a callback
+</parameter_description>
+</parameter>
+<parameter name="callback_data">
+<parameter_description> callback user data
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_drag_dest_set_track_motion">
+<function name="gtk_container_get_border_width">
<description>
-Tells the widget to emit ::drag-motion and ::drag-leave
-events regardless of the targets and the %GTK_DEST_DEFAULT_MOTION
-flag.
+Retrieves the border width of the container. See
+gtk_container_set_border_width().
-This may be used when a widget wants to do generic
-actions regardless of the targets that the source offers.
-
-Since: 2.10
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget that's a drag destination
-</parameter_description>
-</parameter>
-<parameter name="track_motion">
-<parameter_description> whether to accept all targets
+<parameter name="container">
+<parameter_description> a #GtkContainer
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the current border width
+</return>
</function>
-<function name="gtk_disable_setlocale">
+<function name="gtk_container_get_children">
<description>
-Prevents gtk_init(), gtk_init_check(), gtk_init_with_args() and
-gtk_parse_args() from automatically
-calling <literal>setlocale (LC_ALL, "")</literal>. You would
-want to use this function if you wanted to set the locale for
-your program to something other than the user's locale, or if
-you wanted to set different values for different locale categories.
+Returns the container's non-internal children. See
+gtk_container_forall() for details on what constitutes an "internal" child.
-Most programs should not need to call this function.
</description>
<parameters>
+<parameter name="container">
+<parameter_description> a #GtkContainer
+</parameter_description>
+</parameter>
</parameters>
-<return></return>
+<return> a newly-allocated list of the container's non-internal children.
+</return>
</function>
-<function name="gtk_entry_buffer_emit_deleted_text">
+<function name="gtk_container_get_focus_chain">
<description>
-Used when subclassing #GtkEntryBuffer
+Retrieves the focus chain of the container, if one has been
+set explicitly. If no focus chain has been explicitly
+set, GTK+ computes the focus chain based on the positions
+of the children. In that case, GTK+ stores %NULL in
+ focusable_widgets and returns %FALSE.
-Since: 2.18
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkEntryBuffer
-</parameter_description>
-</parameter>
-<parameter name="position">
-<parameter_description> position at which text was deleted
+<parameter name="container">
+<parameter_description> a #GtkContainer
</parameter_description>
</parameter>
-<parameter name="n_chars">
-<parameter_description> number of characters deleted
+<parameter name="focusable_widgets">
+<parameter_description> location
+to store the focus chain of the
+container, or %NULL. You should free this list
+using g_list_free() when you are done with it, however
+no additional reference count is added to the
+individual widgets in the focus chain.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the focus chain of the container
+has been set explicitly.
+</return>
</function>
-<function name="gtk_window_get_skip_taskbar_hint">
+<function name="gtk_container_get_focus_child">
<description>
-Gets the value set by gtk_window_set_skip_taskbar_hint()
+Returns the current focus child widget inside @container. This is not the
+currently focused widget. That can be obtained by calling
+gtk_window_get_focus().
-Since: 2.2
+Since: 2.14
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="container">
+<parameter_description> a #GtkContainer
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if window shouldn't be in taskbar
+<return> The child widget which will recieve the focus inside @container when
+the @conatiner is focussed, or %NULL if none is set.
</return>
</function>
-<function name="gtk_icon_view_set_reorderable">
+<function name="gtk_container_get_focus_hadjustment">
<description>
-This function is a convenience function to allow you to reorder models that
-support the #GtkTreeDragSourceIface and the #GtkTreeDragDestIface. Both
-#GtkTreeStore and #GtkListStore support these. If @reorderable is %TRUE, then
-the user can reorder the model by dragging and dropping rows. The
-developer can listen to these changes by connecting to the model's
-row_inserted and row_deleted signals. The reordering is implemented by setting up
-the icon view as a drag source and destination. Therefore, drag and
-drop can not be used in a reorderable view for any other purpose.
-
-This function does not give you any degree of control over the order -- any
-reordering is allowed. If more control is needed, you should probably
-handle drag and drop manually.
+Retrieves the horizontal focus adjustment for the container. See
+gtk_container_set_focus_hadjustment ().
-Since: 2.8
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> A #GtkIconView.
-</parameter_description>
-</parameter>
-<parameter name="reorderable">
-<parameter_description> %TRUE, if the list of items can be reordered.
+<parameter name="container">
+<parameter_description> a #GtkContainer
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the horizontal focus adjustment, or %NULL if
+none has been set.
+</return>
</function>
-<function name="gtk_tree_view_column_set_cell_data_func">
+<function name="gtk_container_get_focus_vadjustment">
<description>
-Sets the #GtkTreeViewColumnFunc to use for the column. This
-function is used instead of the standard attributes mapping for
-setting the column value, and should set the value of @tree_column's
-cell renderer as appropriate. @func may be %NULL to remove an
-older one.
+Retrieves the vertical focus adjustment for the container. See
+gtk_container_set_focus_vadjustment().
+
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn
+<parameter name="container">
+<parameter_description> a #GtkContainer
</parameter_description>
</parameter>
-<parameter name="cell_renderer">
-<parameter_description> A #GtkCellRenderer
+</parameters>
+<return> the vertical focus adjustment, or %NULL if
+none has been set.
+</return>
+</function>
+
+<function name="gtk_container_get_resize_mode">
+<description>
+Returns the resize mode for the container. See
+gtk_container_set_resize_mode ().
+
+
+</description>
+<parameters>
+<parameter name="container">
+<parameter_description> a #GtkContainer
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> The #GtkTreeViewColumnFunc to use.
+</parameters>
+<return> the current resize mode
+</return>
+</function>
+
+<function name="gtk_container_propagate_expose">
+<description>
+When a container receives an expose event, it must send synthetic
+expose events to all children that don't have their own #GdkWindows.
+This function provides a convenient way of doing this. A container,
+when it receives an expose event, calls gtk_container_propagate_expose()
+once for each child, passing in the event the container received.
+
+gtk_container_propagate_expose() takes care of deciding whether
+an expose event needs to be sent to the child, intersecting
+the event's area with the child area, and sending the event.
+
+In most cases, a container can simply either simply inherit the
+#GtkWidget::expose implementation from #GtkContainer, or, do some drawing
+and then chain to the ::expose implementation from #GtkContainer.
+
+</description>
+<parameters>
+<parameter name="container">
+<parameter_description> a #GtkContainer
</parameter_description>
</parameter>
-<parameter name="func_data">
-<parameter_description> The user data for @func.
+<parameter name="child">
+<parameter_description> a child of @container
</parameter_description>
</parameter>
-<parameter name="destroy">
-<parameter_description> The destroy notification for @func_data
+<parameter name="event">
+<parameter_description> a expose event sent to container
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_common_ancestor">
+<function name="gtk_container_remove">
<description>
-Find the common ancestor of @widget_a and @widget_b that
-is closest to the two widgets.
-
+Removes @widget from @container. @widget must be inside @container.
+Note that @container will own a reference to @widget, and that this
+may be the last reference held; so removing a widget from its
+container can destroy that widget. If you want to use @widget
+again, you need to add a reference to it while it's not inside
+a container, using g_object_ref(). If you don't want to use @widget
+again it's usually more efficient to simply destroy it directly
+using gtk_widget_destroy() since this will remove it from the
+container and help break any circular reference count cycles.
</description>
<parameters>
-<parameter name="widget_a">
-<parameter_description> a #GtkWidget
+<parameter name="container">
+<parameter_description> a #GtkContainer
</parameter_description>
</parameter>
-<parameter name="widget_b">
-<parameter_description> a #GtkWidget
+<parameter name="widget">
+<parameter_description> a current child of @container
</parameter_description>
</parameter>
</parameters>
-<return> the closest common ancestor of @widget_a and
- widget_b or %NULL if @widget_a and @widget_b do not
-share a common ancestor.
-</return>
+<return></return>
</function>
-<function name="gtk_print_settings_get_page_set">
+<function name="gtk_container_set_border_width">
<description>
-Gets the value of %GTK_PRINT_SETTINGS_PAGE_SET.
+Sets the border width of the container.
-Since: 2.10
+The border width of a container is the amount of space to leave
+around the outside of the container. The only exception to this is
+#GtkWindow; because toplevel windows can't leave space outside,
+they leave the space inside. The border is added on all sides of
+the container. To add space to only one side, one approach is to
+create a #GtkAlignment widget, call gtk_widget_set_size_request()
+to give it a size, and place it on the side of the container as
+a spacer.
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="container">
+<parameter_description> a #GtkContainer
+</parameter_description>
+</parameter>
+<parameter name="border_width">
+<parameter_description> amount of blank space to leave <emphasis>outside</emphasis>
+the container. Valid values are in the range 0-65535 pixels.
</parameter_description>
</parameter>
</parameters>
-<return> the set of pages to print
-
-</return>
+<return></return>
</function>
-<function name="gtk_status_icon_set_from_icon_name">
+<function name="gtk_container_set_focus_chain">
<description>
-Makes @status_icon display the icon named @icon_name from the
-current icon theme.
-See gtk_status_icon_new_from_icon_name() for details.
+Sets a focus chain, overriding the one computed automatically by GTK+.
-Since: 2.10
+In principle each widget in the chain should be a descendant of the
+container, but this is not enforced by this method, since it's allowed
+to set the focus chain before you pack the widgets, or have a widget
+in the chain that isn't always packed. The necessary checks are done
+when the focus chain is actually traversed.
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
+<parameter name="container">
+<parameter_description> a #GtkContainer
</parameter_description>
</parameter>
-<parameter name="icon_name">
-<parameter_description> an icon name
+<parameter name="focusable_widgets">
+<parameter_description>
+the new focus chain
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_expander_set_expanded">
+<function name="gtk_container_set_focus_child">
<description>
-Sets the state of the expander. Set to %TRUE, if you want
-the child widget to be revealed, and %FALSE if you want the
-child widget to be hidden.
+Sets, or unsets if @child is %NULL, the focused child of @container.
-Since: 2.4
+This function emits the GtkContainer::set_focus_child signal of
+ container Implementations of #GtkContainer can override the
+default behaviour by overriding the class closure of this signal.
+
+This is function is mostly meant to be used by widgets. Applications can use
+gtk_widget_grab_focus() to manualy set the focus to a specific widget.
</description>
<parameters>
-<parameter name="expander">
-<parameter_description> a #GtkExpander
+<parameter name="container">
+<parameter_description> a #GtkContainer
</parameter_description>
</parameter>
-<parameter name="expanded">
-<parameter_description> whether the child widget is revealed
+<parameter name="child">
+<parameter_description> a #GtkWidget, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_list_store_set_value">
+<function name="gtk_container_set_focus_hadjustment">
<description>
-Sets the data in the cell specified by @iter and @column.
-The type of @value must be convertible to the type of the
-column.
+Hooks up an adjustment to focus handling in a container, so when a child
+of the container is focused, the adjustment is scrolled to show that
+widget. This function sets the horizontal alignment.
+See gtk_scrolled_window_get_hadjustment() for a typical way of obtaining
+the adjustment and gtk_container_set_focus_vadjustment() for setting
+the vertical adjustment.
+The adjustments have to be in pixel units and in the same coordinate
+system as the allocation for immediate children of the container.
</description>
<parameters>
-<parameter name="list_store">
-<parameter_description> A #GtkListStore
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> A valid #GtkTreeIter for the row being modified
-</parameter_description>
-</parameter>
-<parameter name="column">
-<parameter_description> column number to modify
+<parameter name="container">
+<parameter_description> a #GtkContainer
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> new value for the cell
+<parameter name="adjustment">
+<parameter_description> an adjustment which should be adjusted when the focus is
+moved among the descendents of @container
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_cell_renderer_get_size">
+<function name="gtk_container_set_focus_vadjustment">
<description>
-Obtains the width and height needed to render the cell. Used by view
-widgets to determine the appropriate size for the cell_area passed to
-gtk_cell_renderer_render(). If @cell_area is not %NULL, fills in the
-x and y offsets (if set) of the cell relative to this location.
+Hooks up an adjustment to focus handling in a container, so when a
+child of the container is focused, the adjustment is scrolled to
+show that widget. This function sets the vertical alignment. See
+gtk_scrolled_window_get_vadjustment() for a typical way of obtaining
+the adjustment and gtk_container_set_focus_hadjustment() for setting
+the horizontal adjustment.
-Please note that the values set in @width and @height, as well as those
-in @x_offset and @y_offset are inclusive of the xpad and ypad properties.
+The adjustments have to be in pixel units and in the same coordinate
+system as the allocation for immediate children of the container.
</description>
<parameters>
-<parameter name="cell">
-<parameter_description> a #GtkCellRenderer
-</parameter_description>
-</parameter>
-<parameter name="widget">
-<parameter_description> the widget the renderer is rendering to
-</parameter_description>
-</parameter>
-<parameter name="cell_area">
-<parameter_description> The area a cell will be allocated, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="x_offset">
-<parameter_description> location to return x offset of cell relative to @cell_area, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="y_offset">
-<parameter_description> location to return y offset of cell relative to @cell_area, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> location to return width needed to render a cell, or %NULL
+<parameter name="container">
+<parameter_description> a #GtkContainer
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> location to return height needed to render a cell, or %NULL
+<parameter name="adjustment">
+<parameter_description> an adjustment which should be adjusted when the focus
+is moved among the descendents of @container
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_radio_tool_button_set_group">
+<function name="gtk_container_set_reallocate_redraws">
<description>
-Adds @button to @group, removing it from the group it belonged to before.
+Sets the @reallocate_redraws flag of the container to the given value.
-Since: 2.4
+Containers requesting reallocation redraws get automatically
+redrawn if any of their children changed allocation.
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkRadioToolButton
+<parameter name="container">
+<parameter_description> a #GtkContainer
</parameter_description>
</parameter>
-<parameter name="group">
-<parameter_description> an existing radio button group
+<parameter name="needs_redraws">
+<parameter_description> the new value for the container's @reallocate_redraws flag
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_maximize">
+<function name="gtk_container_set_resize_mode">
<description>
-Asks to maximize @window, so that it becomes full-screen. Note that
-you shouldn't assume the window is definitely maximized afterward,
-because other entities (e.g. the user or <link
-linkend="gtk-X11-arch">window manager</link>) could unmaximize it
-again, and not all window managers support maximization. But
-normally the window will end up maximized. Just don't write code
-that crashes if not.
-
-It's permitted to call this function before showing a window,
-in which case the window will be maximized when it appears onscreen
-initially.
-
-You can track maximization via the "window-state-event" signal
-on #GtkWidget.
+Sets the resize mode for the container.
+The resize mode of a container determines whether a resize request
+will be passed to the container's parent, queued for later execution
+or executed immediately.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="container">
+<parameter_description> a #GtkContainer
+</parameter_description>
+</parameter>
+<parameter name="resize_mode">
+<parameter_description> the new resize mode
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_style_detach">
+<function name="gtk_container_unset_focus_chain">
<description>
-Detaches a style from a window. If the style is not attached
-to any windows anymore, it is unrealized. See gtk_style_attach().
-
+Removes a focus chain explicitly set with gtk_container_set_focus_chain().
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
+<parameter name="container">
+<parameter_description> a #GtkContainer
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_draw_shadow_gap">
+<function name="gtk_ctree_insert_node">
<description>
-Draws a shadow around the given rectangle in @window
-using the given style and state and shadow type, leaving a
-gap in one side.
-
-Deprecated: 2.0: Use gtk_paint_shadow_gap() instead.
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
-</parameter_description>
-</parameter>
-<parameter name="shadow_type">
-<parameter_description> type of shadow to draw
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> x origin of the rectangle
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> y origin of the rectangle
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> width of the rectangle
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> width of the rectangle
+<parameter name="pixmap_closed">
+<parameter_description>
</parameter_description>
</parameter>
-<parameter name="gap_side">
-<parameter_description> side in which to leave the gap
+<parameter name="mask_closed">
+<parameter_description>
</parameter_description>
</parameter>
-<parameter name="gap_x">
-<parameter_description> starting position of the gap
+<parameter name="pixmap_opened">
+<parameter_description>
</parameter_description>
</parameter>
-<parameter name="gap_width">
-<parameter_description> width of the gap
+<parameter name="mask_opened">
+<parameter_description>
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_unfullscreen">
+<function name="gtk_ctree_move">
<description>
-Asks to toggle off the fullscreen state for @window. Note that you
-shouldn't assume the window is definitely not full screen
-afterward, because other entities (e.g. the user or <link
-linkend="gtk-X11-arch">window manager</link>) could fullscreen it
-again, and not all window managers honor requests to unfullscreen
-windows. But normally the window will end up restored to its normal
-state. Just don't write code that crashes if not.
-
-You can track the fullscreen state via the "window-state-event" signal
-on #GtkWidget.
-
-Since: 2.2
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="new_parent">
+<parameter_description>
+</parameter_description>
+</parameter>
+<parameter name="new_sibling">
+<parameter_description>
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_layout_is_valid">
+<function name="gtk_ctree_node_set_pixmap">
<description>
-Check if there are any invalid regions in a #GtkTextLayout's buffer
-
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #GtkTextLayout
+<parameter name="mask">
+<parameter_description>
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if any invalid regions were found
-</return>
+<return></return>
</function>
-<function name="gtk_tree_view_set_drag_dest_row">
+<function name="gtk_ctree_node_set_pixtext">
<description>
-Sets the row that is highlighted for feedback.
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> The path of the row to highlight, or %NULL.
-</parameter_description>
-</parameter>
-<parameter name="pos">
-<parameter_description> Specifies whether to drop before, after or into the row
+<parameter name="mask">
+<parameter_description>
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_view_scroll_mark_onscreen">
+<function name="gtk_ctree_set_node_info">
<description>
-Scrolls @text_view the minimum distance such that @mark is contained
-within the visible area of the widget.
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="pixmap_closed">
+<parameter_description>
</parameter_description>
</parameter>
-<parameter name="mark">
-<parameter_description> a mark in the buffer for @text_view
+<parameter name="mask_closed">
+<parameter_description>
+</parameter_description>
+</parameter>
+<parameter name="pixmap_opened">
+<parameter_description>
+</parameter_description>
+</parameter>
+<parameter name="mask_opened">
+<parameter_description>
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_clipboard_wait_for_contents">
+<function name="gtk_custom_paper_unix_dialog_new">
<description>
-Requests the contents of the clipboard using the given target.
-This function waits for the data to be received using the main
-loop, so events, timeouts, etc, may be dispatched during the wait.
+Creates a new custom paper dialog.
+Since: 2.18
</description>
<parameters>
-<parameter name="clipboard">
-<parameter_description> a #GtkClipboard
+<parameter name="title">
+<parameter_description> the title of the dialog, or %NULL
</parameter_description>
</parameter>
-<parameter name="target">
-<parameter_description> an atom representing the form into which the clipboard
-owner should convert the selection.
+<parameter name="parent">
+<parameter_description> transient parent of the dialog, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated #GtkSelectionData object or %NULL
-if retrieving the given target failed. If non-%NULL,
-this value must be freed with gtk_selection_data_free()
-when you are finished with it.
+<return> the new #GtkCustomPaperUnixDialog
+
</return>
</function>
-<function name="gtk_entry_set_width_chars">
+<function name="gtk_dialog_add_action_widget">
<description>
-Changes the size request of the entry to be about the right size
-for @n_chars characters. Note that it changes the size
-<emphasis>request</emphasis>, the size can still be affected by
-how you pack the widget into containers. If @n_chars is -1, the
-size reverts to the default entry size.
+Adds an activatable widget to the action area of a #GtkDialog,
+connecting a signal handler that will emit the #GtkDialog::response
+signal on the dialog when the widget is activated. The widget is
+appended to the end of the dialog's action area. If you want to add a
+non-activatable widget, simply pack it into the @action_area field
+of the #GtkDialog struct.
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="dialog">
+<parameter_description> a #GtkDialog
</parameter_description>
</parameter>
-<parameter name="n_chars">
-<parameter_description> width in chars
+<parameter name="child">
+<parameter_description> an activatable widget
+</parameter_description>
+</parameter>
+<parameter name="response_id">
+<parameter_description> response ID for @child
</parameter_description>
</parameter>
</parameters>
@@ -11346,1368 +11455,1538 @@ returned, but usually you don't need it.
</return>
</function>
-<function name="gtk_tree_view_set_level_indentation">
+<function name="gtk_dialog_add_buttons">
<description>
-Sets the amount of extra indentation for child levels to use in @tree_view
-in addition to the default indentation. The value should be specified in
-pixels, a value of 0 disables this feature and in this case only the default
-indentation will be used.
-This does not have any visible effects for lists.
-
-Since: 2.12
+Adds more buttons, same as calling gtk_dialog_add_button()
+repeatedly. The variable argument list should be %NULL-terminated
+as with gtk_dialog_new_with_buttons(). Each button must have both
+text and response ID.
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
+<parameter name="dialog">
+<parameter_description> a #GtkDialog
</parameter_description>
</parameter>
-<parameter name="indentation">
-<parameter_description> the amount, in pixels, of extra indentation in @tree_view.
+<parameter name="first_button_text">
+<parameter_description> button text or stock ID
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> response ID for first button, then more text-response_id pairs
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_view_unselect_path">
+<function name="gtk_dialog_get_action_area">
<description>
-Unselects the row at @path.
+Returns the action area of @dialog.
-Since: 2.6
+Since: 2.14
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> A #GtkIconView.
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> The #GtkTreePath to be unselected.
+<parameter name="dialog">
+<parameter_description> a #GtkDialog
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the action area.
+
+</return>
</function>
-<function name="gtk_text_iter_ends_line">
+<function name="gtk_dialog_get_content_area">
<description>
-Returns %TRUE if @iter points to the start of the paragraph
-delimiter characters for a line (delimiters will be either a
-newline, a carriage return, a carriage return followed by a
-newline, or a Unicode paragraph separator character). Note that an
-iterator pointing to the \n of a \r\n pair will not be counted as
-the end of a line, the line ends before the \r. The end iterator is
-considered to be at the end of a line, even though there are no
-paragraph delimiter chars there.
+Returns the content area of @dialog.
+Since: 2.14
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
+<parameter name="dialog">
+<parameter_description> a #GtkDialog
</parameter_description>
</parameter>
</parameters>
-<return> whether @iter is at the end of a line
+<return> the content area #GtkVBox.
+
</return>
</function>
-<function name="gtk_accel_group_from_accel_closure">
+<function name="gtk_dialog_get_has_separator">
<description>
-Finds the #GtkAccelGroup to which @closure is connected;
-see gtk_accel_group_connect().
+Accessor for whether the dialog has a separator.
+
+Deprecated: 2.22: This function will be removed in GTK+ 3
</description>
<parameters>
-<parameter name="closure">
-<parameter_description> a #GClosure
+<parameter name="dialog">
+<parameter_description> a #GtkDialog
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkAccelGroup to which @closure is connected, or %NULL.
+<return> %TRUE if the dialog has a separator
+
</return>
</function>
-<function name="gtk_icon_set_add_source">
+<function name="gtk_dialog_get_response_for_widget">
<description>
-Icon sets have a list of #GtkIconSource, which they use as base
-icons for rendering icons in different states and sizes. Icons are
-scaled, made to look insensitive, etc. in
-gtk_icon_set_render_icon(), but #GtkIconSet needs base images to
-work with. The base images and when to use them are described by
-a #GtkIconSource.
-
-This function copies @source, so you can reuse the same source immediately
-without affecting the icon set.
-
-An example of when you'd use this function: a web browser's "Back
-to Previous Page" icon might point in a different direction in
-Hebrew and in English; it might look different when insensitive;
-and it might change size depending on toolbar mode (small/large
-icons). So a single icon set would contain all those variants of
-the icon, and you might add a separate source for each one.
-
-You should nearly always add a "default" icon source with all
-fields wildcarded, which will be used as a fallback if no more
-specific source matches. #GtkIconSet always prefers more specific
-icon sources to more generic icon sources. The order in which you
-add the sources to the icon set does not matter.
+Gets the response id of a widget in the action area
+of a dialog.
-gtk_icon_set_new_from_pixbuf() creates a new icon set with a
-default icon source based on the given pixbuf.
+Since: 2.8
</description>
<parameters>
-<parameter name="icon_set">
-<parameter_description> a #GtkIconSet
+<parameter name="dialog">
+<parameter_description> a #GtkDialog
</parameter_description>
</parameter>
-<parameter name="source">
-<parameter_description> a #GtkIconSource
+<parameter name="widget">
+<parameter_description> a widget in the action area of @dialog
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the response id of @widget, or %GTK_RESPONSE_NONE
+if @widget doesn't have a response id set.
+
+</return>
</function>
-<function name="gtk_icon_view_get_row_spacing">
+<function name="gtk_dialog_get_widget_for_response">
<description>
-Returns the value of the ::row-spacing property.
+Gets the widget button that uses the given response ID in the action area
+of a dialog.
-Since: 2.6
+Since: 2.20
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
+<parameter name="dialog">
+<parameter_description> a #GtkDialog
+</parameter_description>
+</parameter>
+<parameter name="response_id">
+<parameter_description> the response ID used by the @dialog widget
</parameter_description>
</parameter>
</parameters>
-<return> the space between rows
+<return>the @widget button that uses the given @response_id, or %NULL.
</return>
</function>
-<function name="gtk_text_iter_can_insert">
+<function name="gtk_dialog_new_with_buttons">
<description>
-Considering the default editability of the buffer, and tags that
-affect editability, determines whether text inserted at @iter would
-be editable. If text inserted at @iter would be editable then the
-user should be allowed to insert text at @iter.
-gtk_text_buffer_insert_interactive() uses this function to decide
-whether insertions are allowed at a given position.
+Creates a new #GtkDialog with title @title (or %NULL for the default
+title; see gtk_window_set_title()) and transient parent @parent (or
+%NULL for none; see gtk_window_set_transient_for()). The @flags
+argument can be used to make the dialog modal (#GTK_DIALOG_MODAL)
+and/or to have it destroyed along with its transient parent
+(#GTK_DIALOG_DESTROY_WITH_PARENT). After @flags, button
+text/response ID pairs should be listed, with a %NULL pointer ending
+the list. Button text can be either a stock ID such as
+#GTK_STOCK_OK, or some arbitrary text. A response ID can be
+any positive number, or one of the values in the #GtkResponseType
+enumeration. If the user clicks one of these dialog buttons,
+#GtkDialog will emit the #GtkDialog::response signal with the corresponding
+response ID. If a #GtkDialog receives the #GtkWidget::delete-event signal,
+it will emit ::response with a response ID of #GTK_RESPONSE_DELETE_EVENT.
+However, destroying a dialog does not emit the ::response signal;
+so be careful relying on ::response when using the
+#GTK_DIALOG_DESTROY_WITH_PARENT flag. Buttons are from left to right,
+so the first button in the list will be the leftmost button in the dialog.
+
+Here's a simple example:
+|[
+GtkWidget *dialog = gtk_dialog_new_with_buttons ("My dialog",
+main_app_window,
+GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT,
+GTK_STOCK_OK,
+GTK_RESPONSE_ACCEPT,
+GTK_STOCK_CANCEL,
+GTK_RESPONSE_REJECT,
+NULL);
+]|
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
+<parameter name="title">
+<parameter_description> Title of the dialog, or %NULL
</parameter_description>
</parameter>
-<parameter name="default_editability">
-<parameter_description> %TRUE if text is editable by default
+<parameter name="parent">
+<parameter_description> Transient parent of the dialog, or %NULL
</parameter_description>
</parameter>
-</parameters>
-<return> whether text inserted at @iter would be editable
-</return>
-</function>
-
-<function name="gtk_tool_item_get_icon_size">
-<description>
-Returns the icon size used for @tool_item. Custom subclasses of
-#GtkToolItem should call this function to find out what size icons
-they should use.
-
-Since: 2.4
-
-</description>
-<parameters>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem
+<parameter name="flags">
+<parameter_description> from #GtkDialogFlags
+</parameter_description>
+</parameter>
+<parameter name="first_button_text">
+<parameter_description> stock ID or text to go in first button, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> response ID for first button, then additional buttons, ending with %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkIconSize indicating the icon size
-used for @tool_item
-
+<return> a new #GtkDialog
</return>
</function>
-<function name="gtk_scrollbar_new">
+<function name="gtk_dialog_response">
<description>
-Creates a new scrollbar with the given orientation.
-
-Since: 2.16
+Emits the #GtkDialog::response signal with the given response ID.
+Used to indicate that the user has responded to the dialog in some way;
+typically either you or gtk_dialog_run() will be monitoring the
+::response signal and take appropriate action.
</description>
<parameters>
-<parameter name="orientation">
-<parameter_description> the scrollbar's orientation.
+<parameter name="dialog">
+<parameter_description> a #GtkDialog
</parameter_description>
</parameter>
-<parameter name="adjustment">
-<parameter_description> the #GtkAdjustment to use, or %NULL to create a new adjustment.
+<parameter name="response_id">
+<parameter_description> response ID
</parameter_description>
</parameter>
</parameters>
-<return> the new #GtkScrollbar.
-
-</return>
+<return></return>
</function>
-<function name="gtk_text_iter_forward_cursor_position">
+<function name="gtk_dialog_run">
<description>
-Moves @iter forward by a single cursor position. Cursor positions
-are (unsurprisingly) positions where the cursor can appear. Perhaps
-surprisingly, there may not be a cursor position between all
-characters. The most common example for European languages would be
-a carriage return/newline sequence. For some Unicode characters,
-the equivalent of say the letter "a" with an accent mark will be
-represented as two characters, first the letter then a "combining
-mark" that causes the accent to be rendered; so the cursor can't go
-between those two characters. See also the #PangoLogAttr structure and
-pango_break() function.
+Blocks in a recursive main loop until the @dialog either emits the
+#GtkDialog::response signal, or is destroyed. If the dialog is
+destroyed during the call to gtk_dialog_run(), gtk_dialog_run() returns
+#GTK_RESPONSE_NONE. Otherwise, it returns the response ID from the
+::response signal emission.
+
+Before entering the recursive main loop, gtk_dialog_run() calls
+gtk_widget_show() on the dialog for you. Note that you still
+need to show any children of the dialog yourself.
+
+During gtk_dialog_run(), the default behavior of #GtkWidget::delete-event
+is disabled; if the dialog receives ::delete_event, it will not be
+destroyed as windows usually are, and gtk_dialog_run() will return
+#GTK_RESPONSE_DELETE_EVENT. Also, during gtk_dialog_run() the dialog
+will be modal. You can force gtk_dialog_run() to return at any time by
+calling gtk_dialog_response() to emit the ::response signal. Destroying
+the dialog during gtk_dialog_run() is a very bad idea, because your
+post-run code won't know whether the dialog was destroyed or not.
+
+After gtk_dialog_run() returns, you are responsible for hiding or
+destroying the dialog if you wish to do so.
+
+Typical usage of this function might be:
+|[
+gint result = gtk_dialog_run (GTK_DIALOG (dialog));
+switch (result)
+{
+case GTK_RESPONSE_ACCEPT:
+do_application_specific_something ();
+break;
+default:
+do_nothing_since_dialog_was_cancelled ();
+break;
+}
+gtk_widget_destroy (dialog);
+]|
+
+Note that even though the recursive main loop gives the effect of a
+modal dialog (it prevents the user from interacting with other
+windows in the same window group while the dialog is run), callbacks
+such as timeouts, IO channel watches, DND drops, etc, <emphasis>will</emphasis>
+be triggered during a gtk_dialog_run() call.
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="dialog">
+<parameter_description> a #GtkDialog
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if we moved and the new position is dereferenceable
+<return> response ID
</return>
</function>
-<function name="gtk_text_tag_new">
+<function name="gtk_dialog_set_alternative_button_order">
<description>
-Creates a #GtkTextTag. Configure the tag using object arguments,
-i.e. using g_object_set().
+Sets an alternative button order. If the
+#GtkSettings:gtk-alternative-button-order setting is set to %TRUE,
+the dialog buttons are reordered according to the order of the
+response ids passed to this function.
+By default, GTK+ dialogs use the button order advocated by the Gnome
+<ulink url="http://developer.gnome.org/projects/gup/hig/2.0/">Human
+Interface Guidelines</ulink> with the affirmative button at the far
+right, and the cancel button left of it. But the builtin GTK+ dialogs
+and #GtkMessageDialog<!-- -->s do provide an alternative button order,
+which is more suitable on some platforms, e.g. Windows.
+
+Use this function after adding all the buttons to your dialog, as the
+following example shows:
+|[
+cancel_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
+GTK_STOCK_CANCEL,
+GTK_RESPONSE_CANCEL);
+
+ok_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
+GTK_STOCK_OK,
+GTK_RESPONSE_OK);
+
+gtk_widget_grab_default (ok_button);
+
+help_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
+GTK_STOCK_HELP,
+GTK_RESPONSE_HELP);
+
+gtk_dialog_set_alternative_button_order (GTK_DIALOG (dialog),
+GTK_RESPONSE_OK,
+GTK_RESPONSE_CANCEL,
+GTK_RESPONSE_HELP,
+-1);
+]|
+
+Since: 2.6
</description>
<parameters>
-<parameter name="name">
-<parameter_description> tag name, or %NULL
+<parameter name="dialog">
+<parameter_description> a #GtkDialog
+</parameter_description>
+</parameter>
+<parameter name="first_response_id">
+<parameter_description> a response id used by one @dialog's buttons
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> a list of more response ids of @dialog's buttons, terminated by -1
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkTextTag
-</return>
+<return></return>
</function>
-<function name="gtk_clipboard_wait_is_uris_available">
+<function name="gtk_dialog_set_alternative_button_order_from_array">
<description>
-Test to see if there is a list of URIs available to be pasted
-This is done by requesting the TARGETS atom and checking
-if it contains the URI targets. This function
-waits for the data to be received using the main loop, so events,
-timeouts, etc, may be dispatched during the wait.
+Sets an alternative button order. If the
+#GtkSettings:gtk-alternative-button-order setting is set to %TRUE,
+the dialog buttons are reordered according to the order of the
+response ids in @new_order.
-This function is a little faster than calling
-gtk_clipboard_wait_for_uris() since it doesn't need to retrieve
-the actual URI data.
+See gtk_dialog_set_alternative_button_order() for more information.
-Since: 2.14
+This function is for use by language bindings.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="clipboard">
-<parameter_description> a #GtkClipboard
+<parameter name="dialog">
+<parameter_description> a #GtkDialog
+</parameter_description>
+</parameter>
+<parameter name="n_params">
+<parameter_description> the number of response ids in @new_order
+</parameter_description>
+</parameter>
+<parameter name="new_order">
+<parameter_description> an array of response ids of @dialog's buttons
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE is there is an URI list available, %FALSE otherwise.
-
-</return>
+<return></return>
</function>
-<function name="gtk_action_disconnect_accelerator">
+<function name="gtk_dialog_set_default_response">
<description>
-Undoes the effect of one call to gtk_action_connect_accelerator().
-
-Since: 2.4
+Sets the last widget in the dialog's action area with the given @response_id
+as the default widget for the dialog. Pressing "Enter" normally activates
+the default widget.
</description>
<parameters>
-<parameter name="action">
-<parameter_description> a #GtkAction
+<parameter name="dialog">
+<parameter_description> a #GtkDialog
+</parameter_description>
+</parameter>
+<parameter name="response_id">
+<parameter_description> a response ID
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_page_setup_set_right_margin">
+<function name="gtk_dialog_set_has_separator">
<description>
-Sets the right margin of the #GtkPageSetup.
+Sets whether the dialog has a separator above the buttons.
-Since: 2.10
+Deprecated: 2.22: This function will be removed in GTK+ 3
</description>
<parameters>
-<parameter name="setup">
-<parameter_description> a #GtkPageSetup
-</parameter_description>
-</parameter>
-<parameter name="margin">
-<parameter_description> the new right margin in units of @unit
+<parameter name="dialog">
+<parameter_description> a #GtkDialog
</parameter_description>
</parameter>
-<parameter name="unit">
-<parameter_description> the units for @margin
+<parameter name="setting">
+<parameter_description> %TRUE to have a separator
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_toolbar_insert_widget">
+<function name="gtk_dialog_set_response_sensitive">
<description>
-Inserts a widget in the toolbar at the given position.
-
-Deprecated: 2.4: Use gtk_toolbar_insert() instead.
+Calls <literal>gtk_widget_set_sensitive (widget, @setting)</literal>
+for each widget in the dialog's action area with the given @response_id.
+A convenient way to sensitize/desensitize dialog buttons.
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar.
-</parameter_description>
-</parameter>
-<parameter name="widget">
-<parameter_description> a #GtkWidget to add to the toolbar.
-</parameter_description>
-</parameter>
-<parameter name="tooltip_text">
-<parameter_description> the element's tooltip.
+<parameter name="dialog">
+<parameter_description> a #GtkDialog
</parameter_description>
</parameter>
-<parameter name="tooltip_private_text">
-<parameter_description> used for context-sensitive help about this toolbar element.
+<parameter name="response_id">
+<parameter_description> a response ID
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> the number of widgets to insert this widget after.
+<parameter name="setting">
+<parameter_description> %TRUE for sensitive
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_file_chooser_get_filter">
+<function name="gtk_disable_setlocale">
<description>
-Gets the current filter; see gtk_file_chooser_set_filter().
+Prevents gtk_init(), gtk_init_check(), gtk_init_with_args() and
+gtk_parse_args() from automatically
+calling <literal>setlocale (LC_ALL, "")</literal>. You would
+want to use this function if you wanted to set the locale for
+your program to something other than the user's locale, or if
+you wanted to set different values for different locale categories.
-Since: 2.4
+Most programs should not need to call this function.
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
-</parameter_description>
-</parameter>
</parameters>
-<return> the current filter, or %NULL
-
-</return>
+<return></return>
</function>
-<function name="gtk_selection_data_get_targets">
+<function name="gtk_drag_begin">
<description>
-Gets the contents of @selection_data as an array of targets.
-This can be used to interpret the results of getting
-the standard TARGETS target that is always supplied for
-any selection.
+Initiates a drag on the source side. The function
+only needs to be used when the application is
+starting drags itself, and is not needed when
+gtk_drag_source_set() is used.
+
+The @event is used to retrieve the timestamp that will be used internally to
+grab the pointer. If @event is #NULL, then GDK_CURRENT_TIME will be used.
+However, you should try to pass a real event in all cases, since that can be
+used by GTK+ to get information about the start position of the drag, for
+example if the @event is a GDK_MOTION_NOTIFY.
+
+Generally there are three cases when you want to start a drag by hand by calling
+this function:
+
+1. During a button-press-event handler, if you want to start a drag immediately
+when the user presses the mouse button. Pass the @event that you have in your
+button-press-event handler.
+
+2. During a motion-notify-event handler, if you want to start a drag when the mouse
+moves past a certain threshold distance after a button-press. Pass the @event that you
+have in your motion-notify-event handler.
+
+3. During a timeout handler, if you want to start a drag after the mouse
+button is held down for some time. Try to save the last event that you got
+from the mouse, using gdk_event_copy(), and pass it to this function
+(remember to free the event with gdk_event_free() when you are done). If you
+can really not pass a real event, pass #NULL instead.
</description>
<parameters>
-<parameter name="selection_data">
-<parameter_description> a #GtkSelectionData object
+<parameter name="widget">
+<parameter_description> the source widget.
</parameter_description>
</parameter>
<parameter name="targets">
-<parameter_description> location to store an array of targets. The result
-stored here must be freed with g_free().
+<parameter_description> The targets (data formats) in which the
+source can provide the data.
</parameter_description>
</parameter>
-<parameter name="n_atoms">
-<parameter_description> location to store number of items in @targets.
+<parameter name="actions">
+<parameter_description> A bitmask of the allowed drag actions for this drag.
+</parameter_description>
+</parameter>
+<parameter name="button">
+<parameter_description> The button the user clicked to start the drag.
+</parameter_description>
+</parameter>
+<parameter name="event">
+<parameter_description> The event that triggered the start of the drag.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @selection_data contains a valid
-array of targets, otherwise %FALSE.
+<return> the context for this drag.
</return>
</function>
-<function name="gtk_icon_source_get_direction_wildcarded">
+<function name="gtk_drag_check_threshold">
<description>
-Gets the value set by gtk_icon_source_set_direction_wildcarded().
+Checks to see if a mouse drag starting at (@start_x, @start_y) and ending
+at (@current_x, @current_y) has passed the GTK+ drag threshold, and thus
+should trigger the beginning of a drag-and-drop operation.
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GtkIconSource
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="start_x">
+<parameter_description> X coordinate of start of drag
+</parameter_description>
+</parameter>
+<parameter name="start_y">
+<parameter_description> Y coordinate of start of drag
+</parameter_description>
+</parameter>
+<parameter name="current_x">
+<parameter_description> current X coordinate
+</parameter_description>
+</parameter>
+<parameter name="current_y">
+<parameter_description> current Y coordinate
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if this icon source is a base for any text direction variant
+<return> %TRUE if the drag threshold has been passed.
</return>
</function>
-<function name="gtk_entry_get_current_icon_drag_source">
+<function name="gtk_drag_dest_add_image_targets">
<description>
-Returns the index of the icon which is the source of the current
-DND operation, or -1.
-
-This function is meant to be used in a #GtkWidget::drag-data-get
-callback.
+Add the image targets supported by #GtkSelection to
+the target list of the drag destination. The targets
+are added with @info = 0. If you need another value,
+use gtk_target_list_add_image_targets() and
+gtk_drag_dest_set_target_list().
-Since: 2.16
+Since: 2.6
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkIconEntry
+<parameter name="widget">
+<parameter_description> a #GtkWidget that's a drag destination
</parameter_description>
</parameter>
</parameters>
-<return> index of the icon which is the source of the current
-DND operation, or -1.
-
-</return>
+<return></return>
</function>
-<function name="gtk_page_setup_unix_dialog_get_print_settings">
+<function name="gtk_drag_dest_add_text_targets">
<description>
-Gets the current print settings from the dialog.
+Add the text targets supported by #GtkSelection to
+the target list of the drag destination. The targets
+are added with @info = 0. If you need another value,
+use gtk_target_list_add_text_targets() and
+gtk_drag_dest_set_target_list().
-Since: 2.10
+Since: 2.6
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkPageSetupUnixDialog
+<parameter name="widget">
+<parameter_description> a #GtkWidget that's a drag destination
</parameter_description>
</parameter>
</parameters>
-<return> the current print settings
-
-</return>
+<return></return>
</function>
-<function name="gtk_list_store_set_valist">
+<function name="gtk_drag_dest_add_uri_targets">
<description>
-See gtk_list_store_set(); this version takes a va_list for use by language
-bindings.
+Add the URI targets supported by #GtkSelection to
+the target list of the drag destination. The targets
+are added with @info = 0. If you need another value,
+use gtk_target_list_add_uri_targets() and
+gtk_drag_dest_set_target_list().
+Since: 2.6
</description>
<parameters>
-<parameter name="list_store">
-<parameter_description> A #GtkListStore
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> A valid #GtkTreeIter for the row being modified
-</parameter_description>
-</parameter>
-<parameter name="var_args">
-<parameter_description> va_list of column/value pairs
+<parameter name="widget">
+<parameter_description> a #GtkWidget that's a drag destination
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_iter_equal">
+<function name="gtk_drag_dest_find_target">
<description>
-Tests whether two iterators are equal, using the fastest possible
-mechanism. This function is very fast; you can expect it to perform
-better than e.g. getting the character offset for each iterator and
-comparing the offsets yourself. Also, it's a bit faster than
-gtk_text_iter_compare().
-
</description>
<parameters>
-<parameter name="lhs">
-<parameter_description> a #GtkTextIter
+<parameter name="widget">
+<parameter_description> drag destination widget
</parameter_description>
</parameter>
-<parameter name="rhs">
-<parameter_description> another #GtkTextIter
+<parameter name="context">
+<parameter_description> drag context
+</parameter_description>
+</parameter>
+<parameter name="target_list">
+<parameter_description> list of droppable targets, or %NULL to use
+gtk_drag_dest_get_target_list (@widget).
+Looks for a match between the supported targets of @context and the
+ dest_target_list, returning the first matching target, otherwise
+returning %GDK_NONE. @dest_target_list should usually be the return
+value from gtk_drag_dest_get_target_list(), but some widgets may
+have different valid targets for different parts of the widget; in
+that case, they will have to implement a drag_motion handler that
+passes the correct target list to this function.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the iterators point to the same place in the buffer
+<return> first target that the source offers and the dest can
+accept, or %GDK_NONE
</return>
</function>
-<function name="gtk_label_get_selectable">
+<function name="gtk_drag_dest_get_target_list">
<description>
-Gets the value set by gtk_label_set_selectable().
+Returns the list of targets this widget can accept from
+drag-and-drop.
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the user can copy text from the label
+<return> the #GtkTargetList, or %NULL if none
</return>
</function>
-<function name="gtk_window_activate_default">
+<function name="gtk_drag_dest_get_track_motion">
<description>
-Activates the default widget for the window, unless the current
-focused widget has been configured to receive the default action
-(see gtk_widget_set_receives_default()), in which case the
-focused widget is activated.
+Returns whether the widget has been configured to always
+emit ::drag-motion signals.
+Since: 2.10
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="widget">
+<parameter_description> a #GtkWidget that's a drag destination
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if a widget got activated.
+<return> %TRUE if the widget always emits ::drag-motion events
+
</return>
</function>
-<function name="gtk_selection_owner_set_for_display">
+<function name="gtk_drag_dest_set">
<description>
-Claim ownership of a given selection for a particular widget, or,
-if @widget is %NULL, release ownership of the selection.
+Sets a widget as a potential drop destination, and adds default behaviors.
-Since: 2.2
+The default behaviors listed in @flags have an effect similar
+to installing default handlers for the widget's drag-and-drop signals
+(#GtkWidget:drag-motion, #GtkWidget:drag-drop, ...). They all exist
+for convenience. When passing #GTK_DEST_DEFAULT_ALL for instance it is
+sufficient to connect to the widget's #GtkWidget::drag-data-received
+signal to get primitive, but consistent drag-and-drop support.
+
+Things become more complicated when you try to preview the dragged data,
+as described in the documentation for #GtkWidget:drag-motion. The default
+behaviors described by @flags make some assumptions, that can conflict
+with your own signal handlers. For instance #GTK_DEST_DEFAULT_DROP causes
+invokations of gdk_drag_status() in the context of #GtkWidget:drag-motion,
+and invokations of gtk_drag_finish() in #GtkWidget:drag-data-received.
+Especially the later is dramatic, when your own #GtkWidget:drag-motion
+handler calls gtk_drag_get_data() to inspect the dragged data.
+
+There's no way to set a default action here, you can use the
+#GtkWidget:drag-motion callback for that. Here's an example which selects
+the action to use depending on whether the control key is pressed or not:
+|[
+static void
+drag_motion (GtkWidget *widget,
+GdkDragContext *context,
+gint x,
+gint y,
+guint time)
+{
+GdkModifierType mask;
+
+gdk_window_get_pointer (gtk_widget_get_window (widget),
+NULL, NULL, &mask);
+if (mask & GDK_CONTROL_MASK)
+gdk_drag_status (context, GDK_ACTION_COPY, time);
+else
+gdk_drag_status (context, GDK_ACTION_MOVE, time);
+}
+]|
</description>
<parameters>
-<parameter name="display">
-<parameter_description> the #Gdkdisplay where the selection is set
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="widget">
-<parameter_description> new selection owner (a #GdkWidget), or %NULL.
+<parameter name="flags">
+<parameter_description> which types of default drag behavior to use
</parameter_description>
</parameter>
-<parameter name="selection">
-<parameter_description> an interned atom representing the selection to claim.
+<parameter name="targets">
+<parameter_description> a pointer to an array of #GtkTargetEntry<!-- -->s
+indicating the drop types that this @widget will accept, or %NULL.
+Later you can access the list with gtk_drag_dest_get_target_list()
+and gtk_drag_dest_find_target().
</parameter_description>
</parameter>
-<parameter name="time_">
-<parameter_description> timestamp with which to claim the selection
+<parameter name="n_targets">
+<parameter_description> the number of entries in @targets
+</parameter_description>
+</parameter>
+<parameter name="actions">
+<parameter_description> a bitmask of possible actions for a drop onto this @widget.
</parameter_description>
</parameter>
</parameters>
-<return> TRUE if the operation succeeded
-
-</return>
+<return></return>
</function>
-<function name="gtk_text_buffer_set_modified">
+<function name="gtk_drag_dest_set_target_list">
<description>
-Used to keep track of whether the buffer has been modified since the
-last time it was saved. Whenever the buffer is saved to disk, call
-gtk_text_buffer_set_modified (@buffer, FALSE). When the buffer is modified,
-it will automatically toggled on the modified bit again. When the modified
-bit flips, the buffer emits a "modified-changed" signal.
+Sets the target types that this widget can accept from drag-and-drop.
+The widget must first be made into a drag destination with
+gtk_drag_dest_set().
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="widget">
+<parameter_description> a #GtkWidget that's a drag destination
</parameter_description>
</parameter>
-<parameter name="setting">
-<parameter_description> modification flag setting
+<parameter name="target_list">
+<parameter_description> list of droppable targets, or %NULL for none
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_attributes_copy_values">
+<function name="gtk_drag_dest_set_track_motion">
<description>
-Copies the values from @src to @dest so that @dest has the same values
-as @src. Frees existing values in @dest.
+Tells the widget to emit ::drag-motion and ::drag-leave
+events regardless of the targets and the %GTK_DEST_DEFAULT_MOTION
+flag.
+
+This may be used when a widget wants to do generic
+actions regardless of the targets that the source offers.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="src">
-<parameter_description> a #GtkTextAttributes
+<parameter name="widget">
+<parameter_description> a #GtkWidget that's a drag destination
</parameter_description>
</parameter>
-<parameter name="dest">
-<parameter_description> another #GtkTextAttributes
+<parameter name="track_motion">
+<parameter_description> whether to accept all targets
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_paper_size_new_from_ppd">
+<function name="gtk_drag_get_source_widget">
<description>
-Creates a new #GtkPaperSize object by using
-PPD information.
+Determines the source widget for a drag.
-If @ppd_name is not a recognized PPD paper name,
- ppd_display_name, @width and @height are used to
-construct a custom #GtkPaperSize object.
-
-Since: 2.10
</description>
<parameters>
-<parameter name="ppd_name">
-<parameter_description> a PPD paper name
-</parameter_description>
-</parameter>
-<parameter name="ppd_display_name">
-<parameter_description> the corresponding human-readable name
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> the paper width, in points
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> the paper height in points
+<parameter name="context">
+<parameter_description> a (destination side) drag context
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPaperSize, use gtk_paper_size_free()
-to free it
-
+<return> if the drag is occurring
+within a single application, a pointer to the source widget.
+Otherwise, %NULL.
</return>
</function>
-<function name="gtk_widget_get_clipboard">
+<function name="gtk_drag_set_default_icon">
<description>
-Returns the clipboard object for the given selection to
-be used with @widget. @widget must have a #GdkDisplay
-associated with it, so must be attached to a toplevel
-window.
+Changes the default drag icon. GTK+ retains references for the
+arguments, and will release them when they are no longer needed.
-Since: 2.2
+Deprecated: Change the default drag icon via the stock system by
+changing the stock pixbuf for #GTK_STOCK_DND instead.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="colormap">
+<parameter_description> the colormap of the icon
</parameter_description>
</parameter>
-<parameter name="selection">
-<parameter_description> a #GdkAtom which identifies the clipboard
-to use. %GDK_SELECTION_CLIPBOARD gives the
-default clipboard. Another common value
-is %GDK_SELECTION_PRIMARY, which gives
-the primary X selection.
+<parameter name="pixmap">
+<parameter_description> the image data for the icon
+</parameter_description>
+</parameter>
+<parameter name="mask">
+<parameter_description> the transparency mask for an image, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="hot_x">
+<parameter_description> The X offset within @widget of the hotspot.
+</parameter_description>
+</parameter>
+<parameter name="hot_y">
+<parameter_description> The Y offset within @widget of the hotspot.
</parameter_description>
</parameter>
</parameters>
-<return> the appropriate clipboard object. If no
-clipboard already exists, a new one will
-be created. Once a clipboard object has
-been created, it is persistent for all time.
-
-</return>
+<return></return>
</function>
-<function name="gtk_icon_view_get_orientation">
+<function name="gtk_drag_set_icon_default">
<description>
-Returns the value of the ::orientation property which determines
-whether the labels are drawn beside the icons instead of below.
-
-Since: 2.6
-
-Deprecated: 2.22: Use gtk_icon_view_get_item_orientation()
+Sets the icon for a particular drag to the default
+icon.
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
+<parameter name="context">
+<parameter_description> the context for a drag. (This must be called
+ with a context for the source side of a drag)
</parameter_description>
</parameter>
</parameters>
-<return> the relative position of texts and icons
-
-</return>
+<return></return>
</function>
-<function name="gtk_menu_shell_select_first">
+<function name="gtk_drag_set_icon_name">
<description>
-Select the first visible or selectable child of the menu shell;
-don't select tearoff items unless the only item is a tearoff
-item.
+Sets the icon for a given drag from a named themed icon. See
+the docs for #GtkIconTheme for more details. Note that the
+size of the icon depends on the icon theme (the icon is
+loaded at the symbolic size #GTK_ICON_SIZE_DND), thus
+ hot_x and @hot_y have to be used with care.
-Since: 2.2
+Since: 2.8
</description>
<parameters>
-<parameter name="menu_shell">
-<parameter_description> a #GtkMenuShell
+<parameter name="context">
+<parameter_description> the context for a drag. (This must be called
+with a context for the source side of a drag)
</parameter_description>
</parameter>
-<parameter name="search_sensitive">
-<parameter_description> if %TRUE, search for the first selectable
-menu item, otherwise select nothing if
-the first item isn't sensitive. This
-should be %FALSE if the menu is being
-popped up initially.
+<parameter name="icon_name">
+<parameter_description> name of icon to use
+</parameter_description>
+</parameter>
+<parameter name="hot_x">
+<parameter_description> the X offset of the hotspot within the icon
+</parameter_description>
+</parameter>
+<parameter name="hot_y">
+<parameter_description> the Y offset of the hotspot within the icon
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_settings_has_key">
+<function name="gtk_drag_set_icon_pixbuf">
<description>
-Returns %TRUE, if a value is associated with @key.
-
-Since: 2.10
+Sets @pixbuf as the icon for a given drag.
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="context">
+<parameter_description> the context for a drag. (This must be called
+with a context for the source side of a drag)
</parameter_description>
</parameter>
-<parameter name="key">
-<parameter_description> a key
+<parameter name="pixbuf">
+<parameter_description> the #GdkPixbuf to use as the drag icon.
+</parameter_description>
+</parameter>
+<parameter name="hot_x">
+<parameter_description> the X offset within @widget of the hotspot.
+</parameter_description>
+</parameter>
+<parameter name="hot_y">
+<parameter_description> the Y offset within @widget of the hotspot.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE, if @key has a value
-
-</return>
+<return></return>
</function>
-<function name="gtk_tree_model_row_has_child_toggled">
+<function name="gtk_drag_set_icon_pixmap">
<description>
-Emits the "row-has-child-toggled" signal on @tree_model. This should be
-called by models after the child state of a node changes.
+Sets @pixmap as the icon for a given drag. GTK+ retains
+references for the arguments, and will release them when
+they are no longer needed. In general, gtk_drag_set_icon_pixbuf()
+will be more convenient to use.
</description>
<parameters>
-<parameter name="tree_model">
-<parameter_description> A #GtkTreeModel
+<parameter name="context">
+<parameter_description> the context for a drag. (This must be called
+with a context for the source side of a drag)
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> A #GtkTreePath pointing to the changed row
+<parameter name="colormap">
+<parameter_description> the colormap of the icon
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> A valid #GtkTreeIter pointing to the changed row
+<parameter name="pixmap">
+<parameter_description> the image data for the icon
+</parameter_description>
+</parameter>
+<parameter name="mask">
+<parameter_description> the transparency mask for the icon
+</parameter_description>
+</parameter>
+<parameter name="hot_x">
+<parameter_description> the X offset within @pixmap of the hotspot.
+</parameter_description>
+</parameter>
+<parameter name="hot_y">
+<parameter_description> the Y offset within @pixmap of the hotspot.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_add_selection_clipboard">
+<function name="gtk_drag_set_icon_stock">
<description>
-Adds @clipboard to the list of clipboards in which the selection
-contents of @buffer are available. In most cases, @clipboard will be
-the #GtkClipboard of type %GDK_SELECTION_PRIMARY for a view of @buffer.
+Sets the icon for a given drag from a stock ID.
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="context">
+<parameter_description> the context for a drag. (This must be called
+with a context for the source side of a drag)
</parameter_description>
</parameter>
-<parameter name="clipboard">
-<parameter_description> a #GtkClipboard
+<parameter name="stock_id">
+<parameter_description> the ID of the stock icon to use for the drag.
+</parameter_description>
+</parameter>
+<parameter name="hot_x">
+<parameter_description> the X offset within the icon of the hotspot.
+</parameter_description>
+</parameter>
+<parameter name="hot_y">
+<parameter_description> the Y offset within the icon of the hotspot.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_iter_get_bytes_in_line">
+<function name="gtk_drag_set_icon_widget">
<description>
-Returns the number of bytes in the line containing @iter,
-including the paragraph delimiters.
-
+Changes the icon for a widget to a given widget. GTK+
+will not destroy the icon, so if you don't want
+it to persist, you should connect to the "drag-end"
+signal and destroy it yourself.
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
+<parameter name="context">
+<parameter_description> the context for a drag. (This must be called
+ with a context for the source side of a drag)
+</parameter_description>
+</parameter>
+<parameter name="widget">
+<parameter_description> a toplevel window to use as an icon.
+</parameter_description>
+</parameter>
+<parameter name="hot_x">
+<parameter_description> the X offset within @widget of the hotspot.
+</parameter_description>
+</parameter>
+<parameter name="hot_y">
+<parameter_description> the Y offset within @widget of the hotspot.
</parameter_description>
</parameter>
</parameters>
-<return> number of bytes in the line
-</return>
+<return></return>
</function>
-<function name="gtk_print_backend_get_printer_list">
+<function name="gtk_drag_source_add_image_targets">
<description>
+Add the writable image targets supported by #GtkSelection to
+the target list of the drag source. The targets
+are added with @info = 0. If you need another value,
+use gtk_target_list_add_image_targets() and
+gtk_drag_source_set_target_list().
+
+Since: 2.6
</description>
<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget that's is a drag source
+</parameter_description>
+</parameter>
</parameters>
-<return>
-</return>
+<return></return>
</function>
-<function name="gtk_im_context_simple_add_table">
+<function name="gtk_drag_source_add_text_targets">
<description>
-Adds an additional table to search to the input context.
-Each row of the table consists of @max_seq_len key symbols
-followed by two #guint16 interpreted as the high and low
-words of a #gunicode value. Tables are searched starting
-from the last added.
+Add the text targets supported by #GtkSelection to
+the target list of the drag source. The targets
+are added with @info = 0. If you need another value,
+use gtk_target_list_add_text_targets() and
+gtk_drag_source_set_target_list().
-The table must be sorted in dictionary order on the
-numeric value of the key symbol fields. (Values beyond
-the length of the sequence should be zero.)
+Since: 2.6
</description>
<parameters>
-<parameter name="context_simple">
-<parameter_description> A #GtkIMContextSimple
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> the table
-</parameter_description>
-</parameter>
-<parameter name="max_seq_len">
-<parameter_description> Maximum length of a sequence in the table
-(cannot be greater than #GTK_MAX_COMPOSE_LEN)
-</parameter_description>
-</parameter>
-<parameter name="n_seqs">
-<parameter_description> number of sequences in the table
+<parameter name="widget">
+<parameter_description> a #GtkWidget that's is a drag source
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_page_setup_get_paper_size">
+<function name="gtk_drag_source_add_uri_targets">
<description>
-Gets the paper size of the #GtkPageSetup.
+Add the URI targets supported by #GtkSelection to
+the target list of the drag source. The targets
+are added with @info = 0. If you need another value,
+use gtk_target_list_add_uri_targets() and
+gtk_drag_source_set_target_list().
-Since: 2.10
+Since: 2.6
</description>
<parameters>
-<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter name="widget">
+<parameter_description> a #GtkWidget that's is a drag source
</parameter_description>
</parameter>
</parameters>
-<return> the paper size
-
-</return>
+<return></return>
</function>
-<function name="gtk_cell_renderer_get_sensitive">
+<function name="gtk_drag_source_get_target_list">
<description>
-Returns the cell renderer's sensitivity.
+Gets the list of targets this widget can provide for
+drag-and-drop.
-Since: 2.18
+Since: 2.4
</description>
<parameters>
-<parameter name="cell">
-<parameter_description> A #GtkCellRenderer
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the cell renderer is sensitive
+<return> the #GtkTargetList, or %NULL if none
</return>
</function>
-<function name="gtk_range_set_inverted">
+<function name="gtk_drag_source_set">
<description>
-Ranges normally move from lower to higher values as the
-slider moves from top to bottom or left to right. Inverted
-ranges have higher values at the top or on the right rather than
-on the bottom or left.
+Sets up a widget so that GTK+ will start a drag operation when the user
+clicks and drags on the widget. The widget must have a window.
</description>
<parameters>
-<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="setting">
-<parameter_description> %TRUE to invert the range
+<parameter name="start_button_mask">
+<parameter_description> the bitmask of buttons that can start the drag
+</parameter_description>
+</parameter>
+<parameter name="targets">
+<parameter_description> the table of targets that the drag will support,
+may be %NULL
+</parameter_description>
+</parameter>
+<parameter name="n_targets">
+<parameter_description> the number of items in @targets
+</parameter_description>
+</parameter>
+<parameter name="actions">
+<parameter_description> the bitmask of possible actions for a drag from this widget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_assistant_get_n_pages">
+<function name="gtk_drag_source_set_icon">
<description>
-Returns the number of pages in the @assistant
-
-Since: 2.10
+Sets the icon that will be used for drags from a particular widget
+from a pixmap/mask. GTK+ retains references for the arguments, and
+will release them when they are no longer needed.
+Use gtk_drag_source_set_icon_pixbuf() instead.
</description>
<parameters>
-<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-</parameters>
-<return> The number of pages in the @assistant.
-
-</return>
-</function>
-
-<function name="gtk_progress_bar_set_text">
-<description>
-Causes the given @text to appear superimposed on the progress bar.
-
-</description>
-<parameters>
-<parameter name="pbar">
-<parameter_description> a #GtkProgressBar
+<parameter name="colormap">
+<parameter_description> the colormap of the icon
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> a UTF-8 string, or %NULL
+<parameter name="pixmap">
+<parameter_description> the image data for the icon
+</parameter_description>
+</parameter>
+<parameter name="mask">
+<parameter_description> the transparency mask for an image.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_font_button_set_show_style">
+<function name="gtk_drag_source_set_icon_name">
<description>
-If @show_style is %TRUE, the font style will be displayed along with name of the selected font.
+Sets the icon that will be used for drags from a particular source
+to a themed icon. See the docs for #GtkIconTheme for more details.
-Since: 2.4
+Since: 2.8
</description>
<parameters>
-<parameter name="font_button">
-<parameter_description> a #GtkFontButton
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="show_style">
-<parameter_description> %TRUE if font style should be displayed in label.
+<parameter name="icon_name">
+<parameter_description> name of icon to use
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_get_focus_on_map">
+<function name="gtk_drag_source_set_icon_pixbuf">
<description>
-Gets the value set by gtk_window_set_focus_on_map().
-
-Since: 2.6
+Sets the icon that will be used for drags from a particular widget
+from a #GdkPixbuf. GTK+ retains a reference for @pixbuf and will
+release it when it is no longer needed.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="pixbuf">
+<parameter_description> the #GdkPixbuf for the drag icon
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if window should receive the input focus when
-mapped.
-
-</return>
+<return></return>
</function>
-<function name="gtk_file_chooser_get_select_multiple">
+<function name="gtk_drag_source_set_icon_stock">
<description>
-Gets whether multiple files can be selected in the file
-selector. See gtk_file_chooser_set_select_multiple().
-
-Since: 2.4
+Sets the icon that will be used for drags from a particular source
+to a stock icon.
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="stock_id">
+<parameter_description> the ID of the stock icon to use
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if multiple files can be selected.
-
-</return>
+<return></return>
</function>
-<function name="gtk_box_pack_start_defaults">
+<function name="gtk_drag_source_set_target_list">
<description>
-Adds @widget to @box, packed with reference to the start of @box.
-The child is packed after any other child packed with reference
-to the start of @box.
-
-Parameters for how to pack the child @widget, #GtkBox:expand,
-#GtkBox:fill and #GtkBox:padding, are given their default
-values, %TRUE, %TRUE, and 0, respectively.
+Changes the target types that this widget offers for drag-and-drop.
+The widget must first be made into a drag source with
+gtk_drag_source_set().
-Deprecated: 2.14: Use gtk_box_pack_start()
+Since: 2.4
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #GtkBox
+<parameter name="widget">
+<parameter_description> a #GtkWidget that's a drag source
</parameter_description>
</parameter>
-<parameter name="widget">
-<parameter_description> the #GtkWidget to be added to @box
+<parameter name="target_list">
+<parameter_description> list of draggable targets, or %NULL for none
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_action_disconnect_proxy">
+<function name="gtk_drag_update">
<description>
-Disconnects a proxy widget from an action.
-Does <emphasis>not</emphasis> destroy the widget, however.
-
-Since: 2.4
-
-Deprecated: 2.16: Use gtk_activatable_set_related_action() instead.
+Updates the status of the drag; called when the
+cursor moves or the modifier changes
</description>
<parameters>
-<parameter name="action">
-<parameter_description> the action object
+<parameter name="info">
+<parameter_description> DragSourceInfo for the drag
</parameter_description>
</parameter>
-<parameter name="proxy">
-<parameter_description> the proxy widget
+<parameter name="screen">
+<parameter_description> new screen
+</parameter_description>
+</parameter>
+<parameter name="x_root">
+<parameter_description> new X position
+</parameter_description>
+</parameter>
+<parameter name="y_root">
+<parameter_description> new y position
+</parameter_description>
+</parameter>
+<parameter name="event">
+<parameter_description> event received requiring update
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_style_apply_default_background">
+<function name="gtk_draw_arrow">
<description>
+Draws an arrow in the given rectangle on @window using the given
+parameters. @arrow_type determines the direction of the arrow.
+
+Deprecated: 2.0: Use gtk_paint_arrow() instead.
</description>
<parameters>
<parameter name="style">
-<parameter_description>
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
<parameter name="window">
-<parameter_description>
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="set_bg">
-<parameter_description>
+<parameter name="state_type">
+<parameter_description> a state
</parameter_description>
</parameter>
-<parameter name="state_type">
-<parameter_description>
+<parameter name="shadow_type">
+<parameter_description> the type of shadow to draw
</parameter_description>
</parameter>
-<parameter name="area">
-<parameter_description>
+<parameter name="arrow_type">
+<parameter_description> the type of arrow to draw
+</parameter_description>
+</parameter>
+<parameter name="fill">
+<parameter_description> %TRUE if the arrow tip should be filled
</parameter_description>
</parameter>
<parameter name="x">
-<parameter_description>
+<parameter_description> x origin of the rectangle to draw the arrow in
</parameter_description>
</parameter>
<parameter name="y">
-<parameter_description>
+<parameter_description> y origin of the rectangle to draw the arrow in
</parameter_description>
</parameter>
<parameter name="width">
-<parameter_description>
+<parameter_description> width of the rectangle to draw the arrow in
</parameter_description>
</parameter>
<parameter name="height">
-<parameter_description>
+<parameter_description> height of the rectangle to draw the arrow in
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_file_chooser_button_get_focus_on_click">
+<function name="gtk_draw_box">
<description>
-Returns whether the button grabs focus when it is clicked with the mouse.
-See gtk_file_chooser_button_set_focus_on_click().
+Draws a box on @window with the given parameters.
-Since: 2.10
+Deprecated: 2.0: Use gtk_paint_box() instead.
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkFileChooserButton
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-</parameters>
-<return> %TRUE if the button grabs focus when it is clicked with
-the mouse.
-
-</return>
-</function>
-
-<function name="gtk_container_get_resize_mode">
-<description>
-Returns the resize mode for the container. See
-gtk_container_set_resize_mode ().
-
-
-</description>
-<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-</parameters>
-<return> the current resize mode
-</return>
-</function>
-
-<function name="gtk_tree_store_insert_with_values">
-<description>
-Creates a new row at @position. @iter will be changed to point to this
-new row. If @position is larger than the number of rows on the list, then
-the new row will be appended to the list. The row will be filled with
-the values given to this function.
-
-Calling
-<literal>gtk_tree_store_insert_with_values (tree_store, iter, position, ...)</literal>
-has the same effect as calling
-|[
-gtk_tree_store_insert (tree_store, iter, position);
-gtk_tree_store_set (tree_store, iter, ...);
-]|
-with the different that the former will only emit a row_inserted signal,
-while the latter will emit row_inserted, row_changed and if the tree store
-is sorted, rows_reordered. Since emitting the rows_reordered signal
-repeatedly can affect the performance of the program,
-gtk_tree_store_insert_with_values() should generally be preferred when
-inserting rows in a sorted tree store.
-
-Since: 2.10
-
-</description>
-<parameters>
-<parameter name="tree_store">
-<parameter_description> A #GtkTreeStore
+<parameter name="state_type">
+<parameter_description> a state
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> An unset #GtkTreeIter to set the new row, or %NULL.
+<parameter name="shadow_type">
+<parameter_description> the type of shadow to draw
</parameter_description>
</parameter>
-<parameter name="parent">
-<parameter_description> A valid #GtkTreeIter, or %NULL
+<parameter name="x">
+<parameter_description> x origin of the box
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> position to insert the new row
+<parameter name="y">
+<parameter_description> y origin of the box
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> pairs of column number and value, terminated with -1
+<parameter name="width">
+<parameter_description> the width of the box
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the height of the box
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_about_dialog_set_copyright">
+<function name="gtk_draw_box_gap">
<description>
-Sets the copyright string to display in the about dialog.
-This should be a short string of one or two lines.
+Draws a box in @window using the given style and state and shadow type,
+leaving a gap in one side.
-Since: 2.6
+Deprecated: 2.0: Use gtk_paint_box_gap() instead.
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-<parameter name="copyright">
-<parameter_description> (allow-none) the copyright string
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_im_context_focus_in">
-<description>
-Notify the input method that the widget to which this
-input context corresponds has gained focus. The input method
-may, for example, change the displayed feedback to reflect
-this change.
-
-</description>
-<parameters>
-<parameter name="context">
-<parameter_description> a #GtkIMContext
+<parameter name="state_type">
+<parameter_description> a state
+</parameter_description>
+</parameter>
+<parameter name="shadow_type">
+<parameter_description> type of shadow to draw
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> x origin of the rectangle
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y origin of the rectangle
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> width of the rectangle
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> width of the rectangle
+</parameter_description>
+</parameter>
+<parameter name="gap_side">
+<parameter_description> side in which to leave the gap
+</parameter_description>
+</parameter>
+<parameter name="gap_x">
+<parameter_description> starting position of the gap
+</parameter_description>
+</parameter>
+<parameter name="gap_width">
+<parameter_description> width of the gap
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tool_item_group_set_collapsed">
+<function name="gtk_draw_check">
<description>
-Sets whether the @group should be collapsed or expanded.
+Draws a check button indicator in the given rectangle on @window with
+the given parameters.
-Since: 2.20
+Deprecated: 2.0: Use gtk_paint_check() instead.
</description>
<parameters>
-<parameter name="group">
-<parameter_description> a #GtkToolItemGroup
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-<parameter name="collapsed">
-<parameter_description> whether the @group should be collapsed or expanded
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_notebook_set_menu_label_text">
-<description>
-Creates a new label and sets it as the menu label of @child.
-
-</description>
-<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="state_type">
+<parameter_description> a state
</parameter_description>
</parameter>
-<parameter name="child">
-<parameter_description> the child widget
+<parameter name="shadow_type">
+<parameter_description> the type of shadow to draw
</parameter_description>
</parameter>
-<parameter name="menu_text">
-<parameter_description> the label text
+<parameter name="x">
+<parameter_description> x origin of the rectangle to draw the check in
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y origin of the rectangle to draw the check in
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> the width of the rectangle to draw the check in
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the height of the rectangle to draw the check in
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_get_screen">
+<function name="gtk_draw_diamond">
<description>
-Get the #GdkScreen from the toplevel window associated with
-this widget. This function can only be called after the widget
-has been added to a widget hierarchy with a #GtkWindow
-at the top.
-
-In general, you should only create screen specific
-resources when a widget has been realized, and you should
-free those resources when the widget is unrealized.
+Draws a diamond in the given rectangle on @window using the given
+parameters.
-Since: 2.2
+Deprecated: 2.0: Use gtk_paint_diamond() instead.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-</parameters>
-<return> the #GdkScreen for the toplevel for this widget.
-
-</return>
-</function>
-
-<function name="gtk_recent_manager_add_full">
-<description>
-Adds a new resource, pointed by @uri, into the recently used
-resources list, using the metadata specified inside the #GtkRecentData
-structure passed in @recent_data.
-
-The passed URI will be used to identify this resource inside the
-list.
-
-In order to register the new recently used resource, metadata about
-the resource must be passed as well as the URI; the metadata is
-stored in a #GtkRecentData structure, which must contain the MIME
-type of the resource pointed by the URI; the name of the application
-that is registering the item, and a command line to be used when
-launching the item.
-
-Optionally, a #GtkRecentData structure might contain a UTF-8 string
-to be used when viewing the item instead of the last component of the
-URI; a short description of the item; whether the item should be
-considered private - that is, should be displayed only by the
-applications that have registered it.
-
-Since: 2.10
-
-</description>
-<parameters>
-<parameter name="manager">
-<parameter_description> a #GtkRecentManager
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="uri">
-<parameter_description> a valid URI
+<parameter name="state_type">
+<parameter_description> a state
</parameter_description>
</parameter>
-<parameter name="recent_data">
-<parameter_description> metadata of the resource
+<parameter name="shadow_type">
+<parameter_description> the type of shadow to draw
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> x origin of the rectangle to draw the diamond in
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y origin of the rectangle to draw the diamond in
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> width of the rectangle to draw the diamond in
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> height of the rectangle to draw the diamond in
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the new item was successfully added to the
-recently used resources list, %FALSE otherwise.
-
-</return>
+<return></return>
</function>
-<function name="gtk_window_set_modal">
+<function name="gtk_draw_expander">
<description>
-Sets a window modal or non-modal. Modal windows prevent interaction
-with other windows in the same application. To keep modal dialogs
-on top of main application windows, use
-gtk_window_set_transient_for() to make the dialog transient for the
-parent; most <link linkend="gtk-X11-arch">window managers</link>
-will then disallow lowering the dialog below the parent.
-
+Draws an expander as used in #GtkTreeView.
+Deprecated: 2.0: Use gtk_paint_expander() instead.
</description>
<parameters>
+<parameter name="style">
+<parameter_description> a #GtkStyle
+</parameter_description>
+</parameter>
<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="modal">
-<parameter_description> whether the window is modal
+<parameter name="state_type">
+<parameter_description> a state
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> the x position to draw the expander at
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> the y position to draw the expander at
+</parameter_description>
+</parameter>
+<parameter name="expander_style">
+<parameter_description> the style to draw the expander in
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_style_set_background">
+<function name="gtk_draw_extension">
<description>
-Sets the background of @window to the background color or pixmap
-specified by @style for the given state.
+Draws an extension, i.e. a notebook tab.
+
+Deprecated: 2.0: Use gtk_paint_extension() instead.
</description>
<parameters>
@@ -12723,347 +13002,374 @@ specified by @style for the given state.
<parameter_description> a state
</parameter_description>
</parameter>
+<parameter name="shadow_type">
+<parameter_description> type of shadow to draw
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> x origin of the extension
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y origin of the extension
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> width of the extension
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> width of the extension
+</parameter_description>
+</parameter>
+<parameter name="gap_side">
+<parameter_description> the side on to which the extension is attached
+</parameter_description>
+</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_page_setup_get_page_height">
+<function name="gtk_draw_flat_box">
<description>
-Returns the page height in units of @unit.
-
-Note that this function takes orientation and
-margins into consideration.
-See gtk_page_setup_get_paper_height().
+Draws a flat box on @window with the given parameters.
-Since: 2.10
+Deprecated: 2.0: Use gtk_paint_flat_box() instead.
</description>
<parameters>
-<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-<parameter name="unit">
-<parameter_description> the unit for the return value
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-</parameters>
-<return> the page height.
-
-</return>
-</function>
-
-<function name="gtk_tree_selection_select_path">
-<description>
-Select the row at @path.
-
-</description>
-<parameters>
-<parameter name="selection">
-<parameter_description> A #GtkTreeSelection.
+<parameter name="state_type">
+<parameter_description> a state
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> The #GtkTreePath to be selected.
+<parameter name="shadow_type">
+<parameter_description> the type of shadow to draw
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> x origin of the box
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y origin of the box
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> the width of the box
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the height of the box
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_printer_is_virtual">
+<function name="gtk_draw_focus">
<description>
-Returns whether the printer is virtual (i.e. does not
-represent actual printer hardware, but something like
-a CUPS class).
+Draws a focus indicator around the given rectangle on @window using the
+given style.
-Since: 2.10
+Deprecated: 2.0: Use gtk_paint_focus() instead.
</description>
<parameters>
-<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-</parameters>
-<return> %TRUE if @printer is virtual
-
-</return>
-</function>
-
-<function name="gtk_test_list_all_types">
-<description>
-Return the type ids that have been registered after
-calling gtk_test_register_all_types().
-
-Since: 2.14
-
-</description>
-<parameters>
-<parameter name="n_types">
-<parameter_description> location to store number of types
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-</parameters>
-<return> 0-terminated array of type ids
-</return>
-</function>
-
-<function name="gtk_range_get_show_fill_level">
-<description>
-Gets whether the range displays the fill level graphically.
-
-Since: 2.12
-
-</description>
-<parameters>
-<parameter name="range">
-<parameter_description> A #GtkRange
+<parameter name="x">
+<parameter_description> the x origin of the rectangle around which to draw a focus indicator
</parameter_description>
</parameter>
-</parameters>
-<return> %TRUE if @range shows the fill level.
-
-</return>
-</function>
-
-<function name="gtk_tree_view_set_headers_clickable">
-<description>
-Allow the column title buttons to be clicked.
-
-</description>
-<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView.
+<parameter name="y">
+<parameter_description> the y origin of the rectangle around which to draw a focus indicator
</parameter_description>
</parameter>
-<parameter name="setting">
-<parameter_description> %TRUE if the columns are clickable.
+<parameter name="width">
+<parameter_description> the width of the rectangle around which to draw a focus indicator
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the height of the rectangle around which to draw a focus indicator
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_frame_set_label">
+<function name="gtk_draw_handle">
<description>
-Sets the text of the label. If @label is %NULL,
-the current label is removed.
+Draws a handle as used in #GtkHandleBox and #GtkPaned.
+
+Deprecated: 2.0: Use gtk_paint_handle() instead.
</description>
<parameters>
-<parameter name="frame">
-<parameter_description> a #GtkFrame
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-<parameter name="label">
-<parameter_description> the text to use as the label of the frame
+<parameter name="window">
+<parameter_description> a #GdkWindow
+</parameter_description>
+</parameter>
+<parameter name="state_type">
+<parameter_description> a state
+</parameter_description>
+</parameter>
+<parameter name="shadow_type">
+<parameter_description> type of shadow to draw
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> x origin of the handle
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y origin of the handle
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> with of the handle
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> height of the handle
+</parameter_description>
+</parameter>
+<parameter name="orientation">
+<parameter_description> the orientation of the handle
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_context_get_hard_margins">
+<function name="gtk_draw_hline">
<description>
-Obtains the hardware printer margins of the #GtkPrintContext, in units.
+Draws a horizontal line from (@x1, @y) to (@x2, @y) in @window
+using the given style and state.
-Since: 2.20
+Deprecated: 2.0: Use gtk_paint_hline() instead.
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GtkPrintContext
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-<parameter name="top">
-<parameter_description> top hardware printer margin
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="bottom">
-<parameter_description> bottom hardware printer margin
+<parameter name="state_type">
+<parameter_description> a state
</parameter_description>
</parameter>
-<parameter name="left">
-<parameter_description> left hardware printer margin
+<parameter name="x1">
+<parameter_description> the starting x coordinate
</parameter_description>
</parameter>
-<parameter name="right">
-<parameter_description> right hardware printer margin
+<parameter name="x2">
+<parameter_description> the ending x coordinate
</parameter_description>
</parameter>
-</parameters>
-<return> %TRUE if the hard margins were retrieved
-
-</return>
-</function>
-
-<function name="gtk_scale_button_get_adjustment">
-<description>
-Gets the #GtkAdjustment associated with the #GtkScaleButton's scale.
-See gtk_range_get_adjustment() for details.
-
-Since: 2.12
-
-</description>
-<parameters>
-<parameter name="button">
-<parameter_description> a #GtkScaleButton
+<parameter name="y">
+<parameter_description> the y coordinate
</parameter_description>
</parameter>
</parameters>
-<return> the adjustment associated with the scale
-
-</return>
+<return></return>
</function>
-<function name="gtk_tree_store_set_value">
+<function name="gtk_draw_insertion_cursor">
<description>
-Sets the data in the cell specified by @iter and @column.
-The type of @value must be convertible to the type of the
-column.
+Draws a text caret on @drawable at @location. This is not a style function
+but merely a convenience function for drawing the standard cursor shape.
+Since: 2.4
</description>
<parameters>
-<parameter name="tree_store">
-<parameter_description> a #GtkTreeStore
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> A valid #GtkTreeIter for the row being modified
+<parameter name="drawable">
+<parameter_description> a #GdkDrawable
</parameter_description>
</parameter>
-<parameter name="column">
-<parameter_description> column number to modify
+<parameter name="area">
+<parameter_description> rectangle to which the output is clipped, or %NULL if the
+output should not be clipped
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> new value for the cell
+<parameter name="location">
+<parameter_description> location where to draw the cursor (@location->width is ignored)
+</parameter_description>
+</parameter>
+<parameter name="is_primary">
+<parameter_description> if the cursor should be the primary cursor color.
+</parameter_description>
+</parameter>
+<parameter name="direction">
+<parameter_description> whether the cursor is left-to-right or
+right-to-left. Should never be #GTK_TEXT_DIR_NONE
+</parameter_description>
+</parameter>
+<parameter name="draw_arrow">
+<parameter_description> %TRUE to draw a directional arrow on the
+cursor. Should be %FALSE unless the cursor is split.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_about_dialog_get_license">
+<function name="gtk_draw_layout">
<description>
-Returns the license information.
-
-Since: 2.6
+Draws a layout on @window using the given parameters.
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-</parameters>
-<return> The license information. The string is owned by the about
-dialog and must not be modified.
-
-</return>
-</function>
-
-<function name="gtk_icon_source_set_size">
-<description>
-Sets the icon size this icon source is intended to be used
-with.
-
-Setting the icon size on an icon source makes no difference
-if the size is wildcarded. Therefore, you should usually
-call gtk_icon_source_set_size_wildcarded() to un-wildcard it
-in addition to calling this function.
-
-</description>
-<parameters>
-<parameter name="source">
-<parameter_description> a #GtkIconSource
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> icon size this source applies to
+<parameter name="state_type">
+<parameter_description> a state
+</parameter_description>
+</parameter>
+<parameter name="use_text">
+<parameter_description> whether to use the text or foreground
+graphics context of @style
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> x origin
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y origin
+</parameter_description>
+</parameter>
+<parameter name="layout">
+<parameter_description> the layout to draw
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_radio_menu_item_new_with_label">
+<function name="gtk_draw_option">
<description>
-Creates a new #GtkRadioMenuItem whose child is a simple #GtkLabel.
+Draws a radio button indicator in the given rectangle on @window with
+the given parameters.
+Deprecated: 2.0: Use gtk_paint_option() instead.
</description>
<parameters>
-<parameter name="group">
-<parameter_description>
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-<parameter name="label">
-<parameter_description> the text for the label
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-</parameters>
-<return> A new #GtkRadioMenuItem
-</return>
-</function>
-
-<function name="gtk_binding_set_activate">
-<description>
-Find a key binding matching @keyval and @modifiers within
- binding_set and activate the binding on @object.
-
-
-</description>
-<parameters>
-<parameter name="binding_set">
-<parameter_description> a #GtkBindingSet set to activate
+<parameter name="state_type">
+<parameter_description> a state
</parameter_description>
</parameter>
-<parameter name="keyval">
-<parameter_description> key value of the binding
+<parameter name="shadow_type">
+<parameter_description> the type of shadow to draw
</parameter_description>
</parameter>
-<parameter name="modifiers">
-<parameter_description> key modifier of the binding
+<parameter name="x">
+<parameter_description> x origin of the rectangle to draw the option in
</parameter_description>
</parameter>
-<parameter name="object">
-<parameter_description> object to activate when binding found
+<parameter name="y">
+<parameter_description> y origin of the rectangle to draw the option in
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> the width of the rectangle to draw the option in
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the height of the rectangle to draw the option in
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if a binding was found and activated
-</return>
+<return></return>
</function>
-<function name="gtk_widget_is_toplevel">
+<function name="gtk_draw_polygon">
<description>
-Determines whether @widget is a toplevel widget. Currently only
-#GtkWindow and #GtkInvisible are toplevel widgets. Toplevel
-widgets have no parent widget.
+Draws a polygon on @window with the given parameters.
-Since: 2.18
+Deprecated: 2.0: Use gtk_paint_polygon() instead.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="style">
+<parameter_description> a #GtkStyle
+</parameter_description>
+</parameter>
+<parameter name="window">
+<parameter_description> a #GdkWindow
+</parameter_description>
+</parameter>
+<parameter name="state_type">
+<parameter_description> a state
+</parameter_description>
+</parameter>
+<parameter name="shadow_type">
+<parameter_description> type of shadow to draw
+</parameter_description>
+</parameter>
+<parameter name="points">
+<parameter_description> an array of #GdkPoint<!-- -->s
+</parameter_description>
+</parameter>
+<parameter name="npoints">
+<parameter_description> length of @points
+</parameter_description>
+</parameter>
+<parameter name="fill">
+<parameter_description> %TRUE if the polygon should be filled
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @widget is a toplevel, %FALSE otherwise
-
-</return>
+<return></return>
</function>
-<function name="gtk_draw_focus">
+<function name="gtk_draw_resize_grip">
<description>
-Draws a focus indicator around the given rectangle on @window using the
-given style.
+Draws a resize grip in the given rectangle on @window using the given
+parameters.
-Deprecated: 2.0: Use gtk_paint_focus() instead.
+Deprecated: 2.0: Use gtk_paint_resize_grip() instead.
</description>
<parameters>
@@ -13075,1724 +13381,1605 @@ Deprecated: 2.0: Use gtk_paint_focus() instead.
<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
+<parameter name="state_type">
+<parameter_description> a state
+</parameter_description>
+</parameter>
+<parameter name="edge">
+<parameter_description> the edge in which to draw the resize grip
+</parameter_description>
+</parameter>
<parameter name="x">
-<parameter_description> the x origin of the rectangle around which to draw a focus indicator
+<parameter_description> the x origin of the rectangle in which to draw the resize grip
</parameter_description>
</parameter>
<parameter name="y">
-<parameter_description> the y origin of the rectangle around which to draw a focus indicator
+<parameter_description> the y origin of the rectangle in which to draw the resize grip
</parameter_description>
</parameter>
<parameter name="width">
-<parameter_description> the width of the rectangle around which to draw a focus indicator
+<parameter_description> the width of the rectangle in which to draw the resize grip
</parameter_description>
</parameter>
<parameter name="height">
-<parameter_description> the height of the rectangle around which to draw a focus indicator
+<parameter_description> the height of the rectangle in which to draw the resize grip
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_container_child_set_valist">
+<function name="gtk_draw_shadow">
<description>
-Sets one or more child properties for @child and @container.
+Draws a shadow around the given rectangle in @window
+using the given style and state and shadow type.
+
+Deprecated: 2.0: Use gtk_paint_shadow() instead.
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-<parameter name="child">
-<parameter_description> a widget which is a child of @container
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="first_property_name">
-<parameter_description> the name of the first property to set
+<parameter name="state_type">
+<parameter_description> a state
</parameter_description>
</parameter>
-<parameter name="var_args">
-<parameter_description> a %NULL-terminated list of property names and values, starting
-with @first_prop_name
+<parameter name="shadow_type">
+<parameter_description> type of shadow to draw
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> x origin of the rectangle
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y origin of the rectangle
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> width of the rectangle
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> width of the rectangle
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_stock_list_ids">
-<description>
-Retrieves a list of all known stock IDs added to a #GtkIconFactory
-or registered with gtk_stock_add(). The list must be freed with g_slist_free(),
-and each string in the list must be freed with g_free().
-
-
-</description>
-<parameters>
-</parameters>
-<return> a list of known stock IDs
-</return>
-</function>
-
-<function name="gtk_image_menu_item_set_always_show_image">
+<function name="gtk_draw_shadow_gap">
<description>
-If %TRUE, the menu item will ignore the #GtkSettings:gtk-menu-images
-setting and always show the image, if available.
-
-Use this property if the menuitem would be useless or hard to use
-without the image.
+Draws a shadow around the given rectangle in @window
+using the given style and state and shadow type, leaving a
+gap in one side.
-Since: 2.16
+Deprecated: 2.0: Use gtk_paint_shadow_gap() instead.
</description>
<parameters>
-<parameter name="image_menu_item">
-<parameter_description> a #GtkImageMenuItem
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-<parameter name="always_show">
-<parameter_description> %TRUE if the menuitem should always show the image
+<parameter name="window">
+<parameter_description> a #GdkWindow
+</parameter_description>
+</parameter>
+<parameter name="state_type">
+<parameter_description> a state
+</parameter_description>
+</parameter>
+<parameter name="shadow_type">
+<parameter_description> type of shadow to draw
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> x origin of the rectangle
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y origin of the rectangle
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> width of the rectangle
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> width of the rectangle
+</parameter_description>
+</parameter>
+<parameter name="gap_side">
+<parameter_description> side in which to leave the gap
+</parameter_description>
+</parameter>
+<parameter name="gap_x">
+<parameter_description> starting position of the gap
+</parameter_description>
+</parameter>
+<parameter name="gap_width">
+<parameter_description> width of the gap
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_binding_set_find">
+<function name="gtk_draw_slider">
<description>
-Find a binding set by its globally unique name. The @set_name can
-either be a name used for gtk_binding_set_new() or the type name of
-a class used in gtk_binding_set_by_class().
-
+Draws a slider in the given rectangle on @window using the
+given style and orientation.
</description>
<parameters>
-<parameter name="set_name">
-<parameter_description> unique binding set name
+<parameter name="style">
+<parameter_description> a #GtkStyle
+ @window: a #GdkWindow
</parameter_description>
</parameter>
-</parameters>
-<return> %NULL or the specified binding set
-</return>
-</function>
-
-<function name="gtk_ctree_set_node_info">
-<description>
-
-</description>
-<parameters>
-<parameter name="pixmap_closed">
-<parameter_description>
+<parameter name="state_type">
+<parameter_description> a state
</parameter_description>
</parameter>
-<parameter name="mask_closed">
-<parameter_description>
+<parameter name="shadow_type">
+<parameter_description> a shadow
</parameter_description>
</parameter>
-<parameter name="pixmap_opened">
-<parameter_description>
+<parameter name="x">
+<parameter_description> the x origin of the rectangle in which to draw a slider
</parameter_description>
</parameter>
-<parameter name="mask_opened">
-<parameter_description>
+<parameter name="y">
+<parameter_description> the y origin of the rectangle in which to draw a slider
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> the width of the rectangle in which to draw a slider
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the height of the rectangle in which to draw a slider
+</parameter_description>
+</parameter>
+<parameter name="orientation">
+<parameter_description> the orientation to be used
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_image_set_from_gicon">
+<function name="gtk_draw_string">
<description>
-See gtk_image_new_from_gicon() for details.
+Draws a text string on @window with the given parameters.
-Since: 2.14
+Deprecated: 2.0: Use gtk_paint_layout() instead.
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GtkImage
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-<parameter name="icon">
-<parameter_description> an icon
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> an icon size
+<parameter name="state_type">
+<parameter_description> a state
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> x origin
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y origin
+</parameter_description>
+</parameter>
+<parameter name="string">
+<parameter_description> the string to draw
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_set_show_expanders">
+<function name="gtk_draw_tab">
<description>
-Sets whether to draw and enable expanders and indent child rows in
- tree_view When disabled there will be no expanders visible in trees
-and there will be no way to expand and collapse rows by default. Also
-note that hiding the expanders will disable the default indentation. You
-can set a custom indentation in this case using
-gtk_tree_view_set_level_indentation().
-This does not have any visible effects for lists.
+Draws an option menu tab (i.e. the up and down pointing arrows)
+in the given rectangle on @window using the given parameters.
-Since: 2.12
+Deprecated: 2.0: Use gtk_paint_tab() instead.
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-<parameter name="enabled">
-<parameter_description> %TRUE to enable expander drawing, %FALSE otherwise.
+<parameter name="window">
+<parameter_description> a #GdkWindow
+</parameter_description>
+</parameter>
+<parameter name="state_type">
+<parameter_description> a state
+</parameter_description>
+</parameter>
+<parameter name="shadow_type">
+<parameter_description> the type of shadow to draw
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> x origin of the rectangle to draw the tab in
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y origin of the rectangle to draw the tab in
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> the width of the rectangle to draw the tab in
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the height of the rectangle to draw the tab in
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_page_setup_new_from_key_file">
+<function name="gtk_draw_vline">
<description>
-Reads the page setup from the group @group_name in the key file
- key_file Returns a new #GtkPageSetup object with the restored
-page setup, or %NULL if an error occurred.
+Draws a vertical line from (@x, @y1_) to (@x, @y2_) in @window
+using the given style and state.
-Since: 2.12
+Deprecated: 2.0: Use gtk_paint_vline() instead.
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> the #GKeyFile to retrieve the page_setup from
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-<parameter name="group_name">
-<parameter_description> the name of the group in the key_file to read, or %NULL
-to use the default name "Page Setup"
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for an error, or %NULL
+<parameter name="state_type">
+<parameter_description> a state
</parameter_description>
</parameter>
-</parameters>
-<return> the restored #GtkPageSetup
-
-</return>
-</function>
-
-<function name="gtk_notebook_set_scrollable">
-<description>
-Sets whether the tab label area will have arrows for scrolling if
-there are too many tabs to fit in the area.
-
-</description>
-<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="y1_">
+<parameter_description> the starting y coordinate
</parameter_description>
</parameter>
-<parameter name="scrollable">
-<parameter_description> %TRUE if scroll arrows should be added
+<parameter name="y2_">
+<parameter_description> the ending y coordinate
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> the x coordinate
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_expander_set_label">
+<function name="gtk_editable_copy_clipboard">
<description>
-Sets the text of the label of the expander to @label.
-
-This will also clear any previously set labels.
-
-Since: 2.4
+Copies the contents of the currently selected content in the editable and
+puts it on the clipboard.
</description>
<parameters>
-<parameter name="expander">
-<parameter_description> a #GtkExpander
-</parameter_description>
-</parameter>
-<parameter name="label">
-<parameter_description> a string
+<parameter name="editable">
+<parameter_description> a #GtkEditable
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_has_grab">
+<function name="gtk_editable_cut_clipboard">
<description>
-Determines whether the widget is currently grabbing events, so it
-is the only widget receiving input events (keyboard and mouse).
-
-See also gtk_grab_add().
-
-Since: 2.18
+Removes the contents of the currently selected content in the editable and
+puts it on the clipboard.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="editable">
+<parameter_description> a #GtkEditable
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the widget is in the grab_widgets stack
-
-</return>
+<return></return>
</function>
-<function name="gtk_cell_view_set_model">
+<function name="gtk_editable_delete_selection">
<description>
-Sets the model for @cell_view. If @cell_view already has a model
-set, it will remove it before setting the new model. If @model is
-%NULL, then it will unset the old model.
-
-Since: 2.6
+Deletes the currently selected text of the editable.
+This call doesn't do anything if there is no selected text.
</description>
<parameters>
-<parameter name="cell_view">
-<parameter_description> a #GtkCellView
-</parameter_description>
-</parameter>
-<parameter name="model">
-<parameter_description> a #GtkTreeModel
+<parameter name="editable">
+<parameter_description> a #GtkEditable
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_ui_manager_add_ui">
+<function name="gtk_editable_delete_text">
<description>
-Adds a UI element to the current contents of @self.
-
-If @type is %GTK_UI_MANAGER_AUTO, GTK+ inserts a menuitem, toolitem or
-separator if such an element can be inserted at the place determined by
- path Otherwise @type must indicate an element that can be inserted at
-the place determined by @path.
-
-If @path points to a menuitem or toolitem, the new element will be inserted
-before or after this item, depending on @top.
+Deletes a sequence of characters. The characters that are deleted are
+those characters at positions from @start_pos up to, but not including
+ end_pos If @end_pos is negative, then the the characters deleted
+are those from @start_pos to the end of the text.
-Since: 2.4
+Note that the positions are specified in characters, not bytes.
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #GtkUIManager
-</parameter_description>
-</parameter>
-<parameter name="merge_id">
-<parameter_description> the merge id for the merged UI, see gtk_ui_manager_new_merge_id()
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> a path
-</parameter_description>
-</parameter>
-<parameter name="name">
-<parameter_description> the name for the added UI element
-</parameter_description>
-</parameter>
-<parameter name="action">
-<parameter_description> the name of the action to be proxied, or %NULL to add a separator
+<parameter name="editable">
+<parameter_description> a #GtkEditable
</parameter_description>
</parameter>
-<parameter name="type">
-<parameter_description> the type of UI element to add.
+<parameter name="start_pos">
+<parameter_description> start position
</parameter_description>
</parameter>
-<parameter name="top">
-<parameter_description> if %TRUE, the UI element is added before its siblings, otherwise it
-is added after its siblings.
+<parameter name="end_pos">
+<parameter_description> end position
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_button_set_focus_on_click">
+<function name="gtk_editable_get_chars">
<description>
-Sets whether the button will grab focus when it is clicked with the mouse.
-Making mouse clicks not grab focus is useful in places like toolbars where
-you don't want the keyboard focus removed from the main area of the
-application.
+Retrieves a sequence of characters. The characters that are retrieved
+are those characters at positions from @start_pos up to, but not
+including @end_pos. If @end_pos is negative, then the the characters
+retrieved are those characters from @start_pos to the end of the text.
+
+Note that positions are specified in characters, not bytes.
-Since: 2.4
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkButton
+<parameter name="editable">
+<parameter_description> a #GtkEditable
</parameter_description>
</parameter>
-<parameter name="focus_on_click">
-<parameter_description> whether the button grabs focus when clicked with the mouse
+<parameter name="start_pos">
+<parameter_description> start of text
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_action_get_tooltip">
-<description>
-Gets the tooltip text of @action.
-
-Since: 2.16
-
-</description>
-<parameters>
-<parameter name="action">
-<parameter_description> a #GtkAction
+<parameter name="end_pos">
+<parameter_description> end of text
</parameter_description>
</parameter>
</parameters>
-<return> the tooltip text
-
+<return> a pointer to the contents of the widget as a
+string. This string is allocated by the #GtkEditable
+implementation and should be freed by the caller.
</return>
</function>
-<function name="gtk_recent_info_get_display_name">
+<function name="gtk_editable_get_editable">
<description>
-Gets the name of the resource. If none has been defined, the basename
-of the resource is obtained.
+Retrieves whether @editable is editable. See
+gtk_editable_set_editable().
-Since: 2.10
</description>
<parameters>
-<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter name="editable">
+<parameter_description> a #GtkEditable
</parameter_description>
</parameter>
</parameters>
-<return> the display name of the resource. The returned string
-is owned by the recent manager, and should not be freed.
-
+<return> %TRUE if @editable is editable.
</return>
</function>
-<function name="gtk_file_chooser_get_current_folder_uri">
+<function name="gtk_editable_get_position">
<description>
-Gets the current folder of @chooser as an URI.
-See gtk_file_chooser_set_current_folder_uri().
+Retrieves the current position of the cursor relative to the start
+of the content of the editable.
-Note that this is the folder that the file chooser is currently displaying
-(e.g. "file:///home/username/Documents"), which is <emphasis>not the same</emphasis>
-as the currently-selected folder if the chooser is in
-%GTK_FILE_CHOOSER_SELECT_FOLDER mode
-(e.g. "file:///home/username/Documents/selected-folder/". To get the
-currently-selected folder in that mode, use gtk_file_chooser_get_uri() as the
-usual way to get the selection.
+Note that this position is in characters, not in bytes.
-Since: 2.4
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="editable">
+<parameter_description> a #GtkEditable
</parameter_description>
</parameter>
</parameters>
-<return> the URI for the current folder. Free with g_free(). This
-function will also return %NULL if the file chooser was unable to load the
-last folder that was requested from it; for example, as would be for calling
-gtk_file_chooser_set_current_folder_uri() on a nonexistent folder.
-
+<return> the cursor position
</return>
</function>
-<function name="gtk_print_settings_copy">
+<function name="gtk_editable_get_selection_bounds">
<description>
-Copies a #GtkPrintSettings object.
+Retrieves the selection bound of the editable. start_pos will be filled
+with the start of the selection and @end_pos with end. If no text was
+selected both will be identical and %FALSE will be returned.
+
+Note that positions are specified in characters, not bytes.
-Since: 2.10
</description>
<parameters>
-<parameter name="other">
-<parameter_description> a #GtkPrintSettings
+<parameter name="editable">
+<parameter_description> a #GtkEditable
+</parameter_description>
+</parameter>
+<parameter name="start_pos">
+<parameter_description> location to store the starting position, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="end_pos">
+<parameter_description> location to store the end position, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated copy of @other
-
-</return>
-</function>
-
-<function name="gtk_im_context_simple_new">
-<description>
-Creates a new #GtkIMContextSimple.
-
-
-</description>
-<parameters>
-</parameters>
-<return> a new #GtkIMContextSimple.
+<return> %TRUE if an area is selected, %FALSE otherwise
</return>
</function>
-<function name="gtk_icon_view_enable_model_drag_source">
+<function name="gtk_editable_insert_text">
<description>
-Turns @icon_view into a drag source for automatic DND. Calling this
-method sets #GtkIconView:reorderable to %FALSE.
+Inserts @new_text_length bytes of @new_text into the contents of the
+widget, at position @position.
-Since: 2.8
+Note that the position is in characters, not in bytes.
+The function updates @position to point after the newly inserted text.
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconTreeView
-</parameter_description>
-</parameter>
-<parameter name="start_button_mask">
-<parameter_description> Mask of allowed buttons to start drag
+<parameter name="editable">
+<parameter_description> a #GtkEditable
</parameter_description>
</parameter>
-<parameter name="targets">
-<parameter_description> the table of targets that the drag will support
+<parameter name="new_text">
+<parameter_description> the text to append
</parameter_description>
</parameter>
-<parameter name="n_targets">
-<parameter_description> the number of items in @targets
+<parameter name="new_text_length">
+<parameter_description> the length of the text in bytes, or -1
</parameter_description>
</parameter>
-<parameter name="actions">
-<parameter_description> the bitmask of possible actions for a drag from this
-widget
+<parameter name="position">
+<parameter_description> location of the position text will be inserted at
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_selection_unselect_iter">
+<function name="gtk_editable_paste_clipboard">
<description>
-Unselects the specified iterator.
+Pastes the content of the clipboard to the current position of the
+cursor in the editable.
</description>
<parameters>
-<parameter name="selection">
-<parameter_description> A #GtkTreeSelection.
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> The #GtkTreeIter to be unselected.
+<parameter name="editable">
+<parameter_description> a #GtkEditable
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_notebook_set_tab_label_text">
+<function name="gtk_editable_select_region">
<description>
-Creates a new label and sets it as the tab label for the page
-containing @child.
+Selects a region of text. The characters that are selected are
+those characters at positions from @start_pos up to, but not
+including @end_pos. If @end_pos is negative, then the the
+characters selected are those characters from @start_pos to
+the end of the text.
+
+Note that positions are specified in characters, not bytes.
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="editable">
+<parameter_description> a #GtkEditable
</parameter_description>
</parameter>
-<parameter name="child">
-<parameter_description> the page
+<parameter name="start_pos">
+<parameter_description> start of region
</parameter_description>
</parameter>
-<parameter name="tab_text">
-<parameter_description> the label text
+<parameter name="end_pos">
+<parameter_description> end of region
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tool_palette_unset_style">
+<function name="gtk_editable_set_editable">
<description>
-Unsets a toolbar style set with gtk_tool_palette_set_style(),
-so that user preferences will be used to determine the toolbar style.
-
-Since: 2.20
+Determines if the user can edit the text in the editable
+widget or not.
</description>
<parameters>
-<parameter name="palette">
-<parameter_description> a #GtkToolPalette
+<parameter name="editable">
+<parameter_description> a #GtkEditable
+</parameter_description>
+</parameter>
+<parameter name="is_editable">
+<parameter_description> %TRUE if the user is allowed to edit the text
+in the widget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_calendar_new">
+<function name="gtk_editable_set_position">
<description>
-Creates a new calendar, with the current date being selected.
+Sets the cursor position in the editable to the given value.
+The cursor is displayed before the character with the given (base 0)
+index in the contents of the editable. The value must be less than or
+equal to the number of characters in the editable. A value of -1
+indicates that the position should be set after the last character
+of the editable. Note that @position is in characters, not in bytes.
</description>
<parameters>
+<parameter name="editable">
+<parameter_description> a #GtkEditable
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> the position of the cursor
+</parameter_description>
+</parameter>
</parameters>
-<return> a newly #GtkCalendar widget
-</return>
+<return></return>
</function>
-<function name="gtk_print_context_set_cairo_context">
+<function name="gtk_entry_append_text">
<description>
-Sets a new cairo context on a print context.
-
-This function is intended to be used when implementing
-an internal print preview, it is not needed for printing,
-since GTK+ itself creates a suitable cairo context in that
-case.
+Appends the given text to the contents of the widget.
-Since: 2.10
+Deprecated: 2.0: Use gtk_editable_insert_text() instead.
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GtkPrintContext
-</parameter_description>
-</parameter>
-<parameter name="cr">
-<parameter_description> the cairo context
-</parameter_description>
-</parameter>
-<parameter name="dpi_x">
-<parameter_description> the horizontal resolution to use with @cr
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
-<parameter name="dpi_y">
-<parameter_description> the vertical resolution to use with @cr
+<parameter name="text">
+<parameter_description> the text to append
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_iter_ends_word">
+<function name="gtk_entry_buffer_delete_text">
<description>
-Determines whether @iter ends a natural-language word. Word breaks
-are determined by Pango and should be correct for nearly any
-language (if not, the correct fix would be to the Pango word break
-algorithms).
+Deletes a sequence of characters from the buffer. @n_chars characters are
+deleted starting at @position. If @n_chars is negative, then all characters
+until the end of the text are deleted.
+If @position or @n_chars are out of bounds, then they are coerced to sane
+values.
+
+Note that the positions are specified in characters, not bytes.
+
+Since: 2.18
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="buffer">
+<parameter_description> a #GtkEntryBuffer
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> position at which to delete text
+</parameter_description>
+</parameter>
+<parameter name="n_chars">
+<parameter_description> number of characters to delete
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter is at the end of a word
+<return> The number of characters deleted.
+
</return>
</function>
-<function name="gtk_recent_info_exists">
+<function name="gtk_entry_buffer_emit_deleted_text">
<description>
-Checks whether the resource pointed by @info still exists. At
-the moment this check is done only on resources pointing to local files.
+Used when subclassing #GtkEntryBuffer
-Since: 2.10
+Since: 2.18
</description>
<parameters>
-<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter name="buffer">
+<parameter_description> a #GtkEntryBuffer
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> position at which text was deleted
+</parameter_description>
+</parameter>
+<parameter name="n_chars">
+<parameter_description> number of characters deleted
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the resource exists
-
-</return>
+<return></return>
</function>
-<function name="gtk_color_selection_set_has_opacity_control">
+<function name="gtk_entry_buffer_emit_inserted_text">
<description>
-Sets the @colorsel to use or not use opacity.
+Used when subclassing #GtkEntryBuffer
+Since: 2.18
</description>
<parameters>
-<parameter name="colorsel">
-<parameter_description> a #GtkColorSelection.
+<parameter name="buffer">
+<parameter_description> a #GtkEntryBuffer
</parameter_description>
</parameter>
-<parameter name="has_opacity">
-<parameter_description> %TRUE if @colorsel can set the opacity, %FALSE otherwise.
+<parameter name="position">
+<parameter_description> position at which text was inserted
+</parameter_description>
+</parameter>
+<parameter name="chars">
+<parameter_description> text that was inserted
+</parameter_description>
+</parameter>
+<parameter name="n_chars">
+<parameter_description> number of characters inserted
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_expander_get_use_markup">
+<function name="gtk_entry_buffer_get_bytes">
<description>
-Returns whether the label's text is interpreted as marked up with
-the <link linkend="PangoMarkupFormat">Pango text markup
-language</link>. See gtk_expander_set_use_markup ().
+Retrieves the length in bytes of the buffer.
+See gtk_entry_buffer_get_length().
-Since: 2.4
+Since: 2.18
</description>
<parameters>
-<parameter name="expander">
-<parameter_description> a #GtkExpander
+<parameter name="buffer">
+<parameter_description> a #GtkEntryBuffer
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the label's text will be parsed for markup
+<return> The byte length of the buffer.
</return>
</function>
-<function name="gtk_icon_view_new">
+<function name="gtk_entry_buffer_get_length">
<description>
-Creates a new #GtkIconView widget
+Retrieves the length in characters of the buffer.
-Since: 2.6
+Since: 2.18
</description>
<parameters>
+<parameter name="buffer">
+<parameter_description> a #GtkEntryBuffer
+</parameter_description>
+</parameter>
</parameters>
-<return> A newly created #GtkIconView widget
+<return> The number of characters in the buffer.
</return>
</function>
-<function name="gtk_entry_completion_get_popup_completion">
+<function name="gtk_entry_buffer_get_max_length">
<description>
-Returns whether the completions should be presented in a popup window.
+Retrieves the maximum allowed length of the text in
+ buffer See gtk_entry_buffer_set_max_length().
-Since: 2.6
+Since: 2.18
</description>
<parameters>
-<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter name="buffer">
+<parameter_description> a #GtkEntryBuffer
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if popup completion is turned on
+<return> the maximum allowed number of characters
+in #GtkEntryBuffer, or 0 if there is no maximum.
</return>
</function>
-<function name="gtk_aspect_frame_set">
+<function name="gtk_entry_buffer_get_text">
<description>
-Set parameters for an existing #GtkAspectFrame.
+Retrieves the contents of the buffer.
+
+The memory pointer returned by this call will not change
+unless this object emits a signal, or is finalized.
+
+Since: 2.18
</description>
<parameters>
-<parameter name="aspect_frame">
-<parameter_description> a #GtkAspectFrame
-</parameter_description>
-</parameter>
-<parameter name="xalign">
-<parameter_description> Horizontal alignment of the child within the allocation of
-the #GtkAspectFrame. This ranges from 0.0 (left aligned)
-to 1.0 (right aligned)
-</parameter_description>
-</parameter>
-<parameter name="yalign">
-<parameter_description> Vertical alignment of the child within the allocation of
-the #GtkAspectFrame. This ranges from 0.0 (left aligned)
-to 1.0 (right aligned)
-</parameter_description>
-</parameter>
-<parameter name="ratio">
-<parameter_description> The desired aspect ratio.
-</parameter_description>
-</parameter>
-<parameter name="obey_child">
-<parameter_description> If %TRUE, @ratio is ignored, and the aspect
-ratio is taken from the requistion of the child.
+<parameter name="buffer">
+<parameter_description> a #GtkEntryBuffer
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a pointer to the contents of the widget as a
+string. This string points to internally allocated
+storage in the buffer and must not be freed, modified or
+stored.
+
+</return>
</function>
-<function name="gtk_container_add_with_properties">
+<function name="gtk_entry_buffer_insert_text">
<description>
-Adds @widget to @container, setting child properties at the same time.
-See gtk_container_add() and gtk_container_child_set() for more details.
+Inserts @n_chars characters of @chars into the contents of the
+buffer, at position @position.
+
+If @n_chars is negative, then characters from chars will be inserted
+until a null-terminator is found. If @position or @n_chars are out of
+bounds, or the maximum buffer text length is exceeded, then they are
+coerced to sane values.
+
+Note that the position and length are in characters, not in bytes.
+
+Since: 2.18
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
+<parameter name="buffer">
+<parameter_description> a #GtkEntryBuffer
</parameter_description>
</parameter>
-<parameter name="widget">
-<parameter_description> a widget to be placed inside @container
+<parameter name="position">
+<parameter_description> the position at which to insert text.
</parameter_description>
</parameter>
-<parameter name="first_prop_name">
-<parameter_description> the name of the first child property to set
+<parameter name="chars">
+<parameter_description> the text to insert into the buffer.
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> a %NULL-terminated list of property names and values, starting
-with @first_prop_name
+<parameter name="n_chars">
+<parameter_description> the length of the text in characters, or -1
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The number of characters actually inserted.
+
+</return>
</function>
-<function name="gtk_accel_map_change_entry">
+<function name="gtk_entry_buffer_new">
<description>
-Changes the @accel_key and @accel_mods currently associated with @accel_path.
-Due to conflicts with other accelerators, a change may not always be possible,
- replace indicates whether other accelerators may be deleted to resolve such
-conflicts. A change will only occur if all conflicts could be resolved (which
-might not be the case if conflicting accelerators are locked). Successful
-changes are indicated by a %TRUE return value.
+Create a new GtkEntryBuffer object.
-Note that @accel_path string will be stored in a #GQuark. Therefore, if you
-pass a static string, you can save some memory by interning it first with
-g_intern_static_string().
+Optionally, specify initial text to set in the buffer.
+
+Since: 2.18
</description>
<parameters>
-<parameter name="accel_path">
-<parameter_description> a valid accelerator path
-</parameter_description>
-</parameter>
-<parameter name="accel_key">
-<parameter_description> the new accelerator key
-</parameter_description>
-</parameter>
-<parameter name="accel_mods">
-<parameter_description> the new accelerator modifiers
+<parameter name="initial_chars">
+<parameter_description> initial buffer text, or %NULL
</parameter_description>
</parameter>
-<parameter name="replace">
-<parameter_description> %TRUE if other accelerators may be deleted upon conflicts
+<parameter name="n_initial_chars">
+<parameter_description> number of characters in @initial_chars, or -1
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the accelerator could be changed, %FALSE otherwise
+<return> A new GtkEntryBuffer object.
+
</return>
</function>
-<function name="gtk_container_set_resize_mode">
+<function name="gtk_entry_buffer_set_max_length">
<description>
-Sets the resize mode for the container.
+Sets the maximum allowed length of the contents of the buffer. If
+the current contents are longer than the given length, then they
+will be truncated to fit.
-The resize mode of a container determines whether a resize request
-will be passed to the container's parent, queued for later execution
-or executed immediately.
+Since: 2.18
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
+<parameter name="buffer">
+<parameter_description> a #GtkEntryBuffer
</parameter_description>
</parameter>
-<parameter name="resize_mode">
-<parameter_description> the new resize mode
+<parameter name="max_length">
+<parameter_description> the maximum length of the entry buffer, or 0 for no maximum.
+(other than the maximum length of entries.) The value passed in will
+be clamped to the range 0-65536.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_get_has_frame">
+<function name="gtk_entry_buffer_set_text">
<description>
-Accessor for whether the window has a frame window exterior to
- window->window. Gets the value set by gtk_window_set_has_frame ().
+Sets the text in the buffer.
+This is roughly equivalent to calling gtk_entry_buffer_delete_text()
+and gtk_entry_buffer_insert_text().
-</description>
-<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
-</parameter_description>
-</parameter>
-</parameters>
-<return> %TRUE if a frame has been added to the window
-via gtk_window_set_has_frame().
-</return>
-</function>
+Note that @n_chars is in characters, not in bytes.
-<function name="gtk_clipboard_set_text">
-<description>
-Sets the contents of the clipboard to the given UTF-8 string. GTK+ will
-make a copy of the text and take responsibility for responding
-for requests for the text, and for converting the text into
-the requested format.
+Since: 2.18
</description>
<parameters>
-<parameter name="clipboard">
-<parameter_description> a #GtkClipboard object
+<parameter name="buffer">
+<parameter_description> a #GtkEntryBuffer
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> a UTF-8 string.
+<parameter name="chars">
+<parameter_description> the new text
</parameter_description>
</parameter>
-<parameter name="len">
-<parameter_description> length of @text, in bytes, or -1, in which case
-the length will be determined with <function>strlen()</function>.
+<parameter name="n_chars">
+<parameter_description> the number of characters in @text, or -1
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_toolbar_append_space">
+<function name="gtk_entry_completion_complete">
<description>
-Adds a new space to the end of the toolbar.
+Requests a completion operation, or in other words a refiltering of the
+current list with completions, using the current key. The completion list
+view will be updated accordingly.
-Deprecated: 2.4: Use gtk_toolbar_insert() instead.
+Since: 2.4
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar.
+<parameter name="completion">
+<parameter_description> A #GtkEntryCompletion.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_pop_colormap">
-<description>
-Removes a colormap pushed with gtk_widget_push_colormap().
-
-</description>
-<parameters>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_range_set_lower_stepper_sensitivity">
+<function name="gtk_entry_completion_delete_action">
<description>
-Sets the sensitivity policy for the stepper that points to the
-'lower' end of the GtkRange's adjustment.
+Deletes the action at @index_ from @completion's action list.
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter name="completion">
+<parameter_description> A #GtkEntryCompletion.
</parameter_description>
</parameter>
-<parameter name="sensitivity">
-<parameter_description> the lower stepper's sensitivity policy.
+<parameter name="index_">
+<parameter_description> The index of the item to Delete.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_rc_get_style">
+<function name="gtk_entry_completion_get_completion_prefix">
<description>
-Finds all matching RC styles for a given widget,
-composites them together, and then creates a
-#GtkStyle representing the composite appearance.
-(GTK+ actually keeps a cache of previously
-created styles, so a new style may not be
-created.)
+Get the original text entered by the user that triggered
+the completion or %NULL if there's no completion ongoing.
+Since: 2.12
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="completion">
+<parameter_description> a #GtkEntryCompletion
</parameter_description>
</parameter>
</parameters>
-<return> the resulting style. No refcount is added
-to the returned style, so if you want to save this
-style around, you should add a reference yourself.
+<return> the prefix for the current completion
+
</return>
</function>
-<function name="gtk_text_mark_get_name">
+<function name="gtk_entry_completion_get_entry">
<description>
-Returns the mark name; returns NULL for anonymous marks.
+Gets the entry @completion has been attached to.
+Since: 2.4
</description>
<parameters>
-<parameter name="mark">
-<parameter_description> a #GtkTextMark
+<parameter name="completion">
+<parameter_description> A #GtkEntryCompletion.
</parameter_description>
</parameter>
</parameters>
-<return> mark name
+<return> The entry @completion has been attached to.
+
</return>
</function>
-<function name="gtk_icon_set_copy">
+<function name="gtk_entry_completion_get_inline_completion">
<description>
-Copies @icon_set by value.
+Returns whether the common prefix of the possible completions should
+be automatically inserted in the entry.
+Since: 2.6
</description>
<parameters>
-<parameter name="icon_set">
-<parameter_description> a #GtkIconSet
+<parameter name="completion">
+<parameter_description> a #GtkEntryCompletion
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkIconSet identical to the first.
+<return> %TRUE if inline completion is turned on
+
</return>
</function>
-<function name="gtk_recent_chooser_get_show_tips">
+<function name="gtk_entry_completion_get_inline_selection">
<description>
-Gets whether @chooser should display tooltips containing the full path
-of a recently user resource.
+Returns %TRUE if inline-selection mode is turned on.
-Since: 2.10
+Since: 2.12
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
+<parameter name="completion">
+<parameter_description> a #GtkEntryCompletion
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the recent chooser should show tooltips,
-%FALSE otherwise.
+<return> %TRUE if inline-selection mode is on
</return>
</function>
-<function name="gtk_printer_list_papers">
+<function name="gtk_entry_completion_get_minimum_key_length">
<description>
-Lists all the paper sizes @printer supports.
-This will return and empty list unless the printer's details are
-available, see gtk_printer_has_details() and gtk_printer_request_details().
+Returns the minimum key length as set for @completion.
-Since: 2.12
+Since: 2.4
</description>
<parameters>
-<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter name="completion">
+<parameter_description> A #GtkEntryCompletion.
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated list of newly allocated #GtkPageSetup s.
+<return> The currently used minimum key length.
</return>
</function>
-<function name="gtk_print_operation_set_job_name">
+<function name="gtk_entry_completion_get_model">
<description>
-Sets the name of the print job. The name is used to identify
-the job (e.g. in monitoring applications like eggcups).
-
-If you don't set a job name, GTK+ picks a default one by
-numbering successive print jobs.
+Returns the model the #GtkEntryCompletion is using as data source.
+Returns %NULL if the model is unset.
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkPrintOperation
-</parameter_description>
-</parameter>
-<parameter name="job_name">
-<parameter_description> a string that identifies the print job
+<parameter name="completion">
+<parameter_description> A #GtkEntryCompletion.
</parameter_description>
</parameter>
</parameters>
-<return></return>
-</function>
-
-<function name="gtk_text_buffer_place_cursor">
-<description>
-This function moves the "insert" and "selection_bound" marks
-simultaneously. If you move them to the same place in two steps
-with gtk_text_buffer_move_mark(), you will temporarily select a
-region in between their old and new locations, which can be pretty
-inefficient since the temporarily-selected region will force stuff
-to be recalculated. This function moves them as a unit, which can
-be optimized.
+<return> A #GtkTreeModel, or %NULL if none
+is currently being used.
-</description>
-<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="where">
-<parameter_description> where to put the cursor
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
+</return>
</function>
-<function name="gtk_font_button_get_show_size">
+<function name="gtk_entry_completion_get_popup_completion">
<description>
-Returns whether the font size will be shown in the label.
+Returns whether the completions should be presented in a popup window.
-Since: 2.4
+Since: 2.6
</description>
<parameters>
-<parameter name="font_button">
-<parameter_description> a #GtkFontButton
+<parameter name="completion">
+<parameter_description> a #GtkEntryCompletion
</parameter_description>
</parameter>
</parameters>
-<return> whether the font size will be shown in the label.
+<return> %TRUE if popup completion is turned on
</return>
</function>
-<function name="gtk_test_spin_button_click">
+<function name="gtk_entry_completion_get_popup_set_width">
<description>
-This function will generate a @button click in the upwards or downwards
-spin button arrow areas, usually leading to an increase or decrease of
-spin button's value.
+Returns whether the completion popup window will be resized to the
+width of the entry.
-Since: 2.14
+Since: 2.8
</description>
<parameters>
-<parameter name="spinner">
-<parameter_description> valid GtkSpinButton widget.
-</parameter_description>
-</parameter>
-<parameter name="button">
-<parameter_description> Number of the pointer button for the event, usually 1, 2 or 3.
-</parameter_description>
-</parameter>
-<parameter name="upwards">
-<parameter_description> %TRUE for upwards arrow click, %FALSE for downwards arrow click.
+<parameter name="completion">
+<parameter_description> a #GtkEntryCompletion
</parameter_description>
</parameter>
</parameters>
-<return> wether all actions neccessary for the button click simulation were carried out successfully.
+<return> %TRUE if the popup window will be resized to the width of
+the entry
</return>
</function>
-<function name="gtk_notebook_get_group_id">
+<function name="gtk_entry_completion_get_popup_single_match">
<description>
-Gets the current group identificator for @notebook.
+Returns whether the completion popup window will appear even if there is
+only a single match.
-Since: 2.10
-Deprecated: 2.12: use gtk_notebook_get_group() instead.
+Since: 2.8
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="completion">
+<parameter_description> a #GtkEntryCompletion
</parameter_description>
</parameter>
</parameters>
-<return> the group identificator, or -1 if none is set.
+<return> %TRUE if the popup window will appear regardless of the
+number of matches.
</return>
</function>
-<function name="gtk_tree_selection_get_tree_view">
+<function name="gtk_entry_completion_get_text_column">
<description>
-Returns the tree view associated with @selection.
+Returns the column in the model of @completion to get strings from.
+Since: 2.6
</description>
<parameters>
-<parameter name="selection">
-<parameter_description> A #GtkTreeSelection
+<parameter name="completion">
+<parameter_description> a #GtkEntryCompletion
</parameter_description>
</parameter>
</parameters>
-<return> A #GtkTreeView
+<return> the column containing the strings
+
</return>
</function>
-<function name="gtk_list_store_set_valuesv">
+<function name="gtk_entry_completion_insert_action_markup">
<description>
-A variant of gtk_list_store_set_valist() which
-takes the columns and values as two arrays, instead of
-varargs. This function is mainly intended for
-language-bindings and in case the number of columns to
-change is not known until run-time.
+Inserts an action in @completion's action item list at position @index_
+with markup @markup.
-Since: 2.12
+Since: 2.4
</description>
<parameters>
-<parameter name="list_store">
-<parameter_description> A #GtkListStore
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> A valid #GtkTreeIter for the row being modified
-</parameter_description>
-</parameter>
-<parameter name="columns">
-<parameter_description> an array of column numbers
+<parameter name="completion">
+<parameter_description> A #GtkEntryCompletion.
</parameter_description>
</parameter>
-<parameter name="values">
-<parameter_description> an array of GValues
+<parameter name="index_">
+<parameter_description> The index of the item to insert.
</parameter_description>
</parameter>
-<parameter name="n_values">
-<parameter_description> the length of the @columns and @values arrays
+<parameter name="markup">
+<parameter_description> Markup of the item to insert.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_assistant_set_page_title">
+<function name="gtk_entry_completion_insert_action_text">
<description>
-Sets a title for @page. The title is displayed in the header
-area of the assistant when @page is the current page.
+Inserts an action in @completion's action item list at position @index_
+with text @text. If you want the action item to have markup, use
+gtk_entry_completion_insert_action_markup().
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter name="completion">
+<parameter_description> A #GtkEntryCompletion.
</parameter_description>
</parameter>
-<parameter name="page">
-<parameter_description> a page of @assistant
+<parameter name="index_">
+<parameter_description> The index of the item to insert.
</parameter_description>
</parameter>
-<parameter name="title">
-<parameter_description> the new title for @page
+<parameter name="text">
+<parameter_description> Text of the item to insert.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_draw">
+<function name="gtk_entry_completion_insert_prefix">
<description>
-In GTK+ 1.2, this function would immediately render the
-region @area of a widget, by invoking the virtual draw method of a
-widget. In GTK+ 2.0, the draw method is gone, and instead
-gtk_widget_draw() simply invalidates the specified region of the
-widget, then updates the invalid region of the widget immediately.
-Usually you don't want to update the region immediately for
-performance reasons, so in general gtk_widget_queue_draw_area() is
-a better choice if you want to draw a region of a widget.
+Requests a prefix insertion.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="area">
-<parameter_description> area to draw
+<parameter name="completion">
+<parameter_description> a #GtkEntryCompletion
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_toggle_button_set_inconsistent">
+<function name="gtk_entry_completion_new">
<description>
-If the user has selected a range of elements (such as some text or
-spreadsheet cells) that are affected by a toggle button, and the
-current values in that range are inconsistent, you may want to
-display the toggle in an "in between" state. This function turns on
-"in between" display. Normally you would turn off the inconsistent
-state again if the user toggles the toggle button. This has to be
-done manually, gtk_toggle_button_set_inconsistent() only affects
-visual appearance, it doesn't affect the semantics of the button.
+Creates a new #GtkEntryCompletion object.
+Since: 2.4
</description>
<parameters>
-<parameter name="toggle_button">
-<parameter_description> a #GtkToggleButton
+</parameters>
+<return> A newly created #GtkEntryCompletion object.
+
+</return>
+</function>
+
+<function name="gtk_entry_completion_set_inline_completion">
+<description>
+Sets whether the common prefix of the possible completions should
+be automatically inserted in the entry.
+
+Since: 2.6
+
+</description>
+<parameters>
+<parameter name="completion">
+<parameter_description> a #GtkEntryCompletion
</parameter_description>
</parameter>
-<parameter name="setting">
-<parameter_description> %TRUE if state is inconsistent
+<parameter name="inline_completion">
+<parameter_description> %TRUE to do inline completion
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_file_chooser_button_get_width_chars">
+<function name="gtk_entry_completion_set_inline_selection">
<description>
-Retrieves the width in characters of the @button widget's entry and/or label.
+Sets whether it is possible to cycle through the possible completions
+inside the entry.
-Since: 2.6
+Since: 2.12
</description>
<parameters>
-<parameter name="button">
-<parameter_description> the button widget to examine.
+<parameter name="completion">
+<parameter_description> a #GtkEntryCompletion
+</parameter_description>
+</parameter>
+<parameter name="inline_selection">
+<parameter_description> %TRUE to do inline selection
</parameter_description>
</parameter>
</parameters>
-<return> an integer width (in characters) that the button will use to size itself.
-
-</return>
+<return></return>
</function>
-<function name="gtk_cell_renderer_set_padding">
+<function name="gtk_entry_completion_set_match_func">
<description>
-Sets the renderer's padding.
+Sets the match function for @completion to be @func. The match function
+is used to determine if a row should or should not be in the completion
+list.
-Since: 2.18
+Since: 2.4
</description>
<parameters>
-<parameter name="cell">
-<parameter_description> A #GtkCellRenderer
+<parameter name="completion">
+<parameter_description> A #GtkEntryCompletion.
</parameter_description>
</parameter>
-<parameter name="xpad">
-<parameter_description> the x padding of the cell renderer
+<parameter name="func">
+<parameter_description> The #GtkEntryCompletionMatchFunc to use.
</parameter_description>
</parameter>
-<parameter name="ypad">
-<parameter_description> the y padding of the cell renderer
+<parameter name="func_data">
+<parameter_description> The user data for @func.
+</parameter_description>
+</parameter>
+<parameter name="func_notify">
+<parameter_description> Destroy notifier for @func_data.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_cell_view_new_with_markup">
+<function name="gtk_entry_completion_set_minimum_key_length">
<description>
-Creates a new #GtkCellView widget, adds a #GtkCellRendererText
-to it, and makes it show @markup. The text can be
-marked up with the <link linkend="PangoMarkupFormat">Pango text
-markup language</link>.
+Requires the length of the search key for @completion to be at least
+ length This is useful for long lists, where completing using a small
+key takes a lot of time and will come up with meaningless results anyway
+(ie, a too large dataset).
-Since: 2.6
+Since: 2.4
</description>
<parameters>
-<parameter name="markup">
-<parameter_description> the text to display in the cell view
+<parameter name="completion">
+<parameter_description> A #GtkEntryCompletion.
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> The minimum length of the key in order to start completing.
</parameter_description>
</parameter>
</parameters>
-<return> A newly created #GtkCellView widget.
-
-</return>
+<return></return>
</function>
-<function name="gtk_file_chooser_select_all">
+<function name="gtk_entry_completion_set_model">
<description>
-Selects all the files in the current folder of a file chooser.
+Sets the model for a #GtkEntryCompletion. If @completion already has
+a model set, it will remove it before setting the new model.
+If model is %NULL, then it will unset the model.
Since: 2.4
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="completion">
+<parameter_description> A #GtkEntryCompletion.
+</parameter_description>
+</parameter>
+<parameter name="model">
+<parameter_description> The #GtkTreeModel.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_about_dialog_get_logo">
+<function name="gtk_entry_completion_set_popup_completion">
<description>
-Returns the pixbuf displayed as logo in the about dialog.
+Sets whether the completions should be presented in a popup window.
Since: 2.6
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter name="completion">
+<parameter_description> a #GtkEntryCompletion
+</parameter_description>
+</parameter>
+<parameter name="popup_completion">
+<parameter_description> %TRUE to do popup completion
</parameter_description>
</parameter>
</parameters>
-<return> the pixbuf displayed as logo. The pixbuf is
-owned by the about dialog. If you want to keep a reference
-to it, you have to call g_object_ref() on it.
-
-</return>
+<return></return>
</function>
-<function name="gtk_widget_set_extension_events">
+<function name="gtk_entry_completion_set_popup_set_width">
<description>
-Sets the extension events mask to @mode. See #GdkExtensionMode
-and gdk_input_set_extension_events().
+Sets whether the completion popup window will be resized to be the same
+width as the entry.
+
+Since: 2.8
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="completion">
+<parameter_description> a #GtkEntryCompletion
</parameter_description>
</parameter>
-<parameter name="mode">
-<parameter_description> bitfield of extension events to receive
+<parameter name="popup_set_width">
+<parameter_description> %TRUE to make the width of the popup the same as the entry
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_settings_get_length">
+<function name="gtk_entry_completion_set_popup_single_match">
<description>
-Returns the value associated with @key, interpreted
-as a length. The returned value is converted to @units.
+Sets whether the completion popup window will appear even if there is
+only a single match. You may want to set this to %FALSE if you
+are using <link linkend="GtkEntryCompletion--inline-completion">inline
+completion</link>.
-Since: 2.10
+Since: 2.8
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
+<parameter name="completion">
+<parameter_description> a #GtkEntryCompletion
</parameter_description>
</parameter>
-<parameter name="unit">
-<parameter_description> the unit of the return value
+<parameter name="popup_single_match">
+<parameter_description> %TRUE if the popup should appear even for a single
+match
</parameter_description>
</parameter>
</parameters>
-<return> the length value of @key, converted to @unit
-
-</return>
+<return></return>
</function>
-<function name="gtk_action_create_tool_item">
+<function name="gtk_entry_completion_set_text_column">
<description>
-Creates a toolbar item widget that proxies for the given action.
+Convenience function for setting up the most used case of this code: a
+completion list with just strings. This function will set up @completion
+to have a list displaying all (and just) strings in the completion list,
+and to get those strings from @column in the model of @completion.
+
+This functions creates and adds a #GtkCellRendererText for the selected
+column. If you need to set the text column, but don't want the cell
+renderer, use g_object_set() to set the ::text_column property directly.
Since: 2.4
</description>
<parameters>
-<parameter name="action">
-<parameter_description> the action object
+<parameter name="completion">
+<parameter_description> A #GtkEntryCompletion.
+</parameter_description>
+</parameter>
+<parameter name="column">
+<parameter_description> The column in the model of @completion to get strings from.
</parameter_description>
</parameter>
</parameters>
-<return> a toolbar item connected to the action.
-
-</return>
+<return></return>
</function>
-<function name="gtk_print_settings_get">
+<function name="gtk_entry_get_activates_default">
<description>
-Looks up the string value associated with @key.
+Retrieves the value set by gtk_entry_set_activates_default().
-Since: 2.10
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
</parameters>
-<return> the string value for @key
-
+<return> %TRUE if the entry will activate the default widget
</return>
</function>
-<function name="gtk_text_view_get_iter_at_location">
+<function name="gtk_entry_get_alignment">
<description>
-Retrieves the iterator at buffer coordinates @x and @y. Buffer
-coordinates are coordinates for the entire buffer, not just the
-currently-displayed portion. If you have coordinates from an
-event, you have to convert those to buffer coordinates with
-gtk_text_view_window_to_buffer_coords().
+Gets the value set by gtk_entry_set_alignment().
+
+Since: 2.4
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> x position, in buffer coordinates
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> y position, in buffer coordinates
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the alignment
+
+</return>
</function>
-<function name="gtk_print_unix_dialog_add_custom_tab">
+<function name="gtk_entry_get_buffer">
<description>
-Adds a custom tab to the print dialog.
+Get the #GtkEntryBuffer object which holds the text for
+this widget.
+
+Since: 2.18
-Since: 2.10
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
-</parameter_description>
-</parameter>
-<parameter name="child">
-<parameter_description> the widget to put in the custom tab
-</parameter_description>
-</parameter>
-<parameter name="tab_label">
-<parameter_description> the widget to use as tab label
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A #GtkEntryBuffer object.
+</return>
</function>
-<function name="gtk_test_find_label">
+<function name="gtk_entry_get_completion">
<description>
-This function will search @widget and all its descendants for a GtkLabel
-widget with a text string matching @label_pattern.
-The @label_pattern may contain asterisks '*' and question marks '?' as
-placeholders, g_pattern_match() is used for the matching.
-Note that locales other than "C" tend to alter (translate" label strings,
-so this function is genrally only useful in test programs with
-predetermined locales, see gtk_test_init() for more details.
+Returns the auxiliary completion object currently in use by @entry.
-Since: 2.14
+Since: 2.4
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> Valid label or container widget.
-</parameter_description>
-</parameter>
-<parameter name="label_pattern">
-<parameter_description> Shell-glob pattern to match a label string.
+<parameter name="entry">
+<parameter_description> A #GtkEntry
</parameter_description>
</parameter>
</parameters>
-<return> a GtkLabel widget if any is found.
+<return> The auxiliary completion object currently
+in use by @entry.
</return>
</function>
-<function name="gtk_window_has_group">
+<function name="gtk_entry_get_current_icon_drag_source">
<description>
-Returns whether @window has an explicit window group.
+Returns the index of the icon which is the source of the current
+DND operation, or -1.
+This function is meant to be used in a #GtkWidget::drag-data-get
+callback.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="entry">
+<parameter_description> a #GtkIconEntry
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @window has an explicit window group.
+<return> index of the icon which is the source of the current
+DND operation, or -1.
-Since 2.22
</return>
</function>
-<function name="gtk_text_view_set_pixels_below_lines">
+<function name="gtk_entry_get_cursor_hadjustment">
<description>
-Sets the default number of pixels of blank space
-to put below paragraphs in @text_view. May be overridden
-by tags applied to @text_view's buffer.
+Retrieves the horizontal cursor adjustment for the entry.
+See gtk_entry_set_cursor_hadjustment().
+
+Since: 2.12
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
-</parameter_description>
-</parameter>
-<parameter name="pixels_below_lines">
-<parameter_description> pixels below paragraphs
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the horizontal cursor adjustment, or %NULL
+if none has been set.
+
+</return>
</function>
-<function name="gtk_icon_source_set_filename">
+<function name="gtk_entry_get_has_frame">
<description>
-Sets the name of an image file to use as a base image when creating
-icon variants for #GtkIconSet. The filename must be absolute.
+Gets the value set by gtk_entry_set_has_frame().
+
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GtkIconSource
-</parameter_description>
-</parameter>
-<parameter name="filename">
-<parameter_description> image file to use
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether the entry has a beveled frame
+</return>
</function>
-<function name="gtk_file_chooser_set_create_folders">
+<function name="gtk_entry_get_icon_activatable">
<description>
-Sets whether file choser will offer to create new folders.
-This is only relevant if the action is not set to be
-%GTK_FILE_CHOOSER_ACTION_OPEN.
+Returns whether the icon is activatable.
-Since: 2.18
+Since: 2.16
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
-<parameter name="create_folders">
-<parameter_description> %TRUE if the New Folder button should be displayed
+<parameter name="icon_pos">
+<parameter_description> Icon position
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the icon is activatable.
+
+</return>
</function>
-<function name="gtk_widget_set_size_request">
+<function name="gtk_entry_get_icon_at_pos">
<description>
-Sets the minimum size of a widget; that is, the widget's size
-request will be @width by @height. You can use this function to
-force a widget to be either larger or smaller than it normally
-would be.
-
-In most cases, gtk_window_set_default_size() is a better choice for
-toplevel windows than this function; setting the default size will
-still allow users to shrink the window. Setting the size request
-will force them to leave the window at least as large as the size
-request. When dealing with window sizes,
-gtk_window_set_geometry_hints() can be a useful function as well.
-
-Note the inherent danger of setting any fixed size - themes,
-translations into other languages, different fonts, and user action
-can all change the appropriate size for a given widget. So, it's
-basically impossible to hardcode a size that will always be
-correct.
-
-The size request of a widget is the smallest size a widget can
-accept while still functioning well and drawing itself correctly.
-However in some strange cases a widget may be allocated less than
-its requested size, and in many cases a widget may be allocated more
-space than it requested.
-
-If the size request in a given direction is -1 (unset), then
-the "natural" size request of the widget will be used instead.
+Finds the icon at the given position and return its index.
+If @x, @y doesn't lie inside an icon, -1 is returned.
+This function is intended for use in a #GtkWidget::query-tooltip
+signal handler.
-Widgets can't actually be allocated a size less than 1 by 1, but
-you can pass 0,0 to this function to mean "as small as possible."
+Since: 2.16
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> width @widget should request, or -1 to unset
+<parameter name="x">
+<parameter_description> the x coordinate of the position to find
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> height @widget should request, or -1 to unset
+<parameter name="y">
+<parameter_description> the y coordinate of the position to find
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the index of the icon at the given position, or -1
+
+</return>
</function>
-<function name="gtk_recent_chooser_set_limit">
+<function name="gtk_entry_get_icon_gicon">
<description>
-Sets the number of items that should be returned by
-gtk_recent_chooser_get_items() and gtk_recent_chooser_get_uris().
+Retrieves the #GIcon used for the icon, or %NULL if there is
+no icon or if the icon was set by some other method (e.g., by
+stock, pixbuf, or icon name).
-Since: 2.10
+Since: 2.16
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
+<parameter name="entry">
+<parameter_description> A #GtkEntry
</parameter_description>
</parameter>
-<parameter name="limit">
-<parameter_description> a positive integer, or -1 for all items
+<parameter name="icon_pos">
+<parameter_description> Icon position
</parameter_description>
</parameter>
</parameters>
-<return></return>
-</function>
+<return> A #GIcon, or %NULL if no icon is set
+or if the icon is not a #GIcon
-<function name="gtk_paint_vline">
-<description>
-Draws a vertical line from (@x, @y1_) to (@x, @y2_) in @window
-using the given style and state.
-
-</description>
-<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
-</parameter_description>
-</parameter>
-<parameter name="area">
-<parameter_description> rectangle to which the output is clipped, or %NULL if the
-output should not be clipped
-</parameter_description>
-</parameter>
-<parameter name="widget">
-<parameter_description> the widget
-</parameter_description>
-</parameter>
-<parameter name="detail">
-<parameter_description> a style detail
-</parameter_description>
-</parameter>
-<parameter name="y1_">
-<parameter_description> the starting y coordinate
-</parameter_description>
-</parameter>
-<parameter name="y2_">
-<parameter_description> the ending y coordinate
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> the x coordinate
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
+</return>
</function>
<function name="gtk_entry_get_icon_name">
@@ -14820,106 +15007,108 @@ wasn't set from an icon name
</return>
</function>
-<function name="gtk_menu_set_accel_path">
+<function name="gtk_entry_get_icon_pixbuf">
<description>
-Sets an accelerator path for this menu from which accelerator paths
-for its immediate children, its menu items, can be constructed.
-The main purpose of this function is to spare the programmer the
-inconvenience of having to call gtk_menu_item_set_accel_path() on
-each menu item that should support runtime user changable accelerators.
-Instead, by just calling gtk_menu_set_accel_path() on their parent,
-each menu item of this menu, that contains a label describing its purpose,
-automatically gets an accel path assigned. For example, a menu containing
-menu items "New" and "Exit", will, after
-<literal>gtk_menu_set_accel_path (menu, "<Gnumeric-Sheet>/File");</literal>
-has been called, assign its items the accel paths:
-<literal>"<Gnumeric-Sheet>/File/New"</literal> and <literal>"<Gnumeric-Sheet>/File/Exit"</literal>.
-Assigning accel paths to menu items then enables the user to change
-their accelerators at runtime. More details about accelerator paths
-and their default setups can be found at gtk_accel_map_add_entry().
+Retrieves the image used for the icon.
-Note that @accel_path string will be stored in a #GQuark. Therefore, if you
-pass a static string, you can save some memory by interning it first with
-g_intern_static_string().
+Unlike the other methods of setting and getting icon data, this
+method will work regardless of whether the icon was set using a
+#GdkPixbuf, a #GIcon, a stock item, or an icon name.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="menu">
-<parameter_description> a valid #GtkMenu
+<parameter name="entry">
+<parameter_description> A #GtkEntry
</parameter_description>
</parameter>
-<parameter name="accel_path">
-<parameter_description> a valid accelerator path
+<parameter name="icon_pos">
+<parameter_description> Icon position
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A #GdkPixbuf, or %NULL if no icon is
+set for this position.
+
+</return>
</function>
-<function name="gtk_progress_bar_pulse">
+<function name="gtk_entry_get_icon_sensitive">
<description>
-Indicates that some progress is made, but you don't know how much.
-Causes the progress bar to enter "activity mode," where a block
-bounces back and forth. Each call to gtk_progress_bar_pulse()
-causes the block to move by a little bit (the amount of movement
-per pulse is determined by gtk_progress_bar_set_pulse_step()).
+Returns whether the icon appears sensitive or insensitive.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="pbar">
-<parameter_description> a #GtkProgressBar
+<parameter name="entry">
+<parameter_description> a #GtkEntry
+</parameter_description>
+</parameter>
+<parameter name="icon_pos">
+<parameter_description> Icon position
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the icon is sensitive.
+
+</return>
</function>
-<function name="gtk_spin_button_get_range">
+<function name="gtk_entry_get_icon_stock">
<description>
-Gets the range allowed for @spin_button. See
-gtk_spin_button_set_range().
+Retrieves the stock id used for the icon, or %NULL if there is
+no icon or if the icon was set by some other method (e.g., by
+pixbuf, icon name or gicon).
+
+Since: 2.16
</description>
<parameters>
-<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
-</parameter_description>
-</parameter>
-<parameter name="min">
-<parameter_description> location to store minimum allowed value, or %NULL
+<parameter name="entry">
+<parameter_description> A #GtkEntry
</parameter_description>
</parameter>
-<parameter name="max">
-<parameter_description> location to store maximum allowed value, or %NULL
+<parameter name="icon_pos">
+<parameter_description> Icon position
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A stock id, or %NULL if no icon is set or if the icon
+wasn't set from a stock id
+
+</return>
</function>
-<function name="gtk_label_set_single_line_mode">
+<function name="gtk_entry_get_icon_storage_type">
<description>
-Sets whether the label is in single line mode.
+Gets the type of representation being used by the icon
+to store image data. If the icon has no image data,
+the return value will be %GTK_IMAGE_EMPTY.
-Since: 2.6
+Since: 2.16
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
-<parameter name="single_line_mode">
-<parameter_description> %TRUE if the label should be in single line mode
+<parameter name="icon_pos">
+<parameter_description> Icon position
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> image representation being used
+
+</return>
</function>
-<function name="gtk_entry_get_progress_pulse_step">
+<function name="gtk_entry_get_icon_tooltip_markup">
<description>
-Retrieves the pulse step set with gtk_entry_set_progress_pulse_step().
+Gets the contents of the tooltip on the icon at the specified
+position in @entry.
Since: 2.16
@@ -14929,1066 +15118,1168 @@ Since: 2.16
<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
+<parameter name="icon_pos">
+<parameter_description> the icon position
+</parameter_description>
+</parameter>
</parameters>
-<return> a fraction from 0.0 to 1.0
+<return> the tooltip text, or %NULL. Free the returned string
+with g_free() when done.
</return>
</function>
-<function name="gtk_table_get_default_col_spacing">
+<function name="gtk_entry_get_icon_tooltip_text">
<description>
-Gets the default column spacing for the table. This is
-the spacing that will be used for newly added columns.
-(See gtk_table_set_col_spacings())
+Gets the contents of the tooltip on the icon at the specified
+position in @entry.
+Since: 2.16
</description>
<parameters>
-<parameter name="table">
-<parameter_description> a #GtkTable
+<parameter name="entry">
+<parameter_description> a #GtkEntry
+</parameter_description>
+</parameter>
+<parameter name="icon_pos">
+<parameter_description> the icon position
</parameter_description>
</parameter>
</parameters>
-<return> the default column spacing
+<return> the tooltip text, or %NULL. Free the returned string
+with g_free() when done.
+
</return>
</function>
-<function name="gtk_widget_style_attach">
+<function name="gtk_entry_get_icon_window">
<description>
-This function attaches the widget's #GtkStyle to the widget's
-#GdkWindow. It is a replacement for
-
-<programlisting>
-widget->style = gtk_style_attach (widget->style, widget->window);
-</programlisting>
+Returns the #GdkWindow which contains the entry's icon at
+ icon_pos This function is useful when drawing something to the
+entry in an expose-event callback because it enables the callback
+to distinguish between the text window and entry's icon windows.
-and should only ever be called in a derived widget's "realize"
-implementation which does not chain up to its parent class'
-"realize" implementation, because one of the parent classes
-(finally #GtkWidget) would attach the style itself.
+See also gtk_entry_get_text_window().
Since: 2.20
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="entry">
+<parameter_description> A #GtkEntry
+</parameter_description>
+</parameter>
+<parameter name="icon_pos">
+<parameter_description> Icon position
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the entry's icon window at @icon_pos.
+
+</return>
</function>
-<function name="gtk_paper_size_is_equal">
+<function name="gtk_entry_get_inner_border">
<description>
-Compares two #GtkPaperSize objects.
+This function returns the entry's #GtkEntry:inner-border property. See
+gtk_entry_set_inner_border() for more information.
Since: 2.10
</description>
<parameters>
-<parameter name="size1">
-<parameter_description> a #GtkPaperSize object
-</parameter_description>
-</parameter>
-<parameter name="size2">
-<parameter_description> another #GtkPaperSize object
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE, if @size1 and @size2
-represent the same paper size
+<return> the entry's #GtkBorder, or %NULL if none was set.
</return>
</function>
-<function name="gtk_item_factory_from_path">
+<function name="gtk_entry_get_invisible_char">
<description>
-Finds an item factory which has been constructed using the
-<literal>"<name>"</literal> prefix of @path as the @path argument
-for gtk_item_factory_new().
+Retrieves the character displayed in place of the real characters
+for entries with visibility set to false. See gtk_entry_set_invisible_char().
-Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="path">
-<parameter_description> a string starting with a factory path of the form
-<literal>"<name>"</literal>
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkItemFactory created for the given factory path, or %NULL
+<return> the current invisible char, or 0, if the entry does not
+show invisible text at all.
</return>
</function>
-<function name="gtk_recent_chooser_menu_new">
+<function name="gtk_entry_get_layout">
<description>
-Creates a new #GtkRecentChooserMenu widget.
-
-This kind of widget shows the list of recently used resources as
-a menu, each item as a menu item. Each item inside the menu might
-have an icon, representing its MIME type, and a number, for mnemonic
-access.
-
-This widget implements the #GtkRecentChooser interface.
+Gets the #PangoLayout used to display the entry.
+The layout is useful to e.g. convert text positions to
+pixel positions, in combination with gtk_entry_get_layout_offsets().
+The returned layout is owned by the entry and must not be
+modified or freed by the caller.
-This widget creates its own #GtkRecentManager object. See the
-gtk_recent_chooser_menu_new_for_manager() function to know how to create
-a #GtkRecentChooserMenu widget bound to another #GtkRecentManager object.
+Keep in mind that the layout text may contain a preedit string, so
+gtk_entry_layout_index_to_text_index() and
+gtk_entry_text_index_to_layout_index() are needed to convert byte
+indices in the layout to byte indices in the entry contents.
-Since: 2.10
</description>
<parameters>
+<parameter name="entry">
+<parameter_description> a #GtkEntry
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GtkRecentChooserMenu
-
+<return> the #PangoLayout for this entry
</return>
</function>
-<function name="gtk_text_view_get_window">
+<function name="gtk_entry_get_layout_offsets">
<description>
-Retrieves the #GdkWindow corresponding to an area of the text view;
-possible windows include the overall widget window, child windows
-on the left, right, top, bottom, and the window that displays the
-text buffer. Windows are %NULL and nonexistent if their width or
-height is 0, and are nonexistent before the widget has been
-realized.
+Obtains the position of the #PangoLayout used to render text
+in the entry, in widget coordinates. Useful if you want to line
+up the text in an entry with some other text, e.g. when using the
+entry to implement editable cells in a sheet widget.
+
+Also useful to convert mouse events into coordinates inside the
+#PangoLayout, e.g. to take some action if some part of the entry text
+is clicked.
+Note that as the user scrolls around in the entry the offsets will
+change; you'll need to connect to the "notify::scroll-offset"
+signal to track this. Remember when using the #PangoLayout
+functions you need to convert to and from pixels using
+PANGO_PIXELS() or #PANGO_SCALE.
+
+Keep in mind that the layout text may contain a preedit string, so
+gtk_entry_layout_index_to_text_index() and
+gtk_entry_text_index_to_layout_index() are needed to convert byte
+indices in the layout to byte indices in the entry contents.
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
-<parameter name="win">
-<parameter_description> window to get
+<parameter name="x">
+<parameter_description> location to store X offset of layout, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> location to store Y offset of layout, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkWindow, or %NULL
-</return>
+<return></return>
</function>
-<function name="gtk_scale_button_set_orientation">
+<function name="gtk_entry_get_max_length">
<description>
-Sets the orientation of the #GtkScaleButton's popup window.
+Retrieves the maximum allowed length of the text in
+ entry See gtk_entry_set_max_length().
-Since: 2.14
+This is equivalent to:
+
+<informalexample><programlisting>
+gtk_entry_buffer_get_max_length (gtk_entry_get_buffer (entry));
+</programlisting></informalexample>
-Deprecated: 2.16: Use gtk_orientable_set_orientation() instead.
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkScaleButton
-</parameter_description>
-</parameter>
-<parameter name="orientation">
-<parameter_description> the new orientation
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the maximum allowed number of characters
+in #GtkEntry, or 0 if there is no maximum.
+</return>
</function>
-<function name="gtk_button_get_use_stock">
+<function name="gtk_entry_get_overwrite_mode">
<description>
-Returns whether the button label is a stock item.
+Gets the value set by gtk_entry_set_overwrite_mode().
+Since: 2.14
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkButton
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the button label is used to
-select a stock item instead of being
-used directly as the label text.
+<return> whether the text is overwritten when typing.
+
</return>
</function>
-<function name="gtk_widget_get_action">
+<function name="gtk_entry_get_progress_fraction">
<description>
-Returns the #GtkAction that @widget is a proxy for.
-See also gtk_action_get_proxies().
-
-Since: 2.10
+Returns the current fraction of the task that's been completed.
+See gtk_entry_set_progress_fraction().
-Deprecated: 2.16: Use gtk_activatable_get_related_action() instead.
+Since: 2.16
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
</parameters>
-<return> the action that a widget is a proxy for, or
-%NULL, if it is not attached to an action.
+<return> a fraction from 0.0 to 1.0
</return>
</function>
-<function name="gtk_page_setup_get_right_margin">
+<function name="gtk_entry_get_progress_pulse_step">
<description>
-Gets the right margin in units of @unit.
+Retrieves the pulse step set with gtk_entry_set_progress_pulse_step().
-Since: 2.10
+Since: 2.16
</description>
<parameters>
-<parameter name="setup">
-<parameter_description> a #GtkPageSetup
-</parameter_description>
-</parameter>
-<parameter name="unit">
-<parameter_description> the unit for the return value
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
</parameters>
-<return> the right margin
+<return> a fraction from 0.0 to 1.0
</return>
</function>
-<function name="gtk_status_icon_new_from_icon_name">
+<function name="gtk_entry_get_text">
<description>
-Creates a status icon displaying an icon from the current icon theme.
-If the current icon theme is changed, the icon will be updated
-appropriately.
+Retrieves the contents of the entry widget.
+See also gtk_editable_get_chars().
+
+This is equivalent to:
+
+<informalexample><programlisting>
+gtk_entry_buffer_get_text (gtk_entry_get_buffer (entry));
+</programlisting></informalexample>
-Since: 2.10
</description>
<parameters>
-<parameter name="icon_name">
-<parameter_description> an icon name
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkStatusIcon
-
+<return> a pointer to the contents of the widget as a
+string. This string points to internally allocated
+storage in the widget and must not be freed, modified or
+stored.
</return>
</function>
-<function name="gtk_print_job_set_track_print_status">
+<function name="gtk_entry_get_text_length">
<description>
-If track_status is %TRUE, the print job will try to continue report
-on the status of the print job in the printer queues and printer. This
-can allow your application to show things like "out of paper" issues,
-and when the print job actually reaches the printer.
+Retrieves the current length of the text in
+ entry
-This function is often implemented using some form of polling, so it should
-not be enabled unless needed.
+This is equivalent to:
-Since: 2.10
+<informalexample><programlisting>
+gtk_entry_buffer_get_length (gtk_entry_get_buffer (entry));
+</programlisting></informalexample>
+
+Since: 2.14
</description>
<parameters>
-<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
-<parameter name="track_status">
-<parameter_description> %TRUE to track status after printing
+</parameters>
+<return> the current number of characters
+in #GtkEntry, or 0 if there are none.
+
+</return>
+</function>
+
+<function name="gtk_entry_get_text_window">
+<description>
+Returns the #GdkWindow which contains the text. This function is
+useful when drawing something to the entry in an expose-event
+callback because it enables the callback to distinguish between
+the text window and entry's icon windows.
+
+See also gtk_entry_get_icon_window().
+
+Since: 2.20
+
+</description>
+<parameters>
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the entry's text window.
+
+</return>
</function>
-<function name="gtk_tree_path_prev">
+<function name="gtk_entry_get_visibility">
<description>
-Moves the @path to point to the previous node at the current depth,
-if it exists.
+Retrieves whether the text in @entry is visible. See
+gtk_entry_set_visibility().
</description>
<parameters>
-<parameter name="path">
-<parameter_description> A #GtkTreePath.
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @path has a previous node, and the move was made.
+<return> %TRUE if the text is currently visible
</return>
</function>
-<function name="gtk_drag_dest_add_uri_targets">
+<function name="gtk_entry_get_width_chars">
<description>
-Add the URI targets supported by #GtkSelection to
-the target list of the drag destination. The targets
-are added with @info = 0. If you need another value,
-use gtk_target_list_add_uri_targets() and
-gtk_drag_dest_set_target_list().
+Gets the value set by gtk_entry_set_width_chars().
-Since: 2.6
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget that's a drag destination
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> number of chars to request space for, or negative if unset
+</return>
</function>
-<function name="gtk_recent_filter_add_pattern">
+<function name="gtk_entry_im_context_filter_keypress">
<description>
-Adds a rule that allows resources based on a pattern matching their
-display name.
+Allow the #GtkEntry input method to internally handle key press
+and release events. If this function returns %TRUE, then no further
+processing should be done for this key event. See
+gtk_im_context_filter_keypress().
-Since: 2.10
+Note that you are expected to call this function from your handler
+when overriding key event handling. This is needed in the case when
+you need to insert your own key handling between the input method
+and the default key event handling of the #GtkEntry.
+See gtk_text_view_reset_im_context() for an example of use.
+
+Since: 2.22
</description>
<parameters>
-<parameter name="filter">
-<parameter_description> a #GtkRecentFilter
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
-<parameter name="pattern">
-<parameter_description> a file pattern
+<parameter name="event">
+<parameter_description> the key event
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the input method handled the key event.
+
+</return>
</function>
-<function name="gtk_print_settings_get_int">
+<function name="gtk_entry_layout_index_to_text_index">
<description>
-Returns the integer value of @key, or 0.
+Converts from a position in the entry contents (returned
+by gtk_entry_get_text()) to a position in the
+entry's #PangoLayout (returned by gtk_entry_get_layout(),
+with text retrieved via pango_layout_get_text()).
-Since: 2.10
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
-<parameter name="key">
-<parameter_description> a key
+<parameter name="layout_index">
+<parameter_description> byte index into the entry layout text
</parameter_description>
</parameter>
</parameters>
-<return> the integer value of @key
+<return> byte index into the entry contents
+</return>
+</function>
+
+<function name="gtk_entry_new">
+<description>
+Creates a new entry.
+
+</description>
+<parameters>
+</parameters>
+<return> a new #GtkEntry.
</return>
</function>
-<function name="gtk_notebook_get_show_tabs">
+<function name="gtk_entry_new_with_buffer">
<description>
-Returns whether the tabs of the notebook are shown. See
-gtk_notebook_set_show_tabs().
+Creates a new entry with the specified text buffer.
+Since: 2.18
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="buffer">
+<parameter_description> The buffer to use for the new #GtkEntry.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the tabs are shown
+<return> a new #GtkEntry
+
</return>
</function>
-<function name="gtk_tree_view_get_tooltip_column">
+<function name="gtk_entry_new_with_max_length">
<description>
-Returns the column of @tree_view's model which is being used for
-displaying tooltips on @tree_view's rows.
+Creates a new #GtkEntry widget with the given maximum length.
-Since: 2.12
+Deprecated: 2.0: Use gtk_entry_set_max_length() instead.
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
+<parameter name="max">
+<parameter_description> the maximum length of the entry, or 0 for no maximum.
+(other than the maximum length of entries.) The value passed in will
+be clamped to the range 0-65536.
</parameter_description>
</parameter>
</parameters>
-<return> the index of the tooltip column that is currently being
-used, or -1 if this is disabled.
+<return> a new #GtkEntry
</return>
</function>
-<function name="gtk_print_context_set_hard_margins">
+<function name="gtk_entry_prepend_text">
<description>
-set the hard margins in pixel coordinates
+Prepends the given text to the contents of the widget.
+
+Deprecated: 2.0: Use gtk_editable_insert_text() instead.
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GtkPrintContext
-</parameter_description>
-</parameter>
-<parameter name="top">
-<parameter_description> top hardware printer margin
-</parameter_description>
-</parameter>
-<parameter name="bottom">
-<parameter_description> bottom hardware printer margin
-</parameter_description>
-</parameter>
-<parameter name="left">
-<parameter_description> left hardware printer margin
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
-<parameter name="right">
-<parameter_description> right hardware printer margin
+<parameter name="text">
+<parameter_description> the text to prepend
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_recent_chooser_unselect_all">
+<function name="gtk_entry_progress_pulse">
<description>
-Unselects all the items inside @chooser.
+Indicates that some progress is made, but you don't know how much.
+Causes the entry's progress indicator to enter "activity mode,"
+where a block bounces back and forth. Each call to
+gtk_entry_progress_pulse() causes the block to move by a little bit
+(the amount of movement per pulse is determined by
+gtk_entry_set_progress_pulse_step()).
-Since: 2.10
+Since: 2.16
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_spin_button_get_digits">
+<function name="gtk_entry_reset_im_context">
<description>
-Fetches the precision of @spin_button. See gtk_spin_button_set_digits().
+Reset the input method context of the entry if needed.
+This can be necessary in the case where modifying the buffer
+would confuse on-going input method behavior.
+
+Since: 2.22
</description>
<parameters>
-<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
</parameters>
-<return> the current precision
-</return>
+<return></return>
</function>
-<function name="gtk_recent_chooser_dialog_new">
+<function name="gtk_entry_select_region">
<description>
-Creates a new #GtkRecentChooserDialog. This function is analogous to
-gtk_dialog_new_with_buttons().
+Selects a region of text. The characters that are selected are
+those characters at positions from @start_pos up to, but not
+including @end_pos. If @end_pos is negative, then the the characters
+selected will be those characters from @start_pos to the end of
+the text.
-Since: 2.10
+Deprecated: 2.0: Use gtk_editable_select_region() instead.
</description>
<parameters>
-<parameter name="title">
-<parameter_description> Title of the dialog, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="parent">
-<parameter_description> Transient parent of the dialog, or %NULL,
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
-<parameter name="first_button_text">
-<parameter_description> stock ID or text to go in the first button, or %NULL
+<parameter name="start">
+<parameter_description> the starting position
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> response ID for the first button, then additional (button, id)
-pairs, ending with %NULL
+<parameter name="end">
+<parameter_description> the end position
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkRecentChooserDialog
-
-</return>
+<return></return>
</function>
-<function name="gtk_window_set_geometry_hints">
+<function name="gtk_entry_set_activates_default">
<description>
-This function sets up hints about how a window can be resized by
-the user. You can set a minimum and maximum size; allowed resize
-increments (e.g. for xterm, you can only resize by the size of a
-character); aspect ratios; and more. See the #GdkGeometry struct.
+If @setting is %TRUE, pressing Enter in the @entry will activate the default
+widget for the window containing the entry. This usually means that
+the dialog box containing the entry will be closed, since the default
+widget is usually one of the dialog buttons.
+(For experts: if @setting is %TRUE, the entry calls
+gtk_window_activate_default() on the window containing the entry, in
+the default handler for the #GtkWidget::activate signal.)
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
-</parameter_description>
-</parameter>
-<parameter name="geometry_widget">
-<parameter_description> widget the geometry hints will be applied to
-</parameter_description>
-</parameter>
-<parameter name="geometry">
-<parameter_description> struct containing geometry information
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
-<parameter name="geom_mask">
-<parameter_description> mask indicating which struct fields should be paid attention to
+<parameter name="setting">
+<parameter_description> %TRUE to activate window's default widget on Enter keypress
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_column_set_spacing">
+<function name="gtk_entry_set_alignment">
<description>
-Sets the spacing field of @tree_column, which is the number of pixels to
-place between cell renderers packed into it.
+Sets the alignment for the contents of the entry. This controls
+the horizontal positioning of the contents when the displayed
+text is shorter than the width of the entry.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn.
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
-<parameter name="spacing">
-<parameter_description> distance between cell renderers in pixels.
+<parameter name="xalign">
+<parameter_description> The horizontal alignment, from 0 (left) to 1 (right).
+Reversed for RTL layouts
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_label_set_max_width_chars">
+<function name="gtk_entry_set_buffer">
<description>
-Sets the desired maximum width in characters of @label to @n_chars.
+Set the #GtkEntryBuffer object which holds the text for
+this widget.
-Since: 2.6
+Since: 2.18
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
-<parameter name="n_chars">
-<parameter_description> the new desired maximum width, in characters.
+<parameter name="buffer">
+<parameter_description> a #GtkEntryBuffer
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_iter_backward_visible_line">
+<function name="gtk_entry_set_completion">
<description>
-Moves @iter to the start of the previous visible line. Returns %TRUE if
- iter could be moved; i.e. if @iter was at character offset 0, this
-function returns %FALSE. Therefore if @iter was already on line 0,
-but not at the start of the line, @iter is snapped to the start of
-the line and the function returns %TRUE. (Note that this implies that
-in a loop calling this function, the line number may not change on
-every iteration, if your first iteration is on line 0.)
+Sets @completion to be the auxiliary completion object to use with @entry.
+All further configuration of the completion mechanism is done on
+ completion using the #GtkEntryCompletion API. Completion is disabled if
+ completion is set to %NULL.
-Since: 2.8
+Since: 2.4
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
+<parameter name="entry">
+<parameter_description> A #GtkEntry
+</parameter_description>
+</parameter>
+<parameter name="completion">
+<parameter_description> The #GtkEntryCompletion or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> whether @iter moved
-
-</return>
+<return></return>
</function>
-<function name="gtk_accel_group_connect">
+<function name="gtk_entry_set_cursor_hadjustment">
<description>
-Installs an accelerator in this group. When @accel_group is being activated
-in response to a call to gtk_accel_groups_activate(), @closure will be
-invoked if the @accel_key and @accel_mods from gtk_accel_groups_activate()
-match those of this connection.
+Hooks up an adjustment to the cursor position in an entry, so that when
+the cursor is moved, the adjustment is scrolled to show that position.
+See gtk_scrolled_window_get_hadjustment() for a typical way of obtaining
+the adjustment.
-The signature used for the @closure is that of #GtkAccelGroupActivate.
+The adjustment has to be in pixel units and in the same coordinate system
+as the entry.
-Note that, due to implementation details, a single closure can only be
-connected to one accelerator group.
+Since: 2.12
</description>
<parameters>
-<parameter name="accel_group">
-<parameter_description> the accelerator group to install an accelerator in
-</parameter_description>
-</parameter>
-<parameter name="accel_key">
-<parameter_description> key value of the accelerator
-</parameter_description>
-</parameter>
-<parameter name="accel_mods">
-<parameter_description> modifier combination of the accelerator
-</parameter_description>
-</parameter>
-<parameter name="accel_flags">
-<parameter_description> a flag mask to configure this accelerator
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
-<parameter name="closure">
-<parameter_description> closure to be executed upon accelerator activation
+<parameter name="adjustment">
+<parameter_description> an adjustment which should be adjusted when the cursor
+is moved, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_activate">
+<function name="gtk_entry_set_editable">
<description>
-For widgets that can be "activated" (buttons, menu items, etc.)
-this function activates them. Activation is what happens when you
-press Enter on a widget during key navigation. If @widget isn't
-activatable, the function returns %FALSE.
+Determines if the user can edit the text in the editable
+widget or not.
+Deprecated: 2.0: Use gtk_editable_set_editable() instead.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget that's activatable
+<parameter name="entry">
+<parameter_description> a #GtkEntry
+</parameter_description>
+</parameter>
+<parameter name="editable">
+<parameter_description> %TRUE if the user is allowed to edit the text
+in the widget
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the widget was activatable
-</return>
+<return></return>
</function>
-<function name="gtk_window_get_focus">
+<function name="gtk_entry_set_has_frame">
<description>
-Retrieves the current focused widget within the window.
-Note that this is the widget that would have the focus
-if the toplevel window focused; if the toplevel window
-is not focused then <literal>gtk_widget_has_focus (widget)</literal> will
-not be %TRUE for the widget.
-
+Sets whether the entry has a beveled frame around it.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="entry">
+<parameter_description> a #GtkEntry
+</parameter_description>
+</parameter>
+<parameter name="setting">
+<parameter_description> new value
</parameter_description>
</parameter>
</parameters>
-<return> the currently focused widget, or %NULL if there is none.
-</return>
+<return></return>
</function>
-<function name="gtk_tree_view_column_pack_start">
+<function name="gtk_entry_set_icon_activatable">
<description>
-Packs the @cell into the beginning of the column. If @expand is %FALSE, then
-the @cell is allocated no more space than it needs. Any unused space is divided
-evenly between cells for which @expand is %TRUE.
+Sets whether the icon is activatable.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn.
+<parameter name="entry">
+<parameter_description> A #GtkEntry
</parameter_description>
</parameter>
-<parameter name="cell">
-<parameter_description> The #GtkCellRenderer.
+<parameter name="icon_pos">
+<parameter_description> Icon position
</parameter_description>
</parameter>
-<parameter name="expand">
-<parameter_description> %TRUE if @cell is to be given extra space allocated to @tree_column.
+<parameter name="activatable">
+<parameter_description> %TRUE if the icon should be activatable
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_model_rows_reordered">
+<function name="gtk_entry_set_icon_drag_source">
<description>
-Emits the "rows-reordered" signal on @tree_model. This should be called by
-models when their rows have been reordered.
+Sets up the icon at the given position so that GTK+ will start a drag
+operation when the user clicks and drags the icon.
+
+To handle the drag operation, you need to connect to the usual
+#GtkWidget::drag-data-get (or possibly #GtkWidget::drag-data-delete)
+signal, and use gtk_entry_get_current_icon_drag_source() in
+your signal handler to find out if the drag was started from
+an icon.
+
+By default, GTK+ uses the icon as the drag icon. You can use the
+#GtkWidget::drag-begin signal to set a different icon. Note that you
+have to use g_signal_connect_after() to ensure that your signal handler
+gets executed after the default handler.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="tree_model">
-<parameter_description> A #GtkTreeModel
+<parameter name="entry">
+<parameter_description> a #GtkIconEntry
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> A #GtkTreePath pointing to the tree node whose children have been
-reordered
+<parameter name="icon_pos">
+<parameter_description> icon position
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> A valid #GtkTreeIter pointing to the node whose children have been
-reordered, or %NULL if the depth of @path is 0.
+<parameter name="target_list">
+<parameter_description> the targets (data formats) in which the data can be provided
</parameter_description>
</parameter>
-<parameter name="new_order">
-<parameter_description> an array of integers mapping the current position of each child
-to its old position before the re-ordering,
-i.e. @new_order<literal>[newpos] = oldpos</literal>.
+<parameter name="actions">
+<parameter_description> a bitmask of the allowed drag actions
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_binding_set_by_class">
+<function name="gtk_entry_set_icon_from_gicon">
<description>
-This function returns the binding set named after the type name of
-the passed in class structure. New binding sets are created on
-demand by this function.
+Sets the icon shown in the entry at the specified position
+from the current icon theme.
+If the icon isn't known, a "broken image" icon will be displayed
+instead.
+If @icon is %NULL, no icon will be shown in the specified position.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="object_class">
-<parameter_description> a valid #GtkObject class
+<parameter name="entry">
+<parameter_description> A #GtkEntry
+</parameter_description>
+</parameter>
+<parameter name="icon_pos">
+<parameter_description> The position at which to set the icon
+</parameter_description>
+</parameter>
+<parameter name="icon">
+<parameter_description> The icon to set, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the binding set corresponding to @object_class
-</return>
+<return></return>
</function>
-<function name="gtk_text_iter_forward_lines">
+<function name="gtk_entry_set_icon_from_icon_name">
<description>
-Moves @count lines forward, if possible (if @count would move
-past the start or end of the buffer, moves to the start or end of
-the buffer). The return value indicates whether the iterator moved
-onto a dereferenceable position; if the iterator didn't move, or
-moved onto the end iterator, then %FALSE is returned. If @count is 0,
-the function does nothing and returns %FALSE. If @count is negative,
-moves backward by 0 - @count lines.
+Sets the icon shown in the entry at the specified position
+from the current icon theme.
+If the icon name isn't known, a "broken image" icon will be displayed
+instead.
+
+If @icon_name is %NULL, no icon will be shown in the specified position.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="entry">
+<parameter_description> A #GtkEntry
</parameter_description>
</parameter>
-<parameter name="count">
-<parameter_description> number of lines to move forward
+<parameter name="icon_pos">
+<parameter_description> The position at which to set the icon
+</parameter_description>
+</parameter>
+<parameter name="icon_name">
+<parameter_description> An icon name, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> whether @iter moved and is dereferenceable
-</return>
+<return></return>
</function>
-<function name="gtk_print_settings_get_double_with_default">
+<function name="gtk_entry_set_icon_from_pixbuf">
<description>
-Returns the floating point number represented by
-the value that is associated with @key, or @default_val
-if the value does not represent a floating point number.
+Sets the icon shown in the specified position using a pixbuf.
-Floating point numbers are parsed with g_ascii_strtod().
+If @pixbuf is %NULL, no icon will be shown in the specified position.
-Since: 2.10
+Since: 2.16
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
-<parameter name="key">
-<parameter_description> a key
+<parameter name="icon_pos">
+<parameter_description> Icon position
</parameter_description>
</parameter>
-<parameter name="def">
-<parameter_description> the default value
+<parameter name="pixbuf">
+<parameter_description> A #GdkPixbuf, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the floating point number associated with @key
-
-</return>
+<return></return>
</function>
-<function name="gtk_button_box_get_child_secondary">
+<function name="gtk_entry_set_icon_from_stock">
<description>
-Returns whether @child should appear in a secondary group of children.
+Sets the icon shown in the entry at the specified position from
+a stock image.
-Since: 2.4
+If @stock_id is %NULL, no icon will be shown in the specified position.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkButtonBox
+<parameter name="entry">
+<parameter_description> A #GtkEntry
</parameter_description>
</parameter>
-<parameter name="child">
-<parameter_description> a child of @widget
+<parameter name="icon_pos">
+<parameter_description> Icon position
+</parameter_description>
+</parameter>
+<parameter name="stock_id">
+<parameter_description> The name of the stock item, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> whether @child should appear in a secondary group of children.
-
-</return>
+<return></return>
</function>
-<function name="gtk_text_view_new_with_buffer">
+<function name="gtk_entry_set_icon_sensitive">
<description>
-Creates a new #GtkTextView widget displaying the buffer
- buffer One buffer can be shared among many widgets.
- buffer may be %NULL to create a default buffer, in which case
-this function is equivalent to gtk_text_view_new(). The
-text view adds its own reference count to the buffer; it does not
-take over an existing reference.
+Sets the sensitivity for the specified icon.
+Since: 2.16
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="entry">
+<parameter_description> A #GtkEntry
+</parameter_description>
+</parameter>
+<parameter name="icon_pos">
+<parameter_description> Icon position
+</parameter_description>
+</parameter>
+<parameter name="sensitive">
+<parameter_description> Specifies whether the icon should appear
+sensitive or insensitive
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkTextView.
-</return>
+<return></return>
</function>
-<function name="gtk_window_get_icon">
+<function name="gtk_entry_set_icon_tooltip_markup">
<description>
-Gets the value set by gtk_window_set_icon() (or if you've
-called gtk_window_set_icon_list(), gets the first icon in
-the icon list).
+Sets @tooltip as the contents of the tooltip for the icon at
+the specified position. @tooltip is assumed to be marked up with
+the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
+
+Use %NULL for @tooltip to remove an existing tooltip.
+See also gtk_widget_set_tooltip_markup() and
+gtk_enty_set_icon_tooltip_text().
+
+Since: 2.16
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="entry">
+<parameter_description> a #GtkEntry
+</parameter_description>
+</parameter>
+<parameter name="icon_pos">
+<parameter_description> the icon position
+</parameter_description>
+</parameter>
+<parameter name="tooltip">
+<parameter_description> the contents of the tooltip for the icon, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> icon for window
-</return>
+<return></return>
</function>
-<function name="gtk_text_view_set_pixels_inside_wrap">
+<function name="gtk_entry_set_icon_tooltip_text">
<description>
-Sets the default number of pixels of blank space to leave between
-display/wrapped lines within a paragraph. May be overridden by
-tags in @text_view's buffer.
+Sets @tooltip as the contents of the tooltip for the icon
+at the specified position.
+
+Use %NULL for @tooltip to remove an existing tooltip.
+
+See also gtk_widget_set_tooltip_text() and
+gtk_entry_set_icon_tooltip_markup().
+
+Since: 2.16
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
-<parameter name="pixels_inside_wrap">
-<parameter_description> default number of pixels between wrapped lines
+<parameter name="icon_pos">
+<parameter_description> the icon position
+</parameter_description>
+</parameter>
+<parameter name="tooltip">
+<parameter_description> the contents of the tooltip for the icon, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_unix_dialog_get_selected_printer">
+<function name="gtk_entry_set_inner_border">
<description>
-Gets the currently selected printer.
+Sets %entry's inner-border property to %border, or clears it if %NULL
+is passed. The inner-border is the area around the entry's text, but
+inside its frame.
+
+If set, this property overrides the inner-border style property.
+Overriding the style-provided border is useful when you want to do
+in-place editing of some text in a canvas or list widget, where
+pixel-exact positioning of the entry is important.
Since: 2.10
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter name="entry">
+<parameter_description> a #GtkEntry
+</parameter_description>
+</parameter>
+<parameter name="border">
+<parameter_description> a #GtkBorder, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the currently selected printer
-
-</return>
+<return></return>
</function>
-<function name="gtk_aspect_frame_new">
+<function name="gtk_entry_set_invisible_char">
<description>
-Create a new #GtkAspectFrame.
-
+Sets the character to use in place of the actual text when
+gtk_entry_set_visibility() has been called to set text visibility
+to %FALSE. i.e. this is the character used in "password mode" to
+show the user how many characters have been typed. By default, GTK+
+picks the best invisible char available in the current font. If you
+set the invisible char to 0, then the user will get no feedback
+at all; there will be no text on the screen as they type.
</description>
<parameters>
-<parameter name="label">
-<parameter_description> Label text.
-</parameter_description>
-</parameter>
-<parameter name="xalign">
-<parameter_description> Horizontal alignment of the child within the allocation of
-the #GtkAspectFrame. This ranges from 0.0 (left aligned)
-to 1.0 (right aligned)
-</parameter_description>
-</parameter>
-<parameter name="yalign">
-<parameter_description> Vertical alignment of the child within the allocation of
-the #GtkAspectFrame. This ranges from 0.0 (left aligned)
-to 1.0 (right aligned)
-</parameter_description>
-</parameter>
-<parameter name="ratio">
-<parameter_description> The desired aspect ratio.
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
-<parameter name="obey_child">
-<parameter_description> If %TRUE, @ratio is ignored, and the aspect
-ratio is taken from the requistion of the child.
+<parameter name="ch">
+<parameter_description> a Unicode character
</parameter_description>
</parameter>
</parameters>
-<return> the new #GtkAspectFrame.
-</return>
+<return></return>
</function>
-<function name="gtk_widget_set">
+<function name="gtk_entry_set_max_length">
<description>
-Precursor of g_object_set().
+Sets the maximum allowed length of the contents of the widget. If
+the current contents are longer than the given length, then they
+will be truncated to fit.
-Deprecated: 2.0: Use g_object_set() instead.
+This is equivalent to:
+
+<informalexample><programlisting>
+gtk_entry_buffer_set_max_length (gtk_entry_get_buffer (entry), max);
+</programlisting></informalexample>
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="first_property_name">
-<parameter_description> name of first property to set
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> value of first property, followed by more properties,
-%NULL-terminated
+<parameter name="max">
+<parameter_description> the maximum length of the entry, or 0 for no maximum.
+(other than the maximum length of entries.) The value passed in will
+be clamped to the range 0-65536.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_container_get_focus_child">
+<function name="gtk_entry_set_overwrite_mode">
<description>
-Returns the current focus child widget inside @container. This is not the
-currently focused widget. That can be obtained by calling
-gtk_window_get_focus().
+Sets whether the text is overwritten when typing in the #GtkEntry.
Since: 2.14
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
+<parameter name="entry">
+<parameter_description> a #GtkEntry
+</parameter_description>
+</parameter>
+<parameter name="overwrite">
+<parameter_description> new value
</parameter_description>
</parameter>
</parameters>
-<return> The child widget which will recieve the focus inside @container when
-the @conatiner is focussed, or %NULL if none is set.
-
-</return>
+<return></return>
</function>
-<function name="gtk_scale_new_with_range">
+<function name="gtk_entry_set_position">
<description>
-Creates a new scale widget with the given orientation that lets the
-user input a number between @min and @max (including @min and @max)
-with the increment @step. @step must be nonzero; it's the distance
-the slider moves when using the arrow keys to adjust the scale
-value.
-
-Note that the way in which the precision is derived works best if @step
-is a power of ten. If the resulting precision is not suitable for your
-needs, use gtk_scale_set_digits() to correct it.
+Sets the cursor position in an entry to the given value.
-Since: 2.16
+Deprecated: 2.0: Use gtk_editable_set_position() instead.
</description>
<parameters>
-<parameter name="orientation">
-<parameter_description> the scale's orientation.
-</parameter_description>
-</parameter>
-<parameter name="min">
-<parameter_description> minimum value
-</parameter_description>
-</parameter>
-<parameter name="max">
-<parameter_description> maximum value
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
-<parameter name="step">
-<parameter_description> step increment (tick size) used with keyboard shortcuts
+<parameter name="position">
+<parameter_description> the position of the cursor. The cursor is displayed
+before the character with the given (base 0) index in the widget.
+The value must be less than or equal to the number of characters
+in the widget. A value of -1 indicates that the position should
+be set after the last character in the entry. Note that this
+position is in characters, not in bytes.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkScale
-
-</return>
+<return></return>
</function>
-<function name="gtk_selection_data_get_display">
+<function name="gtk_entry_set_progress_fraction">
<description>
-Retrieves the display of the selection.
+Causes the entry's progress indicator to "fill in" the given
+fraction of the bar. The fraction should be between 0.0 and 1.0,
+inclusive.
-Since: 2.14
+Since: 2.16
</description>
<parameters>
-<parameter name="selection_data">
-<parameter_description> a pointer to a #GtkSelectionData structure.
+<parameter name="entry">
+<parameter_description> a #GtkEntry
+</parameter_description>
+</parameter>
+<parameter name="fraction">
+<parameter_description> fraction of the task that's been completed
</parameter_description>
</parameter>
</parameters>
-<return> the display of the selection.
-
-</return>
+<return></return>
</function>
-<function name="gtk_text_view_get_left_margin">
+<function name="gtk_entry_set_progress_pulse_step">
<description>
-Gets the default left margin size of paragraphs in the @text_view.
-Tags in the buffer may override the default.
+Sets the fraction of total entry width to move the progress
+bouncing block for each call to gtk_entry_progress_pulse().
+Since: 2.16
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="entry">
+<parameter_description> a #GtkEntry
+</parameter_description>
+</parameter>
+<parameter name="fraction">
+<parameter_description> fraction between 0.0 and 1.0
</parameter_description>
</parameter>
</parameters>
-<return> left margin in pixels
-</return>
+<return></return>
</function>
-<function name="gtk_widget_get_visual">
+<function name="gtk_entry_set_text">
<description>
-Gets the visual that will be used to render @widget.
+Sets the text in the widget to the given
+value, replacing the current contents.
+See gtk_entry_buffer_set_text().
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="entry">
+<parameter_description> a #GtkEntry
+</parameter_description>
+</parameter>
+<parameter name="text">
+<parameter_description> the new text
</parameter_description>
</parameter>
</parameters>
-<return> the visual for @widget
-</return>
+<return></return>
</function>
-<function name="gtk_entry_get_icon_tooltip_text">
+<function name="gtk_entry_set_visibility">
<description>
-Gets the contents of the tooltip on the icon at the specified
-position in @entry.
+Sets whether the contents of the entry are visible or not.
+When visibility is set to %FALSE, characters are displayed
+as the invisible char, and will also appear that way when
+the text in the entry widget is copied elsewhere.
-Since: 2.16
+By default, GTK+ picks the best invisible character available
+in the current font, but it can be changed with
+gtk_entry_set_invisible_char().
</description>
<parameters>
@@ -15996,1037 +16287,1082 @@ Since: 2.16
<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
-<parameter name="icon_pos">
-<parameter_description> the icon position
+<parameter name="visible">
+<parameter_description> %TRUE if the contents of the entry are displayed
+as plaintext
</parameter_description>
</parameter>
</parameters>
-<return> the tooltip text, or %NULL. Free the returned string
-with g_free() when done.
-
-</return>
+<return></return>
</function>
-<function name="gtk_file_filter_add_custom">
+<function name="gtk_entry_set_width_chars">
<description>
-Adds rule to a filter that allows files based on a custom callback
-function. The bitfield @needed which is passed in provides information
-about what sorts of information that the filter function needs;
-this allows GTK+ to avoid retrieving expensive information when
-it isn't needed by the filter.
-
-Since: 2.4
+Changes the size request of the entry to be about the right size
+for @n_chars characters. Note that it changes the size
+<emphasis>request</emphasis>, the size can still be affected by
+how you pack the widget into containers. If @n_chars is -1, the
+size reverts to the default entry size.
</description>
<parameters>
-<parameter name="filter">
-<parameter_description> a #GtkFileFilter
-</parameter_description>
-</parameter>
-<parameter name="needed">
-<parameter_description> bitfield of flags indicating the information that the custom
-filter function needs.
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> callback function; if the function returns %TRUE, then
-the file will be displayed.
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> data to pass to @func
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
-<parameter name="notify">
-<parameter_description> function to call to free @data when it is no longer needed.
+<parameter name="n_chars">
+<parameter_description> width in chars
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_settings_set_n_copies">
+<function name="gtk_entry_text_index_to_layout_index">
<description>
-Sets the value of %GTK_PRINT_SETTINGS_N_COPIES.
+Converts from a position in the entry's #PangoLayout (returned by
+gtk_entry_get_layout()) to a position in the entry contents
+(returned by gtk_entry_get_text()).
-Since: 2.10
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
-<parameter name="num_copies">
-<parameter_description> the number of copies
+<parameter name="text_index">
+<parameter_description> byte index into the entry contents
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> byte index into the entry layout text
+</return>
</function>
-<function name="gtk_tree_model_sort_convert_child_iter_to_iter">
+<function name="gtk_entry_unset_invisible_char">
<description>
-Sets @sort_iter to point to the row in @tree_model_sort that corresponds to
-the row pointed at by @child_iter. If @sort_iter was not set, %FALSE
-is returned. Note: a boolean is only returned since 2.14.
+Unsets the invisible char previously set with
+gtk_entry_set_invisible_char(). So that the
+default invisible char is used again.
+Since: 2.16
</description>
<parameters>
-<parameter name="tree_model_sort">
-<parameter_description> A #GtkTreeModelSort
-</parameter_description>
-</parameter>
-<parameter name="sort_iter">
-<parameter_description> An uninitialized #GtkTreeIter.
-</parameter_description>
-</parameter>
-<parameter name="child_iter">
-<parameter_description> A valid #GtkTreeIter pointing to a row on the child model
+<parameter name="entry">
+<parameter_description> a #GtkEntry
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE, if @sort_iter was set, i.e. if @sort_iter is a
-valid iterator pointer to a visible row in the child model.
-</return>
+<return></return>
</function>
-<function name="gtk_item_factory_create_items_ac">
+<function name="gtk_enumerate_printers">
<description>
-Creates the menu items from the @entries.
+Calls a function for all #GtkPrinter<!-- -->s.
+If @func returns %TRUE, the enumeration is stopped.
-Deprecated: 2.4: Use #GtkUIManager instead.
+Since: 2.10
</description>
<parameters>
-<parameter name="ifactory">
-<parameter_description> a #GtkItemFactory
-</parameter_description>
-</parameter>
-<parameter name="n_entries">
-<parameter_description> the length of @entries
+<parameter name="func">
+<parameter_description> a function to call for each printer
</parameter_description>
</parameter>
-<parameter name="entries">
-<parameter_description> an array of #GtkItemFactoryEntry<!-- -->s
+<parameter name="data">
+<parameter_description> user data to pass to @func
</parameter_description>
</parameter>
-<parameter name="callback_data">
-<parameter_description> data passed to the callback functions of all entries
+<parameter name="destroy">
+<parameter_description> function to call if @data is no longer needed
</parameter_description>
</parameter>
-<parameter name="callback_type">
-<parameter_description> 1 if the callback functions in @entries are of type
-#GtkItemFactoryCallback1, 2 if they are of type #GtkItemFactoryCallback2
+<parameter name="wait">
+<parameter_description> if %TRUE, wait in a recursive mainloop until
+all printers are enumerated; otherwise return early
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_unref">
+<function name="gtk_event_box_get_above_child">
<description>
-Inverse of gtk_widget_ref(). Equivalent to g_object_unref().
+Returns whether the event box window is above or below the
+windows of its child. See gtk_event_box_set_above_child() for
+details.
-Deprecated: 2.12: Use g_object_unref() instead.
+Since: 2.4
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="event_box">
+<parameter_description> a #GtkEventBox
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the event box window is above the window
+of its child.
+
+</return>
</function>
-<function name="gtk_widget_destroyed">
+<function name="gtk_event_box_get_visible_window">
<description>
-This function sets * widget_pointer to %NULL if @widget_pointer !=
-%NULL. It's intended to be used as a callback connected to the
-"destroy" signal of a widget. You connect gtk_widget_destroyed()
-as a signal handler, and pass the address of your widget variable
-as user data. Then when the widget is destroyed, the variable will
-be set to %NULL. Useful for example to avoid multiple copies
-of the same dialog.
+Returns whether the event box has a visible window.
+See gtk_event_box_set_visible_window() for details.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="widget_pointer">
-<parameter_description> address of a variable that contains @widget
+<parameter name="event_box">
+<parameter_description> a #GtkEventBox
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the event box window is visible
+
+</return>
</function>
-<function name="gtk_window_set_role">
+<function name="gtk_event_box_set_above_child">
<description>
-This function is only useful on X11, not with other GTK+ targets.
-
-In combination with the window title, the window role allows a
-<link linkend="gtk-X11-arch">window manager</link> to identify "the
-same" window when an application is restarted. So for example you
-might set the "toolbox" role on your app's toolbox window, so that
-when the user restarts their session, the window manager can put
-the toolbox back in the same place.
+Set whether the event box window is positioned above the windows of its child,
+as opposed to below it. If the window is above, all events inside the
+event box will go to the event box. If the window is below, events
+in windows of child widgets will first got to that widget, and then
+to its parents.
-If a window already has a unique title, you don't need to set the
-role, since the WM can use the title to identify the window when
-restoring the session.
+The default is to keep the window below the child.
+Since: 2.4
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="event_box">
+<parameter_description> a #GtkEventBox
</parameter_description>
</parameter>
-<parameter name="role">
-<parameter_description> unique identifier for the window to be used when restoring a session
+<parameter name="above_child">
+<parameter_description> %TRUE if the event box window is above the windows of its child
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_entry_set_icon_from_gicon">
+<function name="gtk_event_box_set_visible_window">
<description>
-Sets the icon shown in the entry at the specified position
-from the current icon theme.
-If the icon isn't known, a "broken image" icon will be displayed
-instead.
+Set whether the event box uses a visible or invisible child
+window. The default is to use visible windows.
-If @icon is %NULL, no icon will be shown in the specified position.
+In an invisible window event box, the window that the
+event box creates is a %GDK_INPUT_ONLY window, which
+means that it is invisible and only serves to receive
+events.
-Since: 2.16
+A visible window event box creates a visible (%GDK_INPUT_OUTPUT)
+window that acts as the parent window for all the widgets
+contained in the event box.
+
+You should generally make your event box invisible if
+you just want to trap events. Creating a visible window
+may cause artifacts that are visible to the user, especially
+if the user is using a theme with gradients or pixmaps.
+
+The main reason to create a non input-only event box is if
+you want to set the background to a different color or
+draw on it.
+
+<note><para>
+There is one unexpected issue for an invisible event box that has its
+window below the child. (See gtk_event_box_set_above_child().)
+Since the input-only window is not an ancestor window of any windows
+that descendent widgets of the event box create, events on these
+windows aren't propagated up by the windowing system, but only by GTK+.
+The practical effect of this is if an event isn't in the event
+mask for the descendant window (see gtk_widget_add_events()),
+it won't be received by the event box.
+</para><para>
+This problem doesn't occur for visible event boxes, because in
+that case, the event box window is actually the ancestor of the
+descendant windows, not just at the same place on the screen.
+</para></note>
+
+Since: 2.4
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> A #GtkEntry
-</parameter_description>
-</parameter>
-<parameter name="icon_pos">
-<parameter_description> The position at which to set the icon
+<parameter name="event_box">
+<parameter_description> a #GtkEventBox
</parameter_description>
</parameter>
-<parameter name="icon">
-<parameter_description> The icon to set, or %NULL
+<parameter name="visible_window">
+<parameter_description> boolean value
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_operation_get_has_selection">
+<function name="gtk_expander_get_expanded">
<description>
-Gets the value of #GtkPrintOperation::has-selection property.
+Queries a #GtkExpander and returns its current state. Returns %TRUE
+if the child widget is revealed.
-Since: 2.18
+See gtk_expander_set_expanded().
+
+Since: 2.4
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter name="expander">
+<parameter_description>a #GtkExpander
</parameter_description>
</parameter>
</parameters>
-<return> whether there is a selection
+<return> the current state of the expander.
</return>
</function>
-<function name="gtk_tree_view_column_set_resizable">
+<function name="gtk_expander_get_label">
<description>
-If @resizable is %TRUE, then the user can explicitly resize the column by
-grabbing the outer edge of the column button. If resizable is %TRUE and
-sizing mode of the column is #GTK_TREE_VIEW_COLUMN_AUTOSIZE, then the sizing
-mode is changed to #GTK_TREE_VIEW_COLUMN_GROW_ONLY.
+Fetches the text from a label widget including any embedded
+underlines indicating mnemonics and Pango markup, as set by
+gtk_expander_set_label(). If the label text has not been set the
+return value will be %NULL. This will be the case if you create an
+empty button with gtk_button_new() to use as a container.
+
+Note that this function behaved differently in versions prior to
+2.14 and used to return the label text stripped of embedded
+underlines indicating mnemonics and Pango markup. This problem can
+be avoided by fetching the label text directly from the label
+widget.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn
-</parameter_description>
-</parameter>
-<parameter name="resizable">
-<parameter_description> %TRUE, if the column can be resized
+<parameter name="expander">
+<parameter_description> a #GtkExpander
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The text of the label widget. This string is owned
+by the widget and must not be modified or freed.
+
+</return>
</function>
-<function name="gtk_icon_view_get_model">
+<function name="gtk_expander_get_label_fill">
<description>
-Returns the model the #GtkIconView is based on. Returns %NULL if the
-model is unset.
+Returns whether the label widget will fill all available horizontal
+space allocated to @expander.
-Since: 2.6
+Since: 2.22
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
+<parameter name="expander">
+<parameter_description> a #GtkExpander
</parameter_description>
</parameter>
</parameters>
-<return> A #GtkTreeModel, or %NULL if none is currently being used.
+<return> %TRUE if the label widget will fill all available horizontal
+space
</return>
</function>
-<function name="gtk_file_chooser_get_preview_file">
+<function name="gtk_expander_get_label_widget">
<description>
-Gets the #GFile that should be previewed in a custom preview
-Internal function, see gtk_file_chooser_get_preview_uri().
+Retrieves the label widget for the frame. See
+gtk_expander_set_label_widget().
-Since: 2.14
+Since: 2.4
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="expander">
+<parameter_description> a #GtkExpander
</parameter_description>
</parameter>
</parameters>
-<return> the #GFile for the file to preview, or %NULL if no file
-is selected. Free with g_object_unref().
+<return> the label widget,
+or %NULL if there is none.
</return>
</function>
-<function name="gtk_print_operation_set_support_selection">
+<function name="gtk_expander_get_spacing">
<description>
-Sets whether selection is supported by #GtkPrintOperation.
+Gets the value set by gtk_expander_set_spacing().
-Since: 2.18
+Since: 2.4
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkPrintOperation
-</parameter_description>
-</parameter>
-<parameter name="support_selection">
-<parameter_description> %TRUE to support selection
+<parameter name="expander">
+<parameter_description> a #GtkExpander
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> spacing between the expander and child.
+
+</return>
</function>
-<function name="gtk_widget_get_events">
+<function name="gtk_expander_get_use_markup">
<description>
-Returns the event mask for the widget (a bitfield containing flags
-from the #GdkEventMask enumeration). These are the events that the widget
-will receive.
+Returns whether the label's text is interpreted as marked up with
+the <link linkend="PangoMarkupFormat">Pango text markup
+language</link>. See gtk_expander_set_use_markup ().
+Since: 2.4
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="expander">
+<parameter_description> a #GtkExpander
</parameter_description>
</parameter>
</parameters>
-<return> event mask for @widget
+<return> %TRUE if the label's text will be parsed for markup
+
</return>
</function>
-<function name="gtk_test_find_sibling">
+<function name="gtk_expander_get_use_underline">
<description>
-This function will search siblings of @base_widget and siblings of its
-ancestors for all widgets matching @widget_type.
-Of the matching widgets, the one that is geometrically closest to
- base_widget will be returned.
-The general purpose of this function is to find the most likely "action"
-widget, relative to another labeling widget. Such as finding a
-button or text entry widget, given it's corresponding label widget.
+Returns whether an embedded underline in the expander label indicates a
+mnemonic. See gtk_expander_set_use_underline().
-Since: 2.14
+Since: 2.4
</description>
<parameters>
-<parameter name="base_widget">
-<parameter_description> Valid widget, part of a widget hierarchy
-</parameter_description>
-</parameter>
-<parameter name="widget_type">
-<parameter_description> Type of a aearched for sibling widget
+<parameter name="expander">
+<parameter_description> a #GtkExpander
</parameter_description>
</parameter>
</parameters>
-<return> a widget of type @widget_type if any is found.
+<return> %TRUE if an embedded underline in the expander label
+indicates the mnemonic accelerator keys.
</return>
</function>
-<function name="gtk_text_attributes_copy">
+<function name="gtk_expander_new">
<description>
-Copies @src and returns a new #GtkTextAttributes.
+Creates a new expander using @label as the text of the label.
+Since: 2.4
</description>
<parameters>
-<parameter name="src">
-<parameter_description> a #GtkTextAttributes to be copied
+<parameter name="label">
+<parameter_description> the text of the label
</parameter_description>
</parameter>
</parameters>
-<return> a copy of @src
+<return> a new #GtkExpander widget.
+
</return>
</function>
-<function name="gtk_recent_info_get_application_info">
+<function name="gtk_expander_new_with_mnemonic">
<description>
-Gets the data regarding the application that has registered the resource
-pointed by @info.
-
-If the command line contains any escape characters defined inside the
-storage specification, they will be expanded.
+Creates a new expander using @label as the text of the label.
+If characters in @label are preceded by an underscore, they are underlined.
+If you need a literal underscore character in a label, use '__' (two
+underscores). The first underlined character represents a keyboard
+accelerator called a mnemonic.
+Pressing Alt and that key activates the button.
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="info">
-<parameter_description> a #GtkRecentInfo
-</parameter_description>
-</parameter>
-<parameter name="app_name">
-<parameter_description> the name of the application that has registered this item
-</parameter_description>
-</parameter>
-<parameter name="app_exec">
-<parameter_description> return location for the string containing the command line
-</parameter_description>
-</parameter>
-<parameter name="count">
-<parameter_description> return location for the number of times this item was registered
-</parameter_description>
-</parameter>
-<parameter name="time_">
-<parameter_description> return location for the timestamp this item was last registered
-for this application
+<parameter name="label">
+<parameter_description> the text of the label with an underscore in front of the
+mnemonic character
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if an application with @app_name has registered this
-resource inside the recently used list, or %FALSE otherwise. The
- app_exec string is owned by the #GtkRecentInfo and should not be
-modified or freed
+<return> a new #GtkExpander widget.
</return>
</function>
-<function name="gtk_adjustment_get_page_size">
+<function name="gtk_expander_set_expanded">
<description>
-Retrieves the page size of the adjustment.
+Sets the state of the expander. Set to %TRUE, if you want
+the child widget to be revealed, and %FALSE if you want the
+child widget to be hidden.
-Since: 2.14
+Since: 2.4
</description>
<parameters>
-<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
+<parameter name="expander">
+<parameter_description> a #GtkExpander
+</parameter_description>
+</parameter>
+<parameter name="expanded">
+<parameter_description> whether the child widget is revealed
</parameter_description>
</parameter>
</parameters>
-<return> The current page size of the adjustment.
-
-</return>
+<return></return>
</function>
-<function name="gtk_file_chooser_list_filters">
+<function name="gtk_expander_set_label">
<description>
-Lists the current set of user-selectable filters; see
-gtk_file_chooser_add_filter(), gtk_file_chooser_remove_filter().
+Sets the text of the label of the expander to @label.
+
+This will also clear any previously set labels.
Since: 2.4
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="expander">
+<parameter_description> a #GtkExpander
+</parameter_description>
+</parameter>
+<parameter name="label">
+<parameter_description> a string
</parameter_description>
</parameter>
</parameters>
-<return> a #GSList containing the current set of
-user selectable filters. The contents of the list are
-owned by GTK+, but you must free the list itself with
-g_slist_free() when you are done with it.
-
-</return>
+<return></return>
</function>
-<function name="gtk_text_iter_inside_sentence">
+<function name="gtk_expander_set_label_fill">
<description>
-Determines whether @iter is inside a sentence (as opposed to in
-between two sentences, e.g. after a period and before the first
-letter of the next sentence). Sentence boundaries are determined
-by Pango and should be correct for nearly any language (if not, the
-correct fix would be to the Pango text boundary algorithms).
+Sets whether the label widget should fill all available horizontal space
+allocated to @expander.
+Since: 2.22
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="expander">
+<parameter_description> a #GtkExpander
+</parameter_description>
+</parameter>
+<parameter name="label_fill">
+<parameter_description> %TRUE if the label should should fill all available horizontal
+space
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter is inside a sentence.
-</return>
+<return></return>
</function>
-<function name="gtk_text_iter_compare">
+<function name="gtk_expander_set_label_widget">
<description>
-A qsort()-style function that returns negative if @lhs is less than
- rhs, positive if @lhs is greater than @rhs, and 0 if they're equal.
-Ordering is in character offset order, i.e. the first character in the buffer
-is less than the second character in the buffer.
+Set the label widget for the expander. This is the widget
+that will appear embedded alongside the expander arrow.
+Since: 2.4
</description>
<parameters>
-<parameter name="lhs">
-<parameter_description> a #GtkTextIter
+<parameter name="expander">
+<parameter_description> a #GtkExpander
</parameter_description>
</parameter>
-<parameter name="rhs">
-<parameter_description> another #GtkTextIter
+<parameter name="label_widget">
+<parameter_description> the new label widget
</parameter_description>
</parameter>
</parameters>
-<return> -1 if @lhs is less than @rhs, 1 if @lhs is greater, 0 if they are equal
-</return>
+<return></return>
</function>
-<function name="gtk_printer_accepts_pdf">
+<function name="gtk_expander_set_spacing">
<description>
-Returns whether the printer accepts input in
-PDF format.
+Sets the spacing field of @expander, which is the number of pixels to
+place between expander and the child.
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter name="expander">
+<parameter_description> a #GtkExpander
+</parameter_description>
+</parameter>
+<parameter name="spacing">
+<parameter_description> distance between the expander and child in pixels.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @printer accepts PDF
-
-</return>
+<return></return>
</function>
-<function name="gtk_icon_view_set_pixbuf_column">
+<function name="gtk_expander_set_use_markup">
<description>
-Sets the column with pixbufs for @icon_view to be @column. The pixbuf
-column must be of type #GDK_TYPE_PIXBUF
+Sets whether the text of the label contains markup in <link
+linkend="PangoMarkupFormat">Pango's text markup
+language</link>. See gtk_label_set_markup().
-Since: 2.6
+Since: 2.4
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> A #GtkIconView.
+<parameter name="expander">
+<parameter_description> a #GtkExpander
</parameter_description>
</parameter>
-<parameter name="column">
-<parameter_description> A column in the currently used model, or -1 to disable
+<parameter name="use_markup">
+<parameter_description> %TRUE if the label's text should be parsed for markup
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_draw_string">
+<function name="gtk_expander_set_use_underline">
<description>
-Draws a text string on @window with the given parameters.
+If true, an underline in the text of the expander label indicates
+the next character should be used for the mnemonic accelerator key.
-Deprecated: 2.0: Use gtk_paint_layout() instead.
+Since: 2.4
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
+<parameter name="expander">
+<parameter_description> a #GtkExpander
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> x origin
+<parameter name="use_underline">
+<parameter_description> %TRUE if underlines in the text indicate mnemonics
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> y origin
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_file_chooser_add_filter">
+<description>
+Adds @filter to the list of filters that the user can select between.
+When a filter is selected, only files that are passed by that
+filter are displayed.
+
+Note that the @chooser takes ownership of the filter, so you have to
+ref and sink it if you want to keep a reference.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
-<parameter name="string">
-<parameter_description> the string to draw
+<parameter name="filter">
+<parameter_description> a #GtkFileFilter
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_recent_chooser_get_select_multiple">
+<function name="gtk_file_chooser_add_shortcut_folder">
<description>
-Gets whether @chooser can select multiple items.
+Adds a folder to be displayed with the shortcut folders in a file chooser.
+Note that shortcut folders do not get saved, as they are provided by the
+application. For example, you can use this to add a
+"/usr/share/mydrawprogram/Clipart" folder to the volume list.
-Since: 2.10
+Since: 2.4
</description>
<parameters>
<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
+<parameter_description> a #GtkFileChooser
+</parameter_description>
+</parameter>
+<parameter name="folder">
+<parameter_description> filename of the folder to add
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store error, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @chooser can select more than one item.
+<return> %TRUE if the folder could be added successfully, %FALSE
+otherwise. In the latter case, the @error will be set as appropriate.
</return>
</function>
-<function name="gtk_print_settings_set_page_set">
+<function name="gtk_file_chooser_add_shortcut_folder_uri">
<description>
-Sets the value of %GTK_PRINT_SETTINGS_PAGE_SET.
+Adds a folder URI to be displayed with the shortcut folders in a file
+chooser. Note that shortcut folders do not get saved, as they are provided
+by the application. For example, you can use this to add a
+"file:///usr/share/mydrawprogram/Clipart" folder to the volume list.
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
-<parameter name="page_set">
-<parameter_description> a #GtkPageSet value
+<parameter name="uri">
+<parameter_description> URI of the folder to add
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store error, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the folder could be added successfully, %FALSE
+otherwise. In the latter case, the @error will be set as appropriate.
+
+</return>
</function>
-<function name="gtk_radio_menu_item_new_from_widget">
+<function name="gtk_file_chooser_button_get_focus_on_click">
<description>
-Creates a new #GtkRadioMenuItem adding it to the same group as @group.
+Returns whether the button grabs focus when it is clicked with the mouse.
+See gtk_file_chooser_button_set_focus_on_click().
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="group">
-<parameter_description> An existing #GtkRadioMenuItem
+<parameter name="button">
+<parameter_description> a #GtkFileChooserButton
</parameter_description>
</parameter>
</parameters>
-<return> The new #GtkRadioMenuItem
+<return> %TRUE if the button grabs focus when it is clicked with
+the mouse.
</return>
</function>
-<function name="gtk_toolbar_get_icon_size">
+<function name="gtk_file_chooser_button_get_title">
<description>
-Retrieves the icon size for the toolbar. See gtk_toolbar_set_icon_size().
+Retrieves the title of the browse dialog used by @button. The returned value
+should not be modified or freed.
+Since: 2.6
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar
+<parameter name="button">
+<parameter_description> the button widget to examine.
</parameter_description>
</parameter>
</parameters>
-<return> the current icon size for the icons on
-the toolbar.
+<return> a pointer to the browse dialog's title.
+
</return>
</function>
-<function name="gtk_activatable_get_use_action_appearance">
+<function name="gtk_file_chooser_button_get_width_chars">
<description>
-Gets whether this activatable should reset its layout
-and appearance when setting the related action or when
-the action changes appearance.
+Retrieves the width in characters of the @button widget's entry and/or label.
-Since: 2.16
+Since: 2.6
</description>
<parameters>
-<parameter name="activatable">
-<parameter_description> a #GtkActivatable
+<parameter name="button">
+<parameter_description> the button widget to examine.
</parameter_description>
</parameter>
</parameters>
-<return> whether @activatable uses its actions appearance.
+<return> an integer width (in characters) that the button will use to size itself.
</return>
</function>
-<function name="gtk_tree_view_column_new">
+<function name="gtk_file_chooser_button_new">
<description>
-Creates a new #GtkTreeViewColumn.
+Creates a new file-selecting button widget.
+Since: 2.6
</description>
<parameters>
+<parameter name="title">
+<parameter_description> the title of the browse dialog.
+</parameter_description>
+</parameter>
+<parameter name="action">
+<parameter_description> the open mode for the widget.
+</parameter_description>
+</parameter>
</parameters>
-<return> A newly created #GtkTreeViewColumn.
+<return> a new button widget.
+
</return>
</function>
-<function name="gtk_window_list_toplevels">
+<function name="gtk_file_chooser_button_new_with_backend">
<description>
-Returns a list of all existing toplevel windows. The widgets
-in the list are not individually referenced. If you want
-to iterate through the list and perform actions involving
-callbacks that might destroy the widgets, you <emphasis>must</emphasis> call
-<literal>g_list_foreach (result, (GFunc)g_object_ref, NULL)</literal> first, and
-then unref all the widgets afterwards.
+Creates a new file-selecting button widget using @backend.
+Since: 2.6
+Deprecated: 2.14: Use gtk_file_chooser_button_new() instead.
</description>
<parameters>
+<parameter name="title">
+<parameter_description> the title of the browse dialog.
+</parameter_description>
+</parameter>
+<parameter name="action">
+<parameter_description> the open mode for the widget.
+</parameter_description>
+</parameter>
+<parameter name="backend">
+<parameter_description> the name of the #GtkFileSystem backend to use.
+</parameter_description>
+</parameter>
</parameters>
-<return> list of toplevel widgets
+<return> a new button widget.
+
</return>
</function>
-<function name="gtk_clipboard_wait_is_image_available">
+<function name="gtk_file_chooser_button_new_with_dialog">
<description>
-Test to see if there is an image available to be pasted
-This is done by requesting the TARGETS atom and checking
-if it contains any of the supported image targets. This function
-waits for the data to be received using the main loop, so events,
-timeouts, etc, may be dispatched during the wait.
+Creates a #GtkFileChooserButton widget which uses @dialog as its
+file-picking window.
-This function is a little faster than calling
-gtk_clipboard_wait_for_image() since it doesn't need to retrieve
-the actual image data.
+Note that @dialog must be a #GtkDialog (or subclass) which
+implements the #GtkFileChooser interface and must not have
+%GTK_DIALOG_DESTROY_WITH_PARENT set.
+
+Also note that the dialog needs to have its confirmative button
+added with response %GTK_RESPONSE_ACCEPT or %GTK_RESPONSE_OK in
+order for the button to take over the file selected in the dialog.
Since: 2.6
</description>
<parameters>
-<parameter name="clipboard">
-<parameter_description> a #GtkClipboard
+<parameter name="dialog">
+<parameter_description> the widget to use as dialog
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE is there is an image available, %FALSE otherwise.
+<return> a new button widget.
</return>
</function>
-<function name="gtk_text_buffer_add_mark">
+<function name="gtk_file_chooser_button_set_focus_on_click">
<description>
-Adds the mark at position @where. The mark must not be added to
-another buffer, and if its name is not %NULL then there must not
-be another mark in the buffer with the same name.
-
-Emits the "mark-set" signal as notification of the mark's initial
-placement.
+Sets whether the button will grab focus when it is clicked with the mouse.
+Making mouse clicks not grab focus is useful in places like toolbars where
+you don't want the keyboard focus removed from the main area of the
+application.
-Since: 2.12
+Since: 2.10
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="mark">
-<parameter_description> the mark to add
+<parameter name="button">
+<parameter_description> a #GtkFileChooserButton
</parameter_description>
</parameter>
-<parameter name="where">
-<parameter_description> location to place mark
+<parameter name="focus_on_click">
+<parameter_description> whether the button grabs focus when clicked with the mouse
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_menu_item_remove_submenu">
+<function name="gtk_file_chooser_button_set_title">
<description>
-Removes the widget's submenu.
+Modifies the @title of the browse dialog used by @button.
-Deprecated: 2.12: gtk_menu_item_remove_submenu() is deprecated and
-should not be used in newly written code. Use
-gtk_menu_item_set_submenu() instead.
+Since: 2.6
</description>
<parameters>
-<parameter name="menu_item">
-<parameter_description> a #GtkMenuItem
+<parameter name="button">
+<parameter_description> the button widget to modify.
+</parameter_description>
+</parameter>
+<parameter name="title">
+<parameter_description> the new browse dialog title.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_get_modal">
+<function name="gtk_file_chooser_button_set_width_chars">
<description>
-Returns whether the window is modal. See gtk_window_set_modal().
+Sets the width (in characters) that @button will use to @n_chars.
+Since: 2.6
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="button">
+<parameter_description> the button widget to examine.
+</parameter_description>
+</parameter>
+<parameter name="n_chars">
+<parameter_description> the new width, in characters.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the window is set to be modal and
-establishes a grab when shown
-</return>
+<return></return>
</function>
-<function name="gtk_status_icon_set_tooltip_text">
+<function name="gtk_file_chooser_dialog_new">
<description>
-Sets @text as the contents of the tooltip.
-
-This function will take care of setting #GtkStatusIcon:has-tooltip to
-%TRUE and of the default handler for the #GtkStatusIcon::query-tooltip
-signal.
-
-See also the #GtkStatusIcon:tooltip-text property and
-gtk_tooltip_set_text().
+Creates a new #GtkFileChooserDialog. This function is analogous to
+gtk_dialog_new_with_buttons().
-Since: 2.16
+Since: 2.4
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
+<parameter name="title">
+<parameter_description> Title of the dialog, or %NULL
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> the contents of the tooltip for @status_icon
+<parameter name="parent">
+<parameter_description> Transient parent of the dialog, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="action">
+<parameter_description> Open or save mode for the dialog
+</parameter_description>
+</parameter>
+<parameter name="first_button_text">
+<parameter_description> stock ID or text to go in the first button, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> response ID for the first button, then additional (button, id) pairs, ending with %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GtkFileChooserDialog
+
+</return>
</function>
-<function name="gtk_icon_theme_lookup_icon">
+<function name="gtk_file_chooser_dialog_new_with_backend">
<description>
-Looks up a named icon and returns a structure containing
-information such as the filename of the icon. The icon
-can then be rendered into a pixbuf using
-gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon()
-combines these two steps if all you need is the pixbuf.)
+Creates a new #GtkFileChooserDialog with a specified backend. This is
+especially useful if you use gtk_file_chooser_set_local_only() to allow
+non-local files and you use a more expressive vfs, such as gnome-vfs,
+to load files.
Since: 2.4
+Deprecated: 2.14: Use gtk_file_chooser_dialog_new() instead.
</description>
<parameters>
-<parameter name="icon_theme">
-<parameter_description> a #GtkIconTheme
+<parameter name="title">
+<parameter_description> Title of the dialog, or %NULL
</parameter_description>
</parameter>
-<parameter name="icon_name">
-<parameter_description> the name of the icon to lookup
+<parameter name="parent">
+<parameter_description> Transient parent of the dialog, or %NULL
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> desired icon size
+<parameter name="action">
+<parameter_description> Open or save mode for the dialog
</parameter_description>
</parameter>
-<parameter name="flags">
-<parameter_description> flags modifying the behavior of the icon lookup
+<parameter name="backend">
+<parameter_description> The name of the specific filesystem backend to use.
+</parameter_description>
+</parameter>
+<parameter name="first_button_text">
+<parameter_description> stock ID or text to go in the first button, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> response ID for the first button, then additional (button, id) pairs, ending with %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkIconInfo structure containing information
-about the icon, or %NULL if the icon wasn't found. Free with
-gtk_icon_info_free()
+<return> a new #GtkFileChooserDialog
</return>
</function>
-<function name="gtk_status_icon_set_title">
+<function name="gtk_file_chooser_error_quark">
<description>
-Sets the title of this tray icon.
-This should be a short, human-readable, localized string
-describing the tray icon. It may be used by tools like screen
-readers to render the tray icon.
+Registers an error quark for #GtkFileChooser if necessary.
-Since: 2.18
+Since: 2.4
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
-</parameter_description>
-</parameter>
-<parameter name="title">
-<parameter_description> the title
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> The error quark used for #GtkFileChooser errors.
+
+</return>
</function>
-<function name="gtk_tree_view_column_clear_attributes">
+<function name="gtk_file_chooser_get_action">
<description>
-Clears all existing attributes previously set with
-gtk_tree_view_column_set_attributes().
+Gets the type of operation that the file chooser is performing; see
+gtk_file_chooser_set_action().
+
+Since: 2.4
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> a #GtkTreeViewColumn
-</parameter_description>
-</parameter>
-<parameter name="cell_renderer">
-<parameter_description> a #GtkCellRenderer to clear the attribute mapping on.
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the action that the file selector is performing
+
+</return>
</function>
-<function name="gtk_text_iter_forward_to_end">
+<function name="gtk_file_chooser_get_create_folders">
<description>
-Moves @iter forward to the "end iterator," which points one past the last
-valid character in the buffer. gtk_text_iter_get_char() called on the
-end iterator returns 0, which is convenient for writing loops.
+Gets whether file choser will offer to create new folders.
+See gtk_file_chooser_set_create_folders().
+
+Since: 2.18
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the New Folder button should be displayed.
+
+</return>
</function>
-<function name="gtk_recent_chooser_menu_set_show_numbers">
+<function name="gtk_file_chooser_get_current_folder">
<description>
-Sets whether a number should be added to the items of @menu. The
-numbers are shown to provide a unique character for a mnemonic to
-be used inside ten menu item's label. Only the first the items
-get a number to avoid clashes.
+Gets the current folder of @chooser as a local filename.
+See gtk_file_chooser_set_current_folder().
-Since: 2.10
+Note that this is the folder that the file chooser is currently displaying
+(e.g. "/home/username/Documents"), which is <emphasis>not the same</emphasis>
+as the currently-selected folder if the chooser is in
+%GTK_FILE_CHOOSER_SELECT_FOLDER mode
+(e.g. "/home/username/Documents/selected-folder/". To get the
+currently-selected folder in that mode, use gtk_file_chooser_get_uri() as the
+usual way to get the selection.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="menu">
-<parameter_description> a #GtkRecentChooserMenu
-</parameter_description>
-</parameter>
-<parameter name="show_numbers">
-<parameter_description> whether to show numbers
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the full path of the current folder, or %NULL if the current
+path cannot be represented as a local filename. Free with g_free(). This
+function will also return %NULL if the file chooser was unable to load the
+last folder that was requested from it; for example, as would be for calling
+gtk_file_chooser_set_current_folder() on a nonexistent folder.
+
+</return>
</function>
-<function name="gtk_draw_polygon">
+<function name="gtk_file_chooser_get_current_folder_file">
<description>
-Draws a polygon on @window with the given parameters.
+Gets the current folder of @chooser as #GFile.
+See gtk_file_chooser_get_current_folder_uri().
-Deprecated: 2.0: Use gtk_paint_polygon() instead.
+Since: 2.14
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
-</parameter_description>
-</parameter>
-<parameter name="shadow_type">
-<parameter_description> type of shadow to draw
-</parameter_description>
-</parameter>
-<parameter name="points">
-<parameter_description> an array of #GdkPoint<!-- -->s
-</parameter_description>
-</parameter>
-<parameter name="npoints">
-<parameter_description> length of @points
-</parameter_description>
-</parameter>
-<parameter name="fill">
-<parameter_description> %TRUE if the polygon should be filled
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GFile for the current folder.
+
+</return>
</function>
-<function name="gtk_tool_item_get_text_size_group">
+<function name="gtk_file_chooser_get_current_folder_uri">
<description>
-Returns the size group used for labels in @tool_item. Custom subclasses of
-#GtkToolItem should call this function and use the size group for labels.
+Gets the current folder of @chooser as an URI.
+See gtk_file_chooser_set_current_folder_uri().
-Since: 2.20
+Note that this is the folder that the file chooser is currently displaying
+(e.g. "file:///home/username/Documents"), which is <emphasis>not the same</emphasis>
+as the currently-selected folder if the chooser is in
+%GTK_FILE_CHOOSER_SELECT_FOLDER mode
+(e.g. "file:///home/username/Documents/selected-folder/". To get the
+currently-selected folder in that mode, use gtk_file_chooser_get_uri() as the
+usual way to get the selection.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkSizeGroup
+<return> the URI for the current folder. Free with g_free(). This
+function will also return %NULL if the file chooser was unable to load the
+last folder that was requested from it; for example, as would be for calling
+gtk_file_chooser_set_current_folder_uri() on a nonexistent folder.
</return>
</function>
-<function name="gtk_tree_model_get_string_from_iter">
+<function name="gtk_file_chooser_get_do_overwrite_confirmation">
<description>
-Generates a string representation of the iter. This string is a ':'
-separated list of numbers. For example, "4:10:0:3" would be an
-acceptable return value for this string.
+Queries whether a file chooser is set to confirm for overwriting when the user
+types a file name that already exists.
-Since: 2.2
+Since: 2.8
</description>
<parameters>
-<parameter name="tree_model">
-<parameter_description> A #GtkTreeModel.
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> An #GtkTreeIter.
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
</parameters>
-<return> A newly-allocated string. Must be freed with g_free().
+<return> %TRUE if the file chooser will present a confirmation dialog;
+%FALSE otherwise.
</return>
</function>
-<function name="gtk_file_chooser_remove_shortcut_folder">
+<function name="gtk_file_chooser_get_extra_widget">
<description>
-Removes a folder from a file chooser's list of shortcut folders.
+Gets the current preview widget; see
+gtk_file_chooser_set_extra_widget().
Since: 2.4
@@ -17036,364 +17372,278 @@ Since: 2.4
<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
-<parameter name="folder">
-<parameter_description> filename of the folder to remove
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> location to store error, or %NULL
-</parameter_description>
-</parameter>
</parameters>
-<return> %TRUE if the operation succeeds, %FALSE otherwise.
-In the latter case, the @error will be set as appropriate.
-
-See also: gtk_file_chooser_add_shortcut_folder()
+<return> the current extra widget, or %NULL
</return>
</function>
-<function name="gtk_image_set_from_icon_set">
+<function name="gtk_file_chooser_get_file">
<description>
-See gtk_image_new_from_icon_set() for details.
+Gets the #GFile for the currently selected file in
+the file selector. If multiple files are selected,
+one of the files will be returned at random.
+
+If the file chooser is in folder mode, this function returns the selected
+folder.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GtkImage
-</parameter_description>
-</parameter>
-<parameter name="icon_set">
-<parameter_description> a #GtkIconSet
-</parameter_description>
-</parameter>
-<parameter name="size">
-<parameter_description> a stock icon size
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a selected #GFile. You own the returned file;
+use g_object_unref() to release it.
+
+</return>
</function>
-<function name="gtk_icon_view_get_path_at_pos">
+<function name="gtk_file_chooser_get_filename">
<description>
-Finds the path at the point (@x, @y), relative to bin_window coordinates.
-See gtk_icon_view_get_item_at_pos(), if you are also interested in
-the cell at the specified position.
-See gtk_icon_view_convert_widget_to_bin_window_coords() for converting
-widget coordinates to bin_window coordinates.
+Gets the filename for the currently selected file in
+the file selector. If multiple files are selected,
+one of the filenames will be returned at random.
-Since: 2.6
+If the file chooser is in folder mode, this function returns the selected
+folder.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> A #GtkIconView.
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> The x position to be identified
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> The y position to be identified
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
</parameters>
-<return> The #GtkTreePath corresponding to the icon or %NULL
-if no icon exists at that position.
+<return> The currently selected filename, or %NULL
+if no file is selected, or the selected file can't
+be represented with a local filename. Free with g_free().
</return>
</function>
-<function name="gtk_widget_get_pango_context">
+<function name="gtk_file_chooser_get_filenames">
<description>
-Gets a #PangoContext with the appropriate font map, font description,
-and base direction for this widget. Unlike the context returned
-by gtk_widget_create_pango_context(), this context is owned by
-the widget (it can be used until the screen for the widget changes
-or the widget is removed from its toplevel), and will be updated to
-match any changes to the widget's attributes.
-
-If you create and keep a #PangoLayout using this context, you must
-deal with changes to the context by calling pango_layout_context_changed()
-on the layout in response to the #GtkWidget::style-set and
-#GtkWidget::direction-changed signals for the widget.
+Lists all the selected files and subfolders in the current folder of
+ chooser The returned names are full absolute paths. If files in the current
+folder cannot be represented as local filenames they will be ignored. (See
+gtk_file_chooser_get_uris())
+Since: 2.4
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
</parameters>
-<return> the #PangoContext for the widget.
+<return> a #GSList containing the filenames of all selected
+files and subfolders in the current folder. Free the returned list
+with g_slist_free(), and the filenames with g_free().
+
</return>
</function>
-<function name="gtk_menu_get_title">
+<function name="gtk_file_chooser_get_files">
<description>
-Returns the title of the menu. See gtk_menu_set_title().
+Lists all the selected files and subfolders in the current folder of @chooser
+as #GFile. An internal function, see gtk_file_chooser_get_uris().
+Since: 2.14
</description>
<parameters>
-<parameter name="menu">
-<parameter_description> a #GtkMenu
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
</parameters>
-<return> the title of the menu, or %NULL if the menu has no
-title set on it. This string is owned by the widget and should
-not be modified or freed.
+<return> a #GSList containing a #GFile for each selected
+file and subfolder in the current folder. Free the returned list
+with g_slist_free(), and the files with g_object_unref().
+
</return>
</function>
-<function name="gtk_clipboard_request_text">
+<function name="gtk_file_chooser_get_filter">
<description>
-Requests the contents of the clipboard as text. When the text is
-later received, it will be converted to UTF-8 if necessary, and
- callback will be called.
+Gets the current filter; see gtk_file_chooser_set_filter().
-The @text parameter to @callback will contain the resulting text if
-the request succeeded, or %NULL if it failed. This could happen for
-various reasons, in particular if the clipboard was empty or if the
-contents of the clipboard could not be converted into text form.
+Since: 2.4
</description>
<parameters>
-<parameter name="clipboard">
-<parameter_description> a #GtkClipboard
-</parameter_description>
-</parameter>
-<parameter name="callback">
-<parameter_description> a function to call when the text is received,
-or the retrieval fails. (It will always be called
-one way or the other.)
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to @callback.
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the current filter, or %NULL
+
+</return>
</function>
-<function name="gtk_tree_view_column_cell_get_position">
+<function name="gtk_file_chooser_get_local_only">
<description>
-Obtains the horizontal position and size of a cell in a column. If the
-cell is not found in the column, @start_pos and @width are not changed and
-%FALSE is returned.
+Gets whether only local files can be selected in the
+file selector. See gtk_file_chooser_set_local_only()
+Since: 2.4
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> a #GtkTreeViewColumn
-</parameter_description>
-</parameter>
-<parameter name="cell_renderer">
-<parameter_description> a #GtkCellRenderer
-</parameter_description>
-</parameter>
-<parameter name="start_pos">
-<parameter_description> return location for the horizontal position of @cell within
- tree_column, may be %NULL
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> return location for the width of @cell, may be %NULL
+<parameter name="chooser">
+<parameter_description> a #GtkFileChoosre
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @cell belongs to @tree_column.
+<return> %TRUE if only local files can be selected.
+
</return>
</function>
-<function name="gtk_status_icon_position_menu">
+<function name="gtk_file_chooser_get_preview_file">
<description>
-Menu positioning function to use with gtk_menu_popup()
-to position @menu aligned to the status icon @user_data.
+Gets the #GFile that should be previewed in a custom preview
+Internal function, see gtk_file_chooser_get_preview_uri().
-Since: 2.10
+Since: 2.14
</description>
<parameters>
-<parameter name="menu">
-<parameter_description> the #GtkMenu
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> return location for the x position
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> return location for the y position
-</parameter_description>
-</parameter>
-<parameter name="push_in">
-<parameter_description> whether the first menu item should be offset (pushed in) to be
-aligned with the menu popup position (only useful for GtkOptionMenu).
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> the status icon to position the menu on
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GFile for the file to preview,
+or %NULL if no file is selected. Free with g_object_unref().
+
+</return>
</function>
-<function name="gtk_text_iter_forward_to_line_end">
+<function name="gtk_file_chooser_get_preview_filename">
<description>
-Moves the iterator to point to the paragraph delimiter characters,
-which will be either a newline, a carriage return, a carriage
-return/newline in sequence, or the Unicode paragraph separator
-character. If the iterator is already at the paragraph delimiter
-characters, moves to the paragraph delimiter characters for the
-next line. If @iter is on the last line in the buffer, which does
-not end in paragraph delimiters, moves to the end iterator (end of
-the last line), and returns %FALSE.
+Gets the filename that should be previewed in a custom preview
+widget. See gtk_file_chooser_set_preview_widget().
+Since: 2.4
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if we moved and the new location is not the end iterator
+<return> the filename to preview, or %NULL if no file
+is selected, or if the selected file cannot be represented
+as a local filename. Free with g_free()
+
</return>
</function>
-<function name="gtk_cell_renderer_render">
+<function name="gtk_file_chooser_get_preview_uri">
<description>
-Invokes the virtual render function of the #GtkCellRenderer. The three
-passed-in rectangles are areas of @window. Most renderers will draw within
- cell_area; the xalign, yalign, xpad, and ypad fields of the #GtkCellRenderer
-should be honored with respect to @cell_area. @background_area includes the
-blank space around the cell, and also the area containing the tree expander;
-so the @background_area rectangles for all cells tile to cover the entire
- window @expose_area is a clip rectangle.
+Gets the URI that should be previewed in a custom preview
+widget. See gtk_file_chooser_set_preview_widget().
+
+Since: 2.4
</description>
<parameters>
-<parameter name="cell">
-<parameter_description> a #GtkCellRenderer
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkDrawable to draw to
-</parameter_description>
-</parameter>
-<parameter name="widget">
-<parameter_description> the widget owning @window
-</parameter_description>
-</parameter>
-<parameter name="background_area">
-<parameter_description> entire cell area (including tree expanders and maybe
-padding on the sides)
-</parameter_description>
-</parameter>
-<parameter name="cell_area">
-<parameter_description> area normally rendered by a cell renderer
-</parameter_description>
-</parameter>
-<parameter name="expose_area">
-<parameter_description> area that actually needs updating
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> flags that affect rendering
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the URI for the file to preview, or %NULL if no file is
+selected. Free with g_free().
+
+</return>
</function>
-<function name="gtk_activatable_do_set_related_action">
+<function name="gtk_file_chooser_get_preview_widget">
<description>
-This is a utility function for #GtkActivatable implementors.
-
-When implementing #GtkActivatable you must call this when
-handling changes of the #GtkActivatable:related-action, and
-you must also use this to break references in #GObject->dispose().
-
-This function adds a reference to the currently set related
-action for you, it also makes sure the #GtkActivatable->update()
-method is called when the related #GtkAction properties change
-and registers to the action's proxy list.
-
-<note><para>Be careful to call this before setting the local
-copy of the #GtkAction property, since this function uses
-gtk_activatable_get_action() to retrieve the previous action</para></note>
+Gets the current preview widget; see
+gtk_file_chooser_set_preview_widget().
-Since: 2.16
+Since: 2.4
</description>
<parameters>
-<parameter name="activatable">
-<parameter_description> a #GtkActivatable
-</parameter_description>
-</parameter>
-<parameter name="action">
-<parameter_description> the #GtkAction to set
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the current preview widget, or %NULL
+
+</return>
</function>
-<function name="gtk_event_box_get_above_child">
+<function name="gtk_file_chooser_get_preview_widget_active">
<description>
-Returns whether the event box window is above or below the
-windows of its child. See gtk_event_box_set_above_child() for
-details.
+Gets whether the preview widget set by gtk_file_chooser_set_preview_widget()
+should be shown for the current filename. See
+gtk_file_chooser_set_preview_widget_active().
Since: 2.4
</description>
<parameters>
-<parameter name="event_box">
-<parameter_description> a #GtkEventBox
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the event box window is above the window
-of its child.
+<return> %TRUE if the preview widget is active for the current filename.
</return>
</function>
-<function name="gtk_menu_set_monitor">
+<function name="gtk_file_chooser_get_select_multiple">
<description>
-Informs GTK+ on which monitor a menu should be popped up.
-See gdk_screen_get_monitor_geometry().
-
-This function should be called from a #GtkMenuPositionFunc if the
-menu should not appear on the same monitor as the pointer. This
-information can't be reliably inferred from the coordinates returned
-by a #GtkMenuPositionFunc, since, for very long menus, these coordinates
-may extend beyond the monitor boundaries or even the screen boundaries.
+Gets whether multiple files can be selected in the file
+selector. See gtk_file_chooser_set_select_multiple().
Since: 2.4
</description>
<parameters>
-<parameter name="menu">
-<parameter_description> a #GtkMenu
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
-<parameter name="monitor_num">
-<parameter_description> the number of the monitor on which the menu should
-be popped up
+</parameters>
+<return> %TRUE if multiple files can be selected.
+
+</return>
+</function>
+
+<function name="gtk_file_chooser_get_show_hidden">
+<description>
+Gets whether hidden files and folders are displayed in the file selector.
+See gtk_file_chooser_set_show_hidden().
+
+Since: 2.6
+
+</description>
+<parameters>
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if hidden files and folders are displayed.
+
+</return>
</function>
<function name="gtk_file_chooser_get_uri">
@@ -17420,219 +17670,190 @@ if no file is selected. Free with g_free()
</return>
</function>
-<function name="gtk_assistant_update_buttons_state">
+<function name="gtk_file_chooser_get_uris">
<description>
-Forces @assistant to recompute the buttons state.
-
-GTK+ automatically takes care of this in most situations,
-e.g. when the user goes to a different page, or when the
-visibility or completeness of a page changes.
-
-One situation where it can be necessary to call this
-function is when changing a value on the current page
-affects the future page flow of the assistant.
+Lists all the selected files and subfolders in the current folder of
+ chooser The returned names are full absolute URIs.
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #GSList containing the URIs of all selected
+files and subfolders in the current folder. Free the returned list
+with g_slist_free(), and the filenames with g_free().
+
+</return>
</function>
-<function name="gtk_radio_action_set_current_value">
+<function name="gtk_file_chooser_get_use_preview_label">
<description>
-Sets the currently active group member to the member with value
-property @current_value.
+Gets whether a stock label should be drawn with the name of the previewed
+file. See gtk_file_chooser_set_use_preview_label().
-Since: 2.10
</description>
<parameters>
-<parameter name="action">
-<parameter_description> a #GtkRadioAction
-</parameter_description>
-</parameter>
-<parameter name="current_value">
-<parameter_description> the new value
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the file chooser is set to display a label with the
+name of the previewed file, %FALSE otherwise.
+</return>
</function>
-<function name="gtk_font_selection_get_face">
+<function name="gtk_file_chooser_list_filters">
<description>
-Gets the #PangoFontFace representing the selected font group
-details (i.e. family, slant, weight, width, etc).
+Lists the current set of user-selectable filters; see
+gtk_file_chooser_add_filter(), gtk_file_chooser_remove_filter().
-Since: 2.14
+Since: 2.4
</description>
<parameters>
-<parameter name="fontsel">
-<parameter_description> a #GtkFontSelection
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
</parameters>
-<return> A #PangoFontFace representing the selected font
-group details. The returned object is owned by @fontsel and
-must not be modified or freed.
+<return> a #GSList containing the current set of
+user selectable filters. The contents of the list are
+owned by GTK+, but you must free the list itself with
+g_slist_free() when you are done with it.
</return>
</function>
-<function name="gtk_print_unix_dialog_get_page_setup_set">
+<function name="gtk_file_chooser_list_shortcut_folder_uris">
<description>
-Gets the page setup that is used by the #GtkPrintUnixDialog.
+Queries the list of shortcut folders in the file chooser, as set by
+gtk_file_chooser_add_shortcut_folder_uri().
-Since: 2.18
+Since: 2.4
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
</parameters>
-<return> whether a page setup was set by user.
+<return> A list of folder URIs, or %NULL if there are no shortcut
+folders. Free the returned list with g_slist_free(), and the URIs with
+g_free().
</return>
</function>
-<function name="gtk_image_menu_item_get_image">
+<function name="gtk_file_chooser_list_shortcut_folders">
<description>
-Gets the widget that is currently set as the image of @image_menu_item.
-See gtk_image_menu_item_set_image().
+Queries the list of shortcut folders in the file chooser, as set by
+gtk_file_chooser_add_shortcut_folder().
+
+Since: 2.4
</description>
<parameters>
-<parameter name="image_menu_item">
-<parameter_description> a #GtkImageMenuItem.
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
</parameters>
-<return> the widget set as image of @image_menu_item.
+<return> A list of folder filenames, or %NULL if there are no shortcut
+folders. Free the returned list with g_slist_free(), and the filenames with
+g_free().
+
</return>
</function>
-<function name="gtk_menu_shell_set_take_focus">
+<function name="gtk_file_chooser_remove_filter">
<description>
-If @take_focus is %TRUE (the default) the menu shell will take the keyboard
-focus so that it will receive all keyboard events which is needed to enable
-keyboard navigation in menus.
-
-Setting @take_focus to %FALSE is useful only for special applications
-like virtual keyboard implementations which should not take keyboard
-focus.
-
-The @take_focus state of a menu or menu bar is automatically propagated
-to submenus whenever a submenu is popped up, so you don't have to worry
-about recursively setting it for your entire menu hierarchy. Only when
-programmatically picking a submenu and popping it up manually, the
- take_focus property of the submenu needs to be set explicitely.
-
-Note that setting it to %FALSE has side-effects:
-
-If the focus is in some other app, it keeps the focus and keynav in
-the menu doesn't work. Consequently, keynav on the menu will only
-work if the focus is on some toplevel owned by the onscreen keyboard.
-
-To avoid confusing the user, menus with @take_focus set to %FALSE
-should not display mnemonics or accelerators, since it cannot be
-guaranteed that they will work.
-
-See also gdk_keyboard_grab()
+Removes @filter from the list of filters that the user can select between.
-Since: 2.8
+Since: 2.4
</description>
<parameters>
-<parameter name="menu_shell">
-<parameter_description> a #GtkMenuShell
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
-<parameter name="take_focus">
-<parameter_description> %TRUE if the menu shell should take the keyboard focus on popup.
+<parameter name="filter">
+<parameter_description> a #GtkFileFilter
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_info_bar_set_response_sensitive">
+<function name="gtk_file_chooser_remove_shortcut_folder">
<description>
-Calls gtk_widget_set_sensitive (widget, setting) for each
-widget in the info bars's action area with the given response_id.
-A convenient way to sensitize/desensitize dialog buttons.
+Removes a folder from a file chooser's list of shortcut folders.
-Since: 2.18
+Since: 2.4
</description>
<parameters>
-<parameter name="info_bar">
-<parameter_description> a #GtkInfoBar
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
-<parameter name="response_id">
-<parameter_description> a response ID
+<parameter name="folder">
+<parameter_description> filename of the folder to remove
</parameter_description>
</parameter>
-<parameter name="setting">
-<parameter_description> TRUE for sensitive
+<parameter name="error">
+<parameter_description> location to store error, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
-</function>
-
-<function name="gtk_widget_get_can_focus">
-<description>
-Determines whether @widget can own the input focus. See
-gtk_widget_set_can_focus().
-
-Since: 2.18
+<return> %TRUE if the operation succeeds, %FALSE otherwise.
+In the latter case, the @error will be set as appropriate.
-</description>
-<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-</parameters>
-<return> %TRUE if @widget can own the input focus, %FALSE otherwise
+See also: gtk_file_chooser_add_shortcut_folder()
</return>
</function>
-<function name="gtk_layout_get_hadjustment">
+<function name="gtk_file_chooser_remove_shortcut_folder_uri">
<description>
-This function should only be called after the layout has been
-placed in a #GtkScrolledWindow or otherwise configured for
-scrolling. It returns the #GtkAdjustment used for communication
-between the horizontal scrollbar and @layout.
-
-See #GtkScrolledWindow, #GtkScrollbar, #GtkAdjustment for details.
+Removes a folder URI from a file chooser's list of shortcut folders.
+Since: 2.4
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #GtkLayout
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
+</parameter_description>
+</parameter>
+<parameter name="uri">
+<parameter_description> URI of the folder to remove
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store error, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> horizontal scroll adjustment
+<return> %TRUE if the operation succeeds, %FALSE otherwise.
+In the latter case, the @error will be set as appropriate.
+
+See also: gtk_file_chooser_add_shortcut_folder_uri()
+
</return>
</function>
-<function name="gtk_file_chooser_unselect_all">
+<function name="gtk_file_chooser_select_all">
<description>
-Unselects all the files in the current folder of a file chooser.
+Selects all the files in the current folder of a file chooser.
Since: 2.4
@@ -17646,231 +17867,260 @@ Since: 2.4
<return></return>
</function>
-<function name="gtk_entry_buffer_get_text">
+<function name="gtk_file_chooser_select_file">
<description>
-Retrieves the contents of the buffer.
-
-The memory pointer returned by this call will not change
-unless this object emits a signal, or is finalized.
+Selects the file referred to by @file. An internal function. See
+_gtk_file_chooser_select_uri().
-Since: 2.18
+Since: 2.14
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkEntryBuffer
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
+</parameter_description>
+</parameter>
+<parameter name="file">
+<parameter_description> the file to select
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store error, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the contents of the widget as a
-string. This string points to internally allocated
-storage in the buffer and must not be freed, modified or
-stored.
+<return> %TRUE if both the folder could be changed and the path was
+selected successfully, %FALSE otherwise.
</return>
</function>
-<function name="gtk_assistant_get_page_complete">
+<function name="gtk_file_chooser_select_filename">
<description>
-Gets whether @page is complete.
+Selects a filename. If the file name isn't in the current
+folder of @chooser, then the current folder of @chooser will
+be changed to the folder containing @filename.
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
-<parameter name="page">
-<parameter_description> a page of @assistant
+<parameter name="filename">
+<parameter_description> the filename to select
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @page is complete.
+<return> %TRUE if both the folder could be changed and the file was
+selected successfully, %FALSE otherwise.
</return>
</function>
-<function name="gtk_spin_button_set_range">
+<function name="gtk_file_chooser_select_uri">
<description>
-Sets the minimum and maximum allowable values for @spin_button
+Selects the file to by @uri. If the URI doesn't refer to a
+file in the current folder of @chooser, then the current folder of
+ chooser will be changed to the folder containing @filename.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
-</parameter_description>
-</parameter>
-<parameter name="min">
-<parameter_description> minimum allowable value
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
-<parameter name="max">
-<parameter_description> maximum allowable value
+<parameter name="uri">
+<parameter_description> the URI to select
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if both the folder could be changed and the URI was
+selected successfully, %FALSE otherwise.
+
+</return>
</function>
-<function name="gtk_text_iter_get_visible_line_offset">
+<function name="gtk_file_chooser_set_action">
<description>
-Returns the offset in characters from the start of the
-line to the given @iter, not counting characters that
-are invisible due to tags with the "invisible" flag
-toggled on.
+Sets the type of operation that the chooser is performing; the
+user interface is adapted to suit the selected action. For example,
+an option to create a new folder might be shown if the action is
+%GTK_FILE_CHOOSER_ACTION_SAVE but not if the action is
+%GTK_FILE_CHOOSER_ACTION_OPEN.
+Since: 2.4
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
+</parameter_description>
+</parameter>
+<parameter name="action">
+<parameter_description> the action that the file selector is performing
</parameter_description>
</parameter>
</parameters>
-<return> offset in visible characters from the start of the line
-</return>
+<return></return>
</function>
-<function name="gtk_widget_mnemonic_activate">
+<function name="gtk_file_chooser_set_create_folders">
<description>
-Emits the #GtkWidget::mnemonic-activate signal.
-
-The default handler for this signal activates the @widget if
- group_cycling is %FALSE, and just grabs the focus if @group_cycling
-is %TRUE.
+Sets whether file choser will offer to create new folders.
+This is only relevant if the action is not set to be
+%GTK_FILE_CHOOSER_ACTION_OPEN.
+Since: 2.18
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
-<parameter name="group_cycling">
-<parameter_description> %TRUE if there are other widgets with the same mnemonic
+<parameter name="create_folders">
+<parameter_description> %TRUE if the New Folder button should be displayed
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the signal has been handled
-</return>
+<return></return>
</function>
-<function name="gtk_icon_theme_get_search_path">
+<function name="gtk_file_chooser_set_current_folder">
<description>
-Gets the current search path. See gtk_icon_theme_set_search_path().
+Sets the current folder for @chooser from a local filename.
+The user will be shown the full contents of the current folder,
+plus user interface elements for navigating to other folders.
Since: 2.4
</description>
<parameters>
-<parameter name="icon_theme">
-<parameter_description> a #GtkIconTheme
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> location to store a list of icon theme path directories or %NULL
-The stored value should be freed with g_strfreev().
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
-<parameter name="n_elements">
-<parameter_description> location to store number of elements
-in @path, or %NULL
+<parameter name="filename">
+<parameter_description> the full path of the new current folder
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the folder could be changed successfully, %FALSE
+otherwise.
+
+</return>
</function>
-<function name="gtk_icon_theme_add_builtin_icon">
+<function name="gtk_file_chooser_set_current_folder_file">
<description>
-Registers a built-in icon for icon theme lookups. The idea
-of built-in icons is to allow an application or library
-that uses themed icons to function requiring files to
-be present in the file system. For instance, the default
-images for all of GTK+'s stock icons are registered
-as built-icons.
-
-In general, if you use gtk_icon_theme_add_builtin_icon()
-you should also install the icon in the icon theme, so
-that the icon is generally available.
-
-This function will generally be used with pixbufs loaded
-via gdk_pixbuf_new_from_inline().
+Sets the current folder for @chooser from a #GFile.
+Internal function, see gtk_file_chooser_set_current_folder_uri().
-Since: 2.4
+Since: 2.14
</description>
<parameters>
-<parameter name="icon_name">
-<parameter_description> the name of the icon to register
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> the size at which to register the icon (different
-images can be registered for the same icon name
-at different sizes.)
+<parameter name="file">
+<parameter_description> the #GFile for the new folder
</parameter_description>
</parameter>
-<parameter name="pixbuf">
-<parameter_description> #GdkPixbuf that contains the image to use
-for @icon_name.
+<parameter name="error">
+<parameter_description> location to store error, or %NULL.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the folder could be changed successfully, %FALSE
+otherwise.
+
+</return>
</function>
-<function name="gtk_cell_editable_editing_done">
+<function name="gtk_file_chooser_set_current_folder_uri">
<description>
-Emits the #GtkCellEditable::editing-done signal.
+Sets the current folder for @chooser from an URI.
+The user will be shown the full contents of the current folder,
+plus user interface elements for navigating to other folders.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="cell_editable">
-<parameter_description> A #GtkTreeEditable
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
+</parameter_description>
+</parameter>
+<parameter name="uri">
+<parameter_description> the URI for the new current folder
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the folder could be changed successfully, %FALSE
+otherwise.
+
+</return>
</function>
-<function name="gtk_tree_model_filter_set_visible_column">
+<function name="gtk_file_chooser_set_current_name">
<description>
-Sets @column of the child_model to be the column where @filter should
-look for visibility information. @columns should be a column of type
-%G_TYPE_BOOLEAN, where %TRUE means that a row is visible, and %FALSE
-if not.
+Sets the current name in the file selector, as if entered
+by the user. Note that the name passed in here is a UTF-8
+string rather than a filename. This function is meant for
+such uses as a suggested name in a "Save As..." dialog.
+
+If you want to preselect a particular existing file, you should use
+gtk_file_chooser_set_filename() or gtk_file_chooser_set_uri() instead.
+Please see the documentation for those functions for an example of using
+gtk_file_chooser_set_current_name() as well.
Since: 2.4
</description>
<parameters>
-<parameter name="filter">
-<parameter_description> A #GtkTreeModelFilter.
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
-<parameter name="column">
-<parameter_description> A #gint which is the column containing the visible information.
+<parameter name="name">
+<parameter_description> the filename to use, as a UTF-8 string
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_set_vadjustment">
+<function name="gtk_file_chooser_set_do_overwrite_confirmation">
<description>
-Sets the #GtkAdjustment for the current vertical aspect.
+Sets whether a file chooser in %GTK_FILE_CHOOSER_ACTION_SAVE mode will present
+a confirmation dialog if the user types a file name that already exists. This
+is %FALSE by default.
+
+Regardless of this setting, the @chooser will emit the
+#GtkFileChooser::confirm-overwrite signal when appropriate.
+
+If all you need is the stock confirmation dialog, set this property to %TRUE.
+You can override the way confirmation is done by actually handling the
+#GtkFileChooser::confirm-overwrite signal; please refer to its documentation
+for the details.
+
+Since: 2.8
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
-<parameter name="adjustment">
-<parameter_description> The #GtkAdjustment to set, or %NULL
+<parameter name="do_overwrite_confirmation">
+<parameter_description> whether to confirm overwriting in save mode
</parameter_description>
</parameter>
</parameters>
@@ -17897,291 +18147,393 @@ Since: 2.4
<return></return>
</function>
-<function name="gtk_test_slider_get_value">
+<function name="gtk_file_chooser_set_file">
<description>
-Retrive the literal adjustment value for GtkRange based
-widgets and spin buttons. Note that the value returned by
-this function is anything between the lower and upper bounds
-of the adjustment belonging to @widget, and is not a percentage
-as passed in to gtk_test_slider_set_perc().
+Sets @file as the current filename for the file chooser, by changing
+to the file's parent folder and actually selecting the file in list. If
+the @chooser is in %GTK_FILE_CHOOSER_ACTION_SAVE mode, the file's base name
+will also appear in the dialog's file name entry.
+
+If the file name isn't in the current folder of @chooser, then the current
+folder of @chooser will be changed to the folder containing @filename. This
+is equivalent to a sequence of gtk_file_chooser_unselect_all() followed by
+gtk_file_chooser_select_filename().
+
+Note that the file must exist, or nothing will be done except
+for the directory change.
+
+If you are implementing a <guimenuitem>File/Save As...</guimenuitem> dialog,
+you should use this function if you already have a file name to which the
+user may save; for example, when the user opens an existing file and then
+does <guimenuitem>File/Save As...</guimenuitem> on it. If you don't have
+a file name already — for example, if the user just created a new
+file and is saving it for the first time, do not call this function.
+Instead, use something similar to this:
+|[
+if (document_is_new)
+{
+/ * the user just created a new document * /
+gtk_file_chooser_set_current_folder_file (chooser, default_file_for_saving);
+gtk_file_chooser_set_current_name (chooser, "Untitled document");
+}
+else
+{
+/ * the user edited an existing document * /
+gtk_file_chooser_set_file (chooser, existing_file);
+}
+]|
Since: 2.14
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> valid widget pointer.
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
+</parameter_description>
+</parameter>
+<parameter name="file">
+<parameter_description> the #GFile to set as current
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> location to store the error, or %NULL to ignore errors.
</parameter_description>
</parameter>
</parameters>
-<return> adjustment->value for an adjustment belonging to @widget.
+<return> %TRUE if both the folder could be changed and the file was
+selected successfully, %FALSE otherwise.
</return>
</function>
-<function name="gtk_text_view_get_pixels_inside_wrap">
+<function name="gtk_file_chooser_set_filename">
<description>
-Gets the value set by gtk_text_view_set_pixels_inside_wrap().
+Sets @filename as the current filename for the file chooser, by changing
+to the file's parent folder and actually selecting the file in list. If
+the @chooser is in %GTK_FILE_CHOOSER_ACTION_SAVE mode, the file's base name
+will also appear in the dialog's file name entry.
+
+If the file name isn't in the current folder of @chooser, then the current
+folder of @chooser will be changed to the folder containing @filename. This
+is equivalent to a sequence of gtk_file_chooser_unselect_all() followed by
+gtk_file_chooser_select_filename().
+Note that the file must exist, or nothing will be done except
+for the directory change.
+
+If you are implementing a <guimenuitem>File/Save As...</guimenuitem> dialog,
+you should use this function if you already have a file name to which the
+user may save; for example, when the user opens an existing file and then
+does <guimenuitem>File/Save As...</guimenuitem> on it. If you don't have
+a file name already — for example, if the user just created a new
+file and is saving it for the first time, do not call this function.
+Instead, use something similar to this:
+|[
+if (document_is_new)
+{
+/ * the user just created a new document * /
+gtk_file_chooser_set_current_folder (chooser, default_folder_for_saving);
+gtk_file_chooser_set_current_name (chooser, "Untitled document");
+}
+else
+{
+/ * the user edited an existing document * /
+gtk_file_chooser_set_filename (chooser, existing_filename);
+}
+]|
+
+Since: 2.4
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
+</parameter_description>
+</parameter>
+<parameter name="filename">
+<parameter_description> the filename to set as current
</parameter_description>
</parameter>
</parameters>
-<return> default number of pixels of blank space between wrapped lines
+<return> %TRUE if both the folder could be changed and the file was
+selected successfully, %FALSE otherwise.
+
</return>
</function>
-<function name="gtk_action_group_add_actions">
+<function name="gtk_file_chooser_set_filter">
<description>
-This is a convenience function to create a number of actions and add them
-to the action group.
-
-The "activate" signals of the actions are connected to the callbacks and
-their accel paths are set to
-<literal><Actions>/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.
+Sets the current filter; only the files that pass the
+filter will be displayed. If the user-selectable list of filters
+is non-empty, then the filter should be one of the filters
+in that list. Setting the current filter when the list of
+filters is empty is useful if you want to restrict the displayed
+set of files without letting the user change it.
Since: 2.4
</description>
<parameters>
-<parameter name="action_group">
-<parameter_description> the action group
-</parameter_description>
-</parameter>
-<parameter name="entries">
-<parameter_description> an array of action descriptions
-</parameter_description>
-</parameter>
-<parameter name="n_entries">
-<parameter_description> the number of entries
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> data to pass to the action callbacks
+<parameter name="filter">
+<parameter_description> a #GtkFileFilter
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_accel_map_foreach">
+<function name="gtk_file_chooser_set_local_only">
<description>
-Loops over the entries in the accelerator map whose accel path
-doesn't match any of the filters added with gtk_accel_map_add_filter(),
-and execute @foreach_func on each. The signature of @foreach_func is
-that of #GtkAccelMapForeach, the @changed parameter indicates whether
-this accelerator was changed during runtime (thus, would need
-saving during an accelerator map dump).
+Sets whether only local files can be selected in the
+file selector. If @local_only is %TRUE (the default),
+then the selected file are files are guaranteed to be
+accessible through the operating systems native file
+file system and therefore the application only
+needs to worry about the filename functions in
+#GtkFileChooser, like gtk_file_chooser_get_filename(),
+rather than the URI functions like
+gtk_file_chooser_get_uri(),
+
+Since: 2.4
</description>
<parameters>
-<parameter name="data">
-<parameter_description> data to be passed into @foreach_func
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
-<parameter name="foreach_func">
-<parameter_description> function to be executed for each accel map entry which
-is not filtered out
+<parameter name="local_only">
+<parameter_description> %TRUE if only local files can be selected
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_set_render_icon">
+<function name="gtk_file_chooser_set_preview_widget">
<description>
-Renders an icon using gtk_style_render_icon(). In most cases,
-gtk_widget_render_icon() is better, since it automatically provides
-most of the arguments from the current widget settings. This
-function never returns %NULL; if the icon can't be rendered
-(perhaps because an image file fails to load), a default "missing
-image" icon will be returned instead.
+Sets an application-supplied widget to use to display a custom preview
+of the currently selected file. To implement a preview, after setting the
+preview widget, you connect to the #GtkFileChooser::update-preview
+signal, and call gtk_file_chooser_get_preview_filename() or
+gtk_file_chooser_get_preview_uri() on each change. If you can
+display a preview of the new file, update your widget and
+set the preview active using gtk_file_chooser_set_preview_widget_active().
+Otherwise, set the preview inactive.
+When there is no application-supplied preview widget, or the
+application-supplied preview widget is not active, the file chooser
+may display an internally generated preview of the current file or
+it may display no preview at all.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="icon_set">
-<parameter_description> a #GtkIconSet
-</parameter_description>
-</parameter>
-<parameter name="style">
-<parameter_description> a #GtkStyle associated with @widget, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="direction">
-<parameter_description> text direction
-</parameter_description>
-</parameter>
-<parameter name="state">
-<parameter_description> widget state
-</parameter_description>
-</parameter>
-<parameter name="size">
-<parameter_description> icon size. A size of (GtkIconSize)-1
-means render at the size of the source and don't scale.
-</parameter_description>
-</parameter>
-<parameter name="widget">
-<parameter_description> widget that will display the icon, or %NULL.
-The only use that is typically made of this
-is to determine the appropriate #GdkScreen.
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
-<parameter name="detail">
-<parameter_description> detail to pass to the theme engine, or %NULL.
-Note that passing a detail of anything but %NULL
-will disable caching.
+<parameter name="preview_widget">
+<parameter_description> widget for displaying preview.
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkPixbuf to be displayed
-</return>
+<return></return>
</function>
-<function name="gtk_tree_row_reference_free">
+<function name="gtk_file_chooser_set_preview_widget_active">
<description>
-Free's @reference. @reference may be %NULL.
+Sets whether the preview widget set by
+gtk_file_chooser_set_preview_widget() should be shown for the
+current filename. When @active is set to false, the file chooser
+may display an internally generated preview of the current file
+or it may display no preview at all. See
+gtk_file_chooser_set_preview_widget() for more details.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="reference">
-<parameter_description> A #GtkTreeRowReference, or %NULL
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
+</parameter_description>
+</parameter>
+<parameter name="active">
+<parameter_description> whether to display the user-specified preview widget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_font_selection_dialog_get_font_name">
+<function name="gtk_file_chooser_set_select_multiple">
<description>
-Gets the currently-selected font name.
-
-Note that this can be a different string than what you set with
-gtk_font_selection_dialog_set_font_name(), as the font selection widget
-may normalize font names and thus return a string with a different
-structure. For example, "Helvetica Italic Bold 12" could be normalized
-to "Helvetica Bold Italic 12". Use pango_font_description_equal()
-if you want to compare two font descriptions.
+Sets whether multiple files can be selected in the file selector. This is
+only relevant if the action is set to be %GTK_FILE_CHOOSER_ACTION_OPEN or
+%GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER.
+Since: 2.4
</description>
<parameters>
-<parameter name="fsd">
-<parameter_description> a #GtkFontSelectionDialog
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
+</parameter_description>
+</parameter>
+<parameter name="select_multiple">
+<parameter_description> %TRUE if multiple files can be selected.
</parameter_description>
</parameter>
</parameters>
-<return> A string with the name of the current font, or %NULL if no
-font is selected. You must free this string with g_free().
-</return>
+<return></return>
</function>
-<function name="gtk_cell_view_set_background_color">
+<function name="gtk_file_chooser_set_show_hidden">
<description>
-Sets the background color of @view.
+Sets whether hidden files and folders are displayed in the file selector.
Since: 2.6
</description>
<parameters>
-<parameter name="cell_view">
-<parameter_description> a #GtkCellView
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> the new background color
+<parameter name="show_hidden">
+<parameter_description> %TRUE if hidden files and folders should be displayed.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_color_button_get_title">
+<function name="gtk_file_chooser_set_uri">
<description>
-Gets the title of the color selection dialog.
+Sets the file referred to by @uri as the current file for the file chooser,
+by changing to the URI's parent folder and actually selecting the URI in the
+list. If the @chooser is %GTK_FILE_CHOOSER_ACTION_SAVE mode, the URI's base
+name will also appear in the dialog's file name entry.
+
+If the URI isn't in the current folder of @chooser, then the current folder
+of @chooser will be changed to the folder containing @uri. This is equivalent
+to a sequence of gtk_file_chooser_unselect_all() followed by
+gtk_file_chooser_select_uri().
+
+Note that the URI must exist, or nothing will be done except for the
+directory change.
+If you are implementing a <guimenuitem>File/Save As...</guimenuitem> dialog,
+you should use this function if you already have a file name to which the
+user may save; for example, when the user opens an existing file and then
+does <guimenuitem>File/Save As...</guimenuitem> on it. If you don't have
+a file name already — for example, if the user just created a new
+file and is saving it for the first time, do not call this function.
+Instead, use something similar to this:
+|[
+if (document_is_new)
+{
+/ * the user just created a new document * /
+gtk_file_chooser_set_current_folder_uri (chooser, default_folder_for_saving);
+gtk_file_chooser_set_current_name (chooser, "Untitled document");
+}
+else
+{
+/ * the user edited an existing document * /
+gtk_file_chooser_set_uri (chooser, existing_uri);
+}
+]|
Since: 2.4
</description>
<parameters>
-<parameter name="color_button">
-<parameter_description> a #GtkColorButton
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
+</parameter_description>
+</parameter>
+<parameter name="uri">
+<parameter_description> the URI to set as current
</parameter_description>
</parameter>
</parameters>
-<return> An internal string, do not free the return value
+<return> %TRUE if both the folder could be changed and the URI was
+selected successfully, %FALSE otherwise.
</return>
</function>
-<function name="gtk_container_class_find_child_property">
+<function name="gtk_file_chooser_set_use_preview_label">
<description>
-Finds a child property of a container class by name.
+Sets whether the file chooser should display a stock label with the name of
+the file that is being previewed; the default is %TRUE. Applications that
+want to draw the whole preview area themselves should set this to %FALSE and
+display the name themselves in their preview widget.
+
+See also: gtk_file_chooser_set_preview_widget()
+
+Since: 2.4
</description>
<parameters>
-<parameter name="cclass">
-<parameter_description> a #GtkContainerClass
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
-<parameter name="property_name">
-<parameter_description> the name of the child property to find
+<parameter name="use_label">
+<parameter_description> whether to display a stock label with the name of the previewed file
</parameter_description>
</parameter>
</parameters>
-<return> the #GParamSpec of the child property or %NULL if @class has no
-child property with that name.
-</return>
+<return></return>
</function>
-<function name="gtk_label_set_track_visited_links">
+<function name="gtk_file_chooser_unselect_all">
<description>
-Sets whether the label should keep track of clicked
-links (and use a different color for them).
+Unselects all the files in the current folder of a file chooser.
-Since: 2.18
+Since: 2.4
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
-</parameter_description>
-</parameter>
-<parameter name="track_links">
-<parameter_description> %TRUE to track visited links
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_get_char_count">
+<function name="gtk_file_chooser_unselect_file">
<description>
-Gets the number of characters in the buffer; note that characters
-and bytes are not the same, you can't e.g. expect the contents of
-the buffer in string form to be this many bytes long. The character
-count is cached, so this function is very fast.
+Unselects the file referred to by @file. If the file is not in the current
+directory, does not exist, or is otherwise not currently selected, does nothing.
+Since: 2.14
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
+</parameter_description>
+</parameter>
+<parameter name="file">
+<parameter_description> a #GFile
</parameter_description>
</parameter>
</parameters>
-<return> number of characters in the buffer
-</return>
+<return></return>
</function>
-<function name="gtk_file_chooser_list_shortcut_folder_uris">
+<function name="gtk_file_chooser_unselect_filename">
<description>
-Queries the list of shortcut folders in the file chooser, as set by
-gtk_file_chooser_add_shortcut_folder_uri().
+Unselects a currently selected filename. If the filename
+is not in the current directory, does not exist, or
+is otherwise not currently selected, does nothing.
Since: 2.4
@@ -18191,3136 +18543,2947 @@ Since: 2.4
<parameter_description> a #GtkFileChooser
</parameter_description>
</parameter>
+<parameter name="filename">
+<parameter_description> the filename to unselect
+</parameter_description>
+</parameter>
</parameters>
-<return> A list of folder URIs, or %NULL if there are no shortcut
-folders. Free the returned list with g_slist_free(), and the URIs with
-g_free().
-
-</return>
+<return></return>
</function>
-<function name="gtk_tree_view_column_get_expand">
+<function name="gtk_file_chooser_unselect_uri">
<description>
-Return %TRUE if the column expands to take any available space.
+Unselects the file referred to by @uri. If the file
+is not in the current directory, does not exist, or
+is otherwise not currently selected, does nothing.
Since: 2.4
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> a #GtkTreeViewColumn
+<parameter name="chooser">
+<parameter_description> a #GtkFileChooser
+</parameter_description>
+</parameter>
+<parameter name="uri">
+<parameter_description> the URI to unselect
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE, if the column expands
-
-</return>
+<return></return>
</function>
-<function name="gtk_cell_renderer_combo_new">
+<function name="gtk_file_chooser_widget_new">
<description>
-Creates a new #GtkCellRendererCombo.
-Adjust how text is drawn using object properties.
-Object properties can be set globally (with g_object_set()).
-Also, with #GtkTreeViewColumn, you can bind a property to a value
-in a #GtkTreeModel. For example, you can bind the "text" property
-on the cell renderer to a string value in the model, thus rendering
-a different string in each row of the #GtkTreeView.
+Creates a new #GtkFileChooserWidget. This is a file chooser widget that can
+be embedded in custom windows, and it is the same widget that is used by
+#GtkFileChooserDialog.
-Since: 2.6
+Since: 2.4
</description>
<parameters>
+<parameter name="action">
+<parameter_description> Open or save mode for the widget
+</parameter_description>
+</parameter>
</parameters>
-<return> the new cell renderer
+<return> a new #GtkFileChooserWidget
</return>
</function>
-<function name="gtk_widget_set_receives_default">
+<function name="gtk_file_chooser_widget_new_with_backend">
<description>
-Specifies whether @widget will be treated as the default widget
-within its toplevel when it has the focus, even if another widget
-is the default.
-
-See gtk_widget_grab_default() for details about the meaning of
-"default".
+Creates a new #GtkFileChooserWidget with a specified backend. This is
+especially useful if you use gtk_file_chooser_set_local_only() to allow
+non-local files. This is a file chooser widget that can be embedded in
+custom windows and it is the same widget that is used by
+#GtkFileChooserDialog.
-Since: 2.18
+Since: 2.4
+Deprecated: 2.14: Use gtk_file_chooser_widget_new() instead.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="action">
+<parameter_description> Open or save mode for the widget
</parameter_description>
</parameter>
-<parameter name="receives_default">
-<parameter_description> whether or not @widget can be a default widget.
+<parameter name="backend">
+<parameter_description> The name of the specific filesystem backend to use.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GtkFileChooserWidget
+
+</return>
</function>
-<function name="gtk_text_buffer_get_iter_at_line_offset">
+<function name="gtk_file_filter_add_custom">
<description>
-Obtains an iterator pointing to @char_offset within the given
-line. The @char_offset must exist, offsets off the end of the line
-are not allowed. Note <emphasis>characters</emphasis>, not bytes;
-UTF-8 may encode one character as multiple bytes.
+Adds rule to a filter that allows files based on a custom callback
+function. The bitfield @needed which is passed in provides information
+about what sorts of information that the filter function needs;
+this allows GTK+ to avoid retrieving expensive information when
+it isn't needed by the filter.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="filter">
+<parameter_description> a #GtkFileFilter
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> iterator to initialize
+<parameter name="needed">
+<parameter_description> bitfield of flags indicating the information that the custom
+filter function needs.
</parameter_description>
</parameter>
-<parameter name="line_number">
-<parameter_description> line number counting from 0
+<parameter name="func">
+<parameter_description> callback function; if the function returns %TRUE, then
+the file will be displayed.
</parameter_description>
</parameter>
-<parameter name="char_offset">
-<parameter_description> char offset from start of line
+<parameter name="data">
+<parameter_description> data to pass to @func
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> function to call to free @data when it is no longer needed.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_iter_backward_cursor_position">
+<function name="gtk_file_filter_add_mime_type">
<description>
-Like gtk_text_iter_forward_cursor_position(), but moves backward.
+Adds a rule allowing a given mime type to @filter.
+Since: 2.4
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="filter">
+<parameter_description> A #GtkFileFilter
+</parameter_description>
+</parameter>
+<parameter name="mime_type">
+<parameter_description> name of a MIME type
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if we moved
-</return>
+<return></return>
</function>
-<function name="gtk_text_buffer_get_bounds">
+<function name="gtk_file_filter_add_pattern">
<description>
-Retrieves the first and last iterators in the buffer, i.e. the
-entire buffer lies within the range [ start,@end).
+Adds a rule allowing a shell style glob to a filter.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="start">
-<parameter_description> iterator to initialize with first position in the buffer
+<parameter name="filter">
+<parameter_description> a #GtkFileFilter
</parameter_description>
</parameter>
-<parameter name="end">
-<parameter_description> iterator to initialize with the end iterator
+<parameter name="pattern">
+<parameter_description> a shell style glob
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_drag_set_icon_pixbuf">
+<function name="gtk_file_filter_add_pixbuf_formats">
<description>
-Sets @pixbuf as the icon for a given drag.
+Adds a rule allowing image files in the formats supported
+by GdkPixbuf.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="context">
-<parameter_description> the context for a drag. (This must be called
-with a context for the source side of a drag)
-</parameter_description>
-</parameter>
-<parameter name="pixbuf">
-<parameter_description> the #GdkPixbuf to use as the drag icon.
-</parameter_description>
-</parameter>
-<parameter name="hot_x">
-<parameter_description> the X offset within @widget of the hotspot.
-</parameter_description>
-</parameter>
-<parameter name="hot_y">
-<parameter_description> the Y offset within @widget of the hotspot.
+<parameter name="filter">
+<parameter_description> a #GtkFileFilter
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_context_get_height">
+<function name="gtk_file_filter_filter">
<description>
-Obtains the height of the #GtkPrintContext, in pixels.
+Tests whether a file should be displayed according to @filter.
+The #GtkFileFilterInfo structure @filter_info should include
+the fields returned from gtk_file_filter_get_needed().
-Since: 2.10
+This function will not typically be used by applications; it
+is intended principally for use in the implementation of
+#GtkFileChooser.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GtkPrintContext
+<parameter name="filter">
+<parameter_description> a #GtkFileFilter
+</parameter_description>
+</parameter>
+<parameter name="filter_info">
+<parameter_description> a #GtkFileFilterInfo structure containing information
+about a file.
</parameter_description>
</parameter>
</parameters>
-<return> the height of @context
+<return> %TRUE if the file should be displayed
</return>
</function>
-<function name="gtk_toggle_tool_button_set_active">
+<function name="gtk_file_filter_get_name">
<description>
-Sets the status of the toggle tool button. Set to %TRUE if you
-want the GtkToggleButton to be 'pressed in', and %FALSE to raise it.
-This action causes the toggled signal to be emitted.
+Gets the human-readable name for the filter. See gtk_file_filter_set_name().
Since: 2.4
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkToggleToolButton
-</parameter_description>
-</parameter>
-<parameter name="is_active">
-<parameter_description> whether @button should be active
+<parameter name="filter">
+<parameter_description> a #GtkFileFilter
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The human-readable name of the filter,
+or %NULL. This value is owned by GTK+ and must not
+be modified or freed.
+
+</return>
</function>
-<function name="gtk_icon_factory_add">
+<function name="gtk_file_filter_get_needed">
<description>
-Adds the given @icon_set to the icon factory, under the name
- stock_id @stock_id should be namespaced for your application,
-e.g. "myapp-whatever-icon". Normally applications create a
-#GtkIconFactory, then add it to the list of default factories with
-gtk_icon_factory_add_default(). Then they pass the @stock_id to
-widgets such as #GtkImage to display the icon. Themes can provide
-an icon with the same name (such as "myapp-whatever-icon") to
-override your application's default icons. If an icon already
-existed in @factory for @stock_id, it is unreferenced and replaced
-with the new @icon_set.
+Gets the fields that need to be filled in for the structure
+passed to gtk_file_filter_filter()
+
+This function will not typically be used by applications; it
+is intended principally for use in the implementation of
+#GtkFileChooser.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="factory">
-<parameter_description> a #GtkIconFactory
-</parameter_description>
-</parameter>
-<parameter name="stock_id">
-<parameter_description> icon name
-</parameter_description>
-</parameter>
-<parameter name="icon_set">
-<parameter_description> icon set
+<parameter name="filter">
+<parameter_description> a #GtkFileFilter
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> bitfield of flags indicating needed fields when
+calling gtk_file_filter_filter()
+
+</return>
</function>
-<function name="gtk_icon_view_get_pixbuf_column">
+<function name="gtk_file_filter_new">
<description>
-Returns the column with pixbufs for @icon_view.
+Creates a new #GtkFileFilter with no rules added to it.
+Such a filter doesn't accept any files, so is not
+particularly useful until you add rules with
+gtk_file_filter_add_mime_type(), gtk_file_filter_add_pattern(),
+or gtk_file_filter_add_custom(). To create a filter
+that accepts any file, use:
+|[
+GtkFileFilter *filter = gtk_file_filter_new ();
+gtk_file_filter_add_pattern (filter, "*");
+]|
-Since: 2.6
+Since: 2.4
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> A #GtkIconView.
-</parameter_description>
-</parameter>
</parameters>
-<return> the pixbuf column, or -1 if it's unset.
+<return> a new #GtkFileFilter
</return>
</function>
-<function name="gtk_combo_box_set_add_tearoffs">
+<function name="gtk_file_filter_set_name">
<description>
-Sets whether the popup menu should have a tearoff
-menu item.
+Sets the human-readable name of the filter; this is the string
+that will be displayed in the file selector user interface if
+there is a selectable list of filters.
-Since: 2.6
+Since: 2.4
</description>
<parameters>
-<parameter name="combo_box">
-<parameter_description> a #GtkComboBox
+<parameter name="filter">
+<parameter_description> a #GtkFileFilter
</parameter_description>
</parameter>
-<parameter name="add_tearoffs">
-<parameter_description> %TRUE to add tearoff menu items
+<parameter name="name">
+<parameter_description> the human-readable-name for the filter, or %NULL
+to remove any existing name.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_range_set_restrict_to_fill_level">
+<function name="gtk_file_selection_get_filename">
<description>
-Sets whether the slider is restricted to the fill level. See
-gtk_range_set_fill_level() for a general description of the fill
-level concept.
+This function returns the selected filename in the GLib file name
+encoding. To convert to UTF-8, call g_filename_to_utf8(). The
+returned string points to a statically allocated buffer and should
+be copied if you plan to keep it around.
+
+If no file is selected then the selected directory path is returned.
-Since: 2.12
</description>
<parameters>
-<parameter name="range">
-<parameter_description> A #GtkRange
-</parameter_description>
-</parameter>
-<parameter name="restrict_to_fill_level">
-<parameter_description> Whether the fill level restricts slider movement.
+<parameter name="filesel">
+<parameter_description> a #GtkFileSelection
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> currently-selected filename in the on-disk encoding.
+</return>
</function>
-<function name="gtk_tree_selection_get_selected">
+<function name="gtk_file_selection_get_select_multiple">
<description>
-Sets @iter to the currently selected node if @selection is set to
-#GTK_SELECTION_SINGLE or #GTK_SELECTION_BROWSE. @iter may be NULL if you
-just want to test if @selection has any selected nodes. @model is filled
-with the current model as a convenience. This function will not work if you
-use @selection is #GTK_SELECTION_MULTIPLE.
+Determines whether or not the user is allowed to select multiple files in
+the file list. See gtk_file_selection_set_select_multiple().
</description>
<parameters>
-<parameter name="selection">
-<parameter_description> A #GtkTreeSelection.
-</parameter_description>
-</parameter>
-<parameter name="model">
-<parameter_description> A pointer to set to the #GtkTreeModel, or NULL.
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> The #GtkTreeIter, or NULL.
+<parameter name="filesel">
+<parameter_description> a #GtkFileSelection
</parameter_description>
</parameter>
</parameters>
-<return> TRUE, if there is a selected node.
+<return> %TRUE if the user is allowed to select multiple files in the
+file list
</return>
</function>
-<function name="gtk_toggle_tool_button_get_active">
+<function name="gtk_file_selection_get_selections">
<description>
-Queries a #GtkToggleToolButton and returns its current state.
-Returns %TRUE if the toggle button is pressed in and %FALSE if it is raised.
+Retrieves the list of file selections the user has made in the dialog box.
+This function is intended for use when the user can select multiple files
+in the file list.
+
+The filenames are in the GLib file name encoding. To convert to
+UTF-8, call g_filename_to_utf8() on each string.
-Since: 2.4
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkToggleToolButton
+<parameter name="filesel">
+<parameter_description> a #GtkFileSelection
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the toggle tool button is pressed in, %FALSE if not
-
+<return> a newly-allocated %NULL-terminated array of strings. Use
+g_strfreev() to free it.
</return>
</function>
-<function name="gtk_page_setup_to_key_file">
+<function name="gtk_file_selection_set_filename">
<description>
-This function adds the page setup from @setup to @key_file.
+Sets a default path for the file requestor. If @filename includes a
+directory path, then the requestor will open with that path as its
+current working directory.
-Since: 2.12
+This has the consequence that in order to open the requestor with a
+working directory and an empty filename, @filename must have a trailing
+directory separator.
+
+The encoding of @filename is preferred GLib file name encoding, which
+may not be UTF-8. See g_filename_from_utf8().
</description>
<parameters>
-<parameter name="setup">
-<parameter_description> a #GtkPageSetup
-</parameter_description>
-</parameter>
-<parameter name="key_file">
-<parameter_description> the #GKeyFile to save the page setup to
+<parameter name="filesel">
+<parameter_description> a #GtkFileSelection.
</parameter_description>
</parameter>
-<parameter name="group_name">
-<parameter_description> the group to add the settings to in @key_file,
-or %NULL to use the default name "Page Setup"
+<parameter name="filename">
+<parameter_description> a string to set as the default file name.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_accessible_connect_widget_destroyed">
+<function name="gtk_file_selection_set_select_multiple">
<description>
-This function specifies the callback function to be called when the widget
-corresponding to a GtkAccessible is destroyed.
+Sets whether the user is allowed to select multiple files in the file list.
+Use gtk_file_selection_get_selections () to get the list of selected files.
</description>
<parameters>
-<parameter name="accessible">
-<parameter_description> a #GtkAccessible
+<parameter name="filesel">
+<parameter_description> a #GtkFileSelection
+</parameter_description>
+</parameter>
+<parameter name="select_multiple">
+<parameter_description> whether or not the user is allowed to select multiple
+files in the file list.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_operation_get_error">
+<function name="gtk_fixed_get_has_window">
<description>
-Call this when the result of a print operation is
-%GTK_PRINT_OPERATION_RESULT_ERROR, either as returned by
-gtk_print_operation_run(), or in the #GtkPrintOperation::done signal
-handler. The returned #GError will contain more details on what went wrong.
+Gets whether the #GtkFixed has its own #GdkWindow.
+See gtk_fixed_set_has_window().
-Since: 2.10
+Deprecated: 2.20: Use gtk_widget_get_has_window() instead.
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkPrintOperation
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for the error
+<parameter name="fixed">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @fixed has its own window.
+
+</return>
</function>
-<function name="gtk_box_pack_end">
+<function name="gtk_fixed_set_has_window">
<description>
-Adds @child to @box, packed with reference to the end of @box.
-The @child is packed after (away from end of) any other child
-packed with reference to the end of @box.
+Sets whether a #GtkFixed widget is created with a separate
+#GdkWindow for @widget->window or not. (By default, it will be
+created with no separate #GdkWindow). This function must be called
+while the #GtkFixed is not realized, for instance, immediately after the
+window is created.
+
+This function was added to provide an easy migration path for
+older applications which may expect #GtkFixed to have a separate window.
+
+Deprecated: 2.20: Use gtk_widget_set_has_window() instead.
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #GtkBox
-</parameter_description>
-</parameter>
-<parameter name="child">
-<parameter_description> the #GtkWidget to be added to @box
-</parameter_description>
-</parameter>
-<parameter name="expand">
-<parameter_description> %TRUE if the new child is to be given extra space allocated
-to @box. The extra space will be divided evenly between all children
-of @box that use this option
-</parameter_description>
-</parameter>
-<parameter name="fill">
-<parameter_description> %TRUE if space given to @child by the @expand option is
-actually allocated to @child, rather than just padding it. This
-parameter has no effect if @expand is set to %FALSE. A child is
-always allocated the full height of a #GtkHBox and the full width
-of a #GtkVBox. This option affects the other dimension
+<parameter name="fixed">
+<parameter_description> a #GtkFixed
</parameter_description>
</parameter>
-<parameter name="padding">
-<parameter_description> extra space in pixels to put between this child and its
-neighbors, over and above the global amount specified by
-#GtkBox:spacing property. If @child is a widget at one of the
-reference ends of @box, then @padding pixels are also put between
- child and the reference edge of @box
+<parameter name="has_window">
+<parameter_description> %TRUE if a separate window should be created
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_toolbar_get_show_arrow">
+<function name="gtk_font_button_get_font_name">
<description>
-Returns whether the toolbar has an overflow menu.
-See gtk_toolbar_set_show_arrow().
+Retrieves the name of the currently selected font. This name includes
+style and size information as well. If you want to render something
+with the font, use this string with pango_font_description_from_string() .
+If you're interested in peeking certain values (family name,
+style, size, weight) just query these properties from the
+#PangoFontDescription object.
Since: 2.4
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar
+<parameter name="font_button">
+<parameter_description> a #GtkFontButton
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the toolbar has an overflow menu.
+<return> an internal copy of the font name which must not be freed.
</return>
</function>
-<function name="gtk_entry_get_cursor_hadjustment">
+<function name="gtk_font_button_get_show_size">
<description>
-Retrieves the horizontal cursor adjustment for the entry.
-See gtk_entry_set_cursor_hadjustment().
+Returns whether the font size will be shown in the label.
-Since: 2.12
+Since: 2.4
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="font_button">
+<parameter_description> a #GtkFontButton
</parameter_description>
</parameter>
</parameters>
-<return> the horizontal cursor adjustment, or %NULL
-if none has been set.
+<return> whether the font size will be shown in the label.
</return>
</function>
-<function name="gtk_tree_model_get_path">
+<function name="gtk_font_button_get_show_style">
<description>
-Returns a newly-created #GtkTreePath referenced by @iter. This path should
-be freed with gtk_tree_path_free().
+Returns whether the name of the font style will be shown in the label.
+Since: 2.4
</description>
<parameters>
-<parameter name="tree_model">
-<parameter_description> A #GtkTreeModel.
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> The #GtkTreeIter.
+<parameter name="font_button">
+<parameter_description> a #GtkFontButton
</parameter_description>
</parameter>
</parameters>
-<return> a newly-created #GtkTreePath.
+<return> whether the font style will be shown in the label.
+
</return>
</function>
-<function name="gtk_entry_new_with_buffer">
+<function name="gtk_font_button_get_title">
<description>
-Creates a new entry with the specified text buffer.
+Retrieves the title of the font selection dialog.
-Since: 2.18
+Since: 2.4
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> The buffer to use for the new #GtkEntry.
+<parameter name="font_button">
+<parameter_description> a #GtkFontButton
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkEntry
+<return> an internal copy of the title string which must not be freed.
</return>
</function>
-<function name="gtk_tool_palette_get_expand">
+<function name="gtk_font_button_get_use_font">
<description>
-Gets whether group should be given extra space.
-See gtk_tool_palette_set_expand().
+Returns whether the selected font is used in the label.
-Since: 2.20
+Since: 2.4
</description>
<parameters>
-<parameter name="palette">
-<parameter_description> a #GtkToolPalette
-</parameter_description>
-</parameter>
-<parameter name="group">
-<parameter_description> a #GtkToolItemGroup which is a child of palette
+<parameter name="font_button">
+<parameter_description> a #GtkFontButton
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if group should be given extra space, %FALSE otherwise
+<return> whether the selected font is used in the label.
</return>
</function>
-<function name="gtk_print_settings_to_key_file">
+<function name="gtk_font_button_get_use_size">
<description>
-This function adds the print settings from @settings to @key_file.
+Returns whether the selected size is used in the label.
-Since: 2.12
+Since: 2.4
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
-</parameter_description>
-</parameter>
-<parameter name="key_file">
-<parameter_description> the #GKeyFile to save the print settings to
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> the group to add the settings to in @key_file, or
-%NULL to use the default "Print Settings"
+<parameter name="font_button">
+<parameter_description> a #GtkFontButton
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether the selected size is used in the label.
+
+</return>
</function>
-<function name="gtk_statusbar_set_has_resize_grip">
+<function name="gtk_font_button_new">
<description>
-Sets whether the statusbar has a resize grip.
-%TRUE by default.
+Creates a new font picker widget.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="statusbar">
-<parameter_description> a #GtkStatusBar
-</parameter_description>
-</parameter>
-<parameter name="setting">
-<parameter_description> %TRUE to have a resize grip
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> a new font picker widget.
+
+</return>
</function>
-<function name="gtk_assistant_remove_action_widget">
+<function name="gtk_font_button_new_with_font">
<description>
-Removes a widget from the action area of a #GtkAssistant.
+Creates a new font picker widget.
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="assistant">
-<parameter_description> a #GtkAssistant
-</parameter_description>
-</parameter>
-<parameter name="child">
-<parameter_description> a #GtkWidget
+<parameter name="fontname">
+<parameter_description> Name of font to display in font selection dialog
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new font picker widget.
+
+</return>
</function>
-<function name="gtk_scale_set_digits">
+<function name="gtk_font_button_set_font_name">
<description>
-Sets the number of decimal places that are displayed in the value.
-Also causes the value of the adjustment to be rounded off to this
-number of digits, so the retrieved value matches the value the user saw.
+Sets or updates the currently-displayed font in font picker dialog.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="scale">
-<parameter_description> a #GtkScale
+<parameter name="font_button">
+<parameter_description> a #GtkFontButton
</parameter_description>
</parameter>
-<parameter name="digits">
-<parameter_description> the number of decimal places to display,
-e.g. use 1 to display 1.0, 2 to display 1.00, etc
+<parameter name="fontname">
+<parameter_description> Name of font to display in font selection dialog
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> Return value of gtk_font_selection_dialog_set_font_name() if the
+font selection dialog exists, otherwise %FALSE.
+
+</return>
</function>
-<function name="gtk_drag_source_add_text_targets">
+<function name="gtk_font_button_set_show_size">
<description>
-Add the text targets supported by #GtkSelection to
-the target list of the drag source. The targets
-are added with @info = 0. If you need another value,
-use gtk_target_list_add_text_targets() and
-gtk_drag_source_set_target_list().
+If @show_size is %TRUE, the font size will be displayed along with the name of the selected font.
-Since: 2.6
+Since: 2.4
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget that's is a drag source
+<parameter name="font_button">
+<parameter_description> a #GtkFontButton
+</parameter_description>
+</parameter>
+<parameter name="show_size">
+<parameter_description> %TRUE if font size should be displayed in dialog.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_action_group_new">
+<function name="gtk_font_button_set_show_style">
<description>
-Creates a new #GtkActionGroup object. The name of the action group
-is used when associating <link linkend="Action-Accel">keybindings</link>
-with the actions.
+If @show_style is %TRUE, the font style will be displayed along with name of the selected font.
Since: 2.4
</description>
<parameters>
-<parameter name="name">
-<parameter_description> the name of the action group.
+<parameter name="font_button">
+<parameter_description> a #GtkFontButton
</parameter_description>
</parameter>
-</parameters>
-<return> the new #GtkActionGroup
-
-</return>
-</function>
-
-<function name="gtk_text_buffer_get_selection_bound">
-<description>
-Returns the mark that represents the selection bound. Equivalent
-to calling gtk_text_buffer_get_mark() to get the mark named
-"selection_bound", but very slightly more efficient, and involves
-less typing.
-
-The currently-selected text in @buffer is the region between the
-"selection_bound" and "insert" marks. If "selection_bound" and
-"insert" are in the same place, then there is no current selection.
-gtk_text_buffer_get_selection_bounds() is another convenient function
-for handling the selection, if you just want to know whether there's a
-selection and what its bounds are.
-
-
-</description>
-<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="show_style">
+<parameter_description> %TRUE if font style should be displayed in label.
</parameter_description>
</parameter>
</parameters>
-<return> selection bound mark
-</return>
+<return></return>
</function>
-<function name="gtk_toolbar_set_tooltips">
+<function name="gtk_font_button_set_title">
<description>
-Sets if the tooltips of a toolbar should be active or not.
+Sets the title for the font selection dialog.
-Deprecated: 2.14: The toolkit-wide #GtkSettings:gtk-enable-tooltips property
-is now used instead.
+Since: 2.4
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar.
+<parameter name="font_button">
+<parameter_description> a #GtkFontButton
</parameter_description>
</parameter>
-<parameter name="enable">
-<parameter_description> set to %FALSE to disable the tooltips, or %TRUE to enable them.
+<parameter name="title">
+<parameter_description> a string containing the font selection dialog title
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_iter_copy">
+<function name="gtk_font_button_set_use_font">
<description>
-Creates a dynamically-allocated copy of an iterator. This function
-is not useful in applications, because iterators can be copied with a
-simple assignment (<literal>GtkTextIter i = j;</literal>). The
-function is used by language bindings.
+If @use_font is %TRUE, the font name will be written using the selected font.
+Since: 2.4
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
+<parameter name="font_button">
+<parameter_description> a #GtkFontButton
+</parameter_description>
+</parameter>
+<parameter name="use_font">
+<parameter_description> If %TRUE, font name will be written using font chosen.
</parameter_description>
</parameter>
</parameters>
-<return> a copy of the @iter, free with gtk_text_iter_free ()
-</return>
+<return></return>
</function>
-<function name="gtk_tool_item_group_insert">
+<function name="gtk_font_button_set_use_size">
<description>
-Inserts @item at @position in the list of children of @group.
+If @use_size is %TRUE, the font name will be written using the selected size.
-Since: 2.20
+Since: 2.4
</description>
<parameters>
-<parameter name="group">
-<parameter_description> a #GtkToolItemGroup
-</parameter_description>
-</parameter>
-<parameter name="item">
-<parameter_description> the #GtkToolItem to insert into @group
+<parameter name="font_button">
+<parameter_description> a #GtkFontButton
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> the position of @item in @group, starting with 0.
-The position -1 means end of list.
+<parameter name="use_size">
+<parameter_description> If %TRUE, font name will be written using the selected size.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_settings_get_double">
+<function name="gtk_font_selection_dialog_get_apply_button">
<description>
-Returns the double value associated with @key, or 0.
+Obtains a button. The button doesn't have any function.
-Since: 2.10
+Since: 2.14
+
+Deprecated: 2.16: Don't use this function.
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
+<parameter name="fsd">
+<parameter_description> a #GtkFontSelectionDialog
</parameter_description>
</parameter>
</parameters>
-<return> the double value of @key
+<return> a #GtkWidget
</return>
</function>
-<function name="gtk_item_factory_path_from_widget">
+<function name="gtk_font_selection_dialog_get_cancel_button">
<description>
-If @widget has been created by an item factory, returns the full path
-to it. (The full path of a widget is the concatenation of the factory
-path specified in gtk_item_factory_new() with the path specified in the
-#GtkItemFactoryEntry from which the widget was created.)
+Gets the 'Cancel' button.
-Deprecated: 2.4: Use #GtkUIManager instead.
+Since: 2.14
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a widget
+<parameter name="fsd">
+<parameter_description> a #GtkFontSelectionDialog
</parameter_description>
</parameter>
</parameters>
-<return> the full path to @widget if it has been created by an item
-factory, %NULL otherwise. This value is owned by GTK+ and must not be
-modified or freed.
+<return> the #GtkWidget used in the dialog
+for the 'Cancel' button.
+
</return>
</function>
-<function name="gtk_tool_button_get_stock_id">
+<function name="gtk_font_selection_dialog_get_font">
<description>
-Returns the name of the stock item. See gtk_tool_button_set_stock_id().
-The returned string is owned by GTK+ and must not be freed or modifed.
+Gets the currently-selected font.
-Since: 2.4
+Deprecated: 2.0: Use gtk_font_selection_dialog_get_font_name() instead.
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkToolButton
+<parameter name="fsd">
+<parameter_description> a #GtkFontSelectionDialog
</parameter_description>
</parameter>
</parameters>
-<return> the name of the stock item for @button.
+<return> the #GdkFont from the #GtkFontSelection for the
+currently selected font in the dialog, or %NULL if no font is selected
</return>
</function>
-<function name="gtk_window_set_resizable">
+<function name="gtk_font_selection_dialog_get_font_name">
<description>
-Sets whether the user can resize a window. Windows are user resizable
-by default.
+Gets the currently-selected font name.
+
+Note that this can be a different string than what you set with
+gtk_font_selection_dialog_set_font_name(), as the font selection widget
+may normalize font names and thus return a string with a different
+structure. For example, "Helvetica Italic Bold 12" could be normalized
+to "Helvetica Bold Italic 12". Use pango_font_description_equal()
+if you want to compare two font descriptions.
+
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
-</parameter_description>
-</parameter>
-<parameter name="resizable">
-<parameter_description> %TRUE if the user can resize this window
+<parameter name="fsd">
+<parameter_description> a #GtkFontSelectionDialog
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A string with the name of the current font, or %NULL if no
+font is selected. You must free this string with g_free().
+</return>
</function>
-<function name="gtk_color_button_set_alpha">
+<function name="gtk_font_selection_dialog_get_font_selection">
<description>
-Sets the current opacity to be @alpha.
+Retrieves the #GtkFontSelection widget embedded in the dialog.
-Since: 2.4
+Since: 2.22
</description>
<parameters>
-<parameter name="color_button">
-<parameter_description> a #GtkColorButton.
-</parameter_description>
-</parameter>
-<parameter name="alpha">
-<parameter_description> an integer between 0 and 65535.
+<parameter name="fsd">
+<parameter_description> a #GtkFontSelectionDialog
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the embedded #GtkFontSelection
+
+</return>
</function>
-<function name="gtk_tree_view_get_tooltip_context">
+<function name="gtk_font_selection_dialog_get_ok_button">
<description>
-This function is supposed to be used in a #GtkWidget::query-tooltip
-signal handler for #GtkTreeView. The @x, @y and @keyboard_tip values
-which are received in the signal handler, should be passed to this
-function without modification.
-
-The return value indicates whether there is a tree view row at the given
-coordinates (%TRUE) or not (%FALSE) for mouse tooltips. For keyboard
-tooltips the row returned will be the cursor row. When %TRUE, then any of
- model, @path and @iter which have been provided will be set to point to
-that row and the corresponding model. @x and @y will always be converted
-to be relative to @tree_view's bin_window if @keyboard_tooltip is %FALSE.
+Gets the 'OK' button.
-Since: 2.12
+Since: 2.14
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> the x coordinate (relative to widget coordinates)
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> the y coordinate (relative to widget coordinates)
-</parameter_description>
-</parameter>
-<parameter name="keyboard_tip">
-<parameter_description> whether this is a keyboard tooltip or not
-</parameter_description>
-</parameter>
-<parameter name="model">
-<parameter_description> a pointer to receive a #GtkTreeModel or %NULL
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> a pointer to receive a #GtkTreePath or %NULL
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> a pointer to receive a #GtkTreeIter or %NULL
+<parameter name="fsd">
+<parameter_description> a #GtkFontSelectionDialog
</parameter_description>
</parameter>
</parameters>
-<return> whether or not the given tooltip context points to a row.
+<return> the #GtkWidget used in the dialog
+for the 'OK' button.
</return>
</function>
-<function name="gtk_print_operation_set_defer_drawing">
+<function name="gtk_font_selection_dialog_get_preview_text">
<description>
-Sets up the #GtkPrintOperation to wait for calling of
-gtk_print_operation_draw_page_finish() from application. It can
-be used for drawing page in another thread.
-
-This function must be called in the callback of "draw-page" signal.
+Gets the text displayed in the preview area.
-Since: 2.16
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter name="fsd">
+<parameter_description> a #GtkFontSelectionDialog
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the text displayed in the preview area.
+This string is owned by the widget and should not be
+modified or freed
+</return>
</function>
-<function name="gtk_action_group_get_visible">
+<function name="gtk_font_selection_dialog_new">
<description>
-Returns %TRUE if the group is visible. The constituent actions
-can only be logically visible (see gtk_action_is_visible()) if
-they are visible (see gtk_action_get_visible()) and their group
-is visible.
+Creates a new #GtkFontSelectionDialog.
-Since: 2.4
</description>
<parameters>
-<parameter name="action_group">
-<parameter_description> the action group
+<parameter name="title">
+<parameter_description> the title of the dialog window
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the group is visible.
-
+<return> a new #GtkFontSelectionDialog
</return>
</function>
-<function name="gtk_im_context_reset">
+<function name="gtk_font_selection_dialog_set_font_name">
<description>
-Notify the input method that a change such as a change in cursor
-position has been made. This will typically cause the input
-method to clear the preedit state.
+Sets the currently selected font.
+
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GtkIMContext
+<parameter name="fsd">
+<parameter_description> a #GtkFontSelectionDialog
+</parameter_description>
+</parameter>
+<parameter name="fontname">
+<parameter_description> a font name like "Helvetica 12" or "Times Bold 18"
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the font selected in @fsd is now the
+ fontname specified, %FALSE otherwise.
+</return>
</function>
-<function name="gtk_action_get_visible_horizontal">
+<function name="gtk_font_selection_dialog_set_preview_text">
<description>
-Checks whether @action is visible when horizontal
-
-Since: 2.16
+Sets the text displayed in the preview area.
</description>
<parameters>
-<parameter name="action">
-<parameter_description> a #GtkAction
+<parameter name="fsd">
+<parameter_description> a #GtkFontSelectionDialog
+</parameter_description>
+</parameter>
+<parameter name="text">
+<parameter_description> the text to display in the preview area
</parameter_description>
</parameter>
</parameters>
-<return> whether @action is visible when horizontal
-
-</return>
+<return></return>
</function>
-<function name="gtk_font_button_get_use_font">
+<function name="gtk_font_selection_get_face">
<description>
-Returns whether the selected font is used in the label.
+Gets the #PangoFontFace representing the selected font group
+details (i.e. family, slant, weight, width, etc).
-Since: 2.4
+Since: 2.14
</description>
<parameters>
-<parameter name="font_button">
-<parameter_description> a #GtkFontButton
+<parameter name="fontsel">
+<parameter_description> a #GtkFontSelection
</parameter_description>
</parameter>
</parameters>
-<return> whether the selected font is used in the label.
+<return> A #PangoFontFace representing the
+selected font group details. The returned object is owned by
+ fontsel and must not be modified or freed.
</return>
</function>
-<function name="gtk_text_iter_backward_visible_cursor_position">
+<function name="gtk_font_selection_get_face_list">
<description>
-Moves @iter forward to the previous visible cursor position. See
-gtk_text_iter_backward_cursor_position() for details.
+This returns the #GtkTreeView which lists all styles available for
+the selected font. For example, 'Regular', 'Bold', etc.
-Since: 2.4
+Since: 2.14
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="fontsel">
+<parameter_description> a #GtkFontSelection
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if we moved and the new position is dereferenceable
+<return> A #GtkWidget that is part of @fontsel
</return>
</function>
-<function name="gtk_spin_button_get_value_as_int">
+<function name="gtk_font_selection_get_family">
<description>
-Get the value @spin_button represented as an integer.
+Gets the #PangoFontFamily representing the selected font family.
+Since: 2.14
</description>
<parameters>
-<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter name="fontsel">
+<parameter_description> a #GtkFontSelection
</parameter_description>
</parameter>
</parameters>
-<return> the value of @spin_button
+<return> A #PangoFontFamily representing the
+selected font family. Font families are a collection of font
+faces. The returned object is owned by @fontsel and must not
+be modified or freed.
+
</return>
</function>
-<function name="gtk_print_job_get_printer">
+<function name="gtk_font_selection_get_family_list">
<description>
-Gets the #GtkPrinter of the print job.
+This returns the #GtkTreeView that lists font families, for
+example, 'Sans', 'Serif', etc.
-Since: 2.10
+Since: 2.14
</description>
<parameters>
-<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter name="fontsel">
+<parameter_description> a #GtkFontSelection
</parameter_description>
</parameter>
</parameters>
-<return> the printer of @job
+<return> A #GtkWidget that is part of @fontsel
</return>
</function>
-<function name="gtk_cell_view_new_with_text">
+<function name="gtk_font_selection_get_font">
<description>
-Creates a new #GtkCellView widget, adds a #GtkCellRendererText
-to it, and makes its show @text.
+Gets the currently-selected font.
-Since: 2.6
+Deprecated: 2.0: Use gtk_font_selection_get_font_name() instead.
</description>
<parameters>
-<parameter name="text">
-<parameter_description> the text to display in the cell view
+<parameter name="fontsel">
+<parameter_description> a #GtkFontSelection
</parameter_description>
</parameter>
</parameters>
-<return> A newly created #GtkCellView widget.
+<return> A #GdkFont.
</return>
</function>
-<function name="gtk_layout_new">
+<function name="gtk_font_selection_get_font_name">
<description>
-Creates a new #GtkLayout. Unless you have a specific adjustment
-you'd like the layout to use for scrolling, pass %NULL for
- hadjustment and @vadjustment.
+Gets the currently-selected font name.
+
+Note that this can be a different string than what you set with
+gtk_font_selection_set_font_name(), as the font selection widget may
+normalize font names and thus return a string with a different structure.
+For example, "Helvetica Italic Bold 12" could be normalized to
+"Helvetica Bold Italic 12". Use pango_font_description_equal()
+if you want to compare two font descriptions.
</description>
<parameters>
-<parameter name="hadjustment">
-<parameter_description> horizontal scroll adjustment, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="vadjustment">
-<parameter_description> vertical scroll adjustment, or %NULL
+<parameter name="fontsel">
+<parameter_description> a #GtkFontSelection
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkLayout
+<return> A string with the name of the current font, or %NULL if
+no font is selected. You must free this string with g_free().
</return>
</function>
-<function name="gtk_text_mark_new">
+<function name="gtk_font_selection_get_preview_entry">
<description>
-Creates a text mark. Add it to a buffer using gtk_text_buffer_add_mark().
-If @name is %NULL, the mark is anonymous; otherwise, the mark can be
-retrieved by name using gtk_text_buffer_get_mark(). If a mark has left
-gravity, and text is inserted at the mark's current location, the mark
-will be moved to the left of the newly-inserted text. If the mark has
-right gravity (@left_gravity = %FALSE), the mark will end up on the
-right of newly-inserted text. The standard left-to-right cursor is a
-mark with right gravity (when you type, the cursor stays on the right
-side of the text you're typing).
+This returns the #GtkEntry used to display the font as a preview.
-Since: 2.12
+Since: 2.14
</description>
<parameters>
-<parameter name="name">
-<parameter_description> mark name or %NULL
-</parameter_description>
-</parameter>
-<parameter name="left_gravity">
-<parameter_description> whether the mark should have left gravity
+<parameter name="fontsel">
+<parameter_description> a #GtkFontSelection
</parameter_description>
</parameter>
</parameters>
-<return> new #GtkTextMark
+<return> A #GtkWidget that is part of @fontsel
</return>
</function>
-<function name="gtk_icon_info_copy">
+<function name="gtk_font_selection_get_preview_text">
<description>
-Make a copy of a #GtkIconInfo.
+Gets the text displayed in the preview area.
-Since: 2.4
</description>
<parameters>
-<parameter name="icon_info">
-<parameter_description> a #GtkIconInfo
+<parameter name="fontsel">
+<parameter_description> a #GtkFontSelection
</parameter_description>
</parameter>
</parameters>
-<return> the new GtkIconInfo
-
+<return> the text displayed in the preview area.
+This string is owned by the widget and should not be
+modified or freed
</return>
</function>
-<function name="gtk_tool_item_get_text_alignment">
+<function name="gtk_font_selection_get_size">
<description>
-Returns the text alignment used for @tool_item. Custom subclasses of
-#GtkToolItem should call this function to find out how text should
-be aligned.
+The selected font size.
-Since: 2.20
+Since: 2.14
</description>
<parameters>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem:
+<parameter name="fontsel">
+<parameter_description> a #GtkFontSelection
</parameter_description>
</parameter>
</parameters>
-<return> a #gfloat indicating the horizontal text alignment
-used for @tool_item
+<return> A n integer representing the selected font size,
+or -1 if no font size is selected.
</return>
</function>
-<function name="gtk_tree_view_expand_row">
+<function name="gtk_font_selection_get_size_entry">
<description>
-Opens the row so its children are visible.
+This returns the #GtkEntry used to allow the user to edit the font
+number manually instead of selecting it from the list of font sizes.
+Since: 2.14
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> path to a row
-</parameter_description>
-</parameter>
-<parameter name="open_all">
-<parameter_description> whether to recursively expand, or just expand immediate children
+<parameter name="fontsel">
+<parameter_description> a #GtkFontSelection
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the row existed and had children
+<return> A #GtkWidget that is part of @fontsel
+
</return>
</function>
-<function name="gtk_text_layout_iter_starts_line">
+<function name="gtk_font_selection_get_size_list">
<description>
-Tests whether an iterator is at the start of a display line.
+This returns the #GtkTreeeView used to list font sizes.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #GtkTextLayout
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> iterator to test
+<parameter name="fontsel">
+<parameter_description> a #GtkFontSelection
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A #GtkWidget that is part of @fontsel
+
+</return>
</function>
-<function name="gtk_toolbar_remove_space">
+<function name="gtk_font_selection_new">
<description>
-Removes a space from the specified position.
+Creates a new #GtkFontSelection.
-Deprecated: 2.4: Use gtk_toolbar_insert() instead.
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar.
-</parameter_description>
-</parameter>
-<parameter name="position">
-<parameter_description> the index of the space to remove.
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> a n ew #GtkFontSelection
+</return>
</function>
-<function name="gtk_combo_box_remove_text">
+<function name="gtk_font_selection_set_font_name">
<description>
-Removes the string at @position from @combo_box. Note that you can only use
-this function with combo boxes constructed with gtk_combo_box_new_text().
+Sets the currently-selected font.
+
+Note that the @fontsel needs to know the screen in which it will appear
+for this to work; this can be guaranteed by simply making sure that the
+ fontsel is inserted in a toplevel window before you call this function.
-Since: 2.4
</description>
<parameters>
-<parameter name="combo_box">
-<parameter_description> A #GtkComboBox constructed with gtk_combo_box_new_text()
+<parameter name="fontsel">
+<parameter_description> a #GtkFontSelection
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> Index of the item to remove
+<parameter name="fontname">
+<parameter_description> a font name like "Helvetica 12" or "Times Bold 18"
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the font could be set successfully; %FALSE if no
+such font exists or if the @fontsel doesn't belong to a particular
+screen yet.
+</return>
</function>
-<function name="gtk_window_set_startup_id">
+<function name="gtk_font_selection_set_preview_text">
<description>
-Startup notification identifiers are used by desktop environment to
-track application startup, to provide user feedback and other
-features. This function changes the corresponding property on the
-underlying GdkWindow. Normally, startup identifier is managed
-automatically and you should only use this function in special cases
-like transferring focus from other processes. You should use this
-function before calling gtk_window_present() or any equivalent
-function generating a window map event.
-
-This function is only useful on X11, not with other GTK+ targets.
-
-Since: 2.12
+Sets the text displayed in the preview area.
+The @text is used to show how the selected font looks.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="fontsel">
+<parameter_description> a #GtkFontSelection
</parameter_description>
</parameter>
-<parameter name="startup_id">
-<parameter_description> a string with startup-notification identifier
+<parameter name="text">
+<parameter_description> the text to display in the preview area
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_cell_renderer_toggle_get_activatable">
+<function name="gtk_frame_get_label">
<description>
-Returns whether the cell renderer is activatable. See
-gtk_cell_renderer_toggle_set_activatable().
+If the frame's label widget is a #GtkLabel, returns the
+text in the label widget. (The frame will have a #GtkLabel
+for the label widget if a non-%NULL argument was passed
+to gtk_frame_new().)
-Since: 2.18
</description>
<parameters>
-<parameter name="toggle">
-<parameter_description> a #GtkCellRendererToggle
+<parameter name="frame">
+<parameter_description> a #GtkFrame
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the cell renderer is activatable.
-
+<return> the text in the label, or %NULL if there
+was no label widget or the lable widget was not
+a #GtkLabel. This string is owned by GTK+ and
+must not be modified or freed.
</return>
</function>
-<function name="gtk_entry_completion_set_minimum_key_length">
+<function name="gtk_frame_get_label_align">
<description>
-Requires the length of the search key for @completion to be at least
- length This is useful for long lists, where completing using a small
-key takes a lot of time and will come up with meaningless results anyway
-(ie, a too large dataset).
-
-Since: 2.4
+Retrieves the X and Y alignment of the frame's label. See
+gtk_frame_set_label_align().
</description>
<parameters>
-<parameter name="completion">
-<parameter_description> A #GtkEntryCompletion.
-</parameter_description>
-</parameter>
-<parameter name="length">
-<parameter_description> The minimum length of the key in order to start completing.
+<parameter name="frame">
+<parameter_description> a #GtkFrame
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_container_set_reallocate_redraws">
-<description>
-Sets the @reallocate_redraws flag of the container to the given value.
-
-Containers requesting reallocation redraws get automatically
-redrawn if any of their children changed allocation.
-
-</description>
-<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
+<parameter name="xalign">
+<parameter_description> location to store X alignment of frame's label, or %NULL
</parameter_description>
</parameter>
-<parameter name="needs_redraws">
-<parameter_description> the new value for the container's @reallocate_redraws flag
+<parameter name="yalign">
+<parameter_description> location to store X alignment of frame's label, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_get_realized">
+<function name="gtk_frame_get_label_widget">
<description>
-Determines whether @widget is realized.
+Retrieves the label widget for the frame. See
+gtk_frame_set_label_widget().
-Since: 2.20
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="frame">
+<parameter_description> a #GtkFrame
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @widget is realized, %FALSE otherwise
-
+<return> the label widget, or %NULL if there is none.
</return>
</function>
-<function name="gtk_tree_view_collapse_all">
+<function name="gtk_frame_get_shadow_type">
<description>
-Recursively collapses all visible, expanded nodes in @tree_view.
+Retrieves the shadow type of the frame. See
+gtk_frame_set_shadow_type().
+
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView.
+<parameter name="frame">
+<parameter_description> a #GtkFrame
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the current shadow type of the frame.
+</return>
</function>
-<function name="gtk_notebook_get_show_border">
+<function name="gtk_frame_new">
<description>
-Returns whether a bevel will be drawn around the notebook pages. See
-gtk_notebook_set_show_border().
+Creates a new #GtkFrame, with optional label @label.
+If @label is %NULL, the label is omitted.
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="label">
+<parameter_description> the text to use as the label of the frame
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the bevel is drawn
+<return> a new #GtkFrame widget
</return>
</function>
-<function name="gtk_builder_set_translation_domain">
+<function name="gtk_frame_set_label">
<description>
-Sets the translation domain of @builder.
-See #GtkBuilder:translation-domain.
-
-Since: 2.12
+Sets the text of the label. If @label is %NULL,
+the current label is removed.
</description>
<parameters>
-<parameter name="builder">
-<parameter_description> a #GtkBuilder
+<parameter name="frame">
+<parameter_description> a #GtkFrame
</parameter_description>
</parameter>
-<parameter name="domain">
-<parameter_description> the translation domain or %NULL
+<parameter name="label">
+<parameter_description> the text to use as the label of the frame
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_selection_get_select_function">
+<function name="gtk_frame_set_label_align">
<description>
-Returns the current selection function.
-
-Since: 2.14
+Sets the alignment of the frame widget's label. The
+default values for a newly created frame are 0.0 and 0.5.
</description>
<parameters>
-<parameter name="selection">
-<parameter_description> A #GtkTreeSelection.
+<parameter name="frame">
+<parameter_description> a #GtkFrame
+</parameter_description>
+</parameter>
+<parameter name="xalign">
+<parameter_description> The position of the label along the top edge
+of the widget. A value of 0.0 represents left alignment;
+1.0 represents right alignment.
+</parameter_description>
+</parameter>
+<parameter name="yalign">
+<parameter_description> The y alignment of the label. A value of 0.0 aligns under
+the frame; 1.0 aligns above the frame. If the values are exactly
+0.0 or 1.0 the gap in the frame won't be painted because the label
+will be completely above or below the frame.
</parameter_description>
</parameter>
</parameters>
-<return> The function.
-
-</return>
+<return></return>
</function>
-<function name="gtk_entry_completion_insert_prefix">
+<function name="gtk_frame_set_label_widget">
<description>
-Requests a prefix insertion.
-
-Since: 2.6
+Sets the label widget for the frame. This is the widget that
+will appear embedded in the top edge of the frame as a
+title.
</description>
<parameters>
-<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter name="frame">
+<parameter_description> a #GtkFrame
+</parameter_description>
+</parameter>
+<parameter name="label_widget">
+<parameter_description> the new label widget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_about_dialog_set_comments">
+<function name="gtk_frame_set_shadow_type">
<description>
-Sets the comments string to display in the about dialog.
-This should be a short string of one or two lines.
-
-Since: 2.6
+Sets the shadow type for @frame.
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter name="frame">
+<parameter_description> a #GtkFrame
</parameter_description>
</parameter>
-<parameter name="comments">
-<parameter_description> a comments string
+<parameter name="type">
+<parameter_description> the new #GtkShadowType
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_selection_owner_set">
+<function name="gtk_get_current_event">
<description>
-Claims ownership of a given selection for a particular widget,
-or, if @widget is %NULL, release ownership of the selection.
+Obtains a copy of the event currently being processed by GTK+. For
+example, if you get a "clicked" signal from #GtkButton, the current
+event will be the #GdkEventButton that triggered the "clicked"
+signal. The returned event must be freed with gdk_event_free().
+If there is no current event, the function returns %NULL.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget, or %NULL.
-</parameter_description>
-</parameter>
-<parameter name="selection">
-<parameter_description> an interned atom representing the selection to claim
-</parameter_description>
-</parameter>
-<parameter name="time_">
-<parameter_description> timestamp with which to claim the selection
-</parameter_description>
-</parameter>
</parameters>
-<return> %TRUE if the operation succeeded
+<return> a copy of the current event, or %NULL if no current event.
</return>
</function>
-<function name="gtk_entry_completion_set_inline_completion">
+<function name="gtk_get_current_event_state">
<description>
-Sets whether the common prefix of the possible completions should
-be automatically inserted in the entry.
+If there is a current event and it has a state field, place
+that state field in @state and return %TRUE, otherwise return
+%FALSE.
-Since: 2.6
</description>
<parameters>
-<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
-</parameter_description>
-</parameter>
-<parameter name="inline_completion">
-<parameter_description> %TRUE to do inline completion
+<parameter name="state">
+<parameter_description> a location to store the state of the current event
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if there was a current event and it had a state field
+</return>
</function>
-<function name="gtk_text_iter_get_language">
+<function name="gtk_get_current_event_time">
<description>
-A convenience wrapper around gtk_text_iter_get_attributes (),
-which returns the language in effect at @iter. If no tags affecting
-language apply to @iter, the return value is identical to that of
-gtk_get_default_language ().
+If there is a current event and it has a timestamp, return that
+timestamp, otherwise return %GDK_CURRENT_TIME.
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
-</parameter_description>
-</parameter>
</parameters>
-<return> language in effect at @iter
+<return> the timestamp from the current event, or %GDK_CURRENT_TIME.
</return>
</function>
-<function name="gtk_file_chooser_add_filter">
+<function name="gtk_get_default_language">
<description>
-Adds @filter to the list of filters that the user can select between.
-When a filter is selected, only files that are passed by that
-filter are displayed.
+Returns the #PangoLanguage for the default language currently in
+effect. (Note that this can change over the life of an
+application.) The default language is derived from the current
+locale. It determines, for example, whether GTK+ uses the
+right-to-left or left-to-right text direction.
-Note that the @chooser takes ownership of the filter, so you have to
-ref and sink it if you want to keep a reference.
+This function is equivalent to pango_language_get_default(). See
+that function for details.
-Since: 2.4
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
-</parameter_description>
-</parameter>
-<parameter name="filter">
-<parameter_description> a #GtkFileFilter
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> the default language as a #PangoLanguage, must not be
+freed
+</return>
</function>
-<function name="gtk_cell_renderer_start_editing">
+<function name="gtk_get_event_widget">
<description>
-Passes an activate event to the cell renderer for possible processing.
+If @event is %NULL or the event was not associated with any widget,
+returns %NULL, otherwise returns the widget that received the event
+originally.
</description>
<parameters>
-<parameter name="cell">
-<parameter_description> a #GtkCellRenderer
-</parameter_description>
-</parameter>
<parameter name="event">
<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
-<parameter name="widget">
-<parameter_description> widget that received the event
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> widget-dependent string representation of the event location;
-e.g. for #GtkTreeView, a string representation of #GtkTreePath
-</parameter_description>
-</parameter>
-<parameter name="background_area">
-<parameter_description> background area as passed to gtk_cell_renderer_render()
-</parameter_description>
-</parameter>
-<parameter name="cell_area">
-<parameter_description> cell area as passed to gtk_cell_renderer_render()
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> render flags
-</parameter_description>
-</parameter>
</parameters>
-<return> A new #GtkCellEditable, or %NULL
+<return> the widget that originally
+received @event, or %NULL
</return>
</function>
-<function name="gtk_icon_view_get_margin">
+<function name="gtk_get_option_group">
<description>
-Returns the value of the ::margin property.
+Returns a #GOptionGroup for the commandline arguments recognized
+by GTK+ and GDK. You should add this group to your #GOptionContext
+with g_option_context_add_group(), if you are using
+g_option_context_parse() to parse your commandline arguments.
Since: 2.6
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
+<parameter name="open_default_display">
+<parameter_description> whether to open the default display
+when parsing the commandline arguments
</parameter_description>
</parameter>
</parameters>
-<return> the space at the borders
+<return> a #GOptionGroup for the commandline arguments recognized
+by GTK+
</return>
</function>
-<function name="gtk_paint_handle">
+<function name="gtk_grab_get_current">
<description>
-Draws a handle as used in #GtkHandleBox and #GtkPaned.
-
-</description>
-<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
-</parameter_description>
-</parameter>
-<parameter name="shadow_type">
-<parameter_description> type of shadow to draw
-</parameter_description>
-</parameter>
-<parameter name="area">
-<parameter_description> clip rectangle, or %NULL if the
-output should not be clipped
-</parameter_description>
-</parameter>
-<parameter name="widget">
-<parameter_description> the widget
-</parameter_description>
-</parameter>
-<parameter name="detail">
-<parameter_description> a style detail
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> x origin of the handle
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> y origin of the handle
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> with of the handle
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> height of the handle
-</parameter_description>
-</parameter>
-<parameter name="orientation">
-<parameter_description> the orientation of the handle
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_text_iter_backward_char">
-<description>
-Moves backward by one character offset. Returns %TRUE if movement
-was possible; if @iter was the first in the buffer (character
-offset 0), gtk_text_iter_backward_char () returns %FALSE for convenience when
-writing loops.
+Queries the current grab of the default window group.
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
-</parameter_description>
-</parameter>
</parameters>
-<return> whether movement was possible
+<return> The widget which currently
+has the grab or %NULL if no grab is active
</return>
</function>
-<function name="gtk_tree_model_iter_children">
+<function name="gtk_handle_box_get_child_detached">
<description>
-Sets @iter to point to the first child of @parent. If @parent has no
-children, %FALSE is returned and @iter is set to be invalid. @parent
-will remain a valid node after this function has been called.
-
-If @parent is %NULL returns the first node, equivalent to
-<literal>gtk_tree_model_get_iter_first (tree_model, iter);</literal>
+Whether the handlebox's child is currently detached.
+Since: 2.14
</description>
<parameters>
-<parameter name="tree_model">
-<parameter_description> A #GtkTreeModel.
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> The new #GtkTreeIter to be set to the child.
-</parameter_description>
-</parameter>
-<parameter name="parent">
-<parameter_description> The #GtkTreeIter, or %NULL
+<parameter name="handle_box">
+<parameter_description> a #GtkHandleBox
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE, if @child has been set to the first child.
+<return> %TRUE if the child is currently detached, otherwise %FALSE
+
</return>
</function>
-<function name="gtk_tree_view_get_hover_selection">
+<function name="gtk_handle_box_get_handle_position">
<description>
-Returns whether hover selection mode is turned on for @tree_view.
+Gets the handle position of the handle box. See
+gtk_handle_box_set_handle_position().
-Since: 2.6
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
+<parameter name="handle_box">
+<parameter_description> a #GtkHandleBox
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @tree_view is in hover selection mode
-
+<return> the current handle position.
</return>
</function>
-<function name="gtk_cell_renderer_toggle_set_radio">
+<function name="gtk_handle_box_get_shadow_type">
<description>
-If @radio is %TRUE, the cell renderer renders a radio toggle
-(i.e. a toggle in a group of mutually-exclusive toggles).
-If %FALSE, it renders a check toggle (a standalone boolean option).
-This can be set globally for the cell renderer, or changed just
-before rendering each cell in the model (for #GtkTreeView, you set
-up a per-row setting using #GtkTreeViewColumn to associate model
-columns with cell renderer properties).
+Gets the type of shadow drawn around the handle box. See
+gtk_handle_box_set_shadow_type().
+
</description>
<parameters>
-<parameter name="toggle">
-<parameter_description> a #GtkCellRendererToggle
-</parameter_description>
-</parameter>
-<parameter name="radio">
-<parameter_description> %TRUE to make the toggle look like a radio button
+<parameter name="handle_box">
+<parameter_description> a #GtkHandleBox
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the type of shadow currently drawn around the handle box.
+</return>
</function>
-<function name="gtk_tree_model_get_iter">
+<function name="gtk_handle_box_get_snap_edge">
<description>
-Sets @iter to a valid iterator pointing to @path.
+Gets the edge used for determining reattachment of the handle box. See
+gtk_handle_box_set_snap_edge().
</description>
<parameters>
-<parameter name="tree_model">
-<parameter_description> A #GtkTreeModel.
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> The uninitialized #GtkTreeIter.
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> The #GtkTreePath.
+<parameter name="handle_box">
+<parameter_description> a #GtkHandleBox
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE, if @iter was set.
+<return> the edge used for determining reattachment, or (GtkPositionType)-1 if this
+is determined (as per default) from the handle position.
</return>
</function>
-<function name="gtk_icon_view_path_is_selected">
+<function name="gtk_hbox_new">
<description>
-Returns %TRUE if the icon pointed to by @path is currently
-selected. If @path does not point to a valid location, %FALSE is returned.
+Creates a new #GtkHBox.
-Since: 2.6
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> A #GtkIconView.
+<parameter name="homogeneous">
+<parameter_description> %TRUE if all children are to be given equal space allotments.
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> A #GtkTreePath to check selection on.
+<parameter name="spacing">
+<parameter_description> the number of pixels to place by default between children.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @path is selected.
-
+<return> a new #GtkHBox.
</return>
</function>
-<function name="gtk_accel_map_add_entry">
+<function name="gtk_hscale_new_with_range">
<description>
-Registers a new accelerator with the global accelerator map.
-This function should only be called once per @accel_path
-with the canonical @accel_key and @accel_mods for this path.
-To change the accelerator during runtime programatically, use
-gtk_accel_map_change_entry().
-The accelerator path must consist of "<WINDOWTYPE>/Category1/Category2/.../Action",
-where <WINDOWTYPE> should be a unique application-specific identifier, that
-corresponds to the kind of window the accelerator is being used in, e.g. "Gimp-Image",
-"Abiword-Document" or "Gnumeric-Settings".
-The Category1/.../Action portion is most appropriately chosen by the action the
-accelerator triggers, i.e. for accelerators on menu items, choose the item's menu path,
-e.g. "File/Save As", "Image/View/Zoom" or "Edit/Select All".
-So a full valid accelerator path may look like:
-"<Gimp-Toolbox>/File/Dialogs/Tool Options...".
+Creates a new horizontal scale widget that lets the user input a
+number between @min and @max (including @min and @max) with the
+increment @step. @step must be nonzero; it's the distance the
+slider moves when using the arrow keys to adjust the scale value.
+
+Note that the way in which the precision is derived works best if @step
+is a power of ten. If the resulting precision is not suitable for your
+needs, use gtk_scale_set_digits() to correct it.
-Note that @accel_path string will be stored in a #GQuark. Therefore, if you
-pass a static string, you can save some memory by interning it first with
-g_intern_static_string().
</description>
<parameters>
-<parameter name="accel_path">
-<parameter_description> valid accelerator path
+<parameter name="min">
+<parameter_description> minimum value
</parameter_description>
</parameter>
-<parameter name="accel_key">
-<parameter_description> the accelerator key
+<parameter name="max">
+<parameter_description> maximum value
</parameter_description>
</parameter>
-<parameter name="accel_mods">
-<parameter_description> the accelerator modifiers
+<parameter name="step">
+<parameter_description> step increment (tick size) used with keyboard shortcuts
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GtkHScale
+</return>
</function>
-<function name="gtk_text_buffer_register_serialize_format">
+<function name="gtk_hscrollbar_new">
<description>
-This function registers a rich text serialization @function along with
-its @mime_type with the passed @buffer.
+Creates a new horizontal scrollbar.
-Since: 2.10
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="mime_type">
-<parameter_description> the format's mime-type
-</parameter_description>
-</parameter>
-<parameter name="function">
-<parameter_description> the serialize function to register
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> %function's user_data
-</parameter_description>
-</parameter>
-<parameter name="user_data_destroy">
-<parameter_description> a function to call when @user_data is no longer needed
+<parameter name="adjustment">
+<parameter_description> the #GtkAdjustment to use, or %NULL to create a new adjustment
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkAtom that corresponds to the newly registered
-format's mime-type.
-
+<return> the new #GtkHScrollbar
</return>
</function>
-<function name="gtk_icon_theme_lookup_by_gicon">
+<function name="gtk_hsv_get_color">
<description>
-Looks up an icon and returns a structure containing
-information such as the filename of the icon.
-The icon can then be rendered into a pixbuf using
-gtk_icon_info_load_icon().
+Queries the current color in an HSV color selector.
+Returned values will be in the [0.0, 1.0] range.
Since: 2.14
</description>
<parameters>
-<parameter name="icon_theme">
-<parameter_description> a #GtkIconTheme
+<parameter name="hsv">
+<parameter_description> An HSV color selector
</parameter_description>
</parameter>
-<parameter name="icon">
-<parameter_description> the #GIcon to look up
+<parameter name="h">
+<parameter_description> Return value for the hue
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> desired icon size
+<parameter name="s">
+<parameter_description> Return value for the saturation
</parameter_description>
</parameter>
-<parameter name="flags">
-<parameter_description> flags modifying the behavior of the icon lookup
+<parameter name="v">
+<parameter_description> Return value for the value
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkIconInfo structure containing
-information about the icon, or %NULL if the icon
-wasn't found. Free with gtk_icon_info_free()
-
-</return>
+<return></return>
</function>
-<function name="gtk_tool_button_set_label_widget">
+<function name="gtk_hsv_get_metrics">
<description>
-Sets @label_widget as the widget that will be used as the label
-for @button. If @label_widget is %NULL the "label" property is used
-as label. If "label" is also %NULL, the label in the stock item
-determined by the "stock_id" property is used as label. If
-"stock_id" is also %NULL, @button does not have a label.
+Queries the size and ring width of an HSV color selector.
-Since: 2.4
+Since: 2.14
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkToolButton
+<parameter name="hsv">
+<parameter_description> An HSV color selector
</parameter_description>
</parameter>
-<parameter name="label_widget">
-<parameter_description> the widget used as label, or %NULL
+<parameter name="size">
+<parameter_description> Return value for the diameter of the hue ring
+</parameter_description>
+</parameter>
+<parameter name="ring_width">
+<parameter_description> Return value for the width of the hue ring
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_recent_chooser_menu_get_show_numbers">
+<function name="gtk_hsv_is_adjusting">
<description>
-Returns the value set by gtk_recent_chooser_menu_set_show_numbers().
+An HSV color selector can be said to be adjusting if multiple rapid
+changes are being made to its value, for example, when the user is
+adjusting the value with the mouse. This function queries whether
+the HSV color selector is being adjusted or not.
-Since: 2.10
+Since: 2.14
</description>
<parameters>
-<parameter name="menu">
-<parameter_description> a #GtkRecentChooserMenu
+<parameter name="hsv">
+<parameter_description> A #GtkHSV
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if numbers should be shown.
+<return> %TRUE if clients can ignore changes to the color value,
+since they may be transitory, or %FALSE if they should consider
+the color value status to be final.
</return>
</function>
-<function name="gtk_file_chooser_get_files">
+<function name="gtk_hsv_new">
<description>
-Lists all the selected files and subfolders in the current folder of @chooser
-as #GFile. An internal function, see gtk_file_chooser_get_uris().
+Creates a new HSV color selector.
Since: 2.14
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
-</parameter_description>
-</parameter>
</parameters>
-<return> a #GSList containing a #GFile for each selected
-file and subfolder in the current folder. Free the returned list
-with g_slist_free(), and the files with g_object_unref().
+<return> A newly-created HSV color selector.
</return>
</function>
-<function name="gtk_misc_get_alignment">
+<function name="gtk_hsv_set_color">
<description>
-Gets the X and Y alignment of the widget within its allocation.
-See gtk_misc_set_alignment().
+Sets the current color in an HSV color selector.
+Color component values must be in the [0.0, 1.0] range.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="misc">
-<parameter_description> a #GtkMisc
+<parameter name="hsv">
+<parameter_description> An HSV color selector
</parameter_description>
</parameter>
-<parameter name="xalign">
-<parameter_description> location to store X alignment of @misc, or %NULL
+<parameter name="h">
+<parameter_description> Hue
</parameter_description>
</parameter>
-<parameter name="yalign">
-<parameter_description> location to store Y alignment of @misc, or %NULL
+<parameter name="s">
+<parameter_description> Saturation
+</parameter_description>
+</parameter>
+<parameter name="v">
+<parameter_description> Value
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_settings_set_printer">
+<function name="gtk_hsv_set_metrics">
<description>
-Convenience function to set %GTK_PRINT_SETTINGS_PRINTER
-to @printer.
+Sets the size and ring width of an HSV color selector.
-Since: 2.10
+Since: 2.14
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="hsv">
+<parameter_description> An HSV color selector
</parameter_description>
</parameter>
-<parameter name="printer">
-<parameter_description> the printer name
+<parameter name="size">
+<parameter_description> Diameter for the hue ring
+</parameter_description>
+</parameter>
+<parameter name="ring_width">
+<parameter_description> Width of the hue ring
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_color_button_get_color">
+<function name="gtk_hsv_to_rgb">
<description>
-Sets @color to be the current color in the #GtkColorButton widget.
+Converts a color from HSV space to RGB.
+Input values must be in the [0.0, 1.0] range;
+output values will be in the same range.
-Since: 2.4
+Since: 2.14
</description>
<parameters>
-<parameter name="color_button">
-<parameter_description> a #GtkColorButton.
+<parameter name="h">
+<parameter_description> Hue
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> a #GdkColor to fill in with the current color.
+<parameter name="s">
+<parameter_description> Saturation
+</parameter_description>
+</parameter>
+<parameter name="v">
+<parameter_description> Value
+</parameter_description>
+</parameter>
+<parameter name="r">
+<parameter_description> Return value for the red component
+</parameter_description>
+</parameter>
+<parameter name="g">
+<parameter_description> Return value for the green component
+</parameter_description>
+</parameter>
+<parameter name="b">
+<parameter_description> Return value for the blue component
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_column_set_attributes">
+<function name="gtk_icon_factory_add">
<description>
-Sets the attributes in the list as the attributes of @tree_column.
-The attributes should be in attribute/column order, as in
-gtk_tree_view_column_add_attribute(). All existing attributes
-are removed, and replaced with the new attributes.
+Adds the given @icon_set to the icon factory, under the name
+ stock_id @stock_id should be namespaced for your application,
+e.g. "myapp-whatever-icon". Normally applications create a
+#GtkIconFactory, then add it to the list of default factories with
+gtk_icon_factory_add_default(). Then they pass the @stock_id to
+widgets such as #GtkImage to display the icon. Themes can provide
+an icon with the same name (such as "myapp-whatever-icon") to
+override your application's default icons. If an icon already
+existed in @factory for @stock_id, it is unreferenced and replaced
+with the new @icon_set.
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn.
+<parameter name="factory">
+<parameter_description> a #GtkIconFactory
</parameter_description>
</parameter>
-<parameter name="cell_renderer">
-<parameter_description> the #GtkCellRenderer we're setting the attributes of
+<parameter name="stock_id">
+<parameter_description> icon name
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> A %NULL-terminated list of attributes.
+<parameter name="icon_set">
+<parameter_description> icon set
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_file_chooser_error_quark">
+<function name="gtk_icon_factory_add_default">
<description>
-Registers an error quark for #GtkFileChooser if necessary.
-
-Since: 2.4
+Adds an icon factory to the list of icon factories searched by
+gtk_style_lookup_icon_set(). This means that, for example,
+gtk_image_new_from_stock() will be able to find icons in @factory.
+There will normally be an icon factory added for each library or
+application that comes with icons. The default icon factories
+can be overridden by themes.
</description>
<parameters>
+<parameter name="factory">
+<parameter_description> a #GtkIconFactory
+</parameter_description>
+</parameter>
</parameters>
-<return> The error quark used for #GtkFileChooser errors.
-
-</return>
+<return></return>
</function>
-<function name="gtk_radio_menu_item_new_with_mnemonic">
+<function name="gtk_icon_factory_lookup">
<description>
-Creates a new #GtkRadioMenuItem containing a label. The label
-will be created using gtk_label_new_with_mnemonic(), so underscores
-in @label indicate the mnemonic for the menu item.
+Looks up @stock_id in the icon factory, returning an icon set
+if found, otherwise %NULL. For display to the user, you should
+use gtk_style_lookup_icon_set() on the #GtkStyle for the
+widget that will display the icon, instead of using this
+function directly, so that themes are taken into account.
+
</description>
<parameters>
-<parameter name="group">
-<parameter_description> group the radio menu item is inside
+<parameter name="factory">
+<parameter_description> a #GtkIconFactory
</parameter_description>
</parameter>
-<parameter name="label">
-<parameter_description> the text of the button, with an underscore in front of the
-mnemonic character
+<parameter name="stock_id">
+<parameter_description> an icon name
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkRadioMenuItem
+<return> icon set of @stock_id.
</return>
</function>
-<function name="gtk_plug_get_socket_window">
+<function name="gtk_icon_factory_lookup_default">
<description>
-Retrieves the socket the plug is embedded in.
+Looks for an icon in the list of default icon factories. For
+display to the user, you should use gtk_style_lookup_icon_set() on
+the #GtkStyle for the widget that will display the icon, instead of
+using this function directly, so that themes are taken into
+account.
-Since: 2.14
</description>
<parameters>
-<parameter name="plug">
-<parameter_description> a #GtkPlug
+<parameter name="stock_id">
+<parameter_description> an icon name
</parameter_description>
</parameter>
</parameters>
-<return> the window of the socket, or %NULL
-
+<return> a #GtkIconSet, or %NULL
</return>
</function>
-<function name="gtk_text_buffer_get_mark">
+<function name="gtk_icon_factory_new">
<description>
-Returns the mark named @name in buffer @buffer, or %NULL if no such
-mark exists in the buffer.
+Creates a new #GtkIconFactory. An icon factory manages a collection
+of #GtkIconSet<!-- -->s; a #GtkIconSet manages a set of variants of a
+particular icon (i.e. a #GtkIconSet contains variants for different
+sizes and widget states). Icons in an icon factory are named by a
+stock ID, which is a simple string identifying the icon. Each
+#GtkStyle has a list of #GtkIconFactory<!-- -->s derived from the current
+theme; those icon factories are consulted first when searching for
+an icon. If the theme doesn't set a particular icon, GTK+ looks for
+the icon in a list of default icon factories, maintained by
+gtk_icon_factory_add_default() and
+gtk_icon_factory_remove_default(). Applications with icons should
+add a default icon factory with their icons, which will allow
+themes to override the icons for the application.
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="name">
-<parameter_description> a mark name
-</parameter_description>
-</parameter>
</parameters>
-<return> a #GtkTextMark, or %NULL
+<return> a new #GtkIconFactory
</return>
</function>
-<function name="gtk_paper_size_set_size">
+<function name="gtk_icon_factory_remove_default">
<description>
-Changes the dimensions of a @size to @width x @height.
-
-Since: 2.10
+Removes an icon factory from the list of default icon
+factories. Not normally used; you might use it for a library that
+can be unloaded or shut down.
</description>
<parameters>
-<parameter name="size">
-<parameter_description> a custom #GtkPaperSize object
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> the new width in units of @unit
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> the new height in units of @unit
-</parameter_description>
-</parameter>
-<parameter name="unit">
-<parameter_description> the unit for @width and @height
+<parameter name="factory">
+<parameter_description> a #GtkIconFactory previously added with gtk_icon_factory_add_default()
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_paper_size_get_width">
+<function name="gtk_icon_info_copy">
<description>
-Gets the paper width of the #GtkPaperSize, in
-units of @unit.
+Make a copy of a #GtkIconInfo.
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="size">
-<parameter_description> a #GtkPaperSize object
-</parameter_description>
-</parameter>
-<parameter name="unit">
-<parameter_description> the unit for the return value
+<parameter name="icon_info">
+<parameter_description> a #GtkIconInfo
</parameter_description>
</parameter>
</parameters>
-<return> the paper width
+<return> the new GtkIconInfo
</return>
</function>
-<function name="gtk_list_store_swap">
+<function name="gtk_icon_info_free">
<description>
-Swaps @a and @b in @store. Note that this function only works with
-unsorted stores.
+Free a #GtkIconInfo and associated information
-Since: 2.2
+Since: 2.4
</description>
<parameters>
-<parameter name="store">
-<parameter_description> A #GtkListStore.
-</parameter_description>
-</parameter>
-<parameter name="a">
-<parameter_description> A #GtkTreeIter.
-</parameter_description>
-</parameter>
-<parameter name="b">
-<parameter_description> Another #GtkTreeIter.
+<parameter name="icon_info">
+<parameter_description> a #GtkIconInfo
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_shape_combine_mask">
+<function name="gtk_icon_info_get_attach_points">
<description>
-Sets a shape for this widget's GDK window. This allows for
-transparent windows etc., see gdk_window_shape_combine_mask()
-for more information.
+Fetches the set of attach points for an icon. An attach point
+is a location in the icon that can be used as anchor points for attaching
+emblems or overlays to the icon.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="shape_mask">
-<parameter_description> shape to be added, or %NULL to remove an existing shape
+<parameter name="icon_info">
+<parameter_description> a #GtkIconInfo
</parameter_description>
</parameter>
-<parameter name="offset_x">
-<parameter_description> X position of shape mask with respect to @window
+<parameter name="points">
+<parameter_description> location to store pointer to an array of points, or %NULL
+free the array of points with g_free().
</parameter_description>
</parameter>
-<parameter name="offset_y">
-<parameter_description> Y position of shape mask with respect to @window
+<parameter name="n_points">
+<parameter_description> location to store the number of points in @points, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if there are any attach points for the icon.
+
+</return>
</function>
-<function name="gtk_tree_view_unset_rows_drag_source">
+<function name="gtk_icon_info_get_base_size">
<description>
-Undoes the effect of
-gtk_tree_view_enable_model_drag_source(). Calling this method sets
-#GtkTreeView:reorderable to %FALSE.
+Gets the base size for the icon. The base size
+is a size for the icon that was specified by
+the icon theme creator. This may be different
+than the actual size of image; an example of
+this is small emblem icons that can be attached
+to a larger icon. These icons will be given
+the same base size as the larger icons to which
+they are attached.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
+<parameter name="icon_info">
+<parameter_description> a #GtkIconInfo
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the base size, or 0, if no base
+size is known for the icon.
+
+</return>
</function>
-<function name="gtk_builder_get_objects">
+<function name="gtk_icon_info_get_builtin_pixbuf">
<description>
-Gets all objects that have been constructed by @builder. Note that
-this function does not increment the reference counts of the returned
-objects.
+Gets the built-in image for this icon, if any. To allow
+GTK+ to use built in icon images, you must pass the
+%GTK_ICON_LOOKUP_USE_BUILTIN to
+gtk_icon_theme_lookup_icon().
-Since: 2.12
+Since: 2.4
</description>
<parameters>
-<parameter name="builder">
-<parameter_description> a #GtkBuilder
+<parameter name="icon_info">
+<parameter_description> a #GtkIconInfo structure
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated #GSList containing all the objects
-constructed by the #GtkBuilder instance. It should be freed by
-g_slist_free()
+<return> the built-in image pixbuf, or %NULL. No
+extra reference is added to the returned pixbuf, so if
+you want to keep it around, you must use g_object_ref().
+The returned image must not be modified.
</return>
</function>
-<function name="gtk_expander_get_expanded">
+<function name="gtk_icon_info_get_display_name">
<description>
-Queries a #GtkExpander and returns its current state. Returns %TRUE
-if the child widget is revealed.
-
-See gtk_expander_set_expanded().
+Gets the display name for an icon. A display name is a
+string to be used in place of the icon name in a user
+visible context like a list of icons.
Since: 2.4
</description>
<parameters>
-<parameter name="expander">
-<parameter_description>a #GtkExpander
+<parameter name="icon_info">
+<parameter_description> a #GtkIconInfo
</parameter_description>
</parameter>
</parameters>
-<return> the current state of the expander.
+<return> the display name for the icon or %NULL, if
+the icon doesn't have a specified display name. This value
+is owned @icon_info and must not be modified or free.
</return>
</function>
-<function name="gtk_tool_palette_new">
+<function name="gtk_icon_info_get_embedded_rect">
<description>
-Creates a new tool palette.
+Gets the coordinates of a rectangle within the icon
+that can be used for display of information such
+as a preview of the contents of a text file.
+See gtk_icon_info_set_raw_coordinates() for further
+information about the coordinate system.
-Since: 2.20
+Since: 2.4
</description>
<parameters>
+<parameter name="icon_info">
+<parameter_description> a #GtkIconInfo
+</parameter_description>
+</parameter>
+<parameter name="rectangle">
+<parameter_description> #GdkRectangle in which to store embedded
+rectangle coordinates; coordinates are only stored
+when this function returns %TRUE.
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GtkToolPalette
+<return> %TRUE if the icon has an embedded rectangle
</return>
</function>
-<function name="gtk_tree_view_get_headers_visible">
+<function name="gtk_icon_info_get_filename">
<description>
-Returns %TRUE if the headers on the @tree_view are visible.
+Gets the filename for the icon. If the
+%GTK_ICON_LOOKUP_USE_BUILTIN flag was passed
+to gtk_icon_theme_lookup_icon(), there may be
+no filename if a builtin icon is returned; in this
+case, you should use gtk_icon_info_get_builtin_pixbuf().
+Since: 2.4
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView.
+<parameter name="icon_info">
+<parameter_description> a #GtkIconInfo
</parameter_description>
</parameter>
</parameters>
-<return> Whether the headers are visible or not.
+<return> the filename for the icon, or %NULL
+if gtk_icon_info_get_builtin_pixbuf() should
+be used instead. The return value is owned by
+GTK+ and should not be modified or freed.
+
</return>
</function>
-<function name="gtk_message_dialog_new">
+<function name="gtk_icon_info_load_icon">
<description>
-Creates a new message dialog, which is a simple dialog with an icon
-indicating the dialog type (error, warning, etc.) and some text the
-user may want to see. When the user clicks a button a "response"
-signal is emitted with response IDs from #GtkResponseType. See
-#GtkDialog for more details.
+Renders an icon previously looked up in an icon theme using
+gtk_icon_theme_lookup_icon(); the size will be based on the size
+passed to gtk_icon_theme_lookup_icon(). Note that the resulting
+pixbuf may not be exactly this size; an icon theme may have icons
+that differ slightly from their nominal sizes, and in addition GTK+
+will avoid scaling icons that it considers sufficiently close to the
+requested size or for which the source image would have to be scaled
+up too far. (This maintains sharpness.). This behaviour can be changed
+by passing the %GTK_ICON_LOOKUP_FORCE_SIZE flag when obtaining
+the #GtkIconInfo. If this flag has been specified, the pixbuf
+returned by this function will be scaled to the exact size.
+Since: 2.4
</description>
<parameters>
-<parameter name="parent">
-<parameter_description> transient parent, or %NULL for none
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> flags
-</parameter_description>
-</parameter>
-<parameter name="type">
-<parameter_description> type of message
-</parameter_description>
-</parameter>
-<parameter name="buttons">
-<parameter_description> set of buttons to use
-</parameter_description>
-</parameter>
-<parameter name="message_format">
-<parameter_description> printf()-style format string, or %NULL
+<parameter name="icon_info">
+<parameter_description> a #GtkIconInfo structure from gtk_icon_theme_lookup_icon()
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> arguments for @message_format
+<parameter name="error">
+<parameter_description> location to store error information on failure,
+or %NULL.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkMessageDialog
+<return> the rendered icon; this may be a newly
+created icon or a new reference to an internal icon, so you must
+not modify the icon. Use g_object_unref() to release your reference
+to the icon.
+
</return>
</function>
-<function name="gtk_window_get_default_icon_name">
+<function name="gtk_icon_info_new_for_pixbuf">
<description>
-Returns the fallback icon name for windows that has been set
-with gtk_window_set_default_icon_name(). The returned
-string is owned by GTK+ and should not be modified. It
-is only valid until the next call to
-gtk_window_set_default_icon_name().
+Creates a #GtkIconInfo for a #GdkPixbuf.
-Since: 2.16
+Since: 2.14
</description>
<parameters>
+<parameter name="icon_theme">
+<parameter_description> a #GtkIconTheme
+</parameter_description>
+</parameter>
+<parameter name="pixbuf">
+<parameter_description> the pixbuf to wrap in a #GtkIconInfo
+</parameter_description>
+</parameter>
</parameters>
-<return> the fallback icon name for windows
+<return> a #GtkIconInfo
</return>
</function>
-<function name="gtk_widget_set_direction">
+<function name="gtk_icon_info_set_raw_coordinates">
<description>
-Sets the reading direction on a particular widget. This direction
-controls the primary direction for widgets containing text,
-and also the direction in which the children of a container are
-packed. The ability to set the direction is present in order
-so that correct localization into languages with right-to-left
-reading directions can be done. Generally, applications will
-let the default reading direction present, except for containers
-where the containers are arranged in an order that is explicitely
-visual rather than logical (such as buttons for text justification).
+Sets whether the coordinates returned by gtk_icon_info_get_embedded_rect()
+and gtk_icon_info_get_attach_points() should be returned in their
+original form as specified in the icon theme, instead of scaled
+appropriately for the pixbuf returned by gtk_icon_info_load_icon().
-If the direction is set to %GTK_TEXT_DIR_NONE, then the value
-set by gtk_widget_set_default_direction() will be used.
+Raw coordinates are somewhat strange; they are specified to be with
+respect to the unscaled pixmap for PNG and XPM icons, but for SVG
+icons, they are in a 1000x1000 coordinate space that is scaled
+to the final size of the icon. You can determine if the icon is an SVG
+icon by using gtk_icon_info_get_filename(), and seeing if it is non-%NULL
+and ends in '.svg'.
+
+This function is provided primarily to allow compatibility wrappers
+for older API's, and is not expected to be useful for applications.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="icon_info">
+<parameter_description> a #GtkIconInfo
</parameter_description>
</parameter>
-<parameter name="dir">
-<parameter_description> the new direction
+<parameter name="raw_coordinates">
+<parameter_description> whether the coordinates of embedded rectangles
+and attached points should be returned in their original
+(unscaled) form.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_menu_bar_get_pack_direction">
+<function name="gtk_icon_set_add_source">
<description>
-Retrieves the current pack direction of the menubar.
-See gtk_menu_bar_set_pack_direction().
+Icon sets have a list of #GtkIconSource, which they use as base
+icons for rendering icons in different states and sizes. Icons are
+scaled, made to look insensitive, etc. in
+gtk_icon_set_render_icon(), but #GtkIconSet needs base images to
+work with. The base images and when to use them are described by
+a #GtkIconSource.
-Since: 2.8
+This function copies @source, so you can reuse the same source immediately
+without affecting the icon set.
+
+An example of when you'd use this function: a web browser's "Back
+to Previous Page" icon might point in a different direction in
+Hebrew and in English; it might look different when insensitive;
+and it might change size depending on toolbar mode (small/large
+icons). So a single icon set would contain all those variants of
+the icon, and you might add a separate source for each one.
+
+You should nearly always add a "default" icon source with all
+fields wildcarded, which will be used as a fallback if no more
+specific source matches. #GtkIconSet always prefers more specific
+icon sources to more generic icon sources. The order in which you
+add the sources to the icon set does not matter.
+
+gtk_icon_set_new_from_pixbuf() creates a new icon set with a
+default icon source based on the given pixbuf.
</description>
<parameters>
-<parameter name="menubar">
-<parameter_description> a #GtkMenuBar
+<parameter name="icon_set">
+<parameter_description> a #GtkIconSet
+</parameter_description>
+</parameter>
+<parameter name="source">
+<parameter_description> a #GtkIconSource
</parameter_description>
</parameter>
</parameters>
-<return> the pack direction
-
-</return>
+<return></return>
</function>
-<function name="gtk_entry_get_icon_pixbuf">
+<function name="gtk_icon_set_copy">
<description>
-Retrieves the image used for the icon.
-
-Unlike the other methods of setting and getting icon data, this
-method will work regardless of whether the icon was set using a
-#GdkPixbuf, a #GIcon, a stock item, or an icon name.
+Copies @icon_set by value.
-Since: 2.16
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> A #GtkEntry
-</parameter_description>
-</parameter>
-<parameter name="icon_pos">
-<parameter_description> Icon position
+<parameter name="icon_set">
+<parameter_description> a #GtkIconSet
</parameter_description>
</parameter>
</parameters>
-<return> A #GdkPixbuf, or %NULL if no icon is set for this position.
-
+<return> a new #GtkIconSet identical to the first.
</return>
</function>
-<function name="gtk_tree_view_set_hadjustment">
+<function name="gtk_icon_set_get_sizes">
<description>
-Sets the #GtkAdjustment for the current horizontal aspect.
+Obtains a list of icon sizes this icon set can render. The returned
+array must be freed with g_free().
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView
+<parameter name="icon_set">
+<parameter_description> a #GtkIconSet
</parameter_description>
</parameter>
-<parameter name="adjustment">
-<parameter_description> The #GtkAdjustment to set, or %NULL
+<parameter name="sizes">
+<parameter_description> return location
+for array of sizes
+</parameter_description>
+</parameter>
+<parameter name="n_sizes">
+<parameter_description> location to store number of elements in returned array
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_clipboard_wait_for_image">
+<function name="gtk_icon_set_new">
<description>
-Requests the contents of the clipboard as image and converts
-the result to a #GdkPixbuf. This function waits for
-the data to be received using the main loop, so events,
-timeouts, etc, may be dispatched during the wait.
+Creates a new #GtkIconSet. A #GtkIconSet represents a single icon
+in various sizes and widget states. It can provide a #GdkPixbuf
+for a given size and state on request, and automatically caches
+some of the rendered #GdkPixbuf objects.
+
+Normally you would use gtk_widget_render_icon() instead of
+using #GtkIconSet directly. The one case where you'd use
+#GtkIconSet is to create application-specific icon sets to place in
+a #GtkIconFactory.
-Since: 2.6
</description>
<parameters>
-<parameter name="clipboard">
-<parameter_description> a #GtkClipboard
-</parameter_description>
-</parameter>
</parameters>
-<return> a newly-allocated #GdkPixbuf object which must
-be disposed with g_object_unref(), or %NULL if
-retrieving the selection data failed. (This
-could happen for various reasons, in particular
-if the clipboard was empty or if the contents of
-the clipboard could not be converted into an image.)
-
+<return> a new #GtkIconSet
</return>
</function>
-<function name="gtk_widget_show_all">
+<function name="gtk_icon_set_new_from_pixbuf">
<description>
-Recursively shows a widget, and any child widgets (if the widget is
-a container).
+Creates a new #GtkIconSet with @pixbuf as the default/fallback
+source image. If you don't add any additional #GtkIconSource to the
+icon set, all variants of the icon will be created from @pixbuf,
+using scaling, pixelation, etc. as required to adjust the icon size
+or make the icon look insensitive/prelighted.
+
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="pixbuf">
+<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GtkIconSet
+</return>
</function>
-<function name="gtk_entry_set_invisible_char">
+<function name="gtk_icon_set_ref">
<description>
-Sets the character to use in place of the actual text when
-gtk_entry_set_visibility() has been called to set text visibility
-to %FALSE. i.e. this is the character used in "password mode" to
-show the user how many characters have been typed. By default, GTK+
-picks the best invisible char available in the current font. If you
-set the invisible char to 0, then the user will get no feedback
-at all; there will be no text on the screen as they type.
+Increments the reference count on @icon_set.
+
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
-</parameter_description>
-</parameter>
-<parameter name="ch">
-<parameter_description> a Unicode character
+<parameter name="icon_set">
+<parameter_description> a #GtkIconSet.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> @icon_set.
+</return>
</function>
-<function name="gtk_print_job_send">
+<function name="gtk_icon_set_render_icon">
<description>
-Sends the print job off to the printer.
+Renders an icon using gtk_style_render_icon(). In most cases,
+gtk_widget_render_icon() is better, since it automatically provides
+most of the arguments from the current widget settings. This
+function never returns %NULL; if the icon can't be rendered
+(perhaps because an image file fails to load), a default "missing
+image" icon will be returned instead.
-Since: 2.10
</description>
<parameters>
-<parameter name="job">
-<parameter_description> a GtkPrintJob
+<parameter name="icon_set">
+<parameter_description> a #GtkIconSet
</parameter_description>
</parameter>
-<parameter name="callback">
-<parameter_description> function to call when the job completes or an error occurs
+<parameter name="style">
+<parameter_description> a #GtkStyle associated with @widget, or %NULL
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data that gets passed to @callback
+<parameter name="direction">
+<parameter_description> text direction
</parameter_description>
</parameter>
-<parameter name="dnotify">
-<parameter_description> destroy notify for @user_data
+<parameter name="state">
+<parameter_description> widget state
+</parameter_description>
+</parameter>
+<parameter name="size">
+<parameter_description> icon size. A size of (GtkIconSize)-1
+means render at the size of the source and don't scale.
+</parameter_description>
+</parameter>
+<parameter name="widget">
+<parameter_description> widget that will display the icon, or %NULL.
+The only use that is typically made of this
+is to determine the appropriate #GdkScreen.
+</parameter_description>
+</parameter>
+<parameter name="detail">
+<parameter_description> detail to pass to the theme engine, or %NULL.
+Note that passing a detail of anything but %NULL
+will disable caching.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #GdkPixbuf to be displayed
+</return>
</function>
-<function name="gtk_toggle_action_get_active">
+<function name="gtk_icon_set_unref">
<description>
-Returns the checked state of the toggle action.
-
-Since: 2.4
+Decrements the reference count on @icon_set, and frees memory
+if the reference count reaches 0.
</description>
<parameters>
-<parameter name="action">
-<parameter_description> the action object
+<parameter name="icon_set">
+<parameter_description> a #GtkIconSet
</parameter_description>
</parameter>
</parameters>
-<return> the checked state of the toggle action
-
-</return>
+<return></return>
</function>
-<function name="gtk_widget_queue_clear">
+<function name="gtk_icon_size_from_name">
<description>
-This function does the same as gtk_widget_queue_draw().
+Looks up the icon size associated with @name.
-Deprecated: 2.2: Use gtk_widget_queue_draw() instead.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="name">
+<parameter_description> the name to look up.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the icon size
+</return>
</function>
-<function name="gtk_targets_include_text">
+<function name="gtk_icon_size_get_name">
<description>
-Determines if any of the targets in @targets can be used to
-provide text.
-
-Since: 2.10
+Gets the canonical name of the given icon size. The returned string
+is statically allocated and should not be freed.
</description>
<parameters>
-<parameter name="targets">
-<parameter_description> an array of #GdkAtom<!-- -->s
-</parameter_description>
-</parameter>
-<parameter name="n_targets">
-<parameter_description> the length of @targets
+<parameter name="size">
+<parameter_description> a #GtkIconSize.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @targets include a suitable target for text,
-otherwise %FALSE.
-
+<return> the name of the given icon size.
</return>
</function>
-<function name="gtk_tree_view_widget_to_tree_coords">
+<function name="gtk_icon_size_lookup">
<description>
-Converts bin_window coordinates to coordinates for the
-tree (the full scrollable area of the tree).
-
-Deprecated: 2.12: Due to historial reasons the name of this function is
-incorrect. For converting coordinates relative to the widget to
-bin_window coordinates, please see
-gtk_tree_view_convert_widget_to_bin_window_coords().
+Obtains the pixel size of a semantic icon size, possibly
+modified by user preferences for the default #GtkSettings.
+(See gtk_icon_size_lookup_for_settings().)
+Normally @size would be
+#GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc. This function
+isn't normally needed, gtk_widget_render_icon() is the usual
+way to get an icon for rendering, then just look at the size of
+the rendered pixbuf. The rendered pixbuf may not even correspond to
+the width/height returned by gtk_icon_size_lookup(), because themes
+are free to render the pixbuf however they like, including changing
+the usual size.
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
-</parameter_description>
-</parameter>
-<parameter name="wx">
-<parameter_description> X coordinate relative to bin_window
-</parameter_description>
-</parameter>
-<parameter name="wy">
-<parameter_description> Y coordinate relative to bin_window
+<parameter name="size">
+<parameter_description> an icon size
</parameter_description>
</parameter>
-<parameter name="tx">
-<parameter_description> return location for tree X coordinate
+<parameter name="width">
+<parameter_description> location to store icon width
</parameter_description>
</parameter>
-<parameter name="ty">
-<parameter_description> return location for tree Y coordinate
+<parameter name="height">
+<parameter_description> location to store icon height
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @size was a valid size
+</return>
</function>
-<function name="gtk_cell_view_get_displayed_row">
+<function name="gtk_icon_size_lookup_for_settings">
<description>
-Returns a #GtkTreePath referring to the currently
-displayed row. If no row is currently displayed,
-%NULL is returned.
+Obtains the pixel size of a semantic icon size, possibly
+modified by user preferences for a particular
+#GtkSettings. Normally @size would be
+#GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc. This function
+isn't normally needed, gtk_widget_render_icon() is the usual
+way to get an icon for rendering, then just look at the size of
+the rendered pixbuf. The rendered pixbuf may not even correspond to
+the width/height returned by gtk_icon_size_lookup(), because themes
+are free to render the pixbuf however they like, including changing
+the usual size.
-Since: 2.6
+Since: 2.2
</description>
<parameters>
-<parameter name="cell_view">
-<parameter_description> a #GtkCellView
+<parameter name="settings">
+<parameter_description> a #GtkSettings object, used to determine
+which set of user preferences to used.
+</parameter_description>
+</parameter>
+<parameter name="size">
+<parameter_description> an icon size
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> location to store icon width
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> location to store icon height
</parameter_description>
</parameter>
</parameters>
-<return> the currently displayed row or %NULL
+<return> %TRUE if @size was a valid size
</return>
</function>
-<function name="gtk_menu_item_set_submenu">
+<function name="gtk_icon_size_register">
<description>
-Sets or replaces the menu item's submenu, or removes it when a %NULL
-submenu is passed.
+Registers a new icon size, along the same lines as #GTK_ICON_SIZE_MENU,
+etc. Returns the integer value for the size.
+
</description>
<parameters>
-<parameter name="menu_item">
-<parameter_description> a #GtkMenuItem
+<parameter name="name">
+<parameter_description> name of the icon size
</parameter_description>
</parameter>
-<parameter name="submenu">
-<parameter_description> the submenu, or %NULL
+<parameter name="width">
+<parameter_description> the icon width
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the icon height
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> integer value representing the size
+</return>
</function>
-<function name="gtk_recent_chooser_set_show_tips">
+<function name="gtk_icon_size_register_alias">
<description>
-Sets whether to show a tooltips containing the full path of each
-recently used resource in a #GtkRecentChooser widget.
-
-Since: 2.10
+Registers @alias as another name for @target.
+So calling gtk_icon_size_from_name() with @alias as argument
+will return @target.
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
+<parameter name="alias">
+<parameter_description> an alias for @target
</parameter_description>
</parameter>
-<parameter name="show_tips">
-<parameter_description> %TRUE if tooltips should be shown
+<parameter name="target">
+<parameter_description> an existing icon size
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_ui_manager_add_ui_from_file">
+<function name="gtk_icon_source_copy">
<description>
-Parses a file containing a <link linkend="XML-UI">UI definition</link> and
-merges it with the current contents of @self.
+Creates a copy of @source; mostly useful for language bindings.
-Since: 2.4
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #GtkUIManager object
-</parameter_description>
-</parameter>
-<parameter name="filename">
-<parameter_description> the name of the file to parse
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for an error
+<parameter name="source">
+<parameter_description> a #GtkIconSource
</parameter_description>
</parameter>
</parameters>
-<return> The merge id for the merged UI. The merge id can be used
-to unmerge the UI with gtk_ui_manager_remove_ui(). If an error occurred,
-the return value is 0.
-
+<return> a new #GtkIconSource
</return>
</function>
-<function name="gtk_selection_data_free">
+<function name="gtk_icon_source_free">
<description>
-Frees a #GtkSelectionData structure returned from
-gtk_selection_data_copy().
+Frees a dynamically-allocated icon source, along with its
+filename, size, and pixbuf fields if those are not %NULL.
</description>
<parameters>
-<parameter name="data">
-<parameter_description> a pointer to a #GtkSelectionData structure.
+<parameter name="source">
+<parameter_description> a #GtkIconSource
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_mount_operation_get_screen">
+<function name="gtk_icon_source_get_direction">
<description>
-Gets the screen on which windows of the #GtkMountOperation
-will be shown.
+Obtains the text direction this icon source applies to. The return
+value is only useful/meaningful if the text direction is <emphasis>not</emphasis>
+wildcarded.
-Since: 2.14
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkMountOperation
+<parameter name="source">
+<parameter_description> a #GtkIconSource
</parameter_description>
</parameter>
</parameters>
-<return> the screen on which windows of @op are shown
-
+<return> text direction this source matches
</return>
</function>
-<function name="gtk_spin_button_get_wrap">
+<function name="gtk_icon_source_get_direction_wildcarded">
<description>
-Returns whether the spin button's value wraps around to the
-opposite limit when the upper or lower limit of the range is
-exceeded. See gtk_spin_button_set_wrap().
+Gets the value set by gtk_icon_source_set_direction_wildcarded().
</description>
<parameters>
-<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter name="source">
+<parameter_description> a #GtkIconSource
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the spin button wraps around
+<return> %TRUE if this icon source is a base for any text direction variant
</return>
</function>
-<function name="gtk_requisition_copy">
+<function name="gtk_icon_source_get_filename">
<description>
-Copies a #GtkRequisition.
+Retrieves the source filename, or %NULL if none is set. The
+filename is not a copy, and should not be modified or expected to
+persist beyond the lifetime of the icon source.
</description>
<parameters>
-<parameter name="requisition">
-<parameter_description> a #GtkRequisition
+<parameter name="source">
+<parameter_description> a #GtkIconSource
</parameter_description>
</parameter>
</parameters>
-<return> a copy of @requisition
+<return> image filename. This string must not be modified
+or freed.
</return>
</function>
-<function name="gtk_clipboard_request_image">
+<function name="gtk_icon_source_get_icon_name">
<description>
-Requests the contents of the clipboard as image. When the image is
-later received, it will be converted to a #GdkPixbuf, and
- callback will be called.
-
-The @pixbuf parameter to @callback will contain the resulting
-#GdkPixbuf if the request succeeded, or %NULL if it failed. This
-could happen for various reasons, in particular if the clipboard
-was empty or if the contents of the clipboard could not be
-converted into an image.
+Retrieves the source icon name, or %NULL if none is set. The
+icon_name is not a copy, and should not be modified or expected to
+persist beyond the lifetime of the icon source.
-Since: 2.6
</description>
<parameters>
-<parameter name="clipboard">
-<parameter_description> a #GtkClipboard
-</parameter_description>
-</parameter>
-<parameter name="callback">
-<parameter_description> a function to call when the image is received,
-or the retrieval fails. (It will always be called
-one way or the other.)
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to @callback.
+<parameter name="source">
+<parameter_description> a #GtkIconSource
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> icon name. This string must not be modified or freed.
+</return>
</function>
-<function name="gtk_accel_label_set_accel_widget">
+<function name="gtk_icon_source_get_pixbuf">
<description>
-Sets the widget to be monitored by this accelerator label.
+Retrieves the source pixbuf, or %NULL if none is set.
+In addition, if a filename source is in use, this
+function in some cases will return the pixbuf from
+loaded from the filename. This is, for example, true
+for the GtkIconSource passed to the GtkStyle::render_icon()
+virtual function. The reference count on the pixbuf is
+not incremented.
+
</description>
<parameters>
-<parameter name="accel_label">
-<parameter_description> a #GtkAccelLabel
-</parameter_description>
-</parameter>
-<parameter name="accel_widget">
-<parameter_description> the widget to be monitored.
+<parameter name="source">
+<parameter_description> a #GtkIconSource
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> source pixbuf
+</return>
</function>
-<function name="gtk_text_iter_starts_sentence">
+<function name="gtk_icon_source_get_size">
<description>
-Determines whether @iter begins a sentence. Sentence boundaries are
-determined by Pango and should be correct for nearly any language
-(if not, the correct fix would be to the Pango text boundary
-algorithms).
+Obtains the icon size this source applies to. The return value
+is only useful/meaningful if the icon size is <emphasis>not</emphasis> wildcarded.
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="source">
+<parameter_description> a #GtkIconSource
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter is at the start of a sentence.
+<return> icon size this source matches.
</return>
</function>
-<function name="gtk_widget_get_default_colormap">
+<function name="gtk_icon_source_get_size_wildcarded">
<description>
-Obtains the default colormap used to create widgets.
+Gets the value set by gtk_icon_source_set_size_wildcarded().
</description>
<parameters>
+<parameter name="source">
+<parameter_description> a #GtkIconSource
+</parameter_description>
+</parameter>
</parameters>
-<return> default widget colormap
+<return> %TRUE if this icon source is a base for any icon size variant
</return>
</function>
-<function name="gtk_old_editable_claim_selection">
+<function name="gtk_icon_source_get_state">
<description>
-Claims or gives up ownership of the selection.
+Obtains the widget state this icon source applies to. The return
+value is only useful/meaningful if the widget state is <emphasis>not</emphasis>
+wildcarded.
+
</description>
<parameters>
-<parameter name="old_editable">
-<parameter_description> a #GtkOldEditable
-</parameter_description>
-</parameter>
-<parameter name="claim">
-<parameter_description> if %TRUE, claim ownership of the selection, if %FALSE, give
-up ownership
-</parameter_description>
-</parameter>
-<parameter name="time_">
-<parameter_description> timestamp for this operation
+<parameter name="source">
+<parameter_description> a #GtkIconSource
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> widget state this source matches
+</return>
</function>
-<function name="gtk_tree_selection_unselect_all">
+<function name="gtk_icon_source_get_state_wildcarded">
<description>
-Unselects all the nodes.
+Gets the value set by gtk_icon_source_set_state_wildcarded().
+
</description>
<parameters>
-<parameter name="selection">
-<parameter_description> A #GtkTreeSelection.
+<parameter name="source">
+<parameter_description> a #GtkIconSource
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if this icon source is a base for any widget state variant
+</return>
</function>
-<function name="gtk_widget_get_has_window">
+<function name="gtk_icon_source_new">
<description>
-Determines whether @widget has a #GdkWindow of its own. See
-gtk_widget_set_has_window().
+Creates a new #GtkIconSource. A #GtkIconSource contains a #GdkPixbuf (or
+image filename) that serves as the base image for one or more of the
+icons in a #GtkIconSet, along with a specification for which icons in the
+icon set will be based on that pixbuf or image file. An icon set contains
+a set of icons that represent "the same" logical concept in different states,
+different global text directions, and different sizes.
+
+So for example a web browser's "Back to Previous Page" icon might
+point in a different direction in Hebrew and in English; it might
+look different when insensitive; and it might change size depending
+on toolbar mode (small/large icons). So a single icon set would
+contain all those variants of the icon. #GtkIconSet contains a list
+of #GtkIconSource from which it can derive specific icon variants in
+the set.
+
+In the simplest case, #GtkIconSet contains one source pixbuf from
+which it derives all variants. The convenience function
+gtk_icon_set_new_from_pixbuf() handles this case; if you only have
+one source pixbuf, just use that function.
+
+If you want to use a different base pixbuf for different icon
+variants, you create multiple icon sources, mark which variants
+they'll be used to create, and add them to the icon set with
+gtk_icon_set_add_source().
+
+By default, the icon source has all parameters wildcarded. That is,
+the icon source will be used as the base icon for any desired text
+direction, widget state, or icon size.
-Since: 2.18
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
</parameters>
-<return> %TRUE if @widget has a window, %FALSE otherwise
-
+<return> a new #GtkIconSource
</return>
</function>
-<function name="gtk_clipboard_clear">
+<function name="gtk_icon_source_set_direction">
<description>
-Clears the contents of the clipboard. Generally this should only
-be called between the time you call gtk_clipboard_set_with_owner()
-or gtk_clipboard_set_with_data(),
-and when the @clear_func you supplied is called. Otherwise, the
-clipboard may be owned by someone else.
+Sets the text direction this icon source is intended to be used
+with.
+
+Setting the text direction on an icon source makes no difference
+if the text direction is wildcarded. Therefore, you should usually
+call gtk_icon_source_set_direction_wildcarded() to un-wildcard it
+in addition to calling this function.
</description>
<parameters>
-<parameter name="clipboard">
-<parameter_description> a #GtkClipboard
+<parameter name="source">
+<parameter_description> a #GtkIconSource
+</parameter_description>
+</parameter>
+<parameter name="direction">
+<parameter_description> text direction this source applies to
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_invisible_get_screen">
+<function name="gtk_icon_source_set_direction_wildcarded">
<description>
-Returns the #GdkScreen object associated with @invisible
+If the text direction is wildcarded, this source can be used
+as the base image for an icon in any #GtkTextDirection.
+If the text direction is not wildcarded, then the
+text direction the icon source applies to should be set
+with gtk_icon_source_set_direction(), and the icon source
+will only be used with that text direction.
-Since: 2.2
+#GtkIconSet prefers non-wildcarded sources (exact matches) over
+wildcarded sources, and will use an exact match when possible.
</description>
<parameters>
-<parameter name="invisible">
-<parameter_description> a #GtkInvisible.
+<parameter name="source">
+<parameter_description> a #GtkIconSource
+</parameter_description>
+</parameter>
+<parameter name="setting">
+<parameter_description> %TRUE to wildcard the text direction
</parameter_description>
</parameter>
</parameters>
-<return> the associated #GdkScreen.
-
-</return>
+<return></return>
</function>
-<function name="gtk_cell_renderer_get_alignment">
+<function name="gtk_icon_source_set_filename">
<description>
-Fills in @xalign and @yalign with the appropriate values of @cell.
-
-Since: 2.18
+Sets the name of an image file to use as a base image when creating
+icon variants for #GtkIconSet. The filename must be absolute.
</description>
<parameters>
-<parameter name="cell">
-<parameter_description> A #GtkCellRenderer
-</parameter_description>
-</parameter>
-<parameter name="xalign">
-<parameter_description> location to fill in with the x alignment of the cell, or %NULL
+<parameter name="source">
+<parameter_description> a #GtkIconSource
</parameter_description>
</parameter>
-<parameter name="yalign">
-<parameter_description> location to fill in with the y alignment of the cell, or %NULL
+<parameter name="filename">
+<parameter_description> image file to use
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_ctree_insert_node">
+<function name="gtk_icon_source_set_icon_name">
<description>
+Sets the name of an icon to look up in the current icon theme
+to use as a base image when creating icon variants for #GtkIconSet.
</description>
<parameters>
-<parameter name="pixmap_closed">
-<parameter_description>
-</parameter_description>
-</parameter>
-<parameter name="mask_closed">
-<parameter_description>
-</parameter_description>
-</parameter>
-<parameter name="pixmap_opened">
-<parameter_description>
+<parameter name="source">
+<parameter_description> a #GtkIconSource
</parameter_description>
</parameter>
-<parameter name="mask_opened">
-<parameter_description>
+<parameter name="icon_name">
+<parameter_description> name of icon to use
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_misc_get_padding">
+<function name="gtk_icon_source_set_pixbuf">
<description>
-Gets the padding in the X and Y directions of the widget.
-See gtk_misc_set_padding().
+Sets a pixbuf to use as a base image when creating icon variants
+for #GtkIconSet.
</description>
<parameters>
-<parameter name="misc">
-<parameter_description> a #GtkMisc
-</parameter_description>
-</parameter>
-<parameter name="xpad">
-<parameter_description> location to store padding in the X direction, or %NULL
+<parameter name="source">
+<parameter_description> a #GtkIconSource
</parameter_description>
</parameter>
-<parameter name="ypad">
-<parameter_description> location to store padding in the Y direction, or %NULL
+<parameter name="pixbuf">
+<parameter_description> pixbuf to use as a source
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_get_child_visible">
+<function name="gtk_icon_source_set_size">
<description>
-Gets the value set with gtk_widget_set_child_visible().
-If you feel a need to use this function, your code probably
-needs reorganization.
-
-This function is only useful for container implementations and
-never should be called by an application.
+Sets the icon size this icon source is intended to be used
+with.
+Setting the icon size on an icon source makes no difference
+if the size is wildcarded. Therefore, you should usually
+call gtk_icon_source_set_size_wildcarded() to un-wildcard it
+in addition to calling this function.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="source">
+<parameter_description> a #GtkIconSource
+</parameter_description>
+</parameter>
+<parameter name="size">
+<parameter_description> icon size this source applies to
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the widget is mapped with the parent.
-</return>
+<return></return>
</function>
-<function name="gtk_icon_source_set_state_wildcarded">
+<function name="gtk_icon_source_set_size_wildcarded">
<description>
-If the widget state is wildcarded, this source can be used as the
-base image for an icon in any #GtkStateType. If the widget state
-is not wildcarded, then the state the source applies to should be
-set with gtk_icon_source_set_state() and the icon source will
-only be used with that specific state.
+If the icon size is wildcarded, this source can be used as the base
+image for an icon of any size. If the size is not wildcarded, then
+the size the source applies to should be set with
+gtk_icon_source_set_size() and the icon source will only be used
+with that specific size.
#GtkIconSet prefers non-wildcarded sources (exact matches) over
wildcarded sources, and will use an exact match when possible.
-#GtkIconSet will normally transform wildcarded source images to
-produce an appropriate icon for a given state, for example
-lightening an image on prelight, but will not modify source images
-that match exactly.
+#GtkIconSet will normally scale wildcarded source images to produce
+an appropriate icon at a given size, but will not change the size
+of source images that match exactly.
</description>
<parameters>
@@ -21336,709 +21499,658 @@ that match exactly.
<return></return>
</function>
-<function name="gtk_scale_button_set_icons">
+<function name="gtk_icon_source_set_state">
<description>
-Sets the icons to be used by the scale button.
-For details, see the #GtkScaleButton:icons property.
+Sets the widget state this icon source is intended to be used
+with.
-Since: 2.12
+Setting the widget state on an icon source makes no difference
+if the state is wildcarded. Therefore, you should usually
+call gtk_icon_source_set_state_wildcarded() to un-wildcard it
+in addition to calling this function.
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkScaleButton
+<parameter name="source">
+<parameter_description> a #GtkIconSource
</parameter_description>
</parameter>
-<parameter name="icons">
-<parameter_description> a %NULL-terminated array of icon names
+<parameter name="state">
+<parameter_description> widget state this source applies to
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tool_item_set_tooltip_text">
+<function name="gtk_icon_source_set_state_wildcarded">
<description>
-Sets the text to be displayed as tooltip on the item.
-See gtk_widget_set_tooltip_text().
+If the widget state is wildcarded, this source can be used as the
+base image for an icon in any #GtkStateType. If the widget state
+is not wildcarded, then the state the source applies to should be
+set with gtk_icon_source_set_state() and the icon source will
+only be used with that specific state.
-Since: 2.12
+#GtkIconSet prefers non-wildcarded sources (exact matches) over
+wildcarded sources, and will use an exact match when possible.
+
+#GtkIconSet will normally transform wildcarded source images to
+produce an appropriate icon for a given state, for example
+lightening an image on prelight, but will not modify source images
+that match exactly.
</description>
<parameters>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem
+<parameter name="source">
+<parameter_description> a #GtkIconSource
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> text to be used as tooltip for @tool_item
+<parameter name="setting">
+<parameter_description> %TRUE to wildcard the widget state
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_store_iter_depth">
+<function name="gtk_icon_theme_add_builtin_icon">
<description>
-Returns the depth of @iter. This will be 0 for anything on the root level, 1
-for anything down a level, etc.
+Registers a built-in icon for icon theme lookups. The idea
+of built-in icons is to allow an application or library
+that uses themed icons to function requiring files to
+be present in the file system. For instance, the default
+images for all of GTK+'s stock icons are registered
+as built-icons.
+In general, if you use gtk_icon_theme_add_builtin_icon()
+you should also install the icon in the icon theme, so
+that the icon is generally available.
+
+This function will generally be used with pixbufs loaded
+via gdk_pixbuf_new_from_inline().
+
+Since: 2.4
</description>
<parameters>
-<parameter name="tree_store">
-<parameter_description> A #GtkTreeStore
+<parameter name="icon_name">
+<parameter_description> the name of the icon to register
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> A valid #GtkTreeIter
+<parameter name="size">
+<parameter_description> the size at which to register the icon (different
+images can be registered for the same icon name
+at different sizes.)
+</parameter_description>
+</parameter>
+<parameter name="pixbuf">
+<parameter_description> #GdkPixbuf that contains the image to use
+for @icon_name.
</parameter_description>
</parameter>
</parameters>
-<return> The depth of @iter
-</return>
+<return></return>
</function>
-<function name="gtk_list_store_clear">
+<function name="gtk_icon_theme_append_search_path">
<description>
-Removes all rows from the list store.
+Appends a directory to the search path.
+See gtk_icon_theme_set_search_path().
+Since: 2.4
</description>
<parameters>
-<parameter name="list_store">
-<parameter_description> a #GtkListStore.
+<parameter name="icon_theme">
+<parameter_description> a #GtkIconTheme
+</parameter_description>
+</parameter>
+<parameter name="path">
+<parameter_description> directory name to append to the icon path
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_draw_expander">
+<function name="gtk_icon_theme_choose_icon">
<description>
-Draws an expander as used in #GtkTreeView.
+Looks up a named icon and returns a structure containing
+information such as the filename of the icon. The icon
+can then be rendered into a pixbuf using
+gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon()
+combines these two steps if all you need is the pixbuf.)
-Deprecated: 2.0: Use gtk_paint_expander() instead.
+If @icon_names contains more than one name, this function
+tries them all in the given order before falling back to
+inherited icon themes.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> the x position to draw the expander at
+<parameter name="icon_theme">
+<parameter_description> a #GtkIconTheme
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> the y position to draw the expander at
+<parameter name="icon_names">
+<parameter_description> %NULL-terminated array of icon names to lookup
</parameter_description>
</parameter>
-<parameter name="expander_style">
-<parameter_description> the style to draw the expander in
+<parameter name="size">
+<parameter_description> desired icon size
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_action_get_gicon">
-<description>
-Gets the gicon of @action.
-
-Since: 2.16
-
-</description>
-<parameters>
-<parameter name="action">
-<parameter_description> a #GtkAction
+<parameter name="flags">
+<parameter_description> flags modifying the behavior of the icon lookup
</parameter_description>
</parameter>
</parameters>
-<return> The action's #GIcon if one is set.
+<return> a #GtkIconInfo structure containing information
+about the icon, or %NULL if the icon wasn't found. Free with
+gtk_icon_info_free()
</return>
</function>
-<function name="gtk_menu_get_monitor">
+<function name="gtk_icon_theme_get_default">
<description>
-Retrieves the number of the monitor on which to show the menu.
+Gets the icon theme for the default screen. See
+gtk_icon_theme_get_for_screen().
-Since: 2.14
+Since: 2.4
</description>
<parameters>
-<parameter name="menu">
-<parameter_description> a #GtkMenu
-</parameter_description>
-</parameter>
</parameters>
-<return> the number of the monitor on which the menu should
-be popped up or -1, if no monitor has been set
+<return> A unique #GtkIconTheme associated with
+the default screen. This icon theme is associated with
+the screen and can be used as long as the screen
+is open. Do not ref or unref it.
</return>
</function>
-<function name="gtk_hsv_is_adjusting">
+<function name="gtk_icon_theme_get_example_icon_name">
<description>
-An HSV color selector can be said to be adjusting if multiple rapid
-changes are being made to its value, for example, when the user is
-adjusting the value with the mouse. This function queries whether
-the HSV color selector is being adjusted or not.
+Gets the name of an icon that is representative of the
+current theme (for instance, to use when presenting
+a list of themes to the user.)
-Since: 2.14
+Since: 2.4
</description>
<parameters>
-<parameter name="hsv">
-<parameter_description> A #GtkHSV
+<parameter name="icon_theme">
+<parameter_description> a #GtkIconTheme
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if clients can ignore changes to the color value,
-since they may be transitory, or %FALSE if they should consider
-the color value status to be final.
+<return> the name of an example icon or %NULL.
+Free with g_free().
</return>
</function>
-<function name="gtk_window_set_keep_above">
+<function name="gtk_icon_theme_get_for_screen">
<description>
-Asks to keep @window above, so that it stays on top. Note that
-you shouldn't assume the window is definitely above afterward,
-because other entities (e.g. the user or <link
-linkend="gtk-X11-arch">window manager</link>) could not keep it above,
-and not all window managers support keeping windows above. But
-normally the window will end kept above. Just don't write code
-that crashes if not.
-
-It's permitted to call this function before showing a window,
-in which case the window will be kept above when it appears onscreen
-initially.
-
-You can track the above state via the "window-state-event" signal
-on #GtkWidget.
-
-Note that, according to the <ulink
-url="http://www.freedesktop.org/Standards/wm-spec">Extended Window
-Manager Hints</ulink> specification, the above state is mainly meant
-for user preferences and should not be used by applications e.g. for
-drawing attention to their dialogs.
+Gets the icon theme object associated with @screen; if this
+function has not previously been called for the given
+screen, a new icon theme object will be created and
+associated with the screen. Icon theme objects are
+fairly expensive to create, so using this function
+is usually a better choice than calling than gtk_icon_theme_new()
+and setting the screen yourself; by using this function
+a single icon theme object will be shared between users.
Since: 2.4
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
-</parameter_description>
-</parameter>
-<parameter name="setting">
-<parameter_description> whether to keep @window above other windows
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
-<return></return>
-</function>
-
-<function name="gtk_label_set_text">
-<description>
-Sets the text within the #GtkLabel widget. It overwrites any text that
-was there before.
-
-This will also clear any previously set mnemonic accelerators.
+<return> A unique #GtkIconTheme associated with
+the given screen. This icon theme is associated with
+the screen and can be used as long as the screen
+is open. Do not ref or unref it.
-</description>
-<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
-</parameter_description>
-</parameter>
-<parameter name="str">
-<parameter_description> The text you want to set
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
+</return>
</function>
-<function name="gtk_icon_view_get_item_at_pos">
+<function name="gtk_icon_theme_get_icon_sizes">
<description>
-Finds the path at the point (@x, @y), relative to bin_window coordinates.
-In contrast to gtk_icon_view_get_path_at_pos(), this function also
-obtains the cell at the specified position. The returned path should
-be freed with gtk_tree_path_free().
-See gtk_icon_view_convert_widget_to_bin_window_coords() for converting
-widget coordinates to bin_window coordinates.
+Returns an array of integers describing the sizes at which
+the icon is available without scaling. A size of -1 means
+that the icon is available in a scalable format. The array
+is zero-terminated.
-Since: 2.8
+Since: 2.6
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> A #GtkIconView.
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> The x position to be identified
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> The y position to be identified
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> Return location for the path, or %NULL
+<parameter name="icon_theme">
+<parameter_description> a #GtkIconTheme
</parameter_description>
</parameter>
-<parameter name="cell">
-<parameter_description> Return location for the renderer responsible for the cell
-at (@x, @y), or %NULL
+<parameter name="icon_name">
+<parameter_description> the name of an icon
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if an item exists at the specified position
+<return> An newly allocated array describing the sizes at
+which the icon is available. The array should be freed with g_free()
+when it is no longer needed.
</return>
</function>
-<function name="gtk_list_store_prepend">
+<function name="gtk_icon_theme_get_search_path">
<description>
-Prepends a new row to @list_store. @iter will be changed to point to this new
-row. The row will be empty after this function is called. To fill in
-values, you need to call gtk_list_store_set() or gtk_list_store_set_value().
+Gets the current search path. See gtk_icon_theme_set_search_path().
+Since: 2.4
</description>
<parameters>
-<parameter name="list_store">
-<parameter_description> A #GtkListStore
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> An unset #GtkTreeIter to set to the prepend row
+<parameter name="icon_theme">
+<parameter_description> a #GtkIconTheme
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_print_settings_unset">
-<description>
-Removes any value associated with @key.
-This has the same effect as setting the value to %NULL.
-
-Since: 2.10
-
-</description>
-<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="path">
+<parameter_description> location to store a list of icon theme path directories or %NULL
+The stored value should be freed with g_strfreev().
</parameter_description>
</parameter>
-<parameter name="key">
-<parameter_description> a key
+<parameter name="n_elements">
+<parameter_description> location to store number of elements
+in @path, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_action_group_get_action">
+<function name="gtk_icon_theme_has_icon">
<description>
-Looks up an action in the action group by name.
+Checks whether an icon theme includes an icon
+for a particular name.
Since: 2.4
</description>
<parameters>
-<parameter name="action_group">
-<parameter_description> the action group
+<parameter name="icon_theme">
+<parameter_description> a #GtkIconTheme
</parameter_description>
</parameter>
-<parameter name="action_name">
-<parameter_description> the name of the action
+<parameter name="icon_name">
+<parameter_description> the name of an icon
</parameter_description>
</parameter>
</parameters>
-<return> the action, or %NULL if no action by that name exists
+<return> %TRUE if @icon_theme includes an
+icon for @icon_name.
</return>
</function>
-<function name="gtk_dialog_set_has_separator">
-<description>
-Sets whether the dialog has a separator above the buttons.
-
-Deprecated: 2.22: This function will be removed in GTK+ 3
-
-</description>
-<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkDialog
-</parameter_description>
-</parameter>
-<parameter name="setting">
-<parameter_description> %TRUE to have a separator
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_file_chooser_get_extra_widget">
+<function name="gtk_icon_theme_list_contexts">
<description>
-Gets the current preview widget; see
-gtk_file_chooser_set_extra_widget().
+Gets the list of contexts available within the current
+hierarchy of icon themes
-Since: 2.4
+Since: 2.12
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="icon_theme">
+<parameter_description> a #GtkIconTheme
</parameter_description>
</parameter>
</parameters>
-<return> the current extra widget, or %NULL
+<return> a #GList list holding the names of all the
+contexts in the theme. You must first free each element
+in the list with g_free(), then free the list itself
+with g_list_free().
</return>
</function>
-<function name="gtk_recent_info_get_icon">
+<function name="gtk_icon_theme_list_icons">
<description>
-Retrieves the icon of size @size associated to the resource MIME type.
+Lists the icons in the current icon theme. Only a subset
+of the icons can be listed by providing a context string.
+The set of values for the context string is system dependent,
+but will typically include such values as "Applications" and
+"MimeTypes".
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter name="icon_theme">
+<parameter_description> a #GtkIconTheme
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> the size of the icon in pixels
+<parameter name="context">
+<parameter_description> a string identifying a particular type of icon,
+or %NULL to list all icons.
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkPixbuf containing the icon, or %NULL. Use
-g_object_unref() when finished using the icon.
+<return> a #GList list holding the names of all the
+icons in the theme. You must first free each element
+in the list with g_free(), then free the list itself
+with g_list_free().
</return>
</function>
-<function name="gtk_text_view_set_overwrite">
+<function name="gtk_icon_theme_load_icon">
<description>
-Changes the #GtkTextView overwrite mode.
+Looks up an icon in an icon theme, scales it to the given size
+and renders it into a pixbuf. This is a convenience function;
+if more details about the icon are needed, use
+gtk_icon_theme_lookup_icon() followed by gtk_icon_info_load_icon().
+
+Note that you probably want to listen for icon theme changes and
+update the icon. This is usually done by connecting to the
+GtkWidget::style-set signal. If for some reason you do not want to
+update the icon when the icon theme changes, you should consider
+using gdk_pixbuf_copy() to make a private copy of the pixbuf
+returned by this function. Otherwise GTK+ may need to keep the old
+icon theme loaded, which would be a waste of memory.
Since: 2.4
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="icon_theme">
+<parameter_description> a #GtkIconTheme
</parameter_description>
</parameter>
-<parameter name="overwrite">
-<parameter_description> %TRUE to turn on overwrite mode, %FALSE to turn it off
+<parameter name="icon_name">
+<parameter_description> the name of the icon to lookup
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_entry_set_icon_from_pixbuf">
-<description>
-Sets the icon shown in the specified position using a pixbuf.
-
-If @pixbuf is %NULL, no icon will be shown in the specified position.
-
-Since: 2.16
-
-</description>
-<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="size">
+<parameter_description> the desired icon size. The resulting icon may not be
+exactly this size; see gtk_icon_info_load_icon().
</parameter_description>
</parameter>
-<parameter name="icon_pos">
-<parameter_description> Icon position
+<parameter name="flags">
+<parameter_description> flags modifying the behavior of the icon lookup
</parameter_description>
</parameter>
-<parameter name="pixbuf">
-<parameter_description> A #GdkPixbuf, or %NULL
+<parameter name="error">
+<parameter_description> Location to store error information on failure, or %NULL.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the rendered icon; this may be a newly
+created icon or a new reference to an internal icon, so you must not modify
+the icon. Use g_object_unref() to release your reference to the
+icon. %NULL if the icon isn't found.
+
+</return>
</function>
-<function name="gtk_menu_tool_button_set_arrow_tooltip">
+<function name="gtk_icon_theme_lookup_by_gicon">
<description>
-Sets the #GtkTooltips object to be used for arrow button which
-pops up the menu. See gtk_tool_item_set_tooltip() for setting
-a tooltip on the whole #GtkMenuToolButton.
-
-Since: 2.6
+Looks up an icon and returns a structure containing
+information such as the filename of the icon.
+The icon can then be rendered into a pixbuf using
+gtk_icon_info_load_icon().
-Deprecated: 2.12: Use gtk_menu_tool_button_set_arrow_tooltip_text()
-instead.
+Since: 2.14
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkMenuToolButton
+<parameter name="icon_theme">
+<parameter_description> a #GtkIconTheme
</parameter_description>
</parameter>
-<parameter name="tooltips">
-<parameter_description> the #GtkTooltips object to be used
+<parameter name="icon">
+<parameter_description> the #GIcon to look up
</parameter_description>
</parameter>
-<parameter name="tip_text">
-<parameter_description> text to be used as tooltip text for tool_item
+<parameter name="size">
+<parameter_description> desired icon size
</parameter_description>
</parameter>
-<parameter name="tip_private">
-<parameter_description> text to be used as private tooltip text
+<parameter name="flags">
+<parameter_description> flags modifying the behavior of the icon lookup
</parameter_description>
</parameter>
</parameters>
-<return></return>
-</function>
-
-<function name="gtk_scale_get_value_pos">
-<description>
-Gets the position in which the current value is displayed.
-
+<return> a #GtkIconInfo structure containing
+information about the icon, or %NULL if the icon
+wasn't found. Free with gtk_icon_info_free()
-</description>
-<parameters>
-<parameter name="scale">
-<parameter_description> a #GtkScale
-</parameter_description>
-</parameter>
-</parameters>
-<return> the position in which the current value is displayed
</return>
</function>
-<function name="gtk_font_button_set_font_name">
+<function name="gtk_icon_theme_lookup_icon">
<description>
-Sets or updates the currently-displayed font in font picker dialog.
+Looks up a named icon and returns a structure containing
+information such as the filename of the icon. The icon
+can then be rendered into a pixbuf using
+gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon()
+combines these two steps if all you need is the pixbuf.)
Since: 2.4
</description>
<parameters>
-<parameter name="font_button">
-<parameter_description> a #GtkFontButton
+<parameter name="icon_theme">
+<parameter_description> a #GtkIconTheme
</parameter_description>
</parameter>
-<parameter name="fontname">
-<parameter_description> Name of font to display in font selection dialog
+<parameter name="icon_name">
+<parameter_description> the name of the icon to lookup
+</parameter_description>
+</parameter>
+<parameter name="size">
+<parameter_description> desired icon size
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags modifying the behavior of the icon lookup
</parameter_description>
</parameter>
</parameters>
-<return> Return value of gtk_font_selection_dialog_set_font_name() if the
-font selection dialog exists, otherwise %FALSE.
+<return> a #GtkIconInfo structure containing information
+about the icon, or %NULL if the icon wasn't found. Free with
+gtk_icon_info_free()
</return>
</function>
-<function name="gtk_widget_push_composite_child">
-<description>
-Makes all newly-created widgets as composite children until
-the corresponding gtk_widget_pop_composite_child() call.
-
-A composite child is a child that's an implementation detail of the
-container it's inside and should not be visible to people using the
-container. Composite children aren't treated differently by GTK (but
-see gtk_container_foreach() vs. gtk_container_forall()), but e.g. GUI
-builders might want to treat them in a different way.
-
-Here is a simple example:
-|[
-gtk_widget_push_composite_child ();
-scrolled_window->hscrollbar = gtk_hscrollbar_new (hadjustment);
-gtk_widget_set_composite_name (scrolled_window->hscrollbar, "hscrollbar");
-gtk_widget_pop_composite_child ();
-gtk_widget_set_parent (scrolled_window->hscrollbar,
-GTK_WIDGET (scrolled_window));
-g_object_ref (scrolled_window->hscrollbar);
-]|
-
-</description>
-<parameters>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_font_button_get_font_name">
+<function name="gtk_icon_theme_new">
<description>
-Retrieves the name of the currently selected font. This name includes
-style and size information as well. If you want to render something
-with the font, use this string with pango_font_description_from_string() .
-If you're interested in peeking certain values (family name,
-style, size, weight) just query these properties from the
-#PangoFontDescription object.
+Creates a new icon theme object. Icon theme objects are used
+to lookup up an icon by name in a particular icon theme.
+Usually, you'll want to use gtk_icon_theme_get_default()
+or gtk_icon_theme_get_for_screen() rather than creating
+a new icon theme object for scratch.
Since: 2.4
</description>
<parameters>
-<parameter name="font_button">
-<parameter_description> a #GtkFontButton
-</parameter_description>
-</parameter>
</parameters>
-<return> an internal copy of the font name which must not be freed.
+<return> the newly created #GtkIconTheme object.
</return>
</function>
-<function name="gtk_tree_store_remove">
+<function name="gtk_icon_theme_prepend_search_path">
<description>
-Removes @iter from @tree_store. After being removed, @iter is set to the
-next valid row at that level, or invalidated if it previously pointed to the
-last one.
+Prepends a directory to the search path.
+See gtk_icon_theme_set_search_path().
+Since: 2.4
</description>
<parameters>
-<parameter name="tree_store">
-<parameter_description> A #GtkTreeStore
+<parameter name="icon_theme">
+<parameter_description> a #GtkIconTheme
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> A valid #GtkTreeIter
+<parameter name="path">
+<parameter_description> directory name to prepend to the icon path
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter is still valid, %FALSE if not.
-</return>
+<return></return>
</function>
-<function name="gtk_label_get_use_markup">
+<function name="gtk_icon_theme_rescan_if_needed">
<description>
-Returns whether the label's text is interpreted as marked up with
-the <link linkend="PangoMarkupFormat">Pango text markup
-language</link>. See gtk_label_set_use_markup ().
+Checks to see if the icon theme has changed; if it has, any
+currently cached information is discarded and will be reloaded
+next time @icon_theme is accessed.
+Since: 2.4
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="icon_theme">
+<parameter_description> a #GtkIconTheme
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the label's text will be parsed for markup.
+<return> %TRUE if the icon theme has changed and needed
+to be reloaded.
+
</return>
</function>
-<function name="gtk_text_iter_get_visible_text">
+<function name="gtk_icon_theme_set_custom_theme">
<description>
-Like gtk_text_iter_get_text (), but invisible text is not included.
-Invisible text is usually invisible because a #GtkTextTag with the
-"invisible" attribute turned on has been applied to it.
+Sets the name of the icon theme that the #GtkIconTheme object uses
+overriding system configuration. This function cannot be called
+on the icon theme objects returned from gtk_icon_theme_get_default()
+and gtk_icon_theme_get_for_screen().
+Since: 2.4
</description>
<parameters>
-<parameter name="start">
-<parameter_description> iterator at start of range
+<parameter name="icon_theme">
+<parameter_description> a #GtkIconTheme
</parameter_description>
</parameter>
-<parameter name="end">
-<parameter_description> iterator at end of range
+<parameter name="theme_name">
+<parameter_description> name of icon theme to use instead of configured theme,
+or %NULL to unset a previously set custom theme
</parameter_description>
</parameter>
</parameters>
-<return> string containing visible text in the range
-</return>
+<return></return>
</function>
-<function name="gtk_frame_set_shadow_type">
+<function name="gtk_icon_theme_set_screen">
<description>
-Sets the shadow type for @frame.
+Sets the screen for an icon theme; the screen is used
+to track the user's currently configured icon theme,
+which might be different for different screens.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="frame">
-<parameter_description> a #GtkFrame
+<parameter name="icon_theme">
+<parameter_description> a #GtkIconTheme
</parameter_description>
</parameter>
-<parameter name="type">
-<parameter_description> the new #GtkShadowType
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_container_propagate_expose">
+<function name="gtk_icon_theme_set_search_path">
<description>
-When a container receives an expose event, it must send synthetic
-expose events to all children that don't have their own #GdkWindows.
-This function provides a convenient way of doing this. A container,
-when it receives an expose event, calls gtk_container_propagate_expose()
-once for each child, passing in the event the container received.
+Sets the search path for the icon theme object. When looking
+for an icon theme, GTK+ will search for a subdirectory of
+one or more of the directories in @path with the same name
+as the icon theme. (Themes from multiple of the path elements
+are combined to allow themes to be extended by adding icons
+in the user's home directory.)
-gtk_container_propagate_expose() takes care of deciding whether
-an expose event needs to be sent to the child, intersecting
-the event's area with the child area, and sending the event.
+In addition if an icon found isn't found either in the current
+icon theme or the default icon theme, and an image file with
+the right name is found directly in one of the elements of
+ path, then that image will be used for the icon name.
+(This is legacy feature, and new icons should be put
+into the default icon theme, which is called DEFAULT_THEME_NAME,
+rather than directly on the icon path.)
-In most cases, a container can simply either simply inherit the
-#GtkWidget::expose implementation from #GtkContainer, or, do some drawing
-and then chain to the ::expose implementation from #GtkContainer.
+Since: 2.4
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
+<parameter name="icon_theme">
+<parameter_description> a #GtkIconTheme
</parameter_description>
</parameter>
-<parameter name="child">
-<parameter_description> a child of @container
+<parameter name="path">
+<parameter_description> array of directories that are searched for icon themes
</parameter_description>
</parameter>
-<parameter name="event">
-<parameter_description> a expose event sent to container
+<parameter name="n_elements">
+<parameter_description> number of elements in @path.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_layout_freeze">
+<function name="gtk_icon_view_convert_widget_to_bin_window_coords">
<description>
-This is a deprecated function, it doesn't do anything useful.
+Converts widget coordinates to coordinates for the bin_window,
+as expected by e.g. gtk_icon_view_get_path_at_pos().
+
+Since: 2.12
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #GtkLayout
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
+</parameter_description>
+</parameter>
+<parameter name="wx">
+<parameter_description> X coordinate relative to the widget
+</parameter_description>
+</parameter>
+<parameter name="wy">
+<parameter_description> Y coordinate relative to the widget
+</parameter_description>
+</parameter>
+<parameter name="bx">
+<parameter_description> return location for bin_window X coordinate
+</parameter_description>
+</parameter>
+<parameter name="by">
+<parameter_description> return location for bin_window Y coordinate
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_view_get_item_row">
+<function name="gtk_icon_view_create_drag_icon">
<description>
-Gets the row in which the item @path is currently
-displayed. Row numbers start at 0.
+Creates a #GdkPixmap representation of the item at @path.
+This image is used for a drag icon.
-Since: 2.22
+Since: 2.8
</description>
<parameters>
@@ -22047,4222 +22159,4278 @@ Since: 2.22
</parameter_description>
</parameter>
<parameter name="path">
-<parameter_description> the #GtkTreePath of the item
+<parameter_description> a #GtkTreePath in @icon_view
</parameter_description>
</parameter>
</parameters>
-<return> The row in which the item is displayed
+<return> a newly-allocated pixmap of the drag icon.
</return>
</function>
-<function name="gtk_toggle_action_set_active">
+<function name="gtk_icon_view_enable_model_drag_dest">
<description>
-Sets the checked state on the toggle action.
+Turns @icon_view into a drop destination for automatic DND. Calling this
+method sets #GtkIconView:reorderable to %FALSE.
-Since: 2.4
+Since: 2.8
</description>
<parameters>
-<parameter name="action">
-<parameter_description> the action object
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
</parameter_description>
</parameter>
-<parameter name="is_active">
-<parameter_description> whether the action should be checked or not
+<parameter name="targets">
+<parameter_description> the table of targets that the drag will support
+</parameter_description>
+</parameter>
+<parameter name="n_targets">
+<parameter_description> the number of items in @targets
+</parameter_description>
+</parameter>
+<parameter name="actions">
+<parameter_description> the bitmask of possible actions for a drag to this
+widget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_set_wmclass">
+<function name="gtk_icon_view_enable_model_drag_source">
<description>
-Don't use this function. It sets the X Window System "class" and
-"name" hints for a window. According to the ICCCM, you should
-always set these to the same value for all windows in an
-application, and GTK+ sets them to that value by default, so calling
-this function is sort of pointless. However, you may want to call
-gtk_window_set_role() on each window in your application, for the
-benefit of the session manager. Setting the role allows the window
-manager to restore window positions when loading a saved session.
+Turns @icon_view into a drag source for automatic DND. Calling this
+method sets #GtkIconView:reorderable to %FALSE.
+Since: 2.8
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="icon_view">
+<parameter_description> a #GtkIconTreeView
</parameter_description>
</parameter>
-<parameter name="wmclass_name">
-<parameter_description> window name hint
+<parameter name="start_button_mask">
+<parameter_description> Mask of allowed buttons to start drag
</parameter_description>
</parameter>
-<parameter name="wmclass_class">
-<parameter_description> window class hint
+<parameter name="targets">
+<parameter_description> the table of targets that the drag will support
+</parameter_description>
+</parameter>
+<parameter name="n_targets">
+<parameter_description> the number of items in @targets
+</parameter_description>
+</parameter>
+<parameter name="actions">
+<parameter_description> the bitmask of possible actions for a drag from this
+widget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_file_chooser_get_filename">
+<function name="gtk_icon_view_get_column_spacing">
<description>
-Gets the filename for the currently selected file in
-the file selector. If multiple files are selected,
-one of the filenames will be returned at random.
-
-If the file chooser is in folder mode, this function returns the selected
-folder.
+Returns the value of the ::column-spacing property.
-Since: 2.4
+Since: 2.6
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
</parameter_description>
</parameter>
</parameters>
-<return> The currently selected filename, or %NULL
-if no file is selected, or the selected file can't
-be represented with a local filename. Free with g_free().
+<return> the space between columns
</return>
</function>
-<function name="gtk_widget_hide_on_delete">
+<function name="gtk_icon_view_get_columns">
<description>
-Utility function; intended to be connected to the #GtkWidget::delete-event
-signal on a #GtkWindow. The function calls gtk_widget_hide() on its
-argument, then returns %TRUE. If connected to ::delete-event, the
-result is that clicking the close button for a window (on the
-window frame, top right corner usually) will hide but not destroy
-the window. By default, GTK+ destroys windows when ::delete-event
-is received.
+Returns the value of the ::columns property.
+Since: 2.6
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE
+<return> the number of columns, or -1
+
</return>
</function>
-<function name="gtk_tree_view_set_tooltip_cell">
+<function name="gtk_icon_view_get_cursor">
<description>
-Sets the tip area of @tooltip to the area @path, @column and @cell have
-in common. For example if @path is %NULL and @column is set, the tip
-area will be set to the full area covered by @column. See also
-gtk_tooltip_set_tip_area().
-
-Note that if @path is not specified and @cell is set and part of a column
-containing the expander, the tooltip might not show and hide at the correct
-position. In such cases @path must be set to the current node under the
-mouse cursor for this function to operate correctly.
+Fills in @path and @cell with the current cursor path and cell.
+If the cursor isn't currently set, then * path will be %NULL.
+If no cell currently has focus, then * cell will be %NULL.
-See also gtk_tree_view_set_tooltip_column() for a simpler alternative.
+The returned #GtkTreePath must be freed with gtk_tree_path_free().
-Since: 2.12
+Since: 2.8
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
-</parameter_description>
-</parameter>
-<parameter name="tooltip">
-<parameter_description> a #GtkTooltip
+<parameter name="icon_view">
+<parameter_description> A #GtkIconView
</parameter_description>
</parameter>
<parameter name="path">
-<parameter_description> a #GtkTreePath or %NULL
-</parameter_description>
-</parameter>
-<parameter name="column">
-<parameter_description> a #GtkTreeViewColumn or %NULL
+<parameter_description> Return location for the current cursor path, or %NULL
</parameter_description>
</parameter>
<parameter name="cell">
-<parameter_description> a #GtkCellRenderer or %NULL
+<parameter_description> Return location the current focus cell, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the cursor is set.
+
+</return>
</function>
-<function name="gtk_tree_view_convert_widget_to_tree_coords">
+<function name="gtk_icon_view_get_dest_item_at_pos">
<description>
-Converts widget coordinates to coordinates for the
-tree (the full scrollable area of the tree).
+Determines the destination item for a given position.
-Since: 2.12
+Since: 2.8
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
</parameter_description>
</parameter>
-<parameter name="wx">
-<parameter_description> X coordinate relative to the widget
+<parameter name="drag_x">
+<parameter_description> the position to determine the destination item for
</parameter_description>
</parameter>
-<parameter name="wy">
-<parameter_description> Y coordinate relative to the widget
+<parameter name="drag_y">
+<parameter_description> the position to determine the destination item for
</parameter_description>
</parameter>
-<parameter name="tx">
-<parameter_description> return location for tree X coordinate
+<parameter name="path">
+<parameter_description> Return location for the path of the item, or %NULL.
</parameter_description>
</parameter>
-<parameter name="ty">
-<parameter_description> return location for tree Y coordinate
+<parameter name="pos">
+<parameter_description> Return location for the drop position, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether there is an item at the given position.
+
+</return>
</function>
-<function name="gtk_widget_remove_accelerator">
+<function name="gtk_icon_view_get_drag_dest_item">
<description>
-Removes an accelerator from @widget, previously installed with
-gtk_widget_add_accelerator().
+Gets information about the item that is highlighted for feedback.
+
+Since: 2.8
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> widget to install an accelerator on
-</parameter_description>
-</parameter>
-<parameter name="accel_group">
-<parameter_description> accel group for this widget
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
</parameter_description>
</parameter>
-<parameter name="accel_key">
-<parameter_description> GDK keyval of the accelerator
+<parameter name="path">
+<parameter_description> Return location for the path of the highlighted item, or %NULL.
</parameter_description>
</parameter>
-<parameter name="accel_mods">
-<parameter_description> modifier key combination of the accelerator
+<parameter name="pos">
+<parameter_description> Return location for the drop position, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> whether an accelerator was installed and could be removed
-</return>
+<return></return>
</function>
-<function name="gtk_scrolled_window_get_vadjustment">
+<function name="gtk_icon_view_get_item_at_pos">
<description>
-Returns the vertical scrollbar's adjustment, used to connect the
-vertical scrollbar to the child widget's vertical scroll
-functionality.
+Finds the path at the point (@x, @y), relative to bin_window coordinates.
+In contrast to gtk_icon_view_get_path_at_pos(), this function also
+obtains the cell at the specified position. The returned path should
+be freed with gtk_tree_path_free().
+See gtk_icon_view_convert_widget_to_bin_window_coords() for converting
+widget coordinates to bin_window coordinates.
+Since: 2.8
</description>
<parameters>
-<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter name="icon_view">
+<parameter_description> A #GtkIconView.
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> The x position to be identified
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> The y position to be identified
+</parameter_description>
+</parameter>
+<parameter name="path">
+<parameter_description> Return location for the path, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="cell">
+<parameter_description> Return location for the renderer responsible for the cell
+at (@x, @y), or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the vertical #GtkAdjustment
+<return> %TRUE if an item exists at the specified position
+
</return>
</function>
-<function name="gtk_tree_view_column_set_visible">
+<function name="gtk_icon_view_get_item_column">
<description>
-Sets the visibility of @tree_column.
+Gets the column in which the item @path is currently
+displayed. Column numbers start at 0.
+
+Since: 2.22
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn.
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
</parameter_description>
</parameter>
-<parameter name="visible">
-<parameter_description> %TRUE if the @tree_column is visible.
+<parameter name="path">
+<parameter_description> the #GtkTreePath of the item
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The column in which the item is displayed
+
+</return>
</function>
-<function name="gtk_test_widget_send_key">
+<function name="gtk_icon_view_get_item_orientation">
<description>
-This function will generate keyboard press and release events in
-the middle of the first GdkWindow found that belongs to @widget.
-For %GTK_NO_WINDOW widgets like GtkButton, this will often be an
-input-only event window. For other widgets, this is usually widget->window.
-Certain caveats should be considered when using this function, in
-particular because the mouse pointer is warped to the key press
-location, see gdk_test_simulate_key() for details.
+Returns the value of the ::item-orientation property which determines
+whether the labels are drawn beside the icons instead of below.
-Since: 2.14
+Since: 2.22
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> Widget to generate a key press and release on.
-</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 name="icon_view">
+<parameter_description> a #GtkIconView
</parameter_description>
</parameter>
</parameters>
-<return> wether all actions neccessary for the key event simulation were carried out successfully.
+<return> the relative position of texts and icons
</return>
</function>
-<function name="gtk_print_settings_get_bool_with_default">
+<function name="gtk_icon_view_get_item_padding">
<description>
-Returns the boolean represented by the value
-that is associated with @key, or @default_val
-if the value does not represent a boolean.
-
-The string "true" represents %TRUE, the string
-"false" represents %FALSE.
+Returns the value of the ::item-padding property.
-Since: 2.10
+Since: 2.18
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
-</parameter_description>
-</parameter>
-<parameter name="default_val">
-<parameter_description> the default value
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
</parameter_description>
</parameter>
</parameters>
-<return> the boolean value associated with @key
+<return> the padding around items
</return>
</function>
-<function name="gtk_tree_view_collapse_row">
+<function name="gtk_icon_view_get_item_row">
<description>
-Collapses a row (hides its child rows, if they exist).
+Gets the row in which the item @path is currently
+displayed. Row numbers start at 0.
+Since: 2.22
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
</parameter_description>
</parameter>
<parameter name="path">
-<parameter_description> path to a row in the @tree_view
+<parameter_description> the #GtkTreePath of the item
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the row was collapsed.
+<return> The row in which the item is displayed
+
</return>
</function>
-<function name="gtk_tree_store_reorder">
+<function name="gtk_icon_view_get_item_width">
<description>
-Reorders the children of @parent in @tree_store to follow the order
-indicated by @new_order. Note that this function only works with
-unsorted stores.
+Returns the value of the ::item-width property.
-Since: 2.2
+Since: 2.6
</description>
<parameters>
-<parameter name="tree_store">
-<parameter_description> A #GtkTreeStore.
-</parameter_description>
-</parameter>
-<parameter name="parent">
-<parameter_description> A #GtkTreeIter.
-</parameter_description>
-</parameter>
-<parameter name="new_order">
-<parameter_description> an array of integers mapping the new position of each child
-to its old position before the re-ordering,
-i.e. @new_order<literal>[newpos] = oldpos</literal>.
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the width of a single item, or -1
+
+</return>
</function>
-<function name="gtk_about_dialog_set_name">
+<function name="gtk_icon_view_get_margin">
<description>
-Sets the name to display in the about dialog.
-If this is not set, it defaults to g_get_application_name().
+Returns the value of the ::margin property.
Since: 2.6
-Deprecated: 2.12: Use gtk_about_dialog_set_program_name() instead.
-
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
-</parameter_description>
-</parameter>
-<parameter name="name">
-<parameter_description> the program name
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the space at the borders
+
+</return>
</function>
-<function name="gtk_handle_box_get_child_detached">
+<function name="gtk_icon_view_get_markup_column">
<description>
-Whether the handlebox's child is currently detached.
+Returns the column with markup text for @icon_view.
-Since: 2.14
+Since: 2.6
</description>
<parameters>
-<parameter name="handle_box">
-<parameter_description> a #GtkHandleBox
+<parameter name="icon_view">
+<parameter_description> A #GtkIconView.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the child is currently detached, otherwise %FALSE
+<return> the markup column, or -1 if it's unset.
</return>
</function>
-<function name="gtk_print_unix_dialog_set_current_page">
+<function name="gtk_icon_view_get_model">
<description>
-Sets the current page number. If @current_page is not -1, this enables
-the current page choice for the range of pages to print.
+Returns the model the #GtkIconView is based on. Returns %NULL if the
+model is unset.
-Since: 2.10
+Since: 2.6
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
-</parameter_description>
-</parameter>
-<parameter name="current_page">
-<parameter_description> the current page number.
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A #GtkTreeModel, or %NULL if none is
+currently being used.
+
+</return>
</function>
-<function name="gtk_message_dialog_set_image">
+<function name="gtk_icon_view_get_orientation">
<description>
-Sets the dialog's image to @image.
+Returns the value of the ::orientation property which determines
+whether the labels are drawn beside the icons instead of below.
-Since: 2.10
+Since: 2.6
+
+Deprecated: 2.22: Use gtk_icon_view_get_item_orientation()
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkMessageDialog
-</parameter_description>
-</parameter>
-<parameter name="image">
-<parameter_description> the image
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the relative position of texts and icons
+
+</return>
</function>
-<function name="gtk_viewport_set_shadow_type">
+<function name="gtk_icon_view_get_path_at_pos">
<description>
-Sets the shadow type of the viewport.
+Finds the path at the point (@x, @y), relative to bin_window coordinates.
+See gtk_icon_view_get_item_at_pos(), if you are also interested in
+the cell at the specified position.
+See gtk_icon_view_convert_widget_to_bin_window_coords() for converting
+widget coordinates to bin_window coordinates.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="viewport">
-<parameter_description> a #GtkViewport.
+<parameter name="icon_view">
+<parameter_description> A #GtkIconView.
</parameter_description>
</parameter>
-<parameter name="type">
-<parameter_description> the new shadow type.
+<parameter name="x">
+<parameter_description> The x position to be identified
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> The y position to be identified
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The #GtkTreePath corresponding to the icon or %NULL
+if no icon exists at that position.
+
+</return>
</function>
-<function name="gtk_entry_append_text">
+<function name="gtk_icon_view_get_pixbuf_column">
<description>
-Appends the given text to the contents of the widget.
+Returns the column with pixbufs for @icon_view.
-Deprecated: 2.0: Use gtk_editable_insert_text() instead.
+Since: 2.6
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="icon_view">
+<parameter_description> A #GtkIconView.
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> the text to append
+</parameters>
+<return> the pixbuf column, or -1 if it's unset.
+
+</return>
+</function>
+
+<function name="gtk_icon_view_get_reorderable">
+<description>
+Retrieves whether the user can reorder the list via drag-and-drop.
+See gtk_icon_view_set_reorderable().
+
+Since: 2.8
+
+</description>
+<parameters>
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the list can be reordered.
+
+</return>
</function>
-<function name="gtk_tree_view_get_row_separator_func">
+<function name="gtk_icon_view_get_row_spacing">
<description>
-Returns the current row separator function.
+Returns the value of the ::row-spacing property.
Since: 2.6
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
</parameter_description>
</parameter>
</parameters>
-<return> the current row separator function.
+<return> the space between rows
</return>
</function>
-<function name="gtk_text_buffer_insert_range">
+<function name="gtk_icon_view_get_selected_items">
<description>
-Copies text, tags, and pixbufs between @start and @end (the order
-of @start and @end doesn't matter) and inserts the copy at @iter.
-Used instead of simply getting/inserting text because it preserves
-images and tags. If @start and @end are in a different buffer from
- buffer, the two buffers must share the same tag table.
+Creates a list of paths of all selected items. Additionally, if you are
+planning on modifying the model after calling this function, you may
+want to convert the returned list into a list of #GtkTreeRowReference<!-- -->s.
+To do this, you can use gtk_tree_row_reference_new().
-Implemented via emissions of the insert_text and apply_tag signals,
-so expect those.
+To free the return value, use:
+|[
+g_list_foreach (list, (GFunc)gtk_tree_path_free, NULL);
+g_list_free (list);
+]|
+
+Since: 2.6
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> a position in @buffer
-</parameter_description>
-</parameter>
-<parameter name="start">
-<parameter_description> a position in a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="end">
-<parameter_description> another position in the same buffer as @start
+<parameter name="icon_view">
+<parameter_description> A #GtkIconView.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A #GList containing a #GtkTreePath for each selected row.
+
+</return>
</function>
-<function name="gtk_cell_renderer_get_padding">
+<function name="gtk_icon_view_get_selection_mode">
<description>
-Fills in @xpad and @ypad with the appropriate values of @cell.
+Gets the selection mode of the @icon_view.
-Since: 2.18
+Since: 2.6
</description>
<parameters>
-<parameter name="cell">
-<parameter_description> A #GtkCellRenderer
-</parameter_description>
-</parameter>
-<parameter name="xpad">
-<parameter_description> location to fill in with the x padding of the cell, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="ypad">
-<parameter_description> location to fill in with the y padding of the cell, or %NULL
+<parameter name="icon_view">
+<parameter_description> A #GtkIconView.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the current selection mode
+
+</return>
</function>
-<function name="gtk_about_dialog_set_email_hook">
+<function name="gtk_icon_view_get_spacing">
<description>
-Installs a global function to be called whenever the user activates an
-email link in an about dialog.
-
-Since 2.18 there exists a default function which uses gtk_show_uri(). To
-deactivate it, you can pass %NULL for @func.
+Returns the value of the ::spacing property.
Since: 2.6
</description>
<parameters>
-<parameter name="func">
-<parameter_description> a function to call when an email link is activated.
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> data to pass to @func
-</parameter_description>
-</parameter>
-<parameter name="destroy">
-<parameter_description> #GDestroyNotify for @data
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
</parameter_description>
</parameter>
</parameters>
-<return> the previous email hook.
+<return> the space between cells
</return>
</function>
-<function name="gtk_paint_check">
+<function name="gtk_icon_view_get_text_column">
<description>
-Draws a check button indicator in the given rectangle on @window with
-the given parameters.
+Returns the column with text for @icon_view.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
+<parameter name="icon_view">
+<parameter_description> A #GtkIconView.
</parameter_description>
</parameter>
-<parameter name="shadow_type">
-<parameter_description> the type of shadow to draw
+</parameters>
+<return> the text column, or -1 if it's unset.
+
+</return>
+</function>
+
+<function name="gtk_icon_view_get_tooltip_column">
+<description>
+Returns the column of @icon_view's model which is being used for
+displaying tooltips on @icon_view's rows.
+
+Since: 2.12
+
+</description>
+<parameters>
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
</parameter_description>
</parameter>
-<parameter name="area">
-<parameter_description> clip rectangle, or %NULL if the
-output should not be clipped
+</parameters>
+<return> the index of the tooltip column that is currently being
+used, or -1 if this is disabled.
+
+</return>
+</function>
+
+<function name="gtk_icon_view_get_tooltip_context">
+<description>
+This function is supposed to be used in a #GtkWidget::query-tooltip
+signal handler for #GtkIconView. The @x, @y and @keyboard_tip values
+which are received in the signal handler, should be passed to this
+function without modification.
+
+The return value indicates whether there is an icon view item at the given
+coordinates (%TRUE) or not (%FALSE) for mouse tooltips. For keyboard
+tooltips the item returned will be the cursor item. When %TRUE, then any of
+ model, @path and @iter which have been provided will be set to point to
+that row and the corresponding model. @x and @y will always be converted
+to be relative to @icon_view's bin_window if @keyboard_tooltip is %FALSE.
+
+Since: 2.12
+
+</description>
+<parameters>
+<parameter name="icon_view">
+<parameter_description> an #GtkIconView
</parameter_description>
</parameter>
-<parameter name="widget">
-<parameter_description> the widget
+<parameter name="x">
+<parameter_description> the x coordinate (relative to widget coordinates)
</parameter_description>
</parameter>
-<parameter name="detail">
-<parameter_description> a style detail
+<parameter name="y">
+<parameter_description> the y coordinate (relative to widget coordinates)
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> x origin of the rectangle to draw the check in
+<parameter name="keyboard_tip">
+<parameter_description> whether this is a keyboard tooltip or not
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> y origin of the rectangle to draw the check in
+<parameter name="model">
+<parameter_description> a pointer to receive a #GtkTreeModel or %NULL
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> the width of the rectangle to draw the check in
+<parameter name="path">
+<parameter_description> a pointer to receive a #GtkTreePath or %NULL
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> the height of the rectangle to draw the check in
+<parameter name="iter">
+<parameter_description> a pointer to receive a #GtkTreeIter or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether or not the given tooltip context points to a item
+
+</return>
</function>
-<function name="gtk_recent_chooser_get_uris">
+<function name="gtk_icon_view_get_visible_range">
<description>
-Gets the URI of the recently used resources.
-
-The return value of this function is affected by the "sort-type" and "limit"
-properties of @chooser.
+Sets @start_path and @end_path to be the first and last visible path.
+Note that there may be invisible paths in between.
-Since the returned array is %NULL terminated, @length may be %NULL.
+Both paths should be freed with gtk_tree_path_free() after use.
-Since: 2.10
+Since: 2.8
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
+<parameter name="icon_view">
+<parameter_description> A #GtkIconView
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> return location for a the length of the URI list, or %NULL
+<parameter name="start_path">
+<parameter_description> Return location for start of region, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="end_path">
+<parameter_description> Return location for end of region, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> A newly allocated, %NULL terminated array of strings. Use
-g_strfreev() to free it.
+<return> %TRUE, if valid paths were placed in @start_path and @end_path
</return>
</function>
-<function name="gtk_accel_label_set_accel_closure">
+<function name="gtk_icon_view_item_activated">
<description>
-Sets the closure to be monitored by this accelerator label. The closure
-must be connected to an accelerator group; see gtk_accel_group_connect().
+Activates the item determined by @path.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="accel_label">
-<parameter_description> a #GtkAccelLabel
+<parameter name="icon_view">
+<parameter_description> A #GtkIconView
</parameter_description>
</parameter>
-<parameter name="accel_closure">
-<parameter_description> the closure to monitor for accelerator changes.
+<parameter name="path">
+<parameter_description> The #GtkTreePath to be activated
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_tag_get_priority">
+<function name="gtk_icon_view_new">
<description>
-Get the tag priority.
+Creates a new #GtkIconView widget
+Since: 2.6
</description>
<parameters>
-<parameter name="tag">
-<parameter_description> a #GtkTextTag
-</parameter_description>
-</parameter>
</parameters>
-<return> The tag's priority.
+<return> A newly created #GtkIconView widget
+
</return>
</function>
-<function name="gtk_icon_theme_rescan_if_needed">
+<function name="gtk_icon_view_new_with_model">
<description>
-Checks to see if the icon theme has changed; if it has, any
-currently cached information is discarded and will be reloaded
-next time @icon_theme is accessed.
+Creates a new #GtkIconView widget with the model @model.
-Since: 2.4
+Since: 2.6
</description>
<parameters>
-<parameter name="icon_theme">
-<parameter_description> a #GtkIconTheme
+<parameter name="model">
+<parameter_description> The model.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the icon theme has changed and needed
-to be reloaded.
+<return> A newly created #GtkIconView widget.
</return>
</function>
-<function name="gtk_about_dialog_get_logo_icon_name">
+<function name="gtk_icon_view_path_is_selected">
<description>
-Returns the icon name displayed as logo in the about dialog.
+Returns %TRUE if the icon pointed to by @path is currently
+selected. If @path does not point to a valid location, %FALSE is returned.
Since: 2.6
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter name="icon_view">
+<parameter_description> A #GtkIconView.
+</parameter_description>
+</parameter>
+<parameter name="path">
+<parameter_description> A #GtkTreePath to check selection on.
</parameter_description>
</parameter>
</parameters>
-<return> the icon name displayed as logo. The string is
-owned by the dialog. If you want to keep a reference
-to it, you have to call g_strdup() on it.
+<return> %TRUE if @path is selected.
</return>
</function>
-<function name="gtk_text_view_get_buffer">
+<function name="gtk_icon_view_scroll_to_path">
<description>
-Returns the #GtkTextBuffer being displayed by this text view.
-The reference count on the buffer is not incremented; the caller
-of this function won't own a new reference.
-
+Moves the alignments of @icon_view to the position specified by @path.
+ row_align determines where the row is placed, and @col_align determines
+where @column is placed. Both are expected to be between 0.0 and 1.0.
+0.0 means left/top alignment, 1.0 means right/bottom alignment, 0.5 means
+center.
-</description>
-<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
-</parameter_description>
-</parameter>
-</parameters>
-<return> a #GtkTextBuffer
-</return>
-</function>
+If @use_align is %FALSE, then the alignment arguments are ignored, and the
+tree does the minimum amount of work to scroll the item onto the screen.
+This means that the item will be scrolled to the edge closest to its current
+position. If the item is currently visible on the screen, nothing is done.
-<function name="gtk_tree_view_column_get_sort_order">
-<description>
-Gets the value set by gtk_tree_view_column_set_sort_order().
+This function only works if the model is set, and @path is a valid row on
+the model. If the model changes before the @icon_view is realized, the
+centered path will be modified to reflect this change.
+Since: 2.8
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> a #GtkTreeViewColumn
+<parameter name="icon_view">
+<parameter_description> A #GtkIconView.
</parameter_description>
</parameter>
-</parameters>
-<return> the sort order the sort indicator is indicating
-</return>
-</function>
-
-<function name="gtk_tree_view_column_set_alignment">
-<description>
-Sets the alignment of the title or custom widget inside the column header.
-The alignment determines its location inside the button -- 0.0 for left, 0.5
-for center, 1.0 for right.
-
-</description>
-<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn.
+<parameter name="path">
+<parameter_description> The path of the item to move to.
</parameter_description>
</parameter>
-<parameter name="xalign">
-<parameter_description> The alignment, which is between [0.0 and 1.0] inclusive.
+<parameter name="use_align">
+<parameter_description> whether to use alignment arguments, or %FALSE.
+</parameter_description>
+</parameter>
+<parameter name="row_align">
+<parameter_description> The vertical alignment of the item specified by @path.
+</parameter_description>
+</parameter>
+<parameter name="col_align">
+<parameter_description> The horizontal alignment of the item specified by @path.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_radio_action_get_current_value">
+<function name="gtk_icon_view_select_all">
<description>
-Obtains the value property of the currently active member of
-the group to which @action belongs.
+Selects all the icons. @icon_view must has its selection mode set
+to #GTK_SELECTION_MULTIPLE.
-Since: 2.4
+Since: 2.6
</description>
<parameters>
-<parameter name="action">
-<parameter_description> a #GtkRadioAction
+<parameter name="icon_view">
+<parameter_description> A #GtkIconView.
</parameter_description>
</parameter>
</parameters>
-<return> The value of the currently active group member
-
-</return>
+<return></return>
</function>
-<function name="gtk_recent_info_last_application">
+<function name="gtk_icon_view_select_path">
<description>
-Gets the name of the last application that have registered the
-recently used resource represented by @info.
+Selects the row at @path.
-Since: 2.10
+Since: 2.6
</description>
<parameters>
-<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter name="icon_view">
+<parameter_description> A #GtkIconView.
</parameter_description>
</parameter>
-</parameters>
-<return> an application name. Use g_free() to free it.
-
-</return>
-</function>
-
-<function name="gtk_hscrollbar_new">
-<description>
-Creates a new horizontal scrollbar.
-
-
-</description>
-<parameters>
-<parameter name="adjustment">
-<parameter_description> the #GtkAdjustment to use, or %NULL to create a new adjustment
+<parameter name="path">
+<parameter_description> The #GtkTreePath to be selected.
</parameter_description>
</parameter>
</parameters>
-<return> the new #GtkHScrollbar
-</return>
+<return></return>
</function>
-<function name="gtk_im_context_get_preedit_string">
+<function name="gtk_icon_view_selected_foreach">
<description>
-Retrieve the current preedit string for the input context,
-and a list of attributes to apply to the string.
-This string should be displayed inserted at the insertion
-point.
+Calls a function for each selected icon. Note that the model or
+selection cannot be modified from within this function.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GtkIMContext
-</parameter_description>
-</parameter>
-<parameter name="str">
-<parameter_description> location to store the retrieved string. The
-string retrieved must be freed with g_free ().
+<parameter name="icon_view">
+<parameter_description> A #GtkIconView.
</parameter_description>
</parameter>
-<parameter name="attrs">
-<parameter_description> location to store the retrieved attribute list.
-When you are done with this list, you must
-unreference it with pango_attr_list_unref().
+<parameter name="func">
+<parameter_description> The function to call for each selected icon.
</parameter_description>
</parameter>
-<parameter name="cursor_pos">
-<parameter_description> location to store position of cursor (in characters)
-within the preedit string.
+<parameter name="data">
+<parameter_description> User data to pass to the function.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_set_can_focus">
+<function name="gtk_icon_view_set_column_spacing">
<description>
-Specifies whether @widget can own the input focus. See
-gtk_widget_grab_focus() for actually setting the input focus on a
-widget.
+Sets the ::column-spacing property which specifies the space
+which is inserted between the columns of the icon view.
-Since: 2.18
+Since: 2.6
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
</parameter_description>
</parameter>
-<parameter name="can_focus">
-<parameter_description> whether or not @widget can own the input focus.
+<parameter name="column_spacing">
+<parameter_description> the column spacing
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_progress_bar_get_text">
+<function name="gtk_icon_view_set_columns">
<description>
-Retrieves the text displayed superimposed on the progress bar,
-if any, otherwise %NULL. The return value is a reference
-to the text, not a copy of it, so will become invalid
-if you change the text in the progress bar.
+Sets the ::columns property which determines in how
+many columns the icons are arranged. If @columns is
+-1, the number of columns will be chosen automatically
+to fill the available area.
+Since: 2.6
</description>
<parameters>
-<parameter name="pbar">
-<parameter_description> a #GtkProgressBar
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
+</parameter_description>
+</parameter>
+<parameter name="columns">
+<parameter_description> the number of columns
</parameter_description>
</parameter>
</parameters>
-<return> text, or %NULL; this string is owned by the widget
-and should not be modified or freed.
-</return>
+<return></return>
</function>
-<function name="gtk_list_store_insert_with_values">
+<function name="gtk_icon_view_set_cursor">
<description>
-Creates a new row at @position. @iter will be changed to point to this new
-row. If @position is larger than the number of rows on the list, then the
-new row will be appended to the list. The row will be filled with the
-values given to this function.
+Sets the current keyboard focus to be at @path, and selects it. This is
+useful when you want to focus the user's attention on a particular item.
+If @cell is not %NULL, then focus is given to the cell specified by
+it. Additionally, if @start_editing is %TRUE, then editing should be
+started in the specified cell.
-Calling
-<literal>gtk_list_store_insert_with_values(list_store, iter, position...)</literal>
-has the same effect as calling
-|[
-gtk_list_store_insert (list_store, iter, position);
-gtk_list_store_set (list_store, iter, ...);
-]|
-with the difference that the former will only emit a row_inserted signal,
-while the latter will emit row_inserted, row_changed and, if the list store
-is sorted, rows_reordered. Since emitting the rows_reordered signal
-repeatedly can affect the performance of the program,
-gtk_list_store_insert_with_values() should generally be preferred when
-inserting rows in a sorted list store.
+This function is often followed by <literal>gtk_widget_grab_focus
+(icon_view)</literal> in order to give keyboard focus to the widget.
+Please note that editing can only happen when the widget is realized.
-Since: 2.6
+Since: 2.8
</description>
<parameters>
-<parameter name="list_store">
-<parameter_description> A #GtkListStore
+<parameter name="icon_view">
+<parameter_description> A #GtkIconView
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> An unset #GtkTreeIter to set to the new row, or %NULL.
+<parameter name="path">
+<parameter_description> A #GtkTreePath
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> position to insert the new row
+<parameter name="cell">
+<parameter_description> One of the cell renderers of @icon_view, or %NULL
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> pairs of column number and value, terminated with -1
+<parameter name="start_editing">
+<parameter_description> %TRUE if the specified cell should start being edited.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_info_bar_add_buttons">
+<function name="gtk_icon_view_set_drag_dest_item">
<description>
-Adds more buttons, same as calling gtk_info_bar_add_button()
-repeatedly. The variable argument list should be %NULL-terminated
-as with gtk_info_bar_new_with_buttons(). Each button must have both
-text and response ID.
+Sets the item that is highlighted for feedback.
-Since: 2.18
+Since: 2.8
</description>
<parameters>
-<parameter name="info_bar">
-<parameter_description> a #GtkInfoBar
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
</parameter_description>
</parameter>
-<parameter name="first_button_text">
-<parameter_description> button text or stock ID
+<parameter name="path">
+<parameter_description> The path of the item to highlight, or %NULL.
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> response ID for first button, then more text-response_id pairs,
-ending with %NULL
+<parameter name="pos">
+<parameter_description> Specifies where to drop, relative to the item
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_combo_box_entry_get_text_column">
+<function name="gtk_icon_view_set_item_orientation">
<description>
-Returns the column which @entry_box is using to get the strings from.
+Sets the ::item-orientation property which determines whether
+the labels are drawn beside the icons instead of below.
-Since: 2.4
+Since: 2.22
</description>
<parameters>
-<parameter name="entry_box">
-<parameter_description> A #GtkComboBoxEntry.
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
+</parameter_description>
+</parameter>
+<parameter name="orientation">
+<parameter_description> the relative position of texts and icons
</parameter_description>
</parameter>
</parameters>
-<return> A column in the data source model of @entry_box.
-
-</return>
+<return></return>
</function>
-<function name="gtk_activatable_get_related_action">
+<function name="gtk_icon_view_set_item_padding">
<description>
-Gets the related #GtkAction for @activatable.
+Sets the #GtkIconView:item-padding property which specifies the padding
+around each of the icon view's items.
-Since: 2.16
+Since: 2.18
</description>
<parameters>
-<parameter name="activatable">
-<parameter_description> a #GtkActivatable
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
+</parameter_description>
+</parameter>
+<parameter name="item_padding">
+<parameter_description> the item padding
</parameter_description>
</parameter>
</parameters>
-<return> the related #GtkAction if one is set.
-
-</return>
+<return></return>
</function>
-<function name="gtk_combo_box_set_wrap_width">
+<function name="gtk_icon_view_set_item_width">
<description>
-Sets the wrap width of @combo_box to be @width. The wrap width is basically
-the preferred number of columns when you want the popup to be layed out
-in a table.
+Sets the ::item-width property which specifies the width
+to use for each item. If it is set to -1, the icon view will
+automatically determine a suitable item size.
-Since: 2.4
+Since: 2.6
</description>
<parameters>
-<parameter name="combo_box">
-<parameter_description> A #GtkComboBox
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> Preferred number of columns
+<parameter name="item_width">
+<parameter_description> the width for each item
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_file_selection_set_select_multiple">
+<function name="gtk_icon_view_set_margin">
<description>
-Sets whether the user is allowed to select multiple files in the file list.
-Use gtk_file_selection_get_selections () to get the list of selected files.
+Sets the ::margin property which specifies the space
+which is inserted at the top, bottom, left and right
+of the icon view.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="filesel">
-<parameter_description> a #GtkFileSelection
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
</parameter_description>
</parameter>
-<parameter name="select_multiple">
-<parameter_description> whether or not the user is allowed to select multiple
-files in the file list.
+<parameter name="margin">
+<parameter_description> the margin
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_enable_model_drag_source">
+<function name="gtk_icon_view_set_markup_column">
<description>
-Turns @tree_view into a drag source for automatic DND. Calling this
-method sets #GtkTreeView:reorderable to %FALSE.
+Sets the column with markup information for @icon_view to be
+ column The markup column must be of type #G_TYPE_STRING.
+If the markup column is set to something, it overrides
+the text column set by gtk_icon_view_set_text_column().
+
+Since: 2.6
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
-</parameter_description>
-</parameter>
-<parameter name="start_button_mask">
-<parameter_description> Mask of allowed buttons to start drag
-</parameter_description>
-</parameter>
-<parameter name="targets">
-<parameter_description> the table of targets that the drag will support
-</parameter_description>
-</parameter>
-<parameter name="n_targets">
-<parameter_description> the number of items in @targets
+<parameter name="icon_view">
+<parameter_description> A #GtkIconView.
</parameter_description>
</parameter>
-<parameter name="actions">
-<parameter_description> the bitmask of possible actions for a drag from this
-widget
+<parameter name="column">
+<parameter_description> A column in the currently used model, or -1 to display no text
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_path_free">
+<function name="gtk_icon_view_set_model">
<description>
-Frees @path.
+Sets the model for a #GtkIconView.
+If the @icon_view already has a model set, it will remove
+it before setting the new model. If @model is %NULL, then
+it will unset the old model.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="path">
-<parameter_description> A #GtkTreePath.
+<parameter name="icon_view">
+<parameter_description> A #GtkIconView.
+</parameter_description>
+</parameter>
+<parameter name="model">
+<parameter_description> The model.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_editable_set_position">
+<function name="gtk_icon_view_set_orientation">
<description>
-Sets the cursor position in the editable to the given value.
+Sets the ::orientation property which determines whether the labels
+are drawn beside the icons instead of below.
-The cursor is displayed before the character with the given (base 0)
-index in the contents of the editable. The value must be less than or
-equal to the number of characters in the editable. A value of -1
-indicates that the position should be set after the last character
-of the editable. Note that @position is in characters, not in bytes.
+Since: 2.6
+
+Deprecated: 2.22: Use gtk_icon_view_set_item_orientation()
</description>
<parameters>
-<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> the position of the cursor
+<parameter name="orientation">
+<parameter_description> the relative position of texts and icons
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_set_mnemonics_visible">
+<function name="gtk_icon_view_set_pixbuf_column">
<description>
-Sets the #GtkWindow:mnemonics-visible property.
+Sets the column with pixbufs for @icon_view to be @column. The pixbuf
+column must be of type #GDK_TYPE_PIXBUF
-Since: 2.20
+Since: 2.6
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="icon_view">
+<parameter_description> A #GtkIconView.
</parameter_description>
</parameter>
-<parameter name="setting">
-<parameter_description> the new value
+<parameter name="column">
+<parameter_description> A column in the currently used model, or -1 to disable
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_clipboard_get">
+<function name="gtk_icon_view_set_reorderable">
<description>
-Returns the clipboard object for the given selection.
-See gtk_clipboard_get_for_display() for complete details.
+This function is a convenience function to allow you to reorder models that
+support the #GtkTreeDragSourceIface and the #GtkTreeDragDestIface. Both
+#GtkTreeStore and #GtkListStore support these. If @reorderable is %TRUE, then
+the user can reorder the model by dragging and dropping rows. The
+developer can listen to these changes by connecting to the model's
+row_inserted and row_deleted signals. The reordering is implemented by setting up
+the icon view as a drag source and destination. Therefore, drag and
+drop can not be used in a reorderable view for any other purpose.
+This function does not give you any degree of control over the order -- any
+reordering is allowed. If more control is needed, you should probably
+handle drag and drop manually.
+
+Since: 2.8
</description>
<parameters>
-<parameter name="selection">
-<parameter_description> a #GdkAtom which identifies the clipboard to use
+<parameter name="icon_view">
+<parameter_description> A #GtkIconView.
+</parameter_description>
+</parameter>
+<parameter name="reorderable">
+<parameter_description> %TRUE, if the list of items can be reordered.
</parameter_description>
</parameter>
</parameters>
-<return> the appropriate clipboard object. If no clipboard
-already exists, a new one will be created. Once a clipboard
-object has been created, it is persistent and, since it is
-owned by GTK+, must not be freed or unreffed.
-</return>
+<return></return>
</function>
-<function name="gtk_tree_view_column_get_width">
+<function name="gtk_icon_view_set_row_spacing">
<description>
-Returns the current size of @tree_column in pixels.
+Sets the ::row-spacing property which specifies the space
+which is inserted between the rows of the icon view.
+Since: 2.6
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn.
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
+</parameter_description>
+</parameter>
+<parameter name="row_spacing">
+<parameter_description> the row spacing
</parameter_description>
</parameter>
</parameters>
-<return> The current width of @tree_column.
-</return>
+<return></return>
</function>
-<function name="gtk_recent_chooser_select_uri">
+<function name="gtk_icon_view_set_selection_mode">
<description>
-Selects @uri inside @chooser.
+Sets the selection mode of the @icon_view.
-Since: 2.10
+Since: 2.6
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
-</parameter_description>
-</parameter>
-<parameter name="uri">
-<parameter_description> a URI
+<parameter name="icon_view">
+<parameter_description> A #GtkIconView.
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL
+<parameter name="mode">
+<parameter_description> The selection mode
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @uri was found.
-
-</return>
+<return></return>
</function>
-<function name="gtk_notebook_get_tab_label">
+<function name="gtk_icon_view_set_spacing">
<description>
-Returns the tab label widget for the page @child. %NULL is returned
-if @child is not in @notebook or if no tab label has specifically
-been set for @child.
+Sets the ::spacing property which specifies the space
+which is inserted between the cells (i.e. the icon and
+the text) of an item.
+Since: 2.6
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
</parameter_description>
</parameter>
-<parameter name="child">
-<parameter_description> the page
+<parameter name="spacing">
+<parameter_description> the spacing
</parameter_description>
</parameter>
</parameters>
-<return> the tab label
-</return>
+<return></return>
</function>
-<function name="gtk_range_set_min_slider_size">
+<function name="gtk_icon_view_set_text_column">
<description>
-Sets the minimum size of the range's slider.
-
-This function is useful mainly for #GtkRange subclasses.
+Sets the column with text for @icon_view to be @column. The text
+column must be of type #G_TYPE_STRING.
-Since: 2.20
+Since: 2.6
</description>
<parameters>
-<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter name="icon_view">
+<parameter_description> A #GtkIconView.
</parameter_description>
</parameter>
-<parameter name="min_size">
-<parameter_description> The slider's minimum size
+<parameter name="column">
+<parameter_description> A column in the currently used model, or -1 to display no text
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_item_factory_get_widget">
+<function name="gtk_icon_view_set_tooltip_cell">
<description>
-Obtains the widget which corresponds to @path.
+Sets the tip area of @tooltip to the area which @cell occupies in
+the item pointed to by @path. See also gtk_tooltip_set_tip_area().
-If the widget corresponding to @path is a menu item which opens a
-submenu, then the submenu is returned. If you are interested in the menu
-item, use gtk_item_factory_get_item() instead.
+See also gtk_icon_view_set_tooltip_column() for a simpler alternative.
-Deprecated: 2.4: Use #GtkUIManager instead.
+Since: 2.12
</description>
<parameters>
-<parameter name="ifactory">
-<parameter_description> a #GtkItemFactory
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
+</parameter_description>
+</parameter>
+<parameter name="tooltip">
+<parameter_description> a #GtkTooltip
</parameter_description>
</parameter>
<parameter name="path">
-<parameter_description> the path to the widget
+<parameter_description> a #GtkTreePath
+</parameter_description>
+</parameter>
+<parameter name="cell">
+<parameter_description> a #GtkCellRenderer or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the widget for the given path, or %NULL if @path doesn't lead
-to a widget
-</return>
+<return></return>
</function>
-<function name="gtk_label_get_use_underline">
+<function name="gtk_icon_view_set_tooltip_column">
<description>
-Returns whether an embedded underline in the label indicates a
-mnemonic. See gtk_label_set_use_underline().
+If you only plan to have simple (text-only) tooltips on full items, you
+can use this function to have #GtkIconView handle these automatically
+for you. @column should be set to the column in @icon_view's model
+containing the tooltip texts, or -1 to disable this feature.
+When enabled, #GtkWidget::has-tooltip will be set to %TRUE and
+ icon_view will connect a #GtkWidget::query-tooltip signal handler.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
+</parameter_description>
+</parameter>
+<parameter name="column">
+<parameter_description> an integer, which is a valid column number for @icon_view's model
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE whether an embedded underline in the label indicates
-the mnemonic accelerator keys.
-</return>
+<return></return>
</function>
-<function name="gtk_builder_value_from_string">
+<function name="gtk_icon_view_set_tooltip_item">
<description>
-This function demarshals a value from a string. This function
-calls g_value_init() on the @value argument, so it need not be
-initialised beforehand.
-
-This function can handle char, uchar, boolean, int, uint, long,
-ulong, enum, flags, float, double, string, #GdkColor and
-#GtkAdjustment type values. Support for #GtkWidget type values is
-still to come.
-
-Upon errors %FALSE will be returned and @error will be assigned a
-#GError from the #GTK_BUILDER_ERROR domain.
+Sets the tip area of @tooltip to be the area covered by the item at @path.
+See also gtk_icon_view_set_tooltip_column() for a simpler alternative.
+See also gtk_tooltip_set_tip_area().
Since: 2.12
</description>
<parameters>
-<parameter name="builder">
-<parameter_description> a #GtkBuilder
-</parameter_description>
-</parameter>
-<parameter name="pspec">
-<parameter_description> the #GParamSpec for the property
-</parameter_description>
-</parameter>
-<parameter name="string">
-<parameter_description> the string representation of the value
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> the #GValue to store the result in
+<parameter name="tooltip">
+<parameter_description> a #GtkTooltip
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for an error, or %NULL
+<parameter name="path">
+<parameter_description> a #GtkTreePath
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success
-
-</return>
+<return></return>
</function>
-<function name="gtk_text_iter_forward_visible_cursor_position">
+<function name="gtk_icon_view_unselect_all">
<description>
-Moves @iter forward to the next visible cursor position. See
-gtk_text_iter_forward_cursor_position() for details.
+Unselects all the icons.
-Since: 2.4
+Since: 2.6
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="icon_view">
+<parameter_description> A #GtkIconView.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if we moved and the new position is dereferenceable
-
-</return>
+<return></return>
</function>
-<function name="gtk_tree_view_set_search_equal_func">
+<function name="gtk_icon_view_unselect_path">
<description>
-Sets the compare function for the interactive search capabilities; note
-that somewhat like strcmp() returning 0 for equality
-#GtkTreeViewSearchEqualFunc returns %FALSE on matches.
+Unselects the row at @path.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView
-</parameter_description>
-</parameter>
-<parameter name="search_equal_func">
-<parameter_description> the compare function to use during the search
-</parameter_description>
-</parameter>
-<parameter name="search_user_data">
-<parameter_description> user data to pass to @search_equal_func, or %NULL
+<parameter name="icon_view">
+<parameter_description> A #GtkIconView.
</parameter_description>
</parameter>
-<parameter name="search_destroy">
-<parameter_description> Destroy notifier for @search_user_data, or %NULL
+<parameter name="path">
+<parameter_description> The #GtkTreePath to be unselected.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_set_default_icon_list">
+<function name="gtk_icon_view_unset_model_drag_dest">
<description>
-Sets an icon list to be used as fallback for windows that haven't
-had gtk_window_set_icon_list() called on them to set up a
-window-specific icon list. This function allows you to set up the
-icon for all windows in your app at once.
-
-See gtk_window_set_icon_list() for more details.
+Undoes the effect of gtk_icon_view_enable_model_drag_dest(). Calling this
+method sets #GtkIconView:reorderable to %FALSE.
+Since: 2.8
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a list of #GdkPixbuf
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_im_multicontext_new">
+<function name="gtk_icon_view_unset_model_drag_source">
<description>
-Creates a new #GtkIMMulticontext.
+Undoes the effect of gtk_icon_view_enable_model_drag_source(). Calling this
+method sets #GtkIconView:reorderable to %FALSE.
+Since: 2.8
</description>
<parameters>
+<parameter name="icon_view">
+<parameter_description> a #GtkIconView
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GtkIMMulticontext.
-</return>
+<return></return>
</function>
-<function name="gtk_cell_renderer_accel_new">
+<function name="gtk_im_context_delete_surrounding">
<description>
-Creates a new #GtkCellRendererAccel.
-
-Since: 2.10
-
-</description>
-<parameters>
-</parameters>
-<return> the new cell renderer
+Asks the widget that the input context is attached to to delete
+characters around the cursor position by emitting the
+GtkIMContext::delete_surrounding signal. Note that @offset and @n_chars
+are in characters not in bytes which differs from the usage other
+places in #GtkIMContext.
-</return>
-</function>
+In order to use this function, you should first call
+gtk_im_context_get_surrounding() to get the current context, and
+call this function immediately afterwards to make sure that you
+know what you are deleting. You should also account for the fact
+that even if the signal was handled, the input context might not
+have deleted all the characters that were requested to be deleted.
-<function name="gtk_icon_theme_get_for_screen">
-<description>
-Gets the icon theme object associated with @screen; if this
-function has not previously been called for the given
-screen, a new icon theme object will be created and
-associated with the screen. Icon theme objects are
-fairly expensive to create, so using this function
-is usually a better choice than calling than gtk_icon_theme_new()
-and setting the screen yourself; by using this function
-a single icon theme object will be shared between users.
+This function is used by an input method that wants to make
+subsitutions in the existing text in response to new input. It is
+not useful for applications.
-Since: 2.4
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="context">
+<parameter_description> a #GtkIMContext
+</parameter_description>
+</parameter>
+<parameter name="offset">
+<parameter_description> offset from cursor position in chars;
+a negative value means start before the cursor.
+</parameter_description>
+</parameter>
+<parameter name="n_chars">
+<parameter_description> number of characters to delete.
</parameter_description>
</parameter>
</parameters>
-<return> A unique #GtkIconTheme associated with
-the given screen. This icon theme is associated with
-the screen and can be used as long as the screen
-is open. Do not ref or unref it.
-
+<return> %TRUE if the signal was handled.
</return>
</function>
-<function name="gtk_file_chooser_set_current_folder_file">
+<function name="gtk_im_context_filter_keypress">
<description>
-Sets the current folder for @chooser from a #GFile.
-Internal function, see gtk_file_chooser_set_current_folder_uri().
+Allow an input method to internally handle key press and release
+events. If this function returns %TRUE, then no further processing
+should be done for this key event.
-Since: 2.14
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
-</parameter_description>
-</parameter>
-<parameter name="file">
-<parameter_description> the #GFile for the new folder
+<parameter name="context">
+<parameter_description> a #GtkIMContext
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> location to store error, or %NULL.
+<parameter name="event">
+<parameter_description> the key event
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the folder could be changed successfully, %FALSE
-otherwise.
+<return> %TRUE if the input method handled the key event.
</return>
</function>
-<function name="gtk_label_get_ellipsize">
+<function name="gtk_im_context_focus_in">
<description>
-Returns the ellipsizing position of the label. See gtk_label_set_ellipsize().
-
-Since: 2.6
+Notify the input method that the widget to which this
+input context corresponds has gained focus. The input method
+may, for example, change the displayed feedback to reflect
+this change.
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="context">
+<parameter_description> a #GtkIMContext
</parameter_description>
</parameter>
</parameters>
-<return> #PangoEllipsizeMode
-
-</return>
+<return></return>
</function>
-<function name="gtk_rc_add_default_file">
+<function name="gtk_im_context_focus_out">
<description>
-Adds a file to the list of files to be parsed at the
-end of gtk_init().
+Notify the input method that the widget to which this
+input context corresponds has lost focus. The input method
+may, for example, change the displayed feedback or reset the contexts
+state to reflect this change.
</description>
<parameters>
-<parameter name="filename">
-<parameter_description> the pathname to the file. If @filename is not absolute, it
-is searched in the current directory.
+<parameter name="context">
+<parameter_description> a #GtkIMContext
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_operation_get_status_string">
+<function name="gtk_im_context_get_preedit_string">
<description>
-Returns a string representation of the status of the
-print operation. The string is translated and suitable
-for displaying the print status e.g. in a #GtkStatusbar.
-
-Use gtk_print_operation_get_status() to obtain a status
-value that is suitable for programmatic use.
-
-Since: 2.10
+Retrieve the current preedit string for the input context,
+and a list of attributes to apply to the string.
+This string should be displayed inserted at the insertion
+point.
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter name="context">
+<parameter_description> a #GtkIMContext
+</parameter_description>
+</parameter>
+<parameter name="str">
+<parameter_description> location to store the retrieved string. The
+string retrieved must be freed with g_free ().
+</parameter_description>
+</parameter>
+<parameter name="attrs">
+<parameter_description> location to store the retrieved attribute list.
+When you are done with this list, you must
+unreference it with pango_attr_list_unref().
+</parameter_description>
+</parameter>
+<parameter name="cursor_pos">
+<parameter_description> location to store position of cursor (in characters)
+within the preedit string.
</parameter_description>
</parameter>
</parameters>
-<return> a string representation of the status
-of the print operation
-
-</return>
+<return></return>
</function>
-<function name="gtk_page_setup_get_paper_height">
+<function name="gtk_im_context_get_surrounding">
<description>
-Returns the paper height in units of @unit.
+Retrieves context around the insertion point. Input methods
+typically want context in order to constrain input text based on
+existing text; this is important for languages such as Thai where
+only some sequences of characters are allowed.
-Note that this function takes orientation, but
-not margins into consideration.
-See gtk_page_setup_get_page_height().
+This function is implemented by emitting the
+GtkIMContext::retrieve_surrounding signal on the input method; in
+response to this signal, a widget should provide as much context as
+is available, up to an entire paragraph, by calling
+gtk_im_context_set_surrounding(). Note that there is no obligation
+for a widget to respond to the ::retrieve_surrounding signal, so input
+methods must be prepared to function without context.
-Since: 2.10
</description>
<parameters>
-<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter name="context">
+<parameter_description> a #GtkIMContext
</parameter_description>
</parameter>
-<parameter name="unit">
-<parameter_description> the unit for the return value
+<parameter name="text">
+<parameter_description> location to store a UTF-8 encoded string of text
+holding context around the insertion point.
+If the function returns %TRUE, then you must free
+the result stored in this location with g_free().
+</parameter_description>
+</parameter>
+<parameter name="cursor_index">
+<parameter_description> location to store byte index of the insertion cursor
+within @text.
</parameter_description>
</parameter>
</parameters>
-<return> the paper height.
-
+<return> %TRUE if surrounding text was provided; in this case
+you must free the result stored in *text.
</return>
</function>
-<function name="gtk_widget_set_realized">
+<function name="gtk_im_context_reset">
<description>
-Marks the widget as being realized.
-
-This function should only ever be called in a derived widget's
-"realize" or "unrealize" implementation.
-
-Since: 2.20
+Notify the input method that a change such as a change in cursor
+position has been made. This will typically cause the input
+method to clear the preedit state.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="realized">
-<parameter_description> %TRUE to mark the widget as realized
+<parameter name="context">
+<parameter_description> a #GtkIMContext
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_backspace">
+<function name="gtk_im_context_set_client_window">
<description>
-Performs the appropriate action as if the user hit the delete
-key with the cursor at the position specified by @iter. In the
-normal case a single character will be deleted, but when
-combining accents are involved, more than one character can
-be deleted, and when precomposed character and accent combinations
-are involved, less than one character will be deleted.
-
-Because the buffer is modified, all outstanding iterators become
-invalid after calling this function; however, the @iter will be
-re-initialized to point to the location where text was deleted.
-
-Since: 2.6
+Set the client window for the input context; this is the
+#GdkWindow in which the input appears. This window is
+used in order to correctly position status windows, and may
+also be used for purposes internal to the input method.
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> a position in @buffer
-</parameter_description>
-</parameter>
-<parameter name="interactive">
-<parameter_description> whether the deletion is caused by user interaction
+<parameter name="context">
+<parameter_description> a #GtkIMContext
</parameter_description>
</parameter>
-<parameter name="default_editable">
-<parameter_description> whether the buffer is editable by default
+<parameter name="window">
+<parameter_description> the client window. This may be %NULL to indicate
+that the previous client window no longer exists.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the buffer was modified
-
-</return>
+<return></return>
</function>
-<function name="gtk_action_group_add_action">
+<function name="gtk_im_context_set_cursor_location">
<description>
-Adds an action object to the action group. Note that this function
-does not set up the accel path of the action, which can lead to problems
-if a user tries to modify the accelerator of a menuitem associated with
-the action. Therefore you must either set the accel path yourself with
-gtk_action_set_accel_path(), or use
-<literal>gtk_action_group_add_action_with_accel (..., NULL)</literal>.
-
-Since: 2.4
+Notify the input method that a change in cursor
+position has been made. The location is relative to the client
+window.
</description>
<parameters>
-<parameter name="action_group">
-<parameter_description> the action group
+<parameter name="context">
+<parameter_description> a #GtkIMContext
</parameter_description>
</parameter>
-<parameter name="action">
-<parameter_description> an action
+<parameter name="area">
+<parameter_description> new location
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_scale_button_new">
+<function name="gtk_im_context_set_surrounding">
<description>
-Creates a #GtkScaleButton, with a range between @min and @max, with
-a stepping of @step.
-
-Since: 2.12
+Sets surrounding context around the insertion point and preedit
+string. This function is expected to be called in response to the
+GtkIMContext::retrieve_surrounding signal, and will likely have no
+effect if called at other times.
</description>
<parameters>
-<parameter name="size">
-<parameter_description> a stock icon size
+<parameter name="context">
+<parameter_description> a #GtkIMContext
</parameter_description>
</parameter>
-<parameter name="min">
-<parameter_description> the minimum value of the scale (usually 0)
+<parameter name="text">
+<parameter_description> text surrounding the insertion point, as UTF-8.
+the preedit string should not be included within
+ text
</parameter_description>
</parameter>
-<parameter name="max">
-<parameter_description> the maximum value of the scale (usually 100)
+<parameter name="len">
+<parameter_description> the length of @text, or -1 if @text is nul-terminated
</parameter_description>
</parameter>
-<parameter name="step">
-<parameter_description> the stepping of value when a scroll-wheel event,
-or up/down arrow event occurs (usually 2)
+<parameter name="cursor_index">
+<parameter_description> the byte index of the insertion cursor within @text.
</parameter_description>
</parameter>
-<parameter name="icons">
-<parameter_description> a %NULL-terminated array of icon names, or %NULL if
-you want to set the list later with gtk_scale_button_set_icons()
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_im_context_set_use_preedit">
+<description>
+Sets whether the IM context should use the preedit string
+to display feedback. If @use_preedit is FALSE (default
+is TRUE), then the IM context may use some other method to display
+feedback, such as displaying it in a child of the root window.
+
+</description>
+<parameters>
+<parameter name="context">
+<parameter_description> a #GtkIMContext
+</parameter_description>
+</parameter>
+<parameter name="use_preedit">
+<parameter_description> whether the IM context should use the preedit string.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkScaleButton
-
-</return>
+<return></return>
</function>
-<function name="gtk_page_setup_set_left_margin">
+<function name="gtk_im_context_simple_add_table">
<description>
-Sets the left margin of the #GtkPageSetup.
+Adds an additional table to search to the input context.
+Each row of the table consists of @max_seq_len key symbols
+followed by two #guint16 interpreted as the high and low
+words of a #gunicode value. Tables are searched starting
+from the last added.
-Since: 2.10
+The table must be sorted in dictionary order on the
+numeric value of the key symbol fields. (Values beyond
+the length of the sequence should be zero.)
</description>
<parameters>
-<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter name="context_simple">
+<parameter_description> A #GtkIMContextSimple
</parameter_description>
</parameter>
-<parameter name="margin">
-<parameter_description> the new left margin in units of @unit
+<parameter name="data">
+<parameter_description> the table
</parameter_description>
</parameter>
-<parameter name="unit">
-<parameter_description> the units for @margin
+<parameter name="max_seq_len">
+<parameter_description> Maximum length of a sequence in the table
+(cannot be greater than #GTK_MAX_COMPOSE_LEN)
+</parameter_description>
+</parameter>
+<parameter name="n_seqs">
+<parameter_description> number of sequences in the table
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_column_get_reorderable">
+<function name="gtk_im_context_simple_new">
<description>
-Returns %TRUE if the @tree_column can be reordered by the user.
+Creates a new #GtkIMContextSimple.
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn
-</parameter_description>
-</parameter>
</parameters>
-<return> %TRUE if the @tree_column can be reordered by the user.
+<return> a new #GtkIMContextSimple.
</return>
</function>
-<function name="gtk_recent_chooser_set_select_multiple">
+<function name="gtk_im_multicontext_append_menuitems">
<description>
-Sets whether @chooser can select multiple items.
-
-Since: 2.10
+Add menuitems for various available input methods to a menu;
+the menuitems, when selected, will switch the input method
+for the context and the global default input method.
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
+<parameter name="context">
+<parameter_description> a #GtkIMMulticontext
</parameter_description>
</parameter>
-<parameter name="select_multiple">
-<parameter_description> %TRUE if @chooser can select more than one item
+<parameter name="menushell">
+<parameter_description> a #GtkMenuShell
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_view_select_path">
+<function name="gtk_im_multicontext_get_context_id">
<description>
-Selects the row at @path.
+Gets the id of the currently active slave of the @context.
-Since: 2.6
+Since: 2.16
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> A #GtkIconView.
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> The #GtkTreePath to be selected.
+<parameter name="context">
+<parameter_description> a #GtkIMMulticontext
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the id of the currently active slave
+
+</return>
</function>
-<function name="gtk_status_icon_set_from_stock">
+<function name="gtk_im_multicontext_new">
<description>
-Makes @status_icon display the stock icon with the id @stock_id.
-See gtk_status_icon_new_from_stock() for details.
+Creates a new #GtkIMMulticontext.
-Since: 2.10
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
-</parameter_description>
-</parameter>
-<parameter name="stock_id">
-<parameter_description> a stock icon id
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> a new #GtkIMMulticontext.
+</return>
</function>
-<function name="gtk_container_child_get_property">
+<function name="gtk_im_multicontext_set_context_id">
<description>
-Gets the value of a child property for @child and @container.
+Sets the context id for @context.
+
+This causes the currently active slave of @context to be
+replaced by the slave corresponding to the new context id.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
-</parameter_description>
-</parameter>
-<parameter name="child">
-<parameter_description> a widget which is a child of @container
-</parameter_description>
-</parameter>
-<parameter name="property_name">
-<parameter_description> the name of the property to get
+<parameter name="context">
+<parameter_description> a #GtkIMMulticontext
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> a location to return the value
+<parameter name="context_id">
+<parameter_description> the id to use
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_attributes_new">
+<function name="gtk_image_clear">
<description>
-Creates a #GtkTextAttributes, which describes
-a set of properties on some text.
+Resets the image to be empty.
+Since: 2.8
</description>
<parameters>
+<parameter name="image">
+<parameter_description> a #GtkImage
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GtkTextAttributes
-</return>
+<return></return>
</function>
-<function name="gtk_clipboard_set_can_store">
+<function name="gtk_image_get">
<description>
-Hints that the clipboard data should be stored somewhere when the
-application exits or when gtk_clipboard_store () is called.
-
-This value is reset when the clipboard owner changes.
-Where the clipboard data is stored is platform dependent,
-see gdk_display_store_clipboard () for more information.
+Gets the #GtkImage.
-Since: 2.6
+Deprecated: 2.0: Use gtk_image_get_image() instead.
</description>
<parameters>
-<parameter name="clipboard">
-<parameter_description> a #GtkClipboard
+<parameter name="image">
+<parameter_description> a #GtkImage
</parameter_description>
</parameter>
-<parameter name="targets">
-<parameter_description> array containing information about which forms
-should be stored or %NULL to indicate that all forms should
-be stored.
+<parameter name="val">
+<parameter_description> return location for a #GdkImage
</parameter_description>
</parameter>
-<parameter name="n_targets">
-<parameter_description> number of elements in @targets
+<parameter name="mask">
+<parameter_description> a #GdkBitmap that indicates which parts of the image should be transparent.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_paned_new">
+<function name="gtk_image_get_animation">
<description>
-Creates a new #GtkPaned widget.
+Gets the #GdkPixbufAnimation being displayed by the #GtkImage.
+The storage type of the image must be %GTK_IMAGE_EMPTY or
+%GTK_IMAGE_ANIMATION (see gtk_image_get_storage_type()).
+The caller of this function does not own a reference to the
+returned animation.
-Since: 2.16
</description>
<parameters>
-<parameter name="orientation">
-<parameter_description> the paned's orientation.
+<parameter name="image">
+<parameter_description> a #GtkImage
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPaned.
-
+<return> the displayed animation, or %NULL if
+the image is empty
</return>
</function>
-<function name="gtk_print_run_page_setup_dialog">
+<function name="gtk_image_get_gicon">
<description>
-Runs a page setup dialog, letting the user modify the values from
- page_setup If the user cancels the dialog, the returned #GtkPageSetup
-is identical to the passed in @page_setup, otherwise it contains the
-modifications done in the dialog.
-
-Note that this function may use a recursive mainloop to show the page
-setup dialog. See gtk_print_run_page_setup_dialog_async() if this is
-a problem.
+Gets the #GIcon and size being displayed by the #GtkImage.
+The storage type of the image must be %GTK_IMAGE_EMPTY or
+%GTK_IMAGE_GICON (see gtk_image_get_storage_type()).
+The caller of this function does not own a reference to the
+returned #GIcon.
-Since: 2.10
+Since: 2.14
</description>
<parameters>
-<parameter name="parent">
-<parameter_description> transient parent
+<parameter name="image">
+<parameter_description> a #GtkImage
</parameter_description>
</parameter>
-<parameter name="page_setup">
-<parameter_description> an existing #GtkPageSetup
+<parameter name="gicon">
+<parameter_description> place to store a
+#GIcon, or %NULL
</parameter_description>
</parameter>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="size">
+<parameter_description> place to store an icon size,
+or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPageSetup
-
-</return>
+<return></return>
</function>
-<function name="gtk_clipboard_request_targets">
+<function name="gtk_image_get_icon_name">
<description>
-Requests the contents of the clipboard as list of supported targets.
-When the list is later received, @callback will be called.
-
-The @targets parameter to @callback will contain the resulting targets if
-the request succeeded, or %NULL if it failed.
+Gets the icon name and size being displayed by the #GtkImage.
+The storage type of the image must be %GTK_IMAGE_EMPTY or
+%GTK_IMAGE_ICON_NAME (see gtk_image_get_storage_type()).
+The returned string is owned by the #GtkImage and should not
+be freed.
-Since: 2.4
+Since: 2.6
</description>
<parameters>
-<parameter name="clipboard">
-<parameter_description> a #GtkClipboard
+<parameter name="image">
+<parameter_description> a #GtkImage
</parameter_description>
</parameter>
-<parameter name="callback">
-<parameter_description> a function to call when the targets are received,
-or the retrieval fails. (It will always be called
-one way or the other.)
+<parameter name="icon_name">
+<parameter_description> place to store an
+icon name, or %NULL
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to @callback.
+<parameter name="size">
+<parameter_description> place to store an icon size,
+or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_scale_get_layout_offsets">
+<function name="gtk_image_get_icon_set">
<description>
-Obtains the coordinates where the scale will draw the
-#PangoLayout representing the text in the scale. Remember
-when using the #PangoLayout function you need to convert to
-and from pixels using PANGO_PIXELS() or #PANGO_SCALE.
-
-If the #GtkScale:draw-value property is %FALSE, the return
-values are undefined.
-
-Since: 2.4
+Gets the icon set and size being displayed by the #GtkImage.
+The storage type of the image must be %GTK_IMAGE_EMPTY or
+%GTK_IMAGE_ICON_SET (see gtk_image_get_storage_type()).
</description>
<parameters>
-<parameter name="scale">
-<parameter_description> a #GtkScale
+<parameter name="image">
+<parameter_description> a #GtkImage
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> location to store X offset of layout, or %NULL
+<parameter name="icon_set">
+<parameter_description> location to store a
+#GtkIconSet, or %NULL
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> location to store Y offset of layout, or %NULL
+<parameter name="size">
+<parameter_description> location to store a stock
+icon size, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_iter_copy">
+<function name="gtk_image_get_image">
<description>
-Creates a dynamically allocated tree iterator as a copy of @iter.
-This function is not intended for use in applications, because you
-can just copy the structs by value
-(<literal>GtkTreeIter new_iter = iter;</literal>).
-You must free this iter with gtk_tree_iter_free().
-
+Gets the #GdkImage and mask being displayed by the #GtkImage.
+The storage type of the image must be %GTK_IMAGE_EMPTY or
+%GTK_IMAGE_IMAGE (see gtk_image_get_storage_type()).
+The caller of this function does not own a reference to the
+returned image and mask.
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> A #GtkTreeIter.
+<parameter name="image">
+<parameter_description> a #GtkImage
+</parameter_description>
+</parameter>
+<parameter name="gdk_image">
+<parameter_description> return location for
+a #GtkImage, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="mask">
+<parameter_description> return location for a
+#GdkBitmap, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated copy of @iter.
-</return>
+<return></return>
</function>
-<function name="gtk_recent_chooser_get_filter">
+<function name="gtk_image_get_pixbuf">
<description>
-Gets the #GtkRecentFilter object currently used by @chooser to affect
-the display of the recently used resources.
+Gets the #GdkPixbuf being displayed by the #GtkImage.
+The storage type of the image must be %GTK_IMAGE_EMPTY or
+%GTK_IMAGE_PIXBUF (see gtk_image_get_storage_type()).
+The caller of this function does not own a reference to the
+returned pixbuf.
-Since: 2.10
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
+<parameter name="image">
+<parameter_description> a #GtkImage
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkRecentFilter object.
-
+<return> the displayed pixbuf, or %NULL if
+the image is empty
</return>
</function>
-<function name="gtk_widget_get_tooltip_window">
+<function name="gtk_image_get_pixel_size">
<description>
-Returns the #GtkWindow of the current tooltip. This can be the
-GtkWindow created by default, or the custom tooltip window set
-using gtk_widget_set_tooltip_window().
+Gets the pixel size used for named icons.
-Since: 2.12
+Since: 2.6
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="image">
+<parameter_description> a #GtkImage
</parameter_description>
</parameter>
</parameters>
-<return> The #GtkWindow of the current tooltip.
+<return> the pixel size used for named icons.
</return>
</function>
-<function name="gtk_selection_data_targets_include_rich_text">
+<function name="gtk_image_get_pixmap">
<description>
-Given a #GtkSelectionData object holding a list of targets,
-determines if any of the targets in @targets can be used to
-provide rich text.
-
-Since: 2.10
+Gets the pixmap and mask being displayed by the #GtkImage.
+The storage type of the image must be %GTK_IMAGE_EMPTY or
+%GTK_IMAGE_PIXMAP (see gtk_image_get_storage_type()).
+The caller of this function does not own a reference to the
+returned pixmap and mask.
</description>
<parameters>
-<parameter name="selection_data">
-<parameter_description> a #GtkSelectionData object
+<parameter name="image">
+<parameter_description> a #GtkImage
</parameter_description>
</parameter>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="pixmap">
+<parameter_description> location to store the
+pixmap, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="mask">
+<parameter_description> location to store the
+mask, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @selection_data holds a list of targets,
-and a suitable target for rich text is included,
-otherwise %FALSE.
-
-</return>
+<return></return>
</function>
-<function name="gtk_tree_model_unref_node">
+<function name="gtk_image_get_stock">
<description>
-Lets the tree unref the node. This is an optional method for models to
-implement. To be more specific, models may ignore this call as it exists
-primarily for performance reasons.
-
-For more information on what this means, see gtk_tree_model_ref_node().
-Please note that nodes that are deleted are not unreffed.
+Gets the stock icon name and size being displayed by the #GtkImage.
+The storage type of the image must be %GTK_IMAGE_EMPTY or
+%GTK_IMAGE_STOCK (see gtk_image_get_storage_type()).
+The returned string is owned by the #GtkImage and should not
+be freed.
</description>
<parameters>
-<parameter name="tree_model">
-<parameter_description> A #GtkTreeModel.
+<parameter name="image">
+<parameter_description> a #GtkImage
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> The #GtkTreeIter.
+<parameter name="stock_id">
+<parameter_description> place to store a
+stock icon name, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="size">
+<parameter_description> place to store a stock icon
+size, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_is_sensitive">
+<function name="gtk_image_get_storage_type">
<description>
-Returns the widget's effective sensitivity, which means
-it is sensitive itself and also its parent widget is sensntive
+Gets the type of representation being used by the #GtkImage
+to store image data. If the #GtkImage has no image data,
+the return value will be %GTK_IMAGE_EMPTY.
-Since: 2.18
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="image">
+<parameter_description> a #GtkImage
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the widget is effectively sensitive
-
+<return> image representation being used
</return>
</function>
-<function name="gtk_recent_info_get_groups">
+<function name="gtk_image_menu_item_get_always_show_image">
<description>
-Returns all groups registered for the recently used item @info. The
-array of returned group names will be %NULL terminated, so length might
-optionally be %NULL.
+Returns whether the menu item will ignore the #GtkSettings:gtk-menu-images
+setting and always show the image, if available.
-Since: 2.10
+Since: 2.16
</description>
<parameters>
-<parameter name="info">
-<parameter_description> a #GtkRecentInfo
-</parameter_description>
-</parameter>
-<parameter name="length">
-<parameter_description> return location for the number of groups returned
+<parameter name="image_menu_item">
+<parameter_description> a #GtkImageMenuItem
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated
-%NULL terminated array of strings. Use g_strfreev() to free it.
+<return> %TRUE if the menu item will always show the image
</return>
</function>
-<function name="gtk_toolbar_get_n_items">
+<function name="gtk_image_menu_item_get_image">
<description>
-Returns the number of items on the toolbar.
+Gets the widget that is currently set as the image of @image_menu_item.
+See gtk_image_menu_item_set_image().
-Since: 2.4
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar
+<parameter name="image_menu_item">
+<parameter_description> a #GtkImageMenuItem
</parameter_description>
</parameter>
</parameters>
-<return> the number of items on the toolbar
-
+<return> the widget set as image of @image_menu_item
</return>
</function>
-<function name="gtk_widget_get_direction">
+<function name="gtk_image_menu_item_get_use_stock">
<description>
-Gets the reading direction for a particular widget. See
-gtk_widget_set_direction().
+Checks whether the label set in the menuitem is used as a
+stock id to select the stock item for the item.
+Since: 2.16
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="image_menu_item">
+<parameter_description> a #GtkImageMenuItem
</parameter_description>
</parameter>
</parameters>
-<return> the reading direction for the widget.
+<return> %TRUE if the label set in the menuitem is used as a
+stock id to select the stock item for the item
+
</return>
</function>
-<function name="gtk_status_icon_new_from_stock">
+<function name="gtk_image_menu_item_new">
<description>
-Creates a status icon displaying a stock icon. Sample stock icon
-names are #GTK_STOCK_OPEN, #GTK_STOCK_QUIT. You can register your
-own stock icon names, see gtk_icon_factory_add_default() and
-gtk_icon_factory_add().
+Creates a new #GtkImageMenuItem with an empty label.
-Since: 2.10
+</description>
+<parameters>
+</parameters>
+<return> a new #GtkImageMenuItem.
+</return>
+</function>
+
+<function name="gtk_image_menu_item_new_from_stock">
+<description>
+Creates a new #GtkImageMenuItem containing the image and text from a
+stock item. Some stock ids have preprocessor macros like #GTK_STOCK_OK
+and #GTK_STOCK_APPLY.
+
+If you want this menu item to have changeable accelerators, then pass in
+%NULL for accel_group. Next call gtk_menu_item_set_accel_path() with an
+appropriate path for the menu item, use gtk_stock_lookup() to look up the
+standard accelerator for the stock item, and if one is found, call
+gtk_accel_map_add_entry() to register it.
</description>
<parameters>
<parameter name="stock_id">
-<parameter_description> a stock icon id
+<parameter_description> the name of the stock item.
+</parameter_description>
+</parameter>
+<parameter name="accel_group">
+<parameter_description> the #GtkAccelGroup to add the menu items
+accelerator to, or %NULL.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkStatusIcon
-
+<return> a new #GtkImageMenuItem.
</return>
</function>
-<function name="gtk_text_iter_is_cursor_position">
+<function name="gtk_image_menu_item_new_with_label">
<description>
-See gtk_text_iter_forward_cursor_position() or #PangoLogAttr or
-pango_break() for details on what a cursor position is.
-
+Creates a new #GtkImageMenuItem containing a label.
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="label">
+<parameter_description> the text of the menu item.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the cursor can be placed at @iter
+<return> a new #GtkImageMenuItem.
</return>
</function>
-<function name="gtk_adjustment_set_page_increment">
+<function name="gtk_image_menu_item_new_with_mnemonic">
<description>
-Sets the page increment of the adjustment.
-
-See gtk_adjustment_set_lower() about how to compress multiple
-emissions of the "changed" signal when setting multiple adjustment
-properties.
-
-Since: 2.14
+Creates a new #GtkImageMenuItem containing a label. The label
+will be created using gtk_label_new_with_mnemonic(), so underscores
+in @label indicate the mnemonic for the menu item.
</description>
<parameters>
-<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
-</parameter_description>
-</parameter>
-<parameter name="page_increment">
-<parameter_description> the new page increment
+<parameter name="label">
+<parameter_description> the text of the menu item, with an underscore in front of the
+mnemonic character
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GtkImageMenuItem
+</return>
</function>
-<function name="gtk_text_iter_get_attributes">
+<function name="gtk_image_menu_item_set_accel_group">
<description>
-Computes the effect of any tags applied to this spot in the
-text. The @values parameter should be initialized to the default
-settings you wish to use if no tags are in effect. You'd typically
-obtain the defaults from gtk_text_view_get_default_attributes().
+Specifies an @accel_group to add the menu items accelerator to
+(this only applies to stock items so a stock item must already
+be set, make sure to call gtk_image_menu_item_set_use_stock()
+and gtk_menu_item_set_label() with a valid stock item first).
-gtk_text_iter_get_attributes () will modify @values, applying the
-effects of any tags present at @iter. If any tags affected @values,
-the function returns %TRUE.
+If you want this menu item to have changeable accelerators then
+you shouldnt need this (see gtk_image_menu_item_new_from_stock()).
+Since: 2.16
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
+<parameter name="image_menu_item">
+<parameter_description> a #GtkImageMenuItem
</parameter_description>
</parameter>
-<parameter name="values">
-<parameter_description> a #GtkTextAttributes to be filled in
+<parameter name="accel_group">
+<parameter_description> the #GtkAccelGroup
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @values was modified
-</return>
+<return></return>
</function>
-<function name="gtk_tree_model_filter_set_visible_func">
+<function name="gtk_image_menu_item_set_always_show_image">
<description>
-Sets the visible function used when filtering the @filter to be @func. The
-function should return %TRUE if the given row should be visible and
-%FALSE otherwise.
-
-If the condition calculated by the function changes over time (e.g. because
-it depends on some global parameters), you must call
-gtk_tree_model_filter_refilter() to keep the visibility information of
-the model uptodate.
-
-Note that @func is called whenever a row is inserted, when it may still be
-empty. The visible function should therefore take special care of empty
-rows, like in the example below.
-
-<informalexample><programlisting>
-static gboolean
-visible_func (GtkTreeModel *model,
-GtkTreeIter *iter,
-gpointer data)
-{
-/ * Visible if row is non-empty and first column is "HI" * /
-gchar *str;
-gboolean visible = FALSE;
-
-gtk_tree_model_get (model, iter, 0, &str, -1);
-if (str && strcmp (str, "HI") == 0)
-visible = TRUE;
-g_free (str);
+If %TRUE, the menu item will ignore the #GtkSettings:gtk-menu-images
+setting and always show the image, if available.
-return visible;
-}
-</programlisting></informalexample>
+Use this property if the menuitem would be useless or hard to use
+without the image.
-Since: 2.4
+Since: 2.16
</description>
<parameters>
-<parameter name="filter">
-<parameter_description> A #GtkTreeModelFilter.
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> A #GtkTreeModelFilterVisibleFunc, the visible function.
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> User data to pass to the visible function, or %NULL.
+<parameter name="image_menu_item">
+<parameter_description> a #GtkImageMenuItem
</parameter_description>
</parameter>
-<parameter name="destroy">
-<parameter_description> Destroy notifier of @data, or %NULL.
+<parameter name="always_show">
+<parameter_description> %TRUE if the menuitem should always show the image
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_get_iter_at_line_index">
+<function name="gtk_image_menu_item_set_image">
<description>
-Obtains an iterator pointing to @byte_index within the given line.
- byte_index must be the start of a UTF-8 character, and must not be
-beyond the end of the line. Note <emphasis>bytes</emphasis>, not
-characters; UTF-8 may encode one character as multiple bytes.
+Sets the image of @image_menu_item to the given widget.
+Note that it depends on the show-menu-images setting whether
+the image will be displayed or not.
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="image_menu_item">
+<parameter_description> a #GtkImageMenuItem.
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> iterator to initialize
+<parameter name="image">
+<parameter_description> a widget to set as the image for the menu item.
</parameter_description>
</parameter>
-<parameter name="line_number">
-<parameter_description> line number counting from 0
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_image_menu_item_set_use_stock">
+<description>
+If %TRUE, the label set in the menuitem is used as a
+stock id to select the stock item for the item.
+
+Since: 2.16
+
+</description>
+<parameters>
+<parameter name="image_menu_item">
+<parameter_description> a #GtkImageMenuItem
</parameter_description>
</parameter>
-<parameter name="byte_index">
-<parameter_description> byte index from start of line
+<parameter name="use_stock">
+<parameter_description> %TRUE if the menuitem should use a stock item
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tool_item_get_visible_horizontal">
+<function name="gtk_image_new">
<description>
-Returns whether the @tool_item is visible on toolbars that are
-docked horizontally.
+Creates a new empty #GtkImage widget.
-Since: 2.4
</description>
<parameters>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem
-</parameter_description>
-</parameter>
</parameters>
-<return> %TRUE if @tool_item is visible on toolbars that are
-docked horizontally.
-
+<return> a newly created #GtkImage widget.
</return>
</function>
-<function name="gtk_cell_layout_clear_attributes">
+<function name="gtk_image_new_from_animation">
<description>
-Clears all existing attributes previously set with
-gtk_cell_layout_set_attributes().
+Creates a #GtkImage displaying the given animation.
+The #GtkImage does not assume a reference to the
+animation; you still need to unref it if you own references.
+#GtkImage will add its own reference rather than adopting yours.
+
+Note that the animation frames are shown using a timeout with
+#G_PRIORITY_DEFAULT. When using animations to indicate busyness,
+keep in mind that the animation will only be shown if the main loop
+is not busy with something that has a higher priority.
-Since: 2.4
</description>
<parameters>
-<parameter name="cell_layout">
-<parameter_description> A #GtkCellLayout.
-</parameter_description>
-</parameter>
-<parameter name="cell">
-<parameter_description> A #GtkCellRenderer to clear the attribute mapping on.
+<parameter name="animation">
+<parameter_description> an animation
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GtkImage widget
+</return>
</function>
-<function name="gtk_icon_size_register">
+<function name="gtk_image_new_from_file">
<description>
-Registers a new icon size, along the same lines as #GTK_ICON_SIZE_MENU,
-etc. Returns the integer value for the size.
+Creates a new #GtkImage displaying the file @filename. If the file
+isn't found or can't be loaded, the resulting #GtkImage will
+display a "broken image" icon. This function never returns %NULL,
+it always returns a valid #GtkImage widget.
+
+If the file contains an animation, the image will contain an
+animation.
+
+If you need to detect failures to load the file, use
+gdk_pixbuf_new_from_file() to load the file yourself, then create
+the #GtkImage from the pixbuf. (Or for animations, use
+gdk_pixbuf_animation_new_from_file()).
+
+The storage type (gtk_image_get_storage_type()) of the returned
+image is not defined, it will be whatever is appropriate for
+displaying the file.
</description>
<parameters>
-<parameter name="name">
-<parameter_description> name of the icon size
+<parameter name="filename">
+<parameter_description> a filename
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> the icon width
+</parameters>
+<return> a new #GtkImage
+</return>
+</function>
+
+<function name="gtk_image_new_from_gicon">
+<description>
+Creates a #GtkImage displaying an icon from the current icon theme.
+If the icon name isn't known, a "broken image" icon will be
+displayed instead. If the current icon theme is changed, the icon
+will be updated appropriately.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="icon">
+<parameter_description> an icon
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> the icon height
+<parameter name="size">
+<parameter_description> a stock icon size
</parameter_description>
</parameter>
</parameters>
-<return> integer value representing the size
+<return> a new #GtkImage displaying the themed icon
+
</return>
</function>
-<function name="gtk_tool_item_new">
+<function name="gtk_image_new_from_icon_name">
<description>
-Creates a new #GtkToolItem
+Creates a #GtkImage displaying an icon from the current icon theme.
+If the icon name isn't known, a "broken image" icon will be
+displayed instead. If the current icon theme is changed, the icon
+will be updated appropriately.
-Since: 2.4
+Since: 2.6
</description>
<parameters>
+<parameter name="icon_name">
+<parameter_description> an icon name
+</parameter_description>
+</parameter>
+<parameter name="size">
+<parameter_description> a stock icon size
+</parameter_description>
+</parameter>
</parameters>
-<return> the new #GtkToolItem
+<return> a new #GtkImage displaying the themed icon
</return>
</function>
-<function name="gtk_button_get_alignment">
+<function name="gtk_image_new_from_icon_set">
<description>
-Gets the alignment of the child in the button.
+Creates a #GtkImage displaying an icon set. Sample stock sizes are
+#GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_SMALL_TOOLBAR. Instead of using
+this function, usually it's better to create a #GtkIconFactory, put
+your icon sets in the icon factory, add the icon factory to the
+list of default factories with gtk_icon_factory_add_default(), and
+then use gtk_image_new_from_stock(). This will allow themes to
+override the icon you ship with your application.
+
+The #GtkImage does not assume a reference to the
+icon set; you still need to unref it if you own references.
+#GtkImage will add its own reference rather than adopting yours.
-Since: 2.4
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkButton
-</parameter_description>
-</parameter>
-<parameter name="xalign">
-<parameter_description> return location for horizontal alignment
+<parameter name="icon_set">
+<parameter_description> a #GtkIconSet
</parameter_description>
</parameter>
-<parameter name="yalign">
-<parameter_description> return location for vertical alignment
+<parameter name="size">
+<parameter_description> a stock icon size
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GtkImage
+</return>
</function>
-<function name="gtk_tree_view_set_search_column">
+<function name="gtk_image_new_from_image">
<description>
-Sets @column as the column where the interactive search code should
-search in for the current model.
-
-If the search column is set, users can use the "start-interactive-search"
-key binding to bring up search popup. The enable-search property controls
-whether simply typing text will also start an interactive search.
+Creates a #GtkImage widget displaying a @image with a @mask.
+A #GdkImage is a client-side image buffer in the pixel format of the
+current display. The #GtkImage does not assume a reference to the
+image or mask; you still need to unref them if you own references.
+#GtkImage will add its own reference rather than adopting yours.
-Note that @column refers to a column of the current model. The search
-column is reset to -1 when the model is changed.
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView
+<parameter name="image">
+<parameter_description> a #GdkImage, or %NULL
</parameter_description>
</parameter>
-<parameter name="column">
-<parameter_description> the column of the model to search in, or -1 to disable searching
+<parameter name="mask">
+<parameter_description> a #GdkBitmap, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GtkImage
+</return>
</function>
-<function name="gtk_old_editable_changed">
+<function name="gtk_image_new_from_pixbuf">
<description>
-Emits the ::changed signal on @old_editable.
+Creates a new #GtkImage displaying @pixbuf.
+The #GtkImage does not assume a reference to the
+pixbuf; you still need to unref it if you own references.
+#GtkImage will add its own reference rather than adopting yours.
+
+Note that this function just creates an #GtkImage from the pixbuf. The
+#GtkImage created will not react to state changes. Should you want that,
+you should use gtk_image_new_from_icon_set().
+
</description>
<parameters>
-<parameter name="old_editable">
-<parameter_description> a #GtkOldEditable
+<parameter name="pixbuf">
+<parameter_description> a #GdkPixbuf, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GtkImage
+</return>
</function>
-<function name="gtk_clipboard_store">
+<function name="gtk_image_new_from_pixmap">
<description>
-Stores the current clipboard data somewhere so that it will stay
-around after the application has quit.
+Creates a #GtkImage widget displaying @pixmap with a @mask.
+A #GdkPixmap is a server-side image buffer in the pixel format of the
+current display. The #GtkImage does not assume a reference to the
+pixmap or mask; you still need to unref them if you own references.
+#GtkImage will add its own reference rather than adopting yours.
-Since: 2.6
</description>
<parameters>
-<parameter name="clipboard">
-<parameter_description> a #GtkClipboard
+<parameter name="pixmap">
+<parameter_description> a #GdkPixmap, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="mask">
+<parameter_description> a #GdkBitmap, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GtkImage
+</return>
</function>
-<function name="gtk_text_buffer_get_insert">
+<function name="gtk_image_new_from_stock">
<description>
-Returns the mark that represents the cursor (insertion point).
-Equivalent to calling gtk_text_buffer_get_mark() to get the mark
-named "insert", but very slightly more efficient, and involves less
-typing.
+Creates a #GtkImage displaying a stock icon. Sample stock icon
+names are #GTK_STOCK_OPEN, #GTK_STOCK_QUIT. Sample stock sizes
+are #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_SMALL_TOOLBAR. If the stock
+icon name isn't known, the image will be empty.
+You can register your own stock icon names, see
+gtk_icon_factory_add_default() and gtk_icon_factory_add().
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="stock_id">
+<parameter_description> a stock icon name
+</parameter_description>
+</parameter>
+<parameter name="size">
+<parameter_description> a stock icon size
</parameter_description>
</parameter>
</parameters>
-<return> insertion point mark
+<return> a new #GtkImage displaying the stock icon
</return>
</function>
-<function name="gtk_box_pack_start">
+<function name="gtk_image_set">
<description>
-Adds @child to @box, packed with reference to the start of @box.
-The @child is packed after any other child packed with reference
-to the start of @box.
+Sets the #GtkImage.
+
+Deprecated: 2.0: Use gtk_image_set_from_image() instead.
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #GtkBox
+<parameter name="image">
+<parameter_description> a #GtkImage
</parameter_description>
</parameter>
-<parameter name="child">
-<parameter_description> the #GtkWidget to be added to @box
+<parameter name="val">
+<parameter_description> a #GdkImage
</parameter_description>
</parameter>
-<parameter name="expand">
-<parameter_description> %TRUE if the new child is to be given extra space allocated to
- box The extra space will be divided evenly between all children of
- box that use this option
+<parameter name="mask">
+<parameter_description> a #GdkBitmap that indicates which parts of the image should be transparent.
</parameter_description>
</parameter>
-<parameter name="fill">
-<parameter_description> %TRUE if space given to @child by the @expand option is
-actually allocated to @child, rather than just padding it. This
-parameter has no effect if @expand is set to %FALSE. A child is
-always allocated the full height of a #GtkHBox and the full width
-of a #GtkVBox. This option affects the other dimension
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_image_set_from_animation">
+<description>
+Causes the #GtkImage to display the given animation (or display
+nothing, if you set the animation to %NULL).
+
+</description>
+<parameters>
+<parameter name="image">
+<parameter_description> a #GtkImage
</parameter_description>
</parameter>
-<parameter name="padding">
-<parameter_description> extra space in pixels to put between this child and its
-neighbors, over and above the global amount specified by
-#GtkBox:spacing property. If @child is a widget at one of the
-reference ends of @box, then @padding pixels are also put between
- child and the reference edge of @box
+<parameter name="animation">
+<parameter_description> the #GdkPixbufAnimation
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_entry_set_buffer">
+<function name="gtk_image_set_from_file">
<description>
-Set the #GtkEntryBuffer object which holds the text for
-this widget.
-
-Since: 2.18
+See gtk_image_new_from_file() for details.
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="image">
+<parameter_description> a #GtkImage
</parameter_description>
</parameter>
-<parameter name="buffer">
-<parameter_description> a #GtkEntryBuffer
+<parameter name="filename">
+<parameter_description> a filename or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_destroy">
+<function name="gtk_image_set_from_gicon">
<description>
-Destroys a widget. Equivalent to gtk_object_destroy(), except that
-you don't have to cast the widget to #GtkObject. When a widget is
-destroyed, it will break any references it holds to other objects.
-If the widget is inside a container, the widget will be removed
-from the container. If the widget is a toplevel (derived from
-#GtkWindow), it will be removed from the list of toplevels, and the
-reference GTK+ holds to it will be removed. Removing a
-widget from its container or the list of toplevels results in the
-widget being finalized, unless you've added additional references
-to the widget with g_object_ref().
+See gtk_image_new_from_gicon() for details.
-In most cases, only toplevel widgets (windows) require explicit
-destruction, because when you destroy a toplevel its children will
-be destroyed as well.
+Since: 2.14
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="image">
+<parameter_description> a #GtkImage
+</parameter_description>
+</parameter>
+<parameter name="icon">
+<parameter_description> an icon
+</parameter_description>
+</parameter>
+<parameter name="size">
+<parameter_description> an icon size
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_path_is_ancestor">
+<function name="gtk_image_set_from_icon_name">
<description>
-Returns %TRUE if @descendant is a descendant of @path.
+See gtk_image_new_from_icon_name() for details.
+Since: 2.6
</description>
<parameters>
-<parameter name="path">
-<parameter_description> a #GtkTreePath
+<parameter name="image">
+<parameter_description> a #GtkImage
</parameter_description>
</parameter>
-<parameter name="descendant">
-<parameter_description> another #GtkTreePath
+<parameter name="icon_name">
+<parameter_description> an icon name
+</parameter_description>
+</parameter>
+<parameter name="size">
+<parameter_description> an icon size
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @descendant is contained inside @path
-</return>
+<return></return>
</function>
-<function name="gtk_tree_drag_source_drag_data_get">
+<function name="gtk_image_set_from_icon_set">
<description>
-Asks the #GtkTreeDragSource to fill in @selection_data with a
-representation of the row at @path. @selection_data->target gives
-the required type of the data. Should robustly handle a @path no
-longer found in the model!
-
+See gtk_image_new_from_icon_set() for details.
</description>
<parameters>
-<parameter name="drag_source">
-<parameter_description> a #GtkTreeDragSource
+<parameter name="image">
+<parameter_description> a #GtkImage
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> row that was dragged
+<parameter name="icon_set">
+<parameter_description> a #GtkIconSet
</parameter_description>
</parameter>
-<parameter name="selection_data">
-<parameter_description> a #GtkSelectionData to fill with data from the dragged row
+<parameter name="size">
+<parameter_description> a stock icon size
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if data of the required type was provided
-</return>
+<return></return>
</function>
-<function name="gtk_text_iter_forward_to_tag_toggle">
+<function name="gtk_image_set_from_image">
<description>
-Moves forward to the next toggle (on or off) of the
-#GtkTextTag @tag, or to the next toggle of any tag if
- tag is %NULL. If no matching tag toggles are found,
-returns %FALSE, otherwise %TRUE. Does not return toggles
-located at @iter, only toggles after @iter. Sets @iter to
-the location of the toggle, or to the end of the buffer
-if no toggle is found.
-
+See gtk_image_new_from_image() for details.
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="image">
+<parameter_description> a #GtkImage
</parameter_description>
</parameter>
-<parameter name="tag">
-<parameter_description> a #GtkTextTag, or %NULL
+<parameter name="gdk_image">
+<parameter_description> a #GdkImage or %NULL
+</parameter_description>
+</parameter>
+<parameter name="mask">
+<parameter_description> a #GdkBitmap or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> whether we found a tag toggle after @iter
-</return>
+<return></return>
</function>
-<function name="gtk_tooltip_trigger_tooltip_query">
+<function name="gtk_image_set_from_pixbuf">
<description>
-Triggers a new tooltip query on @display, in order to update the current
-visible tooltip, or to show/hide the current tooltip. This function is
-useful to call when, for example, the state of the widget changed by a
-key press.
-
-Since: 2.12
+See gtk_image_new_from_pixbuf() for details.
</description>
<parameters>
-<parameter name="display">
-<parameter_description> a #GdkDisplay
+<parameter name="image">
+<parameter_description> a #GtkImage
+</parameter_description>
+</parameter>
+<parameter name="pixbuf">
+<parameter_description> a #GdkPixbuf or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_deserialize_set_can_create_tags">
+<function name="gtk_image_set_from_pixmap">
<description>
-Use this function to allow a rich text deserialization function to
-create new tags in the receiving buffer. Note that using this
-function is almost always a bad idea, because the rich text
-functions you register should know how to map the rich text format
-they handler to your text buffers set of tags.
-
-The ability of creating new (arbitrary!) tags in the receiving buffer
-is meant for special rich text formats like the internal one that
-is registered using gtk_text_buffer_register_deserialize_tagset(),
-because that format is essentially a dump of the internal structure
-of the source buffer, including its tag names.
-
-You should allow creation of tags only if you know what you are
-doing, e.g. if you defined a tagset name for your application
-suite's text buffers and you know that it's fine to receive new
-tags from these buffers, because you know that your application can
-handle the newly created tags.
-
-Since: 2.10
+See gtk_image_new_from_pixmap() for details.
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="image">
+<parameter_description> a #GtkImage
</parameter_description>
</parameter>
-<parameter name="format">
-<parameter_description> a #GdkAtom representing a registered rich text format
+<parameter name="pixmap">
+<parameter_description> a #GdkPixmap or %NULL
</parameter_description>
</parameter>
-<parameter name="can_create_tags">
-<parameter_description> whether deserializing this format may create tags
+<parameter name="mask">
+<parameter_description> a #GdkBitmap or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_get_child_requisition">
+<function name="gtk_image_set_from_stock">
<description>
-This function is only for use in widget implementations. Obtains
- widget->requisition, unless someone has forced a particular
-geometry on the widget (e.g. with gtk_widget_set_size_request()),
-in which case it returns that geometry instead of the widget's
-requisition.
-
-This function differs from gtk_widget_size_request() in that
-it retrieves the last size request value from @widget->requisition,
-while gtk_widget_size_request() actually calls the "size_request" method
-on @widget to compute the size request and fill in @widget->requisition,
-and only then returns @widget->requisition.
-
-Because this function does not call the "size_request" method, it
-can only be used when you know that @widget->requisition is
-up-to-date, that is, gtk_widget_size_request() has been called
-since the last time a resize was queued. In general, only container
-implementations have this information; applications should use
-gtk_widget_size_request().
+See gtk_image_new_from_stock() for details.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="image">
+<parameter_description> a #GtkImage
</parameter_description>
</parameter>
-<parameter name="requisition">
-<parameter_description> a #GtkRequisition to be filled in
+<parameter name="stock_id">
+<parameter_description> a stock icon name
+</parameter_description>
+</parameter>
+<parameter name="size">
+<parameter_description> a stock icon size
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_entry_set_progress_pulse_step">
+<function name="gtk_image_set_pixel_size">
<description>
-Sets the fraction of total entry width to move the progress
-bouncing block for each call to gtk_entry_progress_pulse().
+Sets the pixel size to use for named icons. If the pixel size is set
+to a value != -1, it is used instead of the icon size set by
+gtk_image_set_from_icon_name().
-Since: 2.16
+Since: 2.6
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="image">
+<parameter_description> a #GtkImage
</parameter_description>
</parameter>
-<parameter name="fraction">
-<parameter_description> fraction between 0.0 and 1.0
+<parameter name="pixel_size">
+<parameter_description> the new pixel size
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_rc_find_module_in_path">
+<function name="gtk_info_bar_add_action_widget">
<description>
-Searches for a theme engine in the GTK+ search path. This function
-is not useful for applications and should not be used.
+Add an activatable widget to the action area of a #GtkInfoBar,
+connecting a signal handler that will emit the #GtkInfoBar::response
+signal on the message area when the widget is activated. The widget
+is appended to the end of the message areas action area.
+Since: 2.18
</description>
<parameters>
-<parameter name="module_file">
-<parameter_description> name of a theme engine
+<parameter name="info_bar">
+<parameter_description> a #GtkInfoBar
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> an activatable widget
+</parameter_description>
+</parameter>
+<parameter name="response_id">
+<parameter_description> response ID for @child
</parameter_description>
</parameter>
</parameters>
-<return> The filename, if found (must be freed with g_free()),
-otherwise %NULL.
-</return>
+<return></return>
</function>
-<function name="gtk_menu_item_set_label">
+<function name="gtk_info_bar_add_button">
<description>
-Sets @text on the @menu_item label
+Adds a button with the given text (or a stock button, if button_text
+is a stock ID) and sets things up so that clicking the button will emit
+the "response" signal with the given response_id. The button is appended
+to the end of the info bars's action area. The button widget is
+returned, but usually you don't need it.
-Since: 2.16
+Since: 2.18
</description>
<parameters>
-<parameter name="menu_item">
-<parameter_description> a #GtkMenuItem
+<parameter name="info_bar">
+<parameter_description> a #GtkInfoBar
</parameter_description>
</parameter>
-<parameter name="label">
-<parameter_description> the text you want to set
+<parameter name="button_text">
+<parameter_description> text of button, or stock ID
+</parameter_description>
+</parameter>
+<parameter name="response_id">
+<parameter_description> response ID for the button
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the button widget that was added
+
+</return>
</function>
-<function name="gtk_arrow_set">
+<function name="gtk_info_bar_add_buttons">
<description>
-Sets the direction and style of the #GtkArrow, @arrow.
+Adds more buttons, same as calling gtk_info_bar_add_button()
+repeatedly. The variable argument list should be %NULL-terminated
+as with gtk_info_bar_new_with_buttons(). Each button must have both
+text and response ID.
+
+Since: 2.18
</description>
<parameters>
-<parameter name="arrow">
-<parameter_description> a widget of type #GtkArrow.
+<parameter name="info_bar">
+<parameter_description> a #GtkInfoBar
</parameter_description>
</parameter>
-<parameter name="arrow_type">
-<parameter_description> a valid #GtkArrowType.
+<parameter name="first_button_text">
+<parameter_description> button text or stock ID
</parameter_description>
</parameter>
-<parameter name="shadow_type">
-<parameter_description> a valid #GtkShadowType.
+<parameter name="Varargs">
+<parameter_description> response ID for first button, then more text-response_id pairs,
+ending with %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_menu_item_get_accel_path">
+<function name="gtk_info_bar_get_action_area">
<description>
-Retrieve the accelerator path that was previously set on @menu_item.
-
-See gtk_menu_item_set_accel_path() for details.
+Returns the action area of @info_bar.
-Since: 2.14
+Since: 2.18
</description>
<parameters>
-<parameter name="menu_item">
-<parameter_description> a valid #GtkMenuItem
+<parameter name="info_bar">
+<parameter_description> a #GtkInfoBar
</parameter_description>
</parameter>
</parameters>
-<return> the accelerator path corresponding to this menu item's
-functionality, or %NULL if not set
+<return> the action area
</return>
</function>
-<function name="gtk_print_settings_get_resolution">
+<function name="gtk_info_bar_get_content_area">
<description>
-Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION.
+Returns the content area of @info_bar.
-Since: 2.10
+Since: 2.18
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="info_bar">
+<parameter_description> a #GtkInfoBar
</parameter_description>
</parameter>
</parameters>
-<return> the resolution in dpi
+<return> the content area
</return>
</function>
-<function name="gtk_draw_hline">
+<function name="gtk_info_bar_get_message_type">
<description>
-Draws a horizontal line from (@x1, @y) to (@x2, @y) in @window
-using the given style and state.
+Returns the message type of the message area.
-Deprecated: 2.0: Use gtk_paint_hline() instead.
+Since: 2.18
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
-</parameter_description>
-</parameter>
-<parameter name="x1">
-<parameter_description> the starting x coordinate
-</parameter_description>
-</parameter>
-<parameter name="x2">
-<parameter_description> the ending x coordinate
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> the y coordinate
+<parameter name="info_bar">
+<parameter_description> a #GtkInfoBar
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the message type of the message area.
+
+</return>
</function>
-<function name="gtk_recent_chooser_dialog_new_for_manager">
+<function name="gtk_info_bar_new">
<description>
-Creates a new #GtkRecentChooserDialog with a specified recent manager.
+Creates a new #GtkInfoBar object.
-This is useful if you have implemented your own recent manager, or if you
-have a customized instance of a #GtkRecentManager object.
+Since: 2.18
+
+</description>
+<parameters>
+</parameters>
+<return> a new #GtkInfoBar object
+
+</return>
+</function>
+
+<function name="gtk_info_bar_new_with_buttons">
+<description>
+Creates a new #GtkInfoBar with buttons. Button text/response ID
+pairs should be listed, with a %NULL pointer ending the list.
+Button text can be either a stock ID such as %GTK_STOCK_OK, or
+some arbitrary text. A response ID can be any positive number,
+or one of the values in the #GtkResponseType enumeration. If the
+user clicks one of these dialog buttons, GtkInfoBar will emit
+the "response" signal with the corresponding response ID.
-Since: 2.10
</description>
<parameters>
-<parameter name="title">
-<parameter_description> Title of the dialog, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="parent">
-<parameter_description> Transient parent of the dialog, or %NULL,
-</parameter_description>
-</parameter>
-<parameter name="manager">
-<parameter_description> a #GtkRecentManager
-</parameter_description>
-</parameter>
<parameter name="first_button_text">
-<parameter_description> stock ID or text to go in the first button, or %NULL
+<parameter_description> stock ID or text to go in first button, or %NULL
</parameter_description>
</parameter>
<parameter name="Varargs">
-<parameter_description> response ID for the first button, then additional (button, id)
-pairs, ending with %NULL
+<parameter_description> response ID for first button, then additional buttons, ending
+with %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkRecentChooserDialog
-
+<return> a new #GtkInfoBar
</return>
</function>
-<function name="gtk_image_get_image">
+<function name="gtk_info_bar_response">
<description>
-Gets the #GdkImage and mask being displayed by the #GtkImage.
-The storage type of the image must be %GTK_IMAGE_EMPTY or
-%GTK_IMAGE_IMAGE (see gtk_image_get_storage_type()).
-The caller of this function does not own a reference to the
-returned image and mask.
+Emits the 'response' signal with the given @response_id.
+
+Since: 2.18
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GtkImage
-</parameter_description>
-</parameter>
-<parameter name="gdk_image">
-<parameter_description> return location for
-a #GtkImage, or %NULL
+<parameter name="info_bar">
+<parameter_description> a #GtkInfoBar
</parameter_description>
</parameter>
-<parameter name="mask">
-<parameter_description> return location for a
-#GdkBitmap, or %NULL
+<parameter name="response_id">
+<parameter_description> a response ID
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_group_add_window">
+<function name="gtk_info_bar_set_default_response">
<description>
-Adds a window to a #GtkWindowGroup.
+Sets the last widget in the info bar's action area with
+the given response_id as the default widget for the dialog.
+Pressing "Enter" normally activates the default widget.
+
+Note that this function currently requires @info_bar to
+be added to a widget hierarchy.
+
+Since: 2.18
</description>
<parameters>
-<parameter name="window_group">
-<parameter_description> a #GtkWindowGroup
+<parameter name="info_bar">
+<parameter_description> a #GtkInfoBar
</parameter_description>
</parameter>
-<parameter name="window">
-<parameter_description> the #GtkWindow to add
+<parameter name="response_id">
+<parameter_description> a response ID
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_status_icon_set_visible">
+<function name="gtk_info_bar_set_message_type">
<description>
-Shows or hides a status icon.
+Sets the message type of the message area.
+GTK+ uses this type to determine what color to use
+when drawing the message area.
-Since: 2.10
+Since: 2.18
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
+<parameter name="info_bar">
+<parameter_description> a #GtkInfoBar
</parameter_description>
</parameter>
-<parameter name="visible">
-<parameter_description> %TRUE to show the status icon, %FALSE to hide it
+<parameter name="message_type">
+<parameter_description> a #GtkMessageType
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_set_auto_startup_notification">
+<function name="gtk_info_bar_set_response_sensitive">
<description>
-By default, after showing the first #GtkWindow, GTK+ calls
-gdk_notify_startup_complete(). Call this function to disable
-the automatic startup notification. You might do this if your
-first window is a splash screen, and you want to delay notification
-until after your real main window has been shown, for example.
-
-In that example, you would disable startup notification
-temporarily, show your splash screen, then re-enable it so that
-showing the main window would automatically result in notification.
+Calls gtk_widget_set_sensitive (widget, setting) for each
+widget in the info bars's action area with the given response_id.
+A convenient way to sensitize/desensitize dialog buttons.
-Since: 2.2
+Since: 2.18
</description>
<parameters>
+<parameter name="info_bar">
+<parameter_description> a #GtkInfoBar
+</parameter_description>
+</parameter>
+<parameter name="response_id">
+<parameter_description> a response ID
+</parameter_description>
+</parameter>
<parameter name="setting">
-<parameter_description> %TRUE to automatically do startup notification
+<parameter_description> TRUE for sensitive
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_rc_get_im_module_file">
+<function name="gtk_init">
<description>
-Obtains the path to the IM modules file. See the documentation
-of the <link linkend="im-module-file"><envar>GTK_IM_MODULE_FILE</envar></link>
-environment variable for more details.
+Call this function before using any other GTK+ functions in your GUI
+applications. It will initialize everything needed to operate the
+toolkit and parses some standard command line options.
-</description>
-<parameters>
-</parameters>
-<return> a newly-allocated string containing the name of the file
-listing the IM modules available for loading
-</return>
-</function>
+ argc and @argv are adjusted accordingly so your own code will
+never see those standard arguments.
-<function name="gtk_text_iter_get_pixbuf">
-<description>
-If the element at @iter is a pixbuf, the pixbuf is returned
-(with no new reference count added). Otherwise,
-%NULL is returned.
+Note that there are some alternative ways to initialize GTK+:
+if you are calling gtk_parse_args(), gtk_init_check(),
+gtk_init_with_args() or g_option_context_parse() with
+the option group returned by gtk_get_option_group(),
+you <emphasis>don't</emphasis> have to call gtk_init().
+<note><para>
+This function will terminate your program if it was unable to
+initialize the windowing system for some reason. If you want
+your program to fall back to a textual interface you want to
+call gtk_init_check() instead.
+</para></note>
+
+<note><para>
+Since 2.18, GTK+ calls <literal>signal (SIGPIPE, SIG_IGN)</literal>
+during initialization, to ignore SIGPIPE signals, since these are
+almost never wanted in graphical applications. If you do need to
+handle SIGPIPE for some reason, reset the handler after gtk_init(),
+but notice that other libraries (e.g. libdbus or gvfs) might do
+similar things.
+</para></note>
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
+<parameter name="argc">
+<parameter_description> Address of the <parameter>argc</parameter> parameter of
+your main() function. Changed if any arguments were handled
+</parameter_description>
+</parameter>
+<parameter name="argv">
+<parameter_description> Address of the
+<parameter>argv</parameter> parameter of main(). Any options
+understood by GTK+ are stripped before return.
</parameter_description>
</parameter>
</parameters>
-<return> the pixbuf at @iter
-</return>
+<return></return>
</function>
-<function name="gtk_page_setup_get_page_width">
+<function name="gtk_init_check">
<description>
-Returns the page width in units of @unit.
+This function does the same work as gtk_init() with only
+a single change: It does not terminate the program if the GUI can't be
+initialized. Instead it returns %FALSE on failure.
-Note that this function takes orientation and
-margins into consideration.
-See gtk_page_setup_get_paper_width().
+This way the application can fall back to some other means of communication
+with the user - for example a curses or command line interface.
-Since: 2.10
</description>
<parameters>
-<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter name="argc">
+<parameter_description> Address of the <parameter>argc</parameter> parameter of your
+main() function. Changed if any arguments were handled.
</parameter_description>
</parameter>
-<parameter name="unit">
-<parameter_description> the unit for the return value
+<parameter name="argv">
+<parameter_description> Address of the <parameter>argv</parameter> parameter of main().
+Any parameters understood by gtk_init() are stripped before return.
</parameter_description>
</parameter>
</parameters>
-<return> the page width.
-
+<return> %TRUE if the GUI has been successfully initialized,
+%FALSE otherwise.
</return>
</function>
-<function name="gtk_printer_get_location">
+<function name="gtk_init_with_args">
<description>
-Returns a description of the location of the printer.
+This function does the same work as gtk_init_check().
+Additionally, it allows you to add your own commandline options,
+and it automatically generates nicely formatted
+<option>--help</option> output. Note that your program will
+be terminated after writing out the help output.
-Since: 2.10
+Since: 2.6
</description>
<parameters>
-<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter name="argc">
+<parameter_description> a pointer to the number of command line arguments.
</parameter_description>
</parameter>
-</parameters>
-<return> the location of @printer
-
-</return>
-</function>
-
-<function name="gtk_range_set_slider_size_fixed">
-<description>
-Sets whether the range's slider has a fixed size, or a size that
-depends on it's adjustment's page size.
-
-This function is useful mainly for #GtkRange subclasses.
-
-Since: 2.20
-
-</description>
-<parameters>
-<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter name="argv">
+<parameter_description> a pointer to the array of command line arguments.
</parameter_description>
</parameter>
-<parameter name="size_fixed">
-<parameter_description> %TRUE to make the slider size constant
+<parameter name="parameter_string">
+<parameter_description> a string which is displayed in
+the first line of <option>--help</option> output, after
+<literal><replaceable>programname</replaceable> [OPTION...]</literal>
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_icon_info_set_raw_coordinates">
-<description>
-Sets whether the coordinates returned by gtk_icon_info_get_embedded_rect()
-and gtk_icon_info_get_attach_points() should be returned in their
-original form as specified in the icon theme, instead of scaled
-appropriately for the pixbuf returned by gtk_icon_info_load_icon().
-
-Raw coordinates are somewhat strange; they are specified to be with
-respect to the unscaled pixmap for PNG and XPM icons, but for SVG
-icons, they are in a 1000x1000 coordinate space that is scaled
-to the final size of the icon. You can determine if the icon is an SVG
-icon by using gtk_icon_info_get_filename(), and seeing if it is non-%NULL
-and ends in '.svg'.
-
-This function is provided primarily to allow compatibility wrappers
-for older API's, and is not expected to be useful for applications.
-
-Since: 2.4
-
-</description>
-<parameters>
-<parameter name="icon_info">
-<parameter_description> a #GtkIconInfo
+<parameter name="entries">
+<parameter_description> a %NULL-terminated array of #GOptionEntry<!-- -->s
+describing the options of your program
</parameter_description>
</parameter>
-<parameter name="raw_coordinates">
-<parameter_description> whether the coordinates of embedded rectangles
-and attached points should be returned in their original
-(unscaled) form.
+<parameter name="translation_domain">
+<parameter_description> a translation domain to use for translating
+the <option>--help</option> output for the options in @entries
+with gettext(), or %NULL
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a return location for errors
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the GUI has been successfully initialized,
+%FALSE otherwise.
+
+</return>
</function>
-<function name="gtk_tree_view_column_get_sizing">
+<function name="gtk_invisible_get_screen">
<description>
-Returns the current type of @tree_column.
+Returns the #GdkScreen object associated with @invisible
+Since: 2.2
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn.
+<parameter name="invisible">
+<parameter_description> a #GtkInvisible.
</parameter_description>
</parameter>
</parameters>
-<return> The type of @tree_column.
+<return> the associated #GdkScreen.
+
</return>
</function>
-<function name="gtk_list_store_new">
+<function name="gtk_invisible_new">
<description>
-Creates a new list store as with @n_columns columns each of the types passed
-in. Note that only types derived from standard GObject fundamental types
-are supported.
-
-As an example, <literal>gtk_tree_store_new (3, G_TYPE_INT, G_TYPE_STRING,
-GDK_TYPE_PIXBUF);</literal> will create a new #GtkListStore with three columns, of type
-int, string and #GdkPixbuf respectively.
+Creates a new #GtkInvisible.
</description>
<parameters>
-<parameter name="n_columns">
-<parameter_description> number of columns in the list store
-</parameter_description>
-</parameter>
-<parameter name="Varargs">
-<parameter_description> all #GType types for the columns, from first to last
-</parameter_description>
-</parameter>
</parameters>
-<return> a new #GtkListStore
+<return> a new #GtkInvisible.
</return>
</function>
-<function name="gtk_text_iter_starts_line">
+<function name="gtk_invisible_new_for_screen">
<description>
-Returns %TRUE if @iter begins a paragraph,
-i.e. if gtk_text_iter_get_line_offset () would return 0.
-However this function is potentially more efficient than
-gtk_text_iter_get_line_offset () because it doesn't have to compute
-the offset, it just has to see whether it's 0.
+Creates a new #GtkInvisible object for a specified screen
+Since: 2.2
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
+<parameter name="screen">
+<parameter_description> a #GdkScreen which identifies on which
+the new #GtkInvisible will be created.
</parameter_description>
</parameter>
</parameters>
-<return> whether @iter begins a line
+<return> a newly created #GtkInvisible object
+
</return>
</function>
-<function name="gtk_action_create_menu">
+<function name="gtk_invisible_set_screen">
<description>
-If @action provides a #GtkMenu widget as a submenu for the menu
-item or the toolbar item it creates, this function returns an
-instance of that menu.
+Sets the #GdkScreen where the #GtkInvisible object will be displayed.
-Since: 2.12
+Since: 2.2
</description>
<parameters>
-<parameter name="action">
-<parameter_description> a #GtkAction
+<parameter name="invisible">
+<parameter_description> a #GtkInvisible.
+</parameter_description>
+</parameter>
+<parameter name="screen">
+<parameter_description> a #GdkScreen.
</parameter_description>
</parameter>
</parameters>
-<return> the menu item provided by the action, or %NULL.
-
-</return>
+<return></return>
</function>
-<function name="gtk_paper_size_get_default_top_margin">
+<function name="gtk_item_factories_path_delete">
<description>
-Gets the default top margin for the #GtkPaperSize.
+Deletes all widgets constructed from the specified path.
-Since: 2.10
+Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="size">
-<parameter_description> a #GtkPaperSize object
+<parameter name="ifactory_path">
+<parameter_description> a factory path to prepend to @path. May be %NULL if @path
+starts with a factory path
</parameter_description>
</parameter>
-<parameter name="unit">
-<parameter_description> the unit for the return value
+<parameter name="path">
+<parameter_description> a path
</parameter_description>
</parameter>
</parameters>
-<return> the default top margin
-
-</return>
+<return></return>
</function>
-<function name="gtk_font_selection_new">
+<function name="gtk_item_factory_add_foreign">
<description>
-Creates a new #GtkFontSelection.
+Installs an accelerator for @accel_widget in @accel_group, that causes
+the ::activate signal to be emitted if the accelerator is activated.
+This function can be used to make widgets participate in the accel
+saving/restoring functionality provided by gtk_accel_map_save() and
+gtk_accel_map_load(), even if they haven't been created by an item
+factory.
+
+Deprecated: 2.4: The recommended API for this purpose are the functions
+gtk_menu_item_set_accel_path() and gtk_widget_set_accel_path(); don't
+use gtk_item_factory_add_foreign() in new code, since it is likely to
+be removed in the future.
</description>
<parameters>
+<parameter name="accel_widget">
+<parameter_description> widget to install an accelerator on
+</parameter_description>
+</parameter>
+<parameter name="full_path">
+<parameter_description> the full path for the @accel_widget
+</parameter_description>
+</parameter>
+<parameter name="accel_group">
+<parameter_description> the accelerator group to install the accelerator in
+</parameter_description>
+</parameter>
+<parameter name="keyval">
+<parameter_description> key value of the accelerator
+</parameter_description>
+</parameter>
+<parameter name="modifiers">
+<parameter_description> modifier combination of the accelerator
+</parameter_description>
+</parameter>
</parameters>
-<return> a n ew #GtkFontSelection
-</return>
+<return></return>
</function>
-<function name="gtk_menu_item_get_use_underline">
+<function name="gtk_item_factory_construct">
<description>
-Checks if an underline in the text indicates the next character should be
-used for the mnemonic accelerator key.
+Initializes an item factory.
-Since: 2.16
+Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="menu_item">
-<parameter_description> a #GtkMenuItem
+<parameter name="ifactory">
+<parameter_description> a #GtkItemFactory
+</parameter_description>
+</parameter>
+<parameter name="container_type">
+<parameter_description> the kind of menu to create; can be
+#GTK_TYPE_MENU_BAR, #GTK_TYPE_MENU or #GTK_TYPE_OPTION_MENU
+</parameter_description>
+</parameter>
+<parameter name="path">
+<parameter_description> the factory path of @ifactory, a string of the form
+<literal>"<name>"</literal>
+</parameter_description>
+</parameter>
+<parameter name="accel_group">
+<parameter_description> a #GtkAccelGroup to which the accelerators for the
+menu items will be added, or %NULL to create a new one
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if an embedded underline in the label indicates
-the mnemonic accelerator key.
-
-</return>
+<return></return>
</function>
-<function name="gtk_rc_property_parse_requisition">
+<function name="gtk_item_factory_create_item">
<description>
-A #GtkRcPropertyParser for use with gtk_settings_install_property_parser()
-or gtk_widget_class_install_style_property_parser() which parses a
-requisition in the form
-<literal>"{ width, height }"</literal> for integers %width and %height.
+Creates an item for @entry.
+Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="pspec">
-<parameter_description> a #GParamSpec
+<parameter name="ifactory">
+<parameter_description> a #GtkItemFactory
</parameter_description>
</parameter>
-<parameter name="gstring">
-<parameter_description> the #GString to be parsed
+<parameter name="entry">
+<parameter_description> the #GtkItemFactoryEntry to create an item for
</parameter_description>
</parameter>
-<parameter name="property_value">
-<parameter_description> a #GValue which must hold boxed values.
+<parameter name="callback_data">
+<parameter_description> data passed to the callback function of @entry
+</parameter_description>
+</parameter>
+<parameter name="callback_type">
+<parameter_description> 1 if the callback function of @entry is of type
+#GtkItemFactoryCallback1, 2 if it is of type #GtkItemFactoryCallback2
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @gstring could be parsed and @property_value
-has been set to the resulting #GtkRequisition.
-</return>
+<return></return>
</function>
-<function name="gtk_text_buffer_new">
+<function name="gtk_item_factory_create_items">
<description>
-Creates a new text buffer.
+Creates the menu items from the @entries.
+Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="table">
-<parameter_description> a tag table, or %NULL to create a new one
+<parameter name="ifactory">
+<parameter_description> a #GtkItemFactory
+</parameter_description>
+</parameter>
+<parameter name="n_entries">
+<parameter_description> the length of @entries
+</parameter_description>
+</parameter>
+<parameter name="entries">
+<parameter_description> an array of #GtkItemFactoryEntry<!-- -->s whose @callback members
+must by of type #GtkItemFactoryCallback1
+</parameter_description>
+</parameter>
+<parameter name="callback_data">
+<parameter_description> data passed to the callback functions of all entries
</parameter_description>
</parameter>
</parameters>
-<return> a new text buffer
-</return>
+<return></return>
</function>
-<function name="gtk_adjustment_set_page_size">
+<function name="gtk_item_factory_create_items_ac">
<description>
-Sets the page size of the adjustment.
-
-See gtk_adjustment_set_lower() about how to compress multiple
-emissions of the "changed" signal when setting multiple adjustment
-properties.
+Creates the menu items from the @entries.
-Since: 2.14
+Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
+<parameter name="ifactory">
+<parameter_description> a #GtkItemFactory
</parameter_description>
</parameter>
-<parameter name="page_size">
-<parameter_description> the new page size
+<parameter name="n_entries">
+<parameter_description> the length of @entries
+</parameter_description>
+</parameter>
+<parameter name="entries">
+<parameter_description> an array of #GtkItemFactoryEntry<!-- -->s
+</parameter_description>
+</parameter>
+<parameter name="callback_data">
+<parameter_description> data passed to the callback functions of all entries
+</parameter_description>
+</parameter>
+<parameter name="callback_type">
+<parameter_description> 1 if the callback functions in @entries are of type
+#GtkItemFactoryCallback1, 2 if they are of type #GtkItemFactoryCallback2
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_unix_dialog_get_manual_capabilities">
+<function name="gtk_item_factory_create_menu_entries">
<description>
-Gets the value of #GtkPrintUnixDialog::manual-capabilities property.
+Creates the menu items from the @entries.
-Since: 2.18
+Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter name="n_entries">
+<parameter_description> the length of @entries
+</parameter_description>
+</parameter>
+<parameter name="entries">
+<parameter_description> an array of #GtkMenuEntry<!-- -->s
</parameter_description>
</parameter>
</parameters>
-<return> the printing capabilities
-
-</return>
+<return></return>
</function>
-<function name="gtk_notebook_prev_page">
+<function name="gtk_item_factory_delete_entries">
<description>
-Switches to the previous page. Nothing happens if the current page
-is the first page.
+Deletes the menu items which were created from the @entries by the given
+item factory.
+
+Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="ifactory">
+<parameter_description> a #GtkItemFactory
+</parameter_description>
+</parameter>
+<parameter name="n_entries">
+<parameter_description> the length of @entries
+</parameter_description>
+</parameter>
+<parameter name="entries">
+<parameter_description> an array of #GtkItemFactoryEntry<!-- -->s
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_recent_chooser_set_filter">
+<function name="gtk_item_factory_delete_entry">
<description>
-Sets @filter as the current #GtkRecentFilter object used by @chooser
-to affect the displayed recently used resources.
+Deletes the menu item which was created from @entry by the given
+item factory.
-Since: 2.10
+Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
+<parameter name="ifactory">
+<parameter_description> a #GtkItemFactory
</parameter_description>
</parameter>
-<parameter name="filter">
-<parameter_description> a #GtkRecentFilter
+<parameter name="entry">
+<parameter_description> a #GtkItemFactoryEntry
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_buildable_set_name">
+<function name="gtk_item_factory_delete_item">
<description>
-Sets the name of the @buildable object.
+Deletes the menu item which was created for @path by the given
+item factory.
-Since: 2.12
+Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="buildable">
-<parameter_description> a #GtkBuildable
+<parameter name="ifactory">
+<parameter_description> a #GtkItemFactory
</parameter_description>
</parameter>
-<parameter name="name">
-<parameter_description> name to set
+<parameter name="path">
+<parameter_description> a path
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_rc_style_copy">
+<function name="gtk_item_factory_from_path">
<description>
-Makes a copy of the specified #GtkRcStyle. This function
-will correctly copy an RC style that is a member of a class
-derived from #GtkRcStyle.
+Finds an item factory which has been constructed using the
+<literal>"<name>"</literal> prefix of @path as the @path argument
+for gtk_item_factory_new().
+Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="orig">
-<parameter_description> the style to copy
+<parameter name="path">
+<parameter_description> a string starting with a factory path of the form
+<literal>"<name>"</literal>
</parameter_description>
</parameter>
</parameters>
-<return> the resulting #GtkRcStyle
+<return> the #GtkItemFactory created for the given factory path, or %NULL
</return>
</function>
-<function name="gtk_offscreen_window_new">
+<function name="gtk_item_factory_from_widget">
<description>
-Creates a toplevel container widget that is used to retrieve
-snapshots of widgets without showing them on the screen. For
-widgets that are on the screen and part of a normal widget
-hierarchy, gtk_widget_get_snapshot() can be used instead.
+Obtains the item factory from which a widget was created.
-Since: 2.20
+Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
+<parameter name="widget">
+<parameter_description> a widget
+</parameter_description>
+</parameter>
</parameters>
-<return> A pointer to a #GtkWidget
-
+<return> the item factory from which @widget was created, or %NULL
</return>
</function>
-<function name="gtk_tree_model_iter_parent">
+<function name="gtk_item_factory_get_item">
<description>
-Sets @iter to be the parent of @child. If @child is at the toplevel, and
-doesn't have a parent, then @iter is set to an invalid iterator and %FALSE
-is returned. @child will remain a valid node after this function has been
-called.
+Obtains the menu item which corresponds to @path.
+If the widget corresponding to @path is a menu item which opens a
+submenu, then the item is returned. If you are interested in the submenu,
+use gtk_item_factory_get_widget() instead.
+
+Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="tree_model">
-<parameter_description> A #GtkTreeModel
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> The new #GtkTreeIter to set to the parent.
+<parameter name="ifactory">
+<parameter_description> a #GtkItemFactory
</parameter_description>
</parameter>
-<parameter name="child">
-<parameter_description> The #GtkTreeIter.
+<parameter name="path">
+<parameter_description> the path to the menu item
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE, if @iter is set to the parent of @child.
+<return> the menu item for the given path, or %NULL if @path doesn't
+lead to a menu item
</return>
</function>
-<function name="gtk_tool_item_get_toolbar_style">
+<function name="gtk_item_factory_get_item_by_action">
<description>
-Returns the toolbar style used for @tool_item. Custom subclasses of
-#GtkToolItem should call this function in the handler of the
-GtkToolItem::toolbar_reconfigured signal to find out in what style
-the toolbar is displayed and change themselves accordingly
-
-Possibilities are:
-<itemizedlist>
-<listitem> GTK_TOOLBAR_BOTH, meaning the tool item should show
-both an icon and a label, stacked vertically </listitem>
-<listitem> GTK_TOOLBAR_ICONS, meaning the toolbar shows
-only icons </listitem>
-<listitem> GTK_TOOLBAR_TEXT, meaning the tool item should only
-show text</listitem>
-<listitem> GTK_TOOLBAR_BOTH_HORIZ, meaning the tool item should show
-both an icon and a label, arranged horizontally (however, note the
-#GtkToolButton::has_text_horizontally that makes tool buttons not
-show labels when the toolbar style is GTK_TOOLBAR_BOTH_HORIZ.
-</listitem>
-</itemizedlist>
+Obtains the menu item which was constructed from the first
+#GtkItemFactoryEntry with the given @action.
-Since: 2.4
+Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem
+<parameter name="ifactory">
+<parameter_description> a #GtkItemFactory
+</parameter_description>
+</parameter>
+<parameter name="action">
+<parameter_description> an action as specified in the @callback_action field
+of #GtkItemFactoryEntry
</parameter_description>
</parameter>
</parameters>
-<return> A #GtkToolbarStyle indicating the toolbar style used
-for @tool_item.
-
+<return> the menu item which corresponds to the given action, or %NULL
+if no menu item was found
</return>
</function>
-<function name="gtk_widget_get_toplevel">
+<function name="gtk_item_factory_get_widget">
<description>
-This function returns the topmost widget in the container hierarchy
- widget is a part of. If @widget has no parent widgets, it will be
-returned as the topmost widget. No reference will be added to the
-returned widget; it should not be unreferenced.
-
-Note the difference in behavior vs. gtk_widget_get_ancestor();
-<literal>gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW)</literal>
-would return
-%NULL if @widget wasn't inside a toplevel window, and if the
-window was inside a #GtkWindow-derived widget which was in turn
-inside the toplevel #GtkWindow. While the second case may
-seem unlikely, it actually happens when a #GtkPlug is embedded
-inside a #GtkSocket within the same application.
+Obtains the widget which corresponds to @path.
-To reliably find the toplevel #GtkWindow, use
-gtk_widget_get_toplevel() and check if the %TOPLEVEL flags
-is set on the result.
-|[
-GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
-if (gtk_widget_is_toplevel (toplevel))
-{
-/ * Perform action on toplevel. * /
-}
-]|
+If the widget corresponding to @path is a menu item which opens a
+submenu, then the submenu is returned. If you are interested in the menu
+item, use gtk_item_factory_get_item() instead.
+Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="ifactory">
+<parameter_description> a #GtkItemFactory
+</parameter_description>
+</parameter>
+<parameter name="path">
+<parameter_description> the path to the widget
</parameter_description>
</parameter>
</parameters>
-<return> the topmost ancestor of @widget, or @widget itself
-if there's no ancestor.
+<return> the widget for the given path, or %NULL if @path doesn't lead
+to a widget
</return>
</function>
-<function name="gtk_action_set_visible">
+<function name="gtk_item_factory_get_widget_by_action">
<description>
-Sets the ::visible property of the action to @visible. Note that
-this doesn't necessarily mean effective visibility. See
-gtk_action_is_visible()
-for that.
+Obtains the widget which was constructed from the #GtkItemFactoryEntry
+with the given @action.
-Since: 2.6
+If there are multiple items with the same action, the result is
+undefined.
+
+Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="action">
-<parameter_description> the action object
+<parameter name="ifactory">
+<parameter_description> a #GtkItemFactory
</parameter_description>
</parameter>
-<parameter name="visible">
-<parameter_description> %TRUE to make the action visible
+<parameter name="action">
+<parameter_description> an action as specified in the @callback_action field
+of #GtkItemFactoryEntry
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the widget which corresponds to the given action, or %NULL
+if no widget was found
+</return>
</function>
-<function name="gtk_printer_get_backend">
+<function name="gtk_item_factory_new">
<description>
-Returns the backend of the printer.
+Creates a new #GtkItemFactory.
-Since: 2.10
+Beware that the returned object does not have a floating reference.
+
+Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter name="container_type">
+<parameter_description> the kind of menu to create; can be
+#GTK_TYPE_MENU_BAR, #GTK_TYPE_MENU or #GTK_TYPE_OPTION_MENU
+</parameter_description>
+</parameter>
+<parameter name="path">
+<parameter_description> the factory path of the new item factory, a string of the form
+<literal>"<name>"</literal>
+</parameter_description>
+</parameter>
+<parameter name="accel_group">
+<parameter_description> a #GtkAccelGroup to which the accelerators for the
+menu items will be added, or %NULL to create a new one
</parameter_description>
</parameter>
</parameters>
-<return> the backend of @printer
-
+<return> a new #GtkItemFactory
</return>
</function>
-<function name="gtk_window_get_accept_focus">
+<function name="gtk_item_factory_path_from_widget">
<description>
-Gets the value set by gtk_window_set_accept_focus().
+If @widget has been created by an item factory, returns the full path
+to it. (The full path of a widget is the concatenation of the factory
+path specified in gtk_item_factory_new() with the path specified in the
+#GtkItemFactoryEntry from which the widget was created.)
-Since: 2.4
+Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="widget">
+<parameter_description> a widget
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if window should receive the input focus
-
+<return> the full path to @widget if it has been created by an item
+factory, %NULL otherwise. This value is owned by GTK+ and must not be
+modified or freed.
</return>
</function>
-<function name="gtk_dialog_set_alternative_button_order_from_array">
+<function name="gtk_item_factory_popup">
<description>
-Sets an alternative button order. If the
-#GtkSettings:gtk-alternative-button-order setting is set to %TRUE,
-the dialog buttons are reordered according to the order of the
-response ids in @new_order.
+Pops up the menu constructed from the item factory at (@x, @y).
-See gtk_dialog_set_alternative_button_order() for more information.
+The @mouse_button parameter should be the mouse button pressed to initiate
+the menu popup. If the menu popup was initiated by something other than
+a mouse button press, such as a mouse button release or a keypress,
+ mouse_button should be 0.
-This function is for use by language bindings.
+The @time_ parameter should be the time stamp of the event that
+initiated the popup. If such an event is not available, use
+gtk_get_current_event_time() instead.
-Since: 2.6
+The operation of the @mouse_button and the @time_ parameter is the same
+as the @button and @activation_time parameters for gtk_menu_popup().
+
+Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkDialog
+<parameter name="ifactory">
+<parameter_description> a #GtkItemFactory of type #GTK_TYPE_MENU (see gtk_item_factory_new())
</parameter_description>
</parameter>
-<parameter name="n_params">
-<parameter_description> the number of response ids in @new_order
+<parameter name="x">
+<parameter_description> the x position
</parameter_description>
</parameter>
-<parameter name="new_order">
-<parameter_description> an array of response ids of @dialog's buttons
+<parameter name="y">
+<parameter_description> the y position
+</parameter_description>
+</parameter>
+<parameter name="mouse_button">
+<parameter_description> the mouse button which was pressed to initiate the popup
+</parameter_description>
+</parameter>
+<parameter name="time_">
+<parameter_description> the time at which the activation event occurred
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_entry_get_width_chars">
+<function name="gtk_item_factory_popup_data">
<description>
-Gets the value set by gtk_entry_set_width_chars().
+Obtains the @popup_data which was passed to
+gtk_item_factory_popup_with_data(). This data is available until the menu
+is popped down again.
+Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="ifactory">
+<parameter_description> a #GtkItemFactory
</parameter_description>
</parameter>
</parameters>
-<return> number of chars to request space for, or negative if unset
+<return> @popup_data associated with @ifactory
</return>
</function>
-<function name="gtk_print_settings_new_from_key_file">
+<function name="gtk_item_factory_popup_data_from_widget">
<description>
-Reads the print settings from the group @group_name in @key_file. Returns a
-new #GtkPrintSettings object with the restored settings, or %NULL if an
-error occurred. If the file could not be loaded then error is set to either
-a #GFileError or #GKeyFileError.
+Obtains the @popup_data which was passed to
+gtk_item_factory_popup_with_data(). This data is available until the menu
+is popped down again.
-Since: 2.12
+Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> the #GKeyFile to retrieve the settings from
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> the name of the group to use, or %NULL to use
-the default "Print Settings"
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for errors, or %NULL
+<parameter name="widget">
+<parameter_description> a widget
</parameter_description>
</parameter>
</parameters>
-<return> the restored #GtkPrintSettings
-
+<return> @popup_data associated with the item factory from
+which @widget was created, or %NULL if @widget wasn't created
+by an item factory
</return>
</function>
-<function name="gtk_image_set_from_stock">
+<function name="gtk_item_factory_popup_with_data">
<description>
-See gtk_image_new_from_stock() for details.
+Pops up the menu constructed from the item factory at (@x, @y). Callbacks
+can access the @popup_data while the menu is posted via
+gtk_item_factory_popup_data() and gtk_item_factory_popup_data_from_widget().
+
+The @mouse_button parameter should be the mouse button pressed to initiate
+the menu popup. If the menu popup was initiated by something other than
+a mouse button press, such as a mouse button release or a keypress,
+ mouse_button should be 0.
+
+The @time_ parameter should be the time stamp of the event that
+initiated the popup. If such an event is not available, use
+gtk_get_current_event_time() instead.
+
+The operation of the @mouse_button and the @time_ parameters is the same
+as the @button and @activation_time parameters for gtk_menu_popup().
+
+Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GtkImage
+<parameter name="ifactory">
+<parameter_description> a #GtkItemFactory of type #GTK_TYPE_MENU (see gtk_item_factory_new())
</parameter_description>
</parameter>
-<parameter name="stock_id">
-<parameter_description> a stock icon name
+<parameter name="popup_data">
+<parameter_description> data available for callbacks while the menu is posted
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> a stock icon size
+<parameter name="destroy">
+<parameter_description> a #GDestroyNotify function to be called on @popup_data when
+the menu is unposted
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> the x position
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> the y position
+</parameter_description>
+</parameter>
+<parameter name="mouse_button">
+<parameter_description> the mouse button which was pressed to initiate the popup
+</parameter_description>
+</parameter>
+<parameter name="time_">
+<parameter_description> the time at which the activation event occurred
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_statusbar_get_message_area">
+<function name="gtk_item_factory_set_translate_func">
<description>
-Retrieves the box containing the label widget.
+Sets a function to be used for translating the path elements before they
+are displayed.
-Since: 2.20
+Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="statusbar">
-<parameter_description> a #GtkStatusBar
+<parameter name="ifactory">
+<parameter_description> a #GtkItemFactory
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> the #GtkTranslateFunc function to be used to translate path elements
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to pass to @func and @notify
+</parameter_description>
+</parameter>
+<parameter name="notify">
+<parameter_description> a #GDestroyNotify function to be called when @ifactory is
+destroyed and when the translation function is changed again
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkBox
-
-</return>
+<return></return>
</function>
-<function name="gtk_get_current_event_time">
+<function name="gtk_key_hash_free">
<description>
-If there is a current event and it has a timestamp, return that
-timestamp, otherwise return %GDK_CURRENT_TIME.
-
+Destroys a key hash created with gtk_key_hash_new()
</description>
<parameters>
+<parameter name="key_hash">
+<parameter_description> a #GtkKeyHash
+</parameter_description>
+</parameter>
</parameters>
-<return> the timestamp from the current event, or %GDK_CURRENT_TIME.
-</return>
+<return></return>
</function>
-<function name="gtk_separator_tool_item_get_draw">
+<function name="gtk_label_get_angle">
<description>
-Returns whether @item is drawn as a line, or just blank.
-See gtk_separator_tool_item_set_draw().
+Gets the angle of rotation for the label. See
+gtk_label_set_angle().
-Since: 2.4
+Since: 2.6
</description>
<parameters>
-<parameter name="item">
-<parameter_description> a #GtkSeparatorToolItem
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @item is drawn as a line, or just blank.
+<return> the angle of rotation for the label
</return>
</function>
-<function name="gtk_scrolled_window_get_hadjustment">
+<function name="gtk_label_get_attributes">
<description>
-Returns the horizontal scrollbar's adjustment, used to connect the
-horizontal scrollbar to the child widget's horizontal scroll
-functionality.
+Gets the attribute list that was set on the label using
+gtk_label_set_attributes(), if any. This function does
+not reflect attributes that come from the labels markup
+(see gtk_label_set_markup()). If you want to get the
+effective attributes for the label, use
+pango_layout_get_attribute (gtk_label_get_layout (label)).
</description>
<parameters>
-<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
</parameters>
-<return> the horizontal #GtkAdjustment
+<return> the attribute list, or %NULL if none was set.
</return>
</function>
-<function name="gtk_spin_button_get_value">
+<function name="gtk_label_get_current_uri">
<description>
-Get the value in the @spin_button.
+Returns the URI for the currently active link in the label.
+The active link is the one under the mouse pointer or, in a
+selectable label, the link in which the text cursor is currently
+positioned.
+This function is intended for use in a #GtkLabel::activate-link handler
+or for use in a #GtkWidget::query-tooltip handler.
+
+Since: 2.18
</description>
<parameters>
-<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
</parameters>
-<return> the value of @spin_button
+<return> the currently active URI. The string is owned by GTK+ and must
+not be freed or modified.
+
</return>
</function>
-<function name="gtk_entry_get_visibility">
+<function name="gtk_label_get_ellipsize">
<description>
-Retrieves whether the text in @entry is visible. See
-gtk_entry_set_visibility().
+Returns the ellipsizing position of the label. See gtk_label_set_ellipsize().
+Since: 2.6
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the text is currently visible
+<return> #PangoEllipsizeMode
+
</return>
</function>
-<function name="gtk_text_child_anchor_new">
+<function name="gtk_label_get_justify">
<description>
-Creates a new #GtkTextChildAnchor. Usually you would then insert
-it into a #GtkTextBuffer with gtk_text_buffer_insert_child_anchor().
-To perform the creation and insertion in one step, use the
-convenience function gtk_text_buffer_create_child_anchor().
+Returns the justification of the label. See gtk_label_set_justify().
</description>
<parameters>
+<parameter name="label">
+<parameter_description> a #GtkLabel
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GtkTextChildAnchor
+<return> #GtkJustification
</return>
</function>
-<function name="gtk_text_iter_free">
+<function name="gtk_label_get_label">
<description>
-Free an iterator allocated on the heap. This function
-is intended for use in language bindings, and is not
-especially useful for applications, because iterators can
-simply be allocated on the stack.
+Fetches the text from a label widget including any embedded
+underlines indicating mnemonics and Pango markup. (See
+gtk_label_get_text()).
+
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a dynamically-allocated iterator
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the text of the label widget. This string is
+owned by the widget and must not be modified or freed.
+</return>
</function>
-<function name="gtk_print_unix_dialog_get_page_setup">
+<function name="gtk_label_get_layout">
<description>
-Gets the page setup that is used by the #GtkPrintUnixDialog.
+Gets the #PangoLayout used to display the label.
+The layout is useful to e.g. convert text positions to
+pixel positions, in combination with gtk_label_get_layout_offsets().
+The returned layout is owned by the label so need not be
+freed by the caller.
-Since: 2.10
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
</parameters>
-<return> the page setup of @dialog.
-
+<return> the #PangoLayout for this label
</return>
</function>
-<function name="gtk_drag_source_set">
+<function name="gtk_label_get_layout_offsets">
<description>
-Sets up a widget so that GTK+ will start a drag operation when the user
-clicks and drags on the widget. The widget must have a window.
+Obtains the coordinates where the label will draw the #PangoLayout
+representing the text in the label; useful to convert mouse events
+into coordinates inside the #PangoLayout, e.g. to take some action
+if some part of the label is clicked. Of course you will need to
+create a #GtkEventBox to receive the events, and pack the label
+inside it, since labels are a #GTK_NO_WINDOW widget. Remember
+when using the #PangoLayout functions you need to convert to
+and from pixels using PANGO_PIXELS() or #PANGO_SCALE.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="start_button_mask">
-<parameter_description> the bitmask of buttons that can start the drag
-</parameter_description>
-</parameter>
-<parameter name="targets">
-<parameter_description> the table of targets that the drag will support,
-may be %NULL
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
-<parameter name="n_targets">
-<parameter_description> the number of items in @targets
+<parameter name="x">
+<parameter_description> location to store X offset of layout, or %NULL
</parameter_description>
</parameter>
-<parameter name="actions">
-<parameter_description> the bitmask of possible actions for a drag from this widget
+<parameter name="y">
+<parameter_description> location to store Y offset of layout, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_get_rules_hint">
+<function name="gtk_label_get_line_wrap">
<description>
-Gets the setting set by gtk_tree_view_set_rules_hint().
+Returns whether lines in the label are automatically wrapped.
+See gtk_label_set_line_wrap().
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if rules are useful for the user of this tree
+<return> %TRUE if the lines of the label are automatically wrapped.
</return>
</function>
-<function name="gtk_paper_size_copy">
+<function name="gtk_label_get_line_wrap_mode">
<description>
-Copies an existing #GtkPaperSize.
+Returns line wrap mode used by the label. See gtk_label_set_line_wrap_mode().
Since: 2.10
</description>
<parameters>
-<parameter name="other">
-<parameter_description> a #GtkPaperSize
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
</parameters>
-<return> a copy of @other
+<return> %TRUE if the lines of the label are automatically wrapped.
</return>
</function>
-<function name="gtk_text_buffer_insert_with_tags">
+<function name="gtk_label_get_max_width_chars">
<description>
-Inserts @text into @buffer at @iter, applying the list of tags to
-the newly-inserted text. The last tag specified must be NULL to
-terminate the list. Equivalent to calling gtk_text_buffer_insert(),
-then gtk_text_buffer_apply_tag() on the inserted text;
-gtk_text_buffer_insert_with_tags() is just a convenience function.
+Retrieves the desired maximum width of @label, in characters. See
+gtk_label_set_width_chars().
+
+Since: 2.6
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> an iterator in @buffer
-</parameter_description>
-</parameter>
-<parameter name="text">
-<parameter_description> UTF-8 text
-</parameter_description>
-</parameter>
-<parameter name="len">
-<parameter_description> length of @text, or -1
-</parameter_description>
-</parameter>
-<parameter name="first_tag">
-<parameter_description> first tag to apply to @text
-</parameter_description>
-</parameter>
-<parameter name="Varargs">
-<parameter_description> NULL-terminated list of tags to apply
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the maximum width of the label in characters.
+
+</return>
</function>
-<function name="gtk_spin_button_get_increments">
+<function name="gtk_label_get_mnemonic_keyval">
<description>
-Gets the current step and page the increments used by @spin_button. See
-gtk_spin_button_set_increments().
+If the label has been set so that it has an mnemonic key this function
+returns the keyval used for the mnemonic accelerator. If there is no
+mnemonic set up it returns #GDK_VoidSymbol.
+
</description>
<parameters>
-<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
-</parameter_description>
-</parameter>
-<parameter name="step">
-<parameter_description> location to store step increment, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="page">
-<parameter_description> location to store page increment, or %NULL
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> GDK keyval usable for accelerators, or #GDK_VoidSymbol
+</return>
</function>
-<function name="gtk_accelerator_parse">
+<function name="gtk_label_get_mnemonic_widget">
<description>
-Parses a string representing an accelerator. The
-format looks like "<Control>a" or "<Shift><Alt>F1" or
-"<Release>z" (the last one is for key release).
-The parser is fairly liberal and allows lower or upper case,
-and also abbreviations such as "<Ctl>" and "<Ctrl>".
-Key names are parsed using gdk_keyval_from_name(). For character keys the
-name is not the symbol, but the lowercase name, e.g. one would use
-"<Ctrl>minus" instead of "<Ctrl>-".
+Retrieves the target of the mnemonic (keyboard shortcut) of this
+label. See gtk_label_set_mnemonic_widget().
-If the parse fails, @accelerator_key and @accelerator_mods will
-be set to 0 (zero).
</description>
<parameters>
-<parameter name="accelerator">
-<parameter_description> string representing an accelerator
-</parameter_description>
-</parameter>
-<parameter name="accelerator_key">
-<parameter_description> return location for accelerator keyval
-</parameter_description>
-</parameter>
-<parameter name="accelerator_mods">
-<parameter_description> return location for accelerator modifier mask
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the target of the label's mnemonic,
+or %NULL if none has been set and the default algorithm will be used.
+</return>
</function>
-<function name="gtk_combo_box_set_title">
+<function name="gtk_label_get_selectable">
<description>
-Sets the menu's title in tearoff mode.
+Gets the value set by gtk_label_set_selectable().
-Since: 2.10
</description>
<parameters>
-<parameter name="combo_box">
-<parameter_description> a #GtkComboBox
-</parameter_description>
-</parameter>
-<parameter name="title">
-<parameter_description> a title for the menu in tearoff mode
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the user can copy text from the label
+</return>
</function>
-<function name="gtk_text_iter_ends_sentence">
+<function name="gtk_label_get_selection_bounds">
<description>
-Determines whether @iter ends a sentence. Sentence boundaries are
-determined by Pango and should be correct for nearly any language
-(if not, the correct fix would be to the Pango text boundary
-algorithms).
+Gets the selected range of characters in the label, returning %TRUE
+if there's a selection.
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="label">
+<parameter_description> a #GtkLabel
+</parameter_description>
+</parameter>
+<parameter name="start">
+<parameter_description> return location for start of selection, as a character offset
+</parameter_description>
+</parameter>
+<parameter name="end">
+<parameter_description> return location for end of selection, as a character offset
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter is at the end of a sentence.
+<return> %TRUE if selection is non-empty
</return>
</function>
-<function name="gtk_toolbar_set_icon_size">
+<function name="gtk_label_get_single_line_mode">
<description>
-This function sets the size of stock icons in the toolbar. You
-can call it both before you add the icons and after they've been
-added. The size you set will override user preferences for the default
-icon size.
+Returns whether the label is in single line mode.
-This should only be used for special-purpose toolbars, normal
-application toolbars should respect the user preferences for the
-size of icons.
+Since: 2.6
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> A #GtkToolbar
-</parameter_description>
-</parameter>
-<parameter name="icon_size">
-<parameter_description> The #GtkIconSize that stock icons in the
-toolbar shall have.
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE when the label is in single line mode.
+
+</return>
</function>
-<function name="gtk_recent_filter_add_application">
+<function name="gtk_label_get_text">
<description>
-Adds a rule that allows resources based on the name of the application
-that has registered them.
+Fetches the text from a label widget, as displayed on the
+screen. This does not include any embedded underlines
+indicating mnemonics or Pango markup. (See gtk_label_get_label())
-Since: 2.10
</description>
<parameters>
-<parameter name="filter">
-<parameter_description> a #GtkRecentFilter
-</parameter_description>
-</parameter>
-<parameter name="application">
-<parameter_description> an application name
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the text in the label widget. This is the internal
+string used by the label, and must not be modified.
+</return>
</function>
-<function name="gtk_expander_set_label_fill">
+<function name="gtk_label_get_track_visited_links">
<description>
-Sets whether the label widget should fill all available horizontal space
-allocated to @expander.
+Returns whether the label is currently keeping track
+of clicked links.
-Since: 2.22
+Since: 2.18
</description>
<parameters>
-<parameter name="expander">
-<parameter_description> a #GtkExpander
-</parameter_description>
-</parameter>
-<parameter name="label_fill">
-<parameter_description> %TRUE if the label should should fill all available horizontal
-space
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if clicked links are remembered
+
+</return>
</function>
-<function name="gtk_label_set_ellipsize">
+<function name="gtk_label_get_use_markup">
<description>
-Sets the mode used to ellipsize (add an ellipsis: "...") to the text
-if there is not enough space to render the entire string.
+Returns whether the label's text is interpreted as marked up with
+the <link linkend="PangoMarkupFormat">Pango text markup
+language</link>. See gtk_label_set_use_markup ().
-Since: 2.6
</description>
<parameters>
@@ -26270,3087 +26438,2875 @@ Since: 2.6
<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
-<parameter name="mode">
-<parameter_description> a #PangoEllipsizeMode
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the label's text will be parsed for markup.
+</return>
</function>
-<function name="gtk_print_settings_get_scale">
+<function name="gtk_label_get_use_underline">
<description>
-Gets the value of %GTK_PRINT_SETTINGS_SCALE.
+Returns whether an embedded underline in the label indicates a
+mnemonic. See gtk_label_set_use_underline().
-Since: 2.10
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
</parameters>
-<return> the scale in percent
-
+<return> %TRUE whether an embedded underline in the label indicates
+the mnemonic accelerator keys.
</return>
</function>
-<function name="gtk_tool_button_new">
+<function name="gtk_label_get_width_chars">
<description>
-Creates a new %GtkToolButton using @icon_widget as icon and @label as
-label.
+Retrieves the desired width of @label, in characters. See
+gtk_label_set_width_chars().
-Since: 2.4
+Since: 2.6
</description>
<parameters>
<parameter name="label">
-<parameter_description> a string that will be used as label, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="icon_widget">
-<parameter_description> a #GtkMisc widget that will be used as icon widget, or %NULL
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
</parameters>
-<return> A new #GtkToolButton
+<return> the width of the label in characters.
</return>
</function>
-<function name="gtk_message_dialog_set_markup">
+<function name="gtk_label_new">
<description>
-Sets the text of the message dialog to be @str, which is marked
-up with the <link linkend="PangoMarkupFormat">Pango text markup
-language</link>.
+Creates a new label with the given text inside it. You can
+pass %NULL to get an empty label widget.
-Since: 2.4
</description>
<parameters>
-<parameter name="message_dialog">
-<parameter_description> a #GtkMessageDialog
-</parameter_description>
-</parameter>
<parameter name="str">
-<parameter_description> markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>)
+<parameter_description> The text of the label
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the new #GtkLabel
+</return>
</function>
-<function name="gtk_print_settings_get_duplex">
+<function name="gtk_label_new_with_mnemonic">
<description>
-Gets the value of %GTK_PRINT_SETTINGS_DUPLEX.
+Creates a new #GtkLabel, containing the text in @str.
+
+If characters in @str are preceded by an underscore, they are
+underlined. If you need a literal underscore character in a label, use
+'__' (two underscores). The first underlined character represents a
+keyboard accelerator called a mnemonic. The mnemonic key can be used
+to activate another widget, chosen automatically, or explicitly using
+gtk_label_set_mnemonic_widget().
+
+If gtk_label_set_mnemonic_widget() is not called, then the first
+activatable ancestor of the #GtkLabel will be chosen as the mnemonic
+widget. For instance, if the label is inside a button or menu item,
+the button or menu item will automatically become the mnemonic widget
+and be activated by the mnemonic.
-Since: 2.10
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="str">
+<parameter_description> The text of the label, with an underscore in front of the
+mnemonic character
</parameter_description>
</parameter>
</parameters>
-<return> whether to print the output in duplex.
-
+<return> the new #GtkLabel
</return>
</function>
-<function name="gtk_text_view_set_editable">
+<function name="gtk_label_select_region">
<description>
-Sets the default editability of the #GtkTextView. You can override
-this default setting with tags in the buffer, using the "editable"
-attribute of tags.
+Selects a range of characters in the label, if the label is selectable.
+See gtk_label_set_selectable(). If the label is not selectable,
+this function has no effect. If @start_offset or
+ end_offset are -1, then the end of the label will be substituted.
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
-<parameter name="setting">
-<parameter_description> whether it's editable
+<parameter name="start_offset">
+<parameter_description> start offset (in characters not bytes)
+</parameter_description>
+</parameter>
+<parameter name="end_offset">
+<parameter_description> end offset (in characters not bytes)
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_set_decorated">
+<function name="gtk_label_set_angle">
<description>
-By default, windows are decorated with a title bar, resize
-controls, etc. Some <link linkend="gtk-X11-arch">window
-managers</link> allow GTK+ to disable these decorations, creating a
-borderless window. If you set the decorated property to %FALSE
-using this function, GTK+ will do its best to convince the window
-manager not to decorate the window. Depending on the system, this
-function may not have any effect when called on a window that is
-already visible, so you should call it before calling gtk_window_show().
-
-On Windows, this function always works, since there's no window manager
-policy involved.
+Sets the angle of rotation for the label. An angle of 90 reads from
+from bottom to top, an angle of 270, from top to bottom. The angle
+setting for the label is ignored if the label is selectable,
+wrapped, or ellipsized.
+Since: 2.6
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
-<parameter name="setting">
-<parameter_description> %TRUE to decorate the window
+<parameter name="angle">
+<parameter_description> the angle that the baseline of the label makes with
+the horizontal, in degrees, measured counterclockwise
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_get_expander_column">
+<function name="gtk_label_set_attributes">
<description>
-Returns the column that is the current expander column. This
-column has the expander arrow drawn next to it.
+Sets a #PangoAttrList; the attributes in the list are applied to the
+label text.
+<note><para>The attributes set with this function will be applied
+and merged with any other attributes previously effected by way
+of the #GtkLabel:use-underline or #GtkLabel:use-markup properties.
+While it is not recommended to mix markup strings with manually set
+attributes, if you must; know that the attributes will be applied
+to the label after the markup string is parsed.</para></note>
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView
+<parameter name="label">
+<parameter_description> a #GtkLabel
+</parameter_description>
+</parameter>
+<parameter name="attrs">
+<parameter_description> a #PangoAttrList
</parameter_description>
</parameter>
</parameters>
-<return> The expander column.
-</return>
+<return></return>
</function>
-<function name="gtk_info_bar_get_content_area">
+<function name="gtk_label_set_ellipsize">
<description>
-Returns the content area of @info_bar.
+Sets the mode used to ellipsize (add an ellipsis: "...") to the text
+if there is not enough space to render the entire string.
-Since: 2.18
+Since: 2.6
</description>
<parameters>
-<parameter name="info_bar">
-<parameter_description> a #GtkInfoBar
+<parameter name="label">
+<parameter_description> a #GtkLabel
+</parameter_description>
+</parameter>
+<parameter name="mode">
+<parameter_description> a #PangoEllipsizeMode
</parameter_description>
</parameter>
</parameters>
-<return> the content area.
-
-</return>
+<return></return>
</function>
-<function name="gtk_info_bar_get_message_type">
+<function name="gtk_label_set_justify">
<description>
-Returns the message type of the message area.
-
-Since: 2.18
+Sets the alignment of the lines in the text of the label relative to
+each other. %GTK_JUSTIFY_LEFT is the default value when the
+widget is first created with gtk_label_new(). If you instead want
+to set the alignment of the label as a whole, use
+gtk_misc_set_alignment() instead. gtk_label_set_justify() has no
+effect on labels containing only a single line.
</description>
<parameters>
-<parameter name="info_bar">
-<parameter_description> a #GtkInfoBar
+<parameter name="label">
+<parameter_description> a #GtkLabel
+</parameter_description>
+</parameter>
+<parameter name="jtype">
+<parameter_description> a #GtkJustification
</parameter_description>
</parameter>
</parameters>
-<return> the message type of the message area.
-
-</return>
+<return></return>
</function>
-<function name="gtk_text_view_get_default_attributes">
+<function name="gtk_label_set_label">
<description>
-Obtains a copy of the default text attributes. These are the
-attributes used for text unless a tag overrides them.
-You'd typically pass the default attributes in to
-gtk_text_iter_get_attributes() in order to get the
-attributes in effect at a given text position.
-
-The return value is a copy owned by the caller of this function,
-and should be freed.
-
+Sets the text of the label. The label is interpreted as
+including embedded underlines and/or Pango markup depending
+on the values of the #GtkLabel:use-underline" and
+#GtkLabel:use-markup properties.
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="label">
+<parameter_description> a #GtkLabel
+</parameter_description>
+</parameter>
+<parameter name="str">
+<parameter_description> the new text to set for the label
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkTextAttributes
-</return>
+<return></return>
</function>
-<function name="gtk_widget_queue_clear_area">
+<function name="gtk_label_set_line_wrap">
<description>
-This function is no longer different from
-gtk_widget_queue_draw_area(), though it once was. Now it just calls
-gtk_widget_queue_draw_area(). Originally
-gtk_widget_queue_clear_area() would force a redraw of the
-background for %GTK_NO_WINDOW widgets, and
-gtk_widget_queue_draw_area() would not. Now both functions ensure
-the background will be redrawn.
+Toggles line wrapping within the #GtkLabel widget. %TRUE makes it break
+lines if text exceeds the widget's size. %FALSE lets the text get cut off
+by the edge of the widget if it exceeds the widget size.
-Deprecated: 2.2: Use gtk_widget_queue_draw_area() instead.
+Note that setting line wrapping to %TRUE does not make the label
+wrap at its parent container's width, because GTK+ widgets
+conceptually can't make their requisition depend on the parent
+container's size. For a label that wraps at a specific position,
+set the label's width using gtk_widget_set_size_request().
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> x coordinate of upper-left corner of rectangle to redraw
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> y coordinate of upper-left corner of rectangle to redraw
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> width of region to draw
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> height of region to draw
+<parameter name="wrap">
+<parameter_description> the setting
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_accel_groups_from_object">
+<function name="gtk_label_set_line_wrap_mode">
<description>
-Gets a list of all accel groups which are attached to @object.
+If line wrapping is on (see gtk_label_set_line_wrap()) this controls how
+the line wrapping is done. The default is %PANGO_WRAP_WORD which means
+wrap on word boundaries.
+Since: 2.10
</description>
<parameters>
-<parameter name="object">
-<parameter_description> a #GObject, usually a #GtkWindow
+<parameter name="label">
+<parameter_description> a #GtkLabel
+</parameter_description>
+</parameter>
+<parameter name="wrap_mode">
+<parameter_description> the line wrapping mode
</parameter_description>
</parameter>
</parameters>
-<return> a list of all accel groups which are attached to @object
-</return>
+<return></return>
</function>
-<function name="gtk_check_menu_item_get_draw_as_radio">
+<function name="gtk_label_set_markup">
<description>
-Returns whether @check_menu_item looks like a #GtkRadioMenuItem
+Parses @str which is marked up with the <link
+linkend="PangoMarkupFormat">Pango text markup language</link>, setting the
+label's text and attribute list based on the parse results. If the @str is
+external data, you may need to escape it with g_markup_escape_text() or
+g_markup_printf_escaped()<!-- -->:
+|[
+char *markup;
-Since: 2.4
+markup = g_markup_printf_escaped ("<span style=\"italic\">%s</span>", str);
+gtk_label_set_markup (GTK_LABEL (label), markup);
+g_free (markup);
+]|
</description>
<parameters>
-<parameter name="check_menu_item">
-<parameter_description> a #GtkCheckMenuItem
+<parameter name="label">
+<parameter_description> a #GtkLabel
+</parameter_description>
+</parameter>
+<parameter name="str">
+<parameter_description> a markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>)
</parameter_description>
</parameter>
</parameters>
-<return> Whether @check_menu_item looks like a #GtkRadioMenuItem
-
-</return>
+<return></return>
</function>
-<function name="gtk_window_activate_key">
+<function name="gtk_label_set_markup_with_mnemonic">
<description>
-Activates mnemonics and accelerators for this #GtkWindow. This is normally
-called by the default ::key_press_event handler for toplevel windows,
-however in some cases it may be useful to call this directly when
-overriding the standard key handling for a toplevel window.
+Parses @str which is marked up with the <link linkend="PangoMarkupFormat">Pango text markup language</link>,
+setting the label's text and attribute list based on the parse results.
+If characters in @str are preceded by an underscore, they are underlined
+indicating that they represent a keyboard accelerator called a mnemonic.
-Since: 2.4
+The mnemonic key can be used to activate another widget, chosen
+automatically, or explicitly using gtk_label_set_mnemonic_widget().
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
-<parameter name="event">
-<parameter_description> a #GdkEventKey
+<parameter name="str">
+<parameter_description> a markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>)
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if a mnemonic or accelerator was found and activated.
-
-</return>
+<return></return>
</function>
-<function name="gtk_clipboard_get_for_display">
+<function name="gtk_label_set_max_width_chars">
<description>
-Returns the clipboard object for the given selection.
-Cut/copy/paste menu items and keyboard shortcuts should use
-the default clipboard, returned by passing %GDK_SELECTION_CLIPBOARD for @selection.
-(%GDK_NONE is supported as a synonym for GDK_SELECTION_CLIPBOARD
-for backwards compatibility reasons.)
-The currently-selected object or text should be provided on the clipboard
-identified by #GDK_SELECTION_PRIMARY. Cut/copy/paste menu items
-conceptually copy the contents of the #GDK_SELECTION_PRIMARY clipboard
-to the default clipboard, i.e. they copy the selection to what the
-user sees as the clipboard.
-
-(Passing #GDK_NONE is the same as using <literal>gdk_atom_intern
-("CLIPBOARD", FALSE)</literal>. See <ulink
-url="http://www.freedesktop.org/Standards/clipboards-spec">
-http://www.freedesktop.org/Standards/clipboards-spec</ulink>
-for a detailed discussion of the "CLIPBOARD" vs. "PRIMARY"
-selections under the X window system. On Win32 the
-#GDK_SELECTION_PRIMARY clipboard is essentially ignored.)
-
-It's possible to have arbitrary named clipboards; if you do invent
-new clipboards, you should prefix the selection name with an
-underscore (because the ICCCM requires that nonstandard atoms are
-underscore-prefixed), and namespace it as well. For example,
-if your application called "Foo" has a special-purpose
-clipboard, you might call it "_FOO_SPECIAL_CLIPBOARD".
+Sets the desired maximum width in characters of @label to @n_chars.
-Since: 2.2
+Since: 2.6
</description>
<parameters>
-<parameter name="display">
-<parameter_description> the display for which the clipboard is to be retrieved or created
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
-<parameter name="selection">
-<parameter_description> a #GdkAtom which identifies the clipboard
-to use.
+<parameter name="n_chars">
+<parameter_description> the new desired maximum width, in characters.
</parameter_description>
</parameter>
</parameters>
-<return> the appropriate clipboard object. If no
-clipboard already exists, a new one will
-be created. Once a clipboard object has
-been created, it is persistent and, since
-it is owned by GTK+, must not be freed or
-unrefd.
-
-</return>
+<return></return>
</function>
-<function name="gtk_image_get_icon_set">
+<function name="gtk_label_set_mnemonic_widget">
<description>
-Gets the icon set and size being displayed by the #GtkImage.
-The storage type of the image must be %GTK_IMAGE_EMPTY or
-%GTK_IMAGE_ICON_SET (see gtk_image_get_storage_type()).
+If the label has been set so that it has an mnemonic key (using
+i.e. gtk_label_set_markup_with_mnemonic(),
+gtk_label_set_text_with_mnemonic(), gtk_label_new_with_mnemonic()
+or the "use_underline" property) the label can be associated with a
+widget that is the target of the mnemonic. When the label is inside
+a widget (like a #GtkButton or a #GtkNotebook tab) it is
+automatically associated with the correct widget, but sometimes
+(i.e. when the target is a #GtkEntry next to the label) you need to
+set it explicitly using this function.
+
+The target widget will be accelerated by emitting the
+GtkWidget::mnemonic-activate signal on it. The default handler for
+this signal will activate the widget if there are no mnemonic collisions
+and toggle focus between the colliding widgets otherwise.
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GtkImage
-</parameter_description>
-</parameter>
-<parameter name="icon_set">
-<parameter_description> location to store a
-#GtkIconSet, or %NULL
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> location to store a stock
-icon size, or %NULL
+<parameter name="widget">
+<parameter_description> the target #GtkWidget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_entry_im_context_filter_keypress">
+<function name="gtk_label_set_selectable">
<description>
-Allow the #GtkEntry input method to internally handle key press
-and release events. If this function returns %TRUE, then no further
-processing should be done for this key event. See
-gtk_im_context_filter_keypress().
-
-Note that you are expected to call this function from your handler
-when overriding key event handling. This is needed in the case when
-you need to insert your own key handling between the input method
-and the default key event handling of the #GtkEntry.
-See gtk_text_view_reset_im_context() for an example of use.
-
-Since: 2.22
+Selectable labels allow the user to select text from the label, for
+copy-and-paste.
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
-<parameter name="event">
-<parameter_description> the key event
+<parameter name="setting">
+<parameter_description> %TRUE to allow selecting text in the label
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the input method handled the key event.
-
-</return>
+<return></return>
</function>
-<function name="gtk_widget_has_rc_style">
+<function name="gtk_label_set_single_line_mode">
<description>
-Determines if the widget style has been looked up through the rc mechanism.
+Sets whether the label is in single line mode.
-Since: 2.20
+Since: 2.6
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="label">
+<parameter_description> a #GtkLabel
+</parameter_description>
+</parameter>
+<parameter name="single_line_mode">
+<parameter_description> %TRUE if the label should be in single line mode
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the widget has been looked up through the rc
-mechanism, %FALSE otherwise.
-
-</return>
+<return></return>
</function>
-<function name="gtk_entry_set_alignment">
+<function name="gtk_label_set_text">
<description>
-Sets the alignment for the contents of the entry. This controls
-the horizontal positioning of the contents when the displayed
-text is shorter than the width of the entry.
+Sets the text within the #GtkLabel widget. It overwrites any text that
+was there before.
-Since: 2.4
+This will also clear any previously set mnemonic accelerators.
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
-<parameter name="xalign">
-<parameter_description> The horizontal alignment, from 0 (left) to 1 (right).
-Reversed for RTL layouts
+<parameter name="str">
+<parameter_description> The text you want to set
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_view_set_tooltip_cell">
+<function name="gtk_label_set_text_with_mnemonic">
<description>
-Sets the tip area of @tooltip to the area which @cell occupies in
-the item pointed to by @path. See also gtk_tooltip_set_tip_area().
-
-See also gtk_icon_view_set_tooltip_column() for a simpler alternative.
-
-Since: 2.12
+Sets the label's text from the string @str.
+If characters in @str are preceded by an underscore, they are underlined
+indicating that they represent a keyboard accelerator called a mnemonic.
+The mnemonic key can be used to activate another widget, chosen
+automatically, or explicitly using gtk_label_set_mnemonic_widget().
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
-</parameter_description>
-</parameter>
-<parameter name="tooltip">
-<parameter_description> a #GtkTooltip
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> a #GtkTreePath
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
-<parameter name="cell">
-<parameter_description> a #GtkCellRenderer or %NULL
+<parameter name="str">
+<parameter_description> a string
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_source_get_size">
+<function name="gtk_label_set_track_visited_links">
<description>
-Obtains the icon size this source applies to. The return value
-is only useful/meaningful if the icon size is <emphasis>not</emphasis> wildcarded.
+Sets whether the label should keep track of clicked
+links (and use a different color for them).
+Since: 2.18
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GtkIconSource
+<parameter name="label">
+<parameter_description> a #GtkLabel
+</parameter_description>
+</parameter>
+<parameter name="track_links">
+<parameter_description> %TRUE to track visited links
</parameter_description>
</parameter>
</parameters>
-<return> icon size this source matches.
-</return>
+<return></return>
</function>
-<function name="gtk_window_add_mnemonic">
+<function name="gtk_label_set_use_markup">
<description>
-Adds a mnemonic to this window.
+Sets whether the text of the label contains markup in <link
+linkend="PangoMarkupFormat">Pango's text markup
+language</link>. See gtk_label_set_markup().
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
-</parameter_description>
-</parameter>
-<parameter name="keyval">
-<parameter_description> the mnemonic
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
-<parameter name="target">
-<parameter_description> the widget that gets activated by the mnemonic
+<parameter name="setting">
+<parameter_description> %TRUE if the label's text should be parsed for markup.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tool_item_set_tooltip_markup">
+<function name="gtk_label_set_use_underline">
<description>
-Sets the markup text to be displayed as tooltip on the item.
-See gtk_widget_set_tooltip_markup().
-
-Since: 2.12
+If true, an underline in the text indicates the next character should be
+used for the mnemonic accelerator key.
</description>
<parameters>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
-<parameter name="markup">
-<parameter_description> markup text to be used as tooltip for @tool_item
+<parameter name="setting">
+<parameter_description> %TRUE if underlines in the text indicate mnemonics
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_about_dialog_set_artists">
+<function name="gtk_label_set_width_chars">
<description>
-Sets the strings which are displayed in the artists tab
-of the secondary credits dialog.
+Sets the desired width in characters of @label to @n_chars.
Since: 2.6
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter name="label">
+<parameter_description> a #GtkLabel
</parameter_description>
</parameter>
-<parameter name="artists">
-<parameter_description> a %NULL-terminated array of strings
+<parameter name="n_chars">
+<parameter_description> the new desired width, in characters.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_reshow_with_initial_size">
+<function name="gtk_layout_freeze">
<description>
-Hides @window, then reshows it, resetting the
-default size and position of the window. Used
-by GUI builders only.
+This is a deprecated function, it doesn't do anything useful.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="layout">
+<parameter_description> a #GtkLayout
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_printer_is_active">
+<function name="gtk_layout_get_bin_window">
<description>
-Returns whether the printer is currently active (i.e.
-accepts new jobs).
+Retrieve the bin window of the layout used for drawing operations.
-Since: 2.10
+Since: 2.14
</description>
<parameters>
-<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter name="layout">
+<parameter_description> a #GtkLayout
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @printer is active
+<return> a #GdkWindow
</return>
</function>
-<function name="gtk_container_unset_focus_chain">
+<function name="gtk_layout_get_hadjustment">
<description>
-Removes a focus chain explicitly set with gtk_container_set_focus_chain().
+This function should only be called after the layout has been
+placed in a #GtkScrolledWindow or otherwise configured for
+scrolling. It returns the #GtkAdjustment used for communication
+between the horizontal scrollbar and @layout.
+
+See #GtkScrolledWindow, #GtkScrollbar, #GtkAdjustment for details.
+
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
+<parameter name="layout">
+<parameter_description> a #GtkLayout
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> horizontal scroll adjustment
+</return>
</function>
-<function name="gtk_widget_reset_shapes">
+<function name="gtk_layout_get_size">
<description>
-Recursively resets the shape on this widget and its descendants.
+Gets the size that has been set on the layout, and that determines
+the total extents of the layout's scrollbar area. See
+gtk_layout_set_size ().
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="layout">
+<parameter_description> a #GtkLayout
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> location to store the width set on @layout, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> location to store the height set on @layout, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_get_style">
+<function name="gtk_layout_get_vadjustment">
<description>
-Simply an accessor function that returns @widget->style.
+This function should only be called after the layout has been
+placed in a #GtkScrolledWindow or otherwise configured for
+scrolling. It returns the #GtkAdjustment used for communication
+between the vertical scrollbar and @layout.
+
+See #GtkScrolledWindow, #GtkScrollbar, #GtkAdjustment for details.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="layout">
+<parameter_description> a #GtkLayout
</parameter_description>
</parameter>
</parameters>
-<return> the widget's #GtkStyle
+<return> vertical scroll adjustment
</return>
</function>
-<function name="gtk_icon_size_lookup">
+<function name="gtk_layout_move">
<description>
-Obtains the pixel size of a semantic icon size, possibly
-modified by user preferences for the default #GtkSettings.
-(See gtk_icon_size_lookup_for_settings().)
-Normally @size would be
-#GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc. This function
-isn't normally needed, gtk_widget_render_icon() is the usual
-way to get an icon for rendering, then just look at the size of
-the rendered pixbuf. The rendered pixbuf may not even correspond to
-the width/height returned by gtk_icon_size_lookup(), because themes
-are free to render the pixbuf however they like, including changing
-the usual size.
+Moves a current child of @layout to a new position.
</description>
<parameters>
-<parameter name="size">
-<parameter_description> an icon size
+<parameter name="layout">
+<parameter_description> a #GtkLayout
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> location to store icon width
+<parameter name="child_widget">
+<parameter_description> a current child of @layout
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> location to store icon height
+<parameter name="x">
+<parameter_description> X position to move to
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> Y position to move to
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @size was a valid size
-</return>
+<return></return>
</function>
-<function name="gtk_recent_info_get_applications">
+<function name="gtk_layout_new">
<description>
-Retrieves the list of applications that have registered this resource.
+Creates a new #GtkLayout. Unless you have a specific adjustment
+you'd like the layout to use for scrolling, pass %NULL for
+ hadjustment and @vadjustment.
-Since: 2.10
</description>
<parameters>
-<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter name="hadjustment">
+<parameter_description> horizontal scroll adjustment, or %NULL
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> return location for the length of the returned list
+<parameter name="vadjustment">
+<parameter_description> vertical scroll adjustment, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated
-%NULL-terminated array of strings. Use g_strfreev() to free it.
-
+<return> a new #GtkLayout
</return>
</function>
-<function name="gtk_file_chooser_get_preview_uri">
+<function name="gtk_layout_put">
<description>
-Gets the URI that should be previewed in a custom preview
-widget. See gtk_file_chooser_set_preview_widget().
+Adds @child_widget to @layout, at position (@x,@y).
+ layout becomes the new parent container of @child_widget.
-Since: 2.4
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="layout">
+<parameter_description> a #GtkLayout
</parameter_description>
</parameter>
-</parameters>
-<return> the URI for the file to preview, or %NULL if no file is
-selected. Free with g_free().
-
-</return>
-</function>
-
-<function name="gtk_assistant_set_current_page">
-<description>
-Switches the page to @page_num. Note that this will only be necessary
-in custom buttons, as the @assistant flow can be set with
-gtk_assistant_set_forward_page_func().
-
-Since: 2.10
-
-</description>
-<parameters>
-<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter name="child_widget">
+<parameter_description> child widget
</parameter_description>
</parameter>
-<parameter name="page_num">
-<parameter_description> index of the page to switch to, starting from 0.
-If negative, the last page will be used. If greater
-than the number of pages in the @assistant, nothing
-will be done.
+<parameter name="x">
+<parameter_description> X position of child widget
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> Y position of child widget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_view_set_column_spacing">
+<function name="gtk_layout_set_hadjustment">
<description>
-Sets the ::column-spacing property which specifies the space
-which is inserted between the columns of the icon view.
+Sets the horizontal scroll adjustment for the layout.
+
+See #GtkScrolledWindow, #GtkScrollbar, #GtkAdjustment for details.
-Since: 2.6
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
+<parameter name="layout">
+<parameter_description> a #GtkLayout
</parameter_description>
</parameter>
-<parameter name="column_spacing">
-<parameter_description> the column spacing
+<parameter name="adjustment">
+<parameter_description> new scroll adjustment
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_operation_set_unit">
+<function name="gtk_layout_set_size">
<description>
-Sets up the transformation for the cairo context obtained from
-#GtkPrintContext in such a way that distances are measured in
-units of @unit.
+Sets the size of the scrollable area of the layout.
-Since: 2.10
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter name="layout">
+<parameter_description> a #GtkLayout
</parameter_description>
</parameter>
-<parameter name="unit">
-<parameter_description> the unit to use
+<parameter name="width">
+<parameter_description> width of entire scrollable area
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> height of entire scrollable area
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_view_set_left_margin">
+<function name="gtk_layout_set_vadjustment">
<description>
-Sets the default left margin for text in @text_view.
-Tags in the buffer may override the default.
+Sets the vertical scroll adjustment for the layout.
+
+See #GtkScrolledWindow, #GtkScrollbar, #GtkAdjustment for details.
+
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="layout">
+<parameter_description> a #GtkLayout
</parameter_description>
</parameter>
-<parameter name="left_margin">
-<parameter_description> left margin in pixels
+<parameter name="adjustment">
+<parameter_description> new scroll adjustment
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tool_shell_get_style">
+<function name="gtk_layout_thaw">
<description>
-Retrieves whether the tool shell has text, icons, or both. Tool items must
-not call this function directly, but rely on gtk_tool_item_get_style()
-instead.
-
-Since: 2.14
+This is a deprecated function, it doesn't do anything useful.
</description>
<parameters>
-<parameter name="shell">
-<parameter_description> a #GtkToolShell
+<parameter name="layout">
+<parameter_description> a #GtkLayout
</parameter_description>
</parameter>
</parameters>
-<return> the current style of @shell
-
-</return>
+<return></return>
</function>
-<function name="gtk_selection_data_set_text">
+<function name="gtk_link_button_get_uri">
<description>
-Sets the contents of the selection from a UTF-8 encoded string.
-The string is converted to the form determined by
- selection_data->target.
+Retrieves the URI set using gtk_link_button_set_uri().
+Since: 2.10
</description>
<parameters>
-<parameter name="selection_data">
-<parameter_description> a #GtkSelectionData
-</parameter_description>
-</parameter>
-<parameter name="str">
-<parameter_description> a UTF-8 string
-</parameter_description>
-</parameter>
-<parameter name="len">
-<parameter_description> the length of @str, or -1 if @str is nul-terminated.
+<parameter name="link_button">
+<parameter_description> a #GtkLinkButton
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the selection was successfully set,
-otherwise %FALSE.
+<return> a valid URI. The returned string is owned by the link button
+and should not be modified or freed.
+
</return>
</function>
-<function name="gtk_file_chooser_get_file">
+<function name="gtk_link_button_get_visited">
<description>
-Gets the #GFile for the currently selected file in
-the file selector. If multiple files are selected,
-one of the files will be returned at random.
+Retrieves the 'visited' state of the URI where the #GtkLinkButton
+points. The button becomes visited when it is clicked. If the URI
+is changed on the button, the 'visited' state is unset again.
-If the file chooser is in folder mode, this function returns the selected
-folder.
+The state may also be changed using gtk_link_button_set_visited().
Since: 2.14
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="link_button">
+<parameter_description> a #GtkLinkButton
</parameter_description>
</parameter>
</parameters>
-<return> a selected #GFile. You own the returned file; use
-g_object_unref() to release it.
+<return> %TRUE if the link has been visited, %FALSE otherwise
</return>
</function>
-<function name="gtk_buildable_custom_finished">
+<function name="gtk_link_button_new">
<description>
-This is similar to gtk_buildable_parser_finished() but is
-called once for each custom tag handled by the @buildable.
+Creates a new #GtkLinkButton with the URI as its text.
-Since: 2.12
+Since: 2.10
</description>
<parameters>
-<parameter name="buildable">
-<parameter_description> a #GtkBuildable
-</parameter_description>
-</parameter>
-<parameter name="builder">
-<parameter_description> a #GtkBuilder
-</parameter_description>
-</parameter>
-<parameter name="child">
-<parameter_description> child object or %NULL for non-child tags
-</parameter_description>
-</parameter>
-<parameter name="tagname">
-<parameter_description> the name of the tag
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> user data created in custom_tag_start
+<parameter name="uri">
+<parameter_description> a valid URI
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new link button widget.
+
+</return>
</function>
-<function name="gtk_tree_view_remove_column">
+<function name="gtk_link_button_new_with_label">
<description>
-Removes @column from @tree_view.
+Creates a new #GtkLinkButton containing a label.
+Since: 2.10
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView.
+<parameter name="uri">
+<parameter_description> a valid URI
</parameter_description>
</parameter>
-<parameter name="column">
-<parameter_description> The #GtkTreeViewColumn to remove.
+<parameter name="label">
+<parameter_description> the text of the button
</parameter_description>
</parameter>
</parameters>
-<return> The number of columns in @tree_view after removing.
+<return> a new link button widget.
+
</return>
</function>
-<function name="gtk_print_settings_set">
+<function name="gtk_link_button_set_uri">
<description>
-Associates @value with @key.
+Sets @uri as the URI where the #GtkLinkButton points. As a side-effect
+this unsets the 'visited' state of the button.
Since: 2.10
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
+<parameter name="link_button">
+<parameter_description> a #GtkLinkButton
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> a string value, or %NULL
+<parameter name="uri">
+<parameter_description> a valid URI
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_accelerator_get_label">
+<function name="gtk_link_button_set_uri_hook">
<description>
-Converts an accelerator keyval and modifier mask into a string
-which can be used to represent the accelerator to the user.
+Sets @func as the function that should be invoked every time a user clicks
+a #GtkLinkButton. This function is called before every callback registered
+for the "clicked" signal.
-Since: 2.6
+If no uri hook has been set, GTK+ defaults to calling gtk_show_uri().
+
+Since: 2.10
+
+Deprecated: 2.24: Use the #GtkButton::clicked signal instead
</description>
<parameters>
-<parameter name="accelerator_key">
-<parameter_description> accelerator keyval
+<parameter name="func">
+<parameter_description> a function called each time a #GtkLinkButton is clicked, or %NULL
</parameter_description>
</parameter>
-<parameter name="accelerator_mods">
-<parameter_description> accelerator modifier mask
+<parameter name="data">
+<parameter_description> user data to be passed to @func, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="destroy">
+<parameter_description> a #GDestroyNotify that gets called when @data is no longer needed, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated string representing the accelerator.
+<return> the previously set hook function.
</return>
</function>
-<function name="gtk_tree_selection_path_is_selected">
+<function name="gtk_link_button_set_visited">
<description>
-Returns %TRUE if the row pointed to by @path is currently selected. If @path
-does not point to a valid location, %FALSE is returned
+Sets the 'visited' state of the URI where the #GtkLinkButton
+points. See gtk_link_button_get_visited() for more details.
+Since: 2.14
</description>
<parameters>
-<parameter name="selection">
-<parameter_description> A #GtkTreeSelection.
+<parameter name="link_button">
+<parameter_description> a #GtkLinkButton
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> A #GtkTreePath to check selection on.
+<parameter name="visited">
+<parameter_description> the new 'visited' state
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @path is selected.
-</return>
+<return></return>
</function>
-<function name="gtk_dialog_get_response_for_widget">
+<function name="gtk_list_store_append">
<description>
-Gets the response id of a widget in the action area
-of a dialog.
+Appends a new row to @list_store. @iter will be changed to point to this new
+row. The row will be empty after this function is called. To fill in
+values, you need to call gtk_list_store_set() or gtk_list_store_set_value().
-Since: 2.8
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkDialog
+<parameter name="list_store">
+<parameter_description> A #GtkListStore
</parameter_description>
</parameter>
-<parameter name="widget">
-<parameter_description> a widget in the action area of @dialog
+<parameter name="iter">
+<parameter_description> An unset #GtkTreeIter to set to the appended row
</parameter_description>
</parameter>
</parameters>
-<return> the response id of @widget, or %GTK_RESPONSE_NONE
-if @widget doesn't have a response id set.
-
-</return>
+<return></return>
</function>
-<function name="gtk_im_context_set_cursor_location">
+<function name="gtk_list_store_clear">
<description>
-Notify the input method that a change in cursor
-position has been made. The location is relative to the client
-window.
+Removes all rows from the list store.
+
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GtkIMContext
-</parameter_description>
-</parameter>
-<parameter name="area">
-<parameter_description> new location
+<parameter name="list_store">
+<parameter_description> a #GtkListStore.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_about_dialog_set_program_name">
+<function name="gtk_list_store_insert">
<description>
-Sets the name to display in the about dialog.
-If this is not set, it defaults to g_get_application_name().
+Creates a new row at @position. @iter will be changed to point to this new
+row. If @position is larger than the number of rows on the list, then the
+new row will be appended to the list. The row will be empty after this
+function is called. To fill in values, you need to call
+gtk_list_store_set() or gtk_list_store_set_value().
-Since: 2.12
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter name="list_store">
+<parameter_description> A #GtkListStore
</parameter_description>
</parameter>
-<parameter name="name">
-<parameter_description> the program name
+<parameter name="iter">
+<parameter_description> An unset #GtkTreeIter to set to the new row
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> position to insert the new row
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_file_chooser_select_uri">
+<function name="gtk_list_store_insert_after">
<description>
-Selects the file to by @uri. If the URI doesn't refer to a
-file in the current folder of @chooser, then the current folder of
- chooser will be changed to the folder containing @filename.
+Inserts a new row after @sibling. If @sibling is %NULL, then the row will be
+prepended to the beginning of the list. @iter will be changed to point to
+this new row. The row will be empty after this function is called. To fill
+in values, you need to call gtk_list_store_set() or gtk_list_store_set_value().
-Since: 2.4
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="list_store">
+<parameter_description> A #GtkListStore
</parameter_description>
</parameter>
-<parameter name="uri">
-<parameter_description> the URI to select
+<parameter name="iter">
+<parameter_description> An unset #GtkTreeIter to set to the new row
</parameter_description>
</parameter>
-</parameters>
-<return> %TRUE if both the folder could be changed and the URI was
-selected successfully, %FALSE otherwise.
-
-</return>
-</function>
-
-<function name="gtk_tool_button_get_use_underline">
-<description>
-Returns whether underscores in the label property are used as mnemonics
-on menu items on the overflow menu. See gtk_tool_button_set_use_underline().
-
-Since: 2.4
-
-</description>
-<parameters>
-<parameter name="button">
-<parameter_description> a #GtkToolButton
+<parameter name="sibling">
+<parameter_description> A valid #GtkTreeIter, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if underscores in the label property are used as
-mnemonics on menu items on the overflow menu.
-
-</return>
+<return></return>
</function>
-<function name="gtk_page_setup_unix_dialog_new">
+<function name="gtk_list_store_insert_before">
<description>
-Creates a new page setup dialog.
+Inserts a new row before @sibling. If @sibling is %NULL, then the row will
+be appended to the end of the list. @iter will be changed to point to this
+new row. The row will be empty after this function is called. To fill in
+values, you need to call gtk_list_store_set() or gtk_list_store_set_value().
-Since: 2.10
</description>
<parameters>
-<parameter name="title">
-<parameter_description> the title of the dialog, or %NULL
+<parameter name="list_store">
+<parameter_description> A #GtkListStore
</parameter_description>
</parameter>
-<parameter name="parent">
-<parameter_description> transient parent of the dialog, or %NULL
+<parameter name="iter">
+<parameter_description> An unset #GtkTreeIter to set to the new row
+</parameter_description>
+</parameter>
+<parameter name="sibling">
+<parameter_description> A valid #GtkTreeIter, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the new #GtkPageSetupUnixDialog
-
-</return>
+<return></return>
</function>
-<function name="gtk_table_get_row_spacing">
+<function name="gtk_list_store_insert_with_values">
<description>
-Gets the amount of space between row @row, and
-row @row + 1. See gtk_table_set_row_spacing().
+Creates a new row at @position. @iter will be changed to point to this new
+row. If @position is larger than the number of rows on the list, then the
+new row will be appended to the list. The row will be filled with the
+values given to this function.
+Calling
+<literal>gtk_list_store_insert_with_values(list_store, iter, position...)</literal>
+has the same effect as calling
+|[
+gtk_list_store_insert (list_store, iter, position);
+gtk_list_store_set (list_store, iter, ...);
+]|
+with the difference that the former will only emit a row_inserted signal,
+while the latter will emit row_inserted, row_changed and, if the list store
+is sorted, rows_reordered. Since emitting the rows_reordered signal
+repeatedly can affect the performance of the program,
+gtk_list_store_insert_with_values() should generally be preferred when
+inserting rows in a sorted list store.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="table">
-<parameter_description> a #GtkTable
+<parameter name="list_store">
+<parameter_description> A #GtkListStore
</parameter_description>
</parameter>
-<parameter name="row">
-<parameter_description> a row in the table, 0 indicates the first row
+<parameter name="iter">
+<parameter_description> An unset #GtkTreeIter to set to the new row, or %NULL.
</parameter_description>
</parameter>
-</parameters>
-<return> the row spacing
-</return>
-</function>
-
-<function name="gtk_entry_set_text">
-<description>
-Sets the text in the widget to the given
-value, replacing the current contents.
-
-See gtk_entry_buffer_set_text().
-
-</description>
-<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="position">
+<parameter_description> position to insert the new row
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> the new text
+<parameter name="Varargs">
+<parameter_description> pairs of column number and value, terminated with -1
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_queue_resize_no_redraw">
+<function name="gtk_list_store_insert_with_valuesv">
<description>
-This function works like gtk_widget_queue_resize(),
-except that the widget is not invalidated.
+A variant of gtk_list_store_insert_with_values() which
+takes the columns and values as two arrays, instead of
+varargs. This function is mainly intended for
+language-bindings.
-Since: 2.4
+Since: 2.6
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="list_store">
+<parameter_description> A #GtkListStore
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> An unset #GtkTreeIter to set to the new row, or %NULL.
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> position to insert the new row
+</parameter_description>
+</parameter>
+<parameter name="columns">
+<parameter_description> an array of column numbers
+</parameter_description>
+</parameter>
+<parameter name="values">
+<parameter_description> an array of GValues
+</parameter_description>
+</parameter>
+<parameter name="n_values">
+<parameter_description> the length of the @columns and @values arrays
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_recent_info_has_application">
+<function name="gtk_list_store_iter_is_valid">
<description>
-Checks whether an application registered this resource using @app_name.
+<warning>This function is slow. Only use it for debugging and/or testing
+purposes.</warning>
-Since: 2.10
+Checks if the given iter is a valid iter for this #GtkListStore.
+
+Since: 2.2
</description>
<parameters>
-<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter name="list_store">
+<parameter_description> A #GtkListStore.
</parameter_description>
</parameter>
-<parameter name="app_name">
-<parameter_description> a string containing an application name
+<parameter name="iter">
+<parameter_description> A #GtkTreeIter.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if an application with name @app_name was found,
-%FALSE otherwise.
+<return> %TRUE if the iter is valid, %FALSE if the iter is invalid.
</return>
</function>
-<function name="gtk_action_set_visible_vertical">
+<function name="gtk_list_store_move_after">
<description>
-Sets whether @action is visible when vertical
+Moves @iter in @store to the position after @position. Note that this
+function only works with unsorted stores. If @position is %NULL, @iter
+will be moved to the start of the list.
-Since: 2.16
+Since: 2.2
</description>
<parameters>
-<parameter name="action">
-<parameter_description> a #GtkAction
+<parameter name="store">
+<parameter_description> A #GtkListStore.
</parameter_description>
</parameter>
-<parameter name="visible_vertical">
-<parameter_description> whether the action is visible vertically
+<parameter name="iter">
+<parameter_description> A #GtkTreeIter.
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> A #GtkTreeIter or %NULL.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_get_size">
+<function name="gtk_list_store_move_before">
<description>
-Obtains the current size of @window. If @window is not onscreen,
-it returns the size GTK+ will suggest to the <link
-linkend="gtk-X11-arch">window manager</link> for the initial window
-size (but this is not reliably the same as the size the window
-manager will actually select). The size obtained by
-gtk_window_get_size() is the last size received in a
-#GdkEventConfigure, that is, GTK+ uses its locally-stored size,
-rather than querying the X server for the size. As a result, if you
-call gtk_window_resize() then immediately call
-gtk_window_get_size(), the size won't have taken effect yet. After
-the window manager processes the resize request, GTK+ receives
-notification that the size has changed via a configure event, and
-the size of the window gets updated.
-
-Note 1: Nearly any use of this function creates a race condition,
-because the size of the window may change between the time that you
-get the size and the time that you perform some action assuming
-that size is the current size. To avoid race conditions, connect to
-"configure-event" on the window and adjust your size-dependent
-state to match the size delivered in the #GdkEventConfigure.
-
-Note 2: The returned size does <emphasis>not</emphasis> include the
-size of the window manager decorations (aka the window frame or
-border). Those are not drawn by GTK+ and GTK+ has no reliable
-method of determining their size.
-
-Note 3: If you are getting a window size in order to position
-the window onscreen, there may be a better way. The preferred
-way is to simply set the window's semantic type with
-gtk_window_set_type_hint(), which allows the window manager to
-e.g. center dialogs. Also, if you set the transient parent of
-dialogs with gtk_window_set_transient_for() window managers
-will often center the dialog over its parent window. It's
-much preferred to let the window manager handle these
-things rather than doing it yourself, because all apps will
-behave consistently and according to user prefs if the window
-manager handles it. Also, the window manager can take the size
-of the window decorations/border into account, while your
-application cannot.
-
-In any case, if you insist on application-specified window
-positioning, there's <emphasis>still</emphasis> a better way than
-doing it yourself - gtk_window_set_position() will frequently
-handle the details for you.
+Moves @iter in @store to the position before @position. Note that this
+function only works with unsorted stores. If @position is %NULL, @iter
+will be moved to the end of the list.
+Since: 2.2
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="store">
+<parameter_description> A #GtkListStore.
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> return location for width, or %NULL
+<parameter name="iter">
+<parameter_description> A #GtkTreeIter.
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> return location for height, or %NULL
+<parameter name="position">
+<parameter_description> A #GtkTreeIter, or %NULL.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_rc_reset_styles">
+<function name="gtk_list_store_new">
<description>
-This function recomputes the styles for all widgets that use a
-particular #GtkSettings object. (There is one #GtkSettings object
-per #GdkScreen, see gtk_settings_get_for_screen()); It is useful
-when some global parameter has changed that affects the appearance
-of all widgets, because when a widget gets a new style, it will
-both redraw and recompute any cached information about its
-appearance. As an example, it is used when the default font size
-set by the operating system changes. Note that this function
-doesn't affect widgets that have a style set explicitely on them
-with gtk_widget_set_style().
-
-Since: 2.4
+Creates a new list store as with @n_columns columns each of the types passed
+in. Note that only types derived from standard GObject fundamental types
+are supported.
-</description>
-<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkSettings
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
-</function>
+As an example, <literal>gtk_tree_store_new (3, G_TYPE_INT, G_TYPE_STRING,
+GDK_TYPE_PIXBUF);</literal> will create a new #GtkListStore with three columns, of type
+int, string and #GdkPixbuf respectively.
-<function name="gtk_container_add">
-<description>
-Adds @widget to @container. Typically used for simple containers
-such as #GtkWindow, #GtkFrame, or #GtkButton; for more complicated
-layout containers such as #GtkBox or #GtkTable, this function will
-pick default packing parameters that may not be correct. So
-consider functions such as gtk_box_pack_start() and
-gtk_table_attach() as an alternative to gtk_container_add() in
-those cases. A widget may be added to only one container at a time;
-you can't place the same widget inside two different containers.
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
+<parameter name="n_columns">
+<parameter_description> number of columns in the list store
</parameter_description>
</parameter>
-<parameter name="widget">
-<parameter_description> a widget to be placed inside @container
+<parameter name="Varargs">
+<parameter_description> all #GType types for the columns, from first to last
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GtkListStore
+</return>
</function>
-<function name="gtk_entry_get_progress_fraction">
+<function name="gtk_list_store_newv">
<description>
-Returns the current fraction of the task that's been completed.
-See gtk_entry_set_progress_fraction().
+Non-vararg creation function. Used primarily by language bindings.
-Since: 2.16
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="n_columns">
+<parameter_description> number of columns in the list store
+</parameter_description>
+</parameter>
+<parameter name="types">
+<parameter_description> an array of #GType types for the columns, from first to last
</parameter_description>
</parameter>
</parameters>
-<return> a fraction from 0.0 to 1.0
-
+<return> a new #GtkListStore
</return>
</function>
-<function name="gtk_item_factory_set_translate_func">
+<function name="gtk_list_store_prepend">
<description>
-Sets a function to be used for translating the path elements before they
-are displayed.
+Prepends a new row to @list_store. @iter will be changed to point to this new
+row. The row will be empty after this function is called. To fill in
+values, you need to call gtk_list_store_set() or gtk_list_store_set_value().
-Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="ifactory">
-<parameter_description> a #GtkItemFactory
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> the #GtkTranslateFunc function to be used to translate path elements
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> data to pass to @func and @notify
+<parameter name="list_store">
+<parameter_description> A #GtkListStore
</parameter_description>
</parameter>
-<parameter name="notify">
-<parameter_description> a #GDestroyNotify function to be called when @ifactory is
-destroyed and when the translation function is changed again
+<parameter name="iter">
+<parameter_description> An unset #GtkTreeIter to set to the prepend row
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_iter_get_tags">
+<function name="gtk_list_store_remove">
<description>
-Returns a list of tags that apply to @iter, in ascending order of
-priority (highest-priority tags are last). The #GtkTextTag in the
-list don't have a reference added, but you have to free the list
-itself.
+Removes the given row from the list store. After being removed,
+ iter is set to be the next valid row, or invalidated if it pointed
+to the last row in @list_store.
</description>
<parameters>
+<parameter name="list_store">
+<parameter_description> A #GtkListStore
+</parameter_description>
+</parameter>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> A valid #GtkTreeIter
</parameter_description>
</parameter>
</parameters>
-<return> list of #GtkTextTag
+<return> %TRUE if @iter is valid, %FALSE if not.
</return>
</function>
-<function name="gtk_text_iter_forward_visible_line">
+<function name="gtk_list_store_reorder">
<description>
-Moves @iter to the start of the next visible line. Returns %TRUE if there
-was a next line to move to, and %FALSE if @iter was simply moved to
-the end of the buffer and is now not dereferenceable, or if @iter was
-already at the end of the buffer.
+Reorders @store to follow the order indicated by @new_order. Note that
+this function only works with unsorted stores.
-Since: 2.8
+Since: 2.2
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
+<parameter name="store">
+<parameter_description> A #GtkListStore.
+</parameter_description>
+</parameter>
+<parameter name="new_order">
+<parameter_description> an array of integers mapping the new position of each child
+to its old position before the re-ordering,
+i.e. @new_order<literal>[newpos] = oldpos</literal>.
</parameter_description>
</parameter>
</parameters>
-<return> whether @iter can be dereferenced
-
-</return>
+<return></return>
</function>
-<function name="gtk_tree_view_get_search_entry">
+<function name="gtk_list_store_set">
<description>
-Returns the #GtkEntry which is currently in use as interactive search
-entry for @tree_view. In case the built-in entry is being used, %NULL
-will be returned.
+Sets the value of one or more cells in the row referenced by @iter.
+The variable argument list should contain integer column numbers,
+each column number followed by the value to be set.
+The list is terminated by a -1. For example, to set column 0 with type
+%G_TYPE_STRING to "Foo", you would write <literal>gtk_list_store_set (store, iter,
+0, "Foo", -1)</literal>.
-Since: 2.10
+The value will be referenced by the store if it is a %G_TYPE_OBJECT, and it
+will be copied if it is a %G_TYPE_STRING or %G_TYPE_BOXED.
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView
+<parameter name="list_store">
+<parameter_description> a #GtkListStore
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> row iterator
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> pairs of column number and value, terminated with -1
</parameter_description>
</parameter>
</parameters>
-<return> the entry currently in use as search entry.
-
-</return>
+<return></return>
</function>
-<function name="gtk_button_box_set_child_secondary">
+<function name="gtk_list_store_set_column_types">
<description>
-Sets whether @child should appear in a secondary group of children.
-A typical use of a secondary child is the help button in a dialog.
-
-This group appears after the other children if the style
-is %GTK_BUTTONBOX_START, %GTK_BUTTONBOX_SPREAD or
-%GTK_BUTTONBOX_EDGE, and before the other children if the style
-is %GTK_BUTTONBOX_END. For horizontal button boxes, the definition
-of before/after depends on direction of the widget (see
-gtk_widget_set_direction()). If the style is %GTK_BUTTONBOX_START
-or %GTK_BUTTONBOX_END, then the secondary children are aligned at
-the other end of the button box from the main children. For the
-other styles, they appear immediately next to the main children.
+This function is meant primarily for #GObjects that inherit from #GtkListStore,
+and should only be used when constructing a new #GtkListStore. It will not
+function after a row has been added, or a method on the #GtkTreeModel
+interface is called.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkButtonBox
+<parameter name="list_store">
+<parameter_description> A #GtkListStore
</parameter_description>
</parameter>
-<parameter name="child">
-<parameter_description> a child of @widget
+<parameter name="n_columns">
+<parameter_description> Number of columns for the list store
</parameter_description>
</parameter>
-<parameter name="is_secondary">
-<parameter_description> if %TRUE, the @child appears in a secondary group of the
-button box.
+<parameter name="types">
+<parameter_description> An array length n of #GTypes
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_item_factory_delete_entries">
+<function name="gtk_list_store_set_valist">
<description>
-Deletes the menu items which were created from the @entries by the given
-item factory.
+See gtk_list_store_set(); this version takes a va_list for use by language
+bindings.
-Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="ifactory">
-<parameter_description> a #GtkItemFactory
+<parameter name="list_store">
+<parameter_description> A #GtkListStore
</parameter_description>
</parameter>
-<parameter name="n_entries">
-<parameter_description> the length of @entries
+<parameter name="iter">
+<parameter_description> A valid #GtkTreeIter for the row being modified
</parameter_description>
</parameter>
-<parameter name="entries">
-<parameter_description> an array of #GtkItemFactoryEntry<!-- -->s
+<parameter name="var_args">
+<parameter_description> va_list of column/value pairs
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_operation_preview_is_selected">
+<function name="gtk_list_store_set_value">
<description>
-Returns whether the given page is included in the set of pages that
-have been selected for printing.
+Sets the data in the cell specified by @iter and @column.
+The type of @value must be convertible to the type of the
+column.
-Since: 2.10
</description>
<parameters>
-<parameter name="preview">
-<parameter_description> a #GtkPrintOperationPreview
+<parameter name="list_store">
+<parameter_description> A #GtkListStore
</parameter_description>
</parameter>
-<parameter name="page_nr">
-<parameter_description> a page number
+<parameter name="iter">
+<parameter_description> A valid #GtkTreeIter for the row being modified
</parameter_description>
</parameter>
-</parameters>
-<return> %TRUE if the page has been selected for printing
-
-</return>
-</function>
-
-<function name="gtk_spin_button_set_digits">
-<description>
-Set the precision to be displayed by @spin_button. Up to 20 digit precision
-is allowed.
-
-</description>
-<parameters>
-<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter name="column">
+<parameter_description> column number to modify
</parameter_description>
</parameter>
-<parameter name="digits">
-<parameter_description> the number of digits after the decimal point to be displayed for the spin button's value
+<parameter name="value">
+<parameter_description> new value for the cell
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_tag_table_add">
+<function name="gtk_list_store_set_valuesv">
<description>
-Add a tag to the table. The tag is assigned the highest priority
-in the table.
+A variant of gtk_list_store_set_valist() which
+takes the columns and values as two arrays, instead of
+varargs. This function is mainly intended for
+language-bindings and in case the number of columns to
+change is not known until run-time.
- tag must not be in a tag table already, and may not have
-the same name as an already-added tag.
+Since: 2.12
</description>
<parameters>
-<parameter name="table">
-<parameter_description> a #GtkTextTagTable
+<parameter name="list_store">
+<parameter_description> A #GtkListStore
</parameter_description>
</parameter>
-<parameter name="tag">
-<parameter_description> a #GtkTextTag
+<parameter name="iter">
+<parameter_description> A valid #GtkTreeIter for the row being modified
+</parameter_description>
+</parameter>
+<parameter name="columns">
+<parameter_description> an array of column numbers
+</parameter_description>
+</parameter>
+<parameter name="values">
+<parameter_description> an array of GValues
+</parameter_description>
+</parameter>
+<parameter name="n_values">
+<parameter_description> the length of the @columns and @values arrays
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_toggle_tool_button_new">
-<description>
-Returns a new #GtkToggleToolButton
-
-Since: 2.4
-
-</description>
-<parameters>
-</parameters>
-<return> a newly created #GtkToggleToolButton
-
-</return>
-</function>
-
-<function name="gtk_option_menu_get_history">
+<function name="gtk_list_store_swap">
<description>
-Retrieves the index of the currently selected menu item. The menu
-items are numbered from top to bottom, starting with 0.
+Swaps @a and @b in @store. Note that this function only works with
+unsorted stores.
-Deprecated: 2.4: Use #GtkComboBox instead.
+Since: 2.2
</description>
<parameters>
-<parameter name="option_menu">
-<parameter_description> a #GtkOptionMenu
+<parameter name="store">
+<parameter_description> A #GtkListStore.
+</parameter_description>
+</parameter>
+<parameter name="a">
+<parameter_description> A #GtkTreeIter.
+</parameter_description>
+</parameter>
+<parameter name="b">
+<parameter_description> Another #GtkTreeIter.
</parameter_description>
</parameter>
</parameters>
-<return> index of the selected menu item, or -1 if there are no menu items
-</return>
+<return></return>
</function>
-<function name="gtk_toolbar_prepend_space">
+<function name="gtk_menu_attach">
<description>
-Adds a new space to the beginning of the toolbar.
+Adds a new #GtkMenuItem to a (table) menu. The number of 'cells' that
+an item will occupy is specified by @left_attach, @right_attach,
+ top_attach and @bottom_attach. These each represent the leftmost,
+rightmost, uppermost and lower column and row numbers of the table.
+(Columns and rows are indexed from zero).
-Deprecated: 2.4: Use gtk_toolbar_insert() instead.
+Note that this function is not related to gtk_menu_detach().
+
+Since: 2.4
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar.
+<parameter name="menu">
+<parameter_description> a #GtkMenu.
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> a #GtkMenuItem.
+</parameter_description>
+</parameter>
+<parameter name="left_attach">
+<parameter_description> The column number to attach the left side of the item to.
+</parameter_description>
+</parameter>
+<parameter name="right_attach">
+<parameter_description> The column number to attach the right side of the item to.
+</parameter_description>
+</parameter>
+<parameter name="top_attach">
+<parameter_description> The row number to attach the top of the item to.
+</parameter_description>
+</parameter>
+<parameter name="bottom_attach">
+<parameter_description> The row number to attach the bottom of the item to.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_theme_get_example_icon_name">
+<function name="gtk_menu_bar_get_child_pack_direction">
<description>
-Gets the name of an icon that is representative of the
-current theme (for instance, to use when presenting
-a list of themes to the user.)
+Retrieves the current child pack direction of the menubar.
+See gtk_menu_bar_set_child_pack_direction().
-Since: 2.4
+Since: 2.8
</description>
<parameters>
-<parameter name="icon_theme">
-<parameter_description> a #GtkIconTheme
+<parameter name="menubar">
+<parameter_description> a #GtkMenuBar
</parameter_description>
</parameter>
</parameters>
-<return> the name of an example icon or %NULL.
-Free with g_free().
+<return> the child pack direction
</return>
</function>
-<function name="gtk_page_setup_new">
+<function name="gtk_menu_bar_get_pack_direction">
<description>
-Creates a new #GtkPageSetup.
+Retrieves the current pack direction of the menubar.
+See gtk_menu_bar_set_pack_direction().
-Since: 2.10
+Since: 2.8
</description>
<parameters>
+<parameter name="menubar">
+<parameter_description> a #GtkMenuBar
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GtkPageSetup.
+<return> the pack direction
</return>
</function>
-<function name="gtk_target_list_add_uri_targets">
+<function name="gtk_menu_bar_set_child_pack_direction">
<description>
-Appends the URI targets supported by #GtkSelection to
-the target list. All targets are added with the same @info.
+Sets how widgets should be packed inside the children of a menubar.
-Since: 2.6
+Since: 2.8
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GtkTargetList
+<parameter name="menubar">
+<parameter_description> a #GtkMenuBar
</parameter_description>
</parameter>
-<parameter name="info">
-<parameter_description> an ID that will be passed back to the application
+<parameter name="child_pack_dir">
+<parameter_description> a new #GtkPackDirection
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_iter_get_visible_slice">
+<function name="gtk_menu_bar_set_pack_direction">
<description>
-Like gtk_text_iter_get_slice (), but invisible text is not included.
-Invisible text is usually invisible because a #GtkTextTag with the
-"invisible" attribute turned on has been applied to it.
+Sets how items should be packed inside a menubar.
+Since: 2.8
</description>
<parameters>
-<parameter name="start">
-<parameter_description> iterator at start of range
+<parameter name="menubar">
+<parameter_description> a #GtkMenuBar
</parameter_description>
</parameter>
-<parameter name="end">
-<parameter_description> iterator at end of range
+<parameter name="pack_dir">
+<parameter_description> a new #GtkPackDirection
</parameter_description>
</parameter>
</parameters>
-<return> slice of text from the buffer
-</return>
+<return></return>
</function>
-<function name="gtk_range_get_fill_level">
+<function name="gtk_menu_get_accel_path">
<description>
-Gets the current position of the fill level indicator.
+Retrieves the accelerator path set on the menu.
-Since: 2.12
+Since: 2.14
</description>
<parameters>
-<parameter name="range">
-<parameter_description> A #GtkRange
+<parameter name="menu">
+<parameter_description> a valid #GtkMenu
</parameter_description>
</parameter>
</parameters>
-<return> The current fill level
+<return> the accelerator path set on the menu.
</return>
</function>
-<function name="gtk_assistant_append_page">
+<function name="gtk_menu_get_for_attach_widget">
<description>
-Appends a page to the @assistant.
+Returns a list of the menus which are attached to this widget.
+This list is owned by GTK+ and must not be modified.
-Since: 2.10
+Since: 2.6
</description>
<parameters>
-<parameter name="assistant">
-<parameter_description> a #GtkAssistant
-</parameter_description>
-</parameter>
-<parameter name="page">
+<parameter name="widget">
<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> the index (starting at 0) of the inserted page
+<return> the list of menus attached to his widget.
</return>
</function>
-<function name="gtk_text_iter_backward_visible_cursor_positions">
+<function name="gtk_menu_get_monitor">
<description>
-Moves up to @count visible cursor positions. See
-gtk_text_iter_backward_cursor_position() for details.
+Retrieves the number of the monitor on which to show the menu.
-Since: 2.4
+Since: 2.14
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
-</parameter_description>
-</parameter>
-<parameter name="count">
-<parameter_description> number of positions to move
+<parameter name="menu">
+<parameter_description> a #GtkMenu
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if we moved and the new position is dereferenceable
+<return> the number of the monitor on which the menu should
+be popped up or -1, if no monitor has been set
</return>
</function>
-<function name="gtk_text_view_place_cursor_onscreen">
+<function name="gtk_menu_get_reserve_toggle_size">
<description>
-Moves the cursor to the currently visible region of the
-buffer, it it isn't there already.
+Returns whether the menu reserves space for toggles and
+icons, regardless of their actual presence.
+Since: 2.18
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="menu">
+<parameter_description> a #GtkMenu
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the cursor had to be moved.
+<return> Whether the menu reserves toggle space
+
</return>
</function>
-<function name="gtk_label_get_mnemonic_keyval">
+<function name="gtk_menu_get_tearoff_state">
<description>
-If the label has been set so that it has an mnemonic key this function
-returns the keyval used for the mnemonic accelerator. If there is no
-mnemonic set up it returns #GDK_VoidSymbol.
+Returns whether the menu is torn off. See
+gtk_menu_set_tearoff_state ().
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="menu">
+<parameter_description> a #GtkMenu
</parameter_description>
</parameter>
</parameters>
-<return> GDK keyval usable for accelerators, or #GDK_VoidSymbol
+<return> %TRUE if the menu is currently torn off.
</return>
</function>
-<function name="gtk_page_setup_set_bottom_margin">
+<function name="gtk_menu_get_title">
<description>
-Sets the bottom margin of the #GtkPageSetup.
+Returns the title of the menu. See gtk_menu_set_title().
-Since: 2.10
</description>
<parameters>
-<parameter name="setup">
-<parameter_description> a #GtkPageSetup
-</parameter_description>
-</parameter>
-<parameter name="margin">
-<parameter_description> the new bottom margin in units of @unit
-</parameter_description>
-</parameter>
-<parameter name="unit">
-<parameter_description> the units for @margin
+<parameter name="menu">
+<parameter_description> a #GtkMenu
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the title of the menu, or %NULL if the menu has no
+title set on it. This string is owned by the widget and should
+not be modified or freed.
+</return>
</function>
-<function name="gtk_action_set_gicon">
+<function name="gtk_menu_item_get_accel_path">
<description>
-Sets the icon of @action.
+Retrieve the accelerator path that was previously set on @menu_item.
-Since: 2.16
+See gtk_menu_item_set_accel_path() for details.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="action">
-<parameter_description> a #GtkAction
-</parameter_description>
-</parameter>
-<parameter name="icon">
-<parameter_description> the #GIcon to set
+<parameter name="menu_item">
+<parameter_description> a valid #GtkMenuItem
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the accelerator path corresponding to this menu item's
+functionality, or %NULL if not set
+
+</return>
</function>
-<function name="gtk_tool_button_get_icon_widget">
+<function name="gtk_menu_item_get_label">
<description>
-Return the widget used as icon widget on @button. See
-gtk_tool_button_set_icon_widget().
+Sets @text on the @menu_item label
-Since: 2.4
+Since: 2.16
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkToolButton
+<parameter name="menu_item">
+<parameter_description> a #GtkMenuItem
</parameter_description>
</parameter>
</parameters>
-<return> The widget used as icon on @button, or %NULL.
+<return> The text in the @menu_item label. This is the internal
+string used by the label, and must not be modified.
</return>
</function>
-<function name="gtk_accel_map_foreach_unfiltered">
+<function name="gtk_menu_item_get_right_justified">
<description>
-Loops over all entries in the accelerator map, and execute
- foreach_func on each. The signature of @foreach_func is that of
-#GtkAccelMapForeach, the @changed parameter indicates whether
-this accelerator was changed during runtime (thus, would need
-saving during an accelerator map dump).
+Gets whether the menu item appears justified at the right
+side of the menu bar.
+
</description>
<parameters>
-<parameter name="data">
-<parameter_description> data to be passed into @foreach_func
-</parameter_description>
-</parameter>
-<parameter name="foreach_func">
-<parameter_description> function to be executed for each accel map entry
+<parameter name="menu_item">
+<parameter_description> a #GtkMenuItem
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the menu item will appear at the
+far right if added to a menu bar.
+</return>
</function>
-<function name="gtk_tree_view_set_row_separator_func">
+<function name="gtk_menu_item_get_submenu">
<description>
-Sets the row separator function, which is used to determine
-whether a row should be drawn as a separator. If the row separator
-function is %NULL, no separators are drawn. This is the default value.
+Gets the submenu underneath this menu item, if any.
+See gtk_menu_item_set_submenu().
-Since: 2.6
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> a #GtkTreeViewRowSeparatorFunc
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> user data to pass to @func, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="destroy">
-<parameter_description> destroy notifier for @data, or %NULL
+<parameter name="menu_item">
+<parameter_description> a #GtkMenuItem
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> submenu for this menu item, or %NULL if none.
+</return>
</function>
-<function name="gtk_text_iter_forward_char">
+<function name="gtk_menu_item_get_use_underline">
<description>
-Moves @iter forward by one character offset. Note that images
-embedded in the buffer occupy 1 character slot, so
-gtk_text_iter_forward_char () may actually move onto an image instead
-of a character, if you have images in your buffer. If @iter is the
-end iterator or one character before it, @iter will now point at
-the end iterator, and gtk_text_iter_forward_char () returns %FALSE for
-convenience when writing loops.
+Checks if an underline in the text indicates the next character should be
+used for the mnemonic accelerator key.
+Since: 2.16
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
+<parameter name="menu_item">
+<parameter_description> a #GtkMenuItem
</parameter_description>
</parameter>
</parameters>
-<return> whether @iter moved and is dereferenceable
+<return> %TRUE if an embedded underline in the label indicates
+the mnemonic accelerator key.
+
</return>
</function>
-<function name="gtk_text_tag_table_get_size">
+<function name="gtk_menu_item_new_with_mnemonic">
<description>
-Returns the size of the table (number of tags)
-
+Creates a new #GtkMenuItem containing a label. The label
+will be created using gtk_label_new_with_mnemonic(), so underscores
+in @label indicate the mnemonic for the menu item.
</description>
<parameters>
-<parameter name="table">
-<parameter_description> a #GtkTextTagTable
+<parameter name="label">
+<parameter_description> The text of the button, with an underscore in front of the
+mnemonic character
</parameter_description>
</parameter>
</parameters>
-<return> number of tags in @table
+<return> a new #GtkMenuItem
</return>
</function>
-<function name="gtk_text_buffer_get_selection_bounds">
+<function name="gtk_menu_item_remove_submenu">
<description>
-Returns %TRUE if some text is selected; places the bounds
-of the selection in @start and @end (if the selection has length 0,
-then @start and @end are filled in with the same value).
- start and @end will be in ascending order. If @start and @end are
-NULL, then they are not filled in, but the return value still indicates
-whether text is selected.
+Removes the widget's submenu.
+Deprecated: 2.12: gtk_menu_item_remove_submenu() is deprecated and
+should not be used in newly written code. Use
+gtk_menu_item_set_submenu() instead.
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="start">
-<parameter_description> iterator to initialize with selection start
-</parameter_description>
-</parameter>
-<parameter name="end">
-<parameter_description> iterator to initialize with selection end
+<parameter name="menu_item">
+<parameter_description> a #GtkMenuItem
</parameter_description>
</parameter>
</parameters>
-<return> whether the selection has nonzero length
-</return>
+<return></return>
</function>
-<function name="gtk_drag_update">
+<function name="gtk_menu_item_set_accel_path">
<description>
-Updates the status of the drag; called when the
-cursor moves or the modifier changes
+Set the accelerator path on @menu_item, through which runtime changes of the
+menu item's accelerator caused by the user can be identified and saved to
+persistant storage (see gtk_accel_map_save() on this).
+To setup a default accelerator for this menu item, call
+gtk_accel_map_add_entry() with the same @accel_path.
+See also gtk_accel_map_add_entry() on the specifics of accelerator paths,
+and gtk_menu_set_accel_path() for a more convenient variant of this function.
+
+This function is basically a convenience wrapper that handles calling
+gtk_widget_set_accel_path() with the appropriate accelerator group for
+the menu item.
+
+Note that you do need to set an accelerator on the parent menu with
+gtk_menu_set_accel_group() for this to work.
+
+Note that @accel_path string will be stored in a #GQuark. Therefore, if you
+pass a static string, you can save some memory by interning it first with
+g_intern_static_string().
</description>
<parameters>
-<parameter name="info">
-<parameter_description> DragSourceInfo for the drag
-</parameter_description>
-</parameter>
-<parameter name="screen">
-<parameter_description> new screen
+<parameter name="menu_item">
+<parameter_description> a valid #GtkMenuItem
</parameter_description>
</parameter>
-<parameter name="x_root">
-<parameter_description> new X position
+<parameter name="accel_path">
+<parameter_description> accelerator path, corresponding to this menu item's
+functionality, or %NULL to unset the current path.
</parameter_description>
</parameter>
-<parameter name="y_root">
-<parameter_description> new y position
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_menu_item_set_label">
+<description>
+Sets @text on the @menu_item label
+
+Since: 2.16
+
+</description>
+<parameters>
+<parameter name="menu_item">
+<parameter_description> a #GtkMenuItem
</parameter_description>
</parameter>
-<parameter name="event">
-<parameter_description> event received requiring update
+<parameter name="label">
+<parameter_description> the text you want to set
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_iter_begins_tag">
+<function name="gtk_menu_item_set_right_justified">
<description>
-Returns %TRUE if @tag is toggled on at exactly this point. If @tag
-is %NULL, returns %TRUE if any tag is toggled on at this point. Note
-that the gtk_text_iter_begins_tag () returns %TRUE if @iter is the
-<emphasis>start</emphasis> of the tagged range;
-gtk_text_iter_has_tag () tells you whether an iterator is
-<emphasis>within</emphasis> a tagged range.
-
+Sets whether the menu item appears justified at the right
+side of a menu bar. This was traditionally done for "Help" menu
+items, but is now considered a bad idea. (If the widget
+layout is reversed for a right-to-left language like Hebrew
+or Arabic, right-justified-menu-items appear at the left.)
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
+<parameter name="menu_item">
+<parameter_description> a #GtkMenuItem.
</parameter_description>
</parameter>
-<parameter name="tag">
-<parameter_description> a #GtkTextTag, or %NULL
+<parameter name="right_justified">
+<parameter_description> if %TRUE the menu item will appear at the
+far right if added to a menu bar.
</parameter_description>
</parameter>
</parameters>
-<return> whether @iter is the start of a range tagged with @tag
-</return>
+<return></return>
</function>
-<function name="gtk_page_setup_unix_dialog_set_print_settings">
+<function name="gtk_menu_item_set_submenu">
<description>
-Sets the #GtkPrintSettings from which the page setup dialog
-takes its values.
-
-Since: 2.10
+Sets or replaces the menu item's submenu, or removes it when a %NULL
+submenu is passed.
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkPageSetupUnixDialog
+<parameter name="menu_item">
+<parameter_description> a #GtkMenuItem
</parameter_description>
</parameter>
-<parameter name="print_settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="submenu">
+<parameter_description> the submenu, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_column_set_sort_indicator">
+<function name="gtk_menu_item_set_use_underline">
<description>
-Call this function with a @setting of %TRUE to display an arrow in
-the header button indicating the column is sorted. Call
-gtk_tree_view_column_set_sort_order() to change the direction of
-the arrow.
+If true, an underline in the text indicates the next character should be
+used for the mnemonic accelerator key.
+Since: 2.16
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> a #GtkTreeViewColumn
+<parameter name="menu_item">
+<parameter_description> a #GtkMenuItem
</parameter_description>
</parameter>
<parameter name="setting">
-<parameter_description> %TRUE to display an indicator that the column is sorted
+<parameter_description> %TRUE if underlines in the text indicate mnemonics
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_item_factory_popup_with_data">
+<function name="gtk_menu_popup">
<description>
-Pops up the menu constructed from the item factory at (@x, @y). Callbacks
-can access the @popup_data while the menu is posted via
-gtk_item_factory_popup_data() and gtk_item_factory_popup_data_from_widget().
+Displays a menu and makes it available for selection. Applications can use
+this function to display context-sensitive menus, and will typically supply
+%NULL for the @parent_menu_shell, @parent_menu_item, @func and @data
+parameters. The default menu positioning function will position the menu
+at the current mouse cursor position.
-The @mouse_button parameter should be the mouse button pressed to initiate
+The @button parameter should be the mouse button pressed to initiate
the menu popup. If the menu popup was initiated by something other than
a mouse button press, such as a mouse button release or a keypress,
- mouse_button should be 0.
-
-The @time_ parameter should be the time stamp of the event that
-initiated the popup. If such an event is not available, use
-gtk_get_current_event_time() instead.
-
-The operation of the @mouse_button and the @time_ parameters is the same
-as the @button and @activation_time parameters for gtk_menu_popup().
+ button should be 0.
-Deprecated: 2.4: Use #GtkUIManager instead.
+The @activate_time parameter is used to conflict-resolve initiation of
+concurrent requests for mouse/keyboard grab requests. To function
+properly, this needs to be the time stamp of the user event (such as
+a mouse click or key press) that caused the initiation of the popup.
+Only if no such event is available, gtk_get_current_event_time() can
+be used instead.
</description>
<parameters>
-<parameter name="ifactory">
-<parameter_description> a #GtkItemFactory of type #GTK_TYPE_MENU (see gtk_item_factory_new())
+<parameter name="menu">
+<parameter_description> a #GtkMenu.
</parameter_description>
</parameter>
-<parameter name="popup_data">
-<parameter_description> data available for callbacks while the menu is posted
+<parameter name="parent_menu_shell">
+<parameter_description> the menu shell containing the triggering menu item, or %NULL
</parameter_description>
</parameter>
-<parameter name="destroy">
-<parameter_description> a #GDestroyNotify function to be called on @popup_data when
-the menu is unposted
+<parameter name="parent_menu_item">
+<parameter_description> the menu item whose activation triggered the popup, or %NULL
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> the x position
+<parameter name="func">
+<parameter_description> a user supplied function used to position the menu, or %NULL
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> the y position
+<parameter name="data">
+<parameter_description> user supplied data to be passed to @func.
</parameter_description>
</parameter>
-<parameter name="mouse_button">
-<parameter_description> the mouse button which was pressed to initiate the popup
+<parameter name="button">
+<parameter_description> the mouse button which was pressed to initiate the event.
</parameter_description>
</parameter>
-<parameter name="time_">
-<parameter_description> the time at which the activation event occurred
+<parameter name="activate_time">
+<parameter_description> the time at which the activation event occurred.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_set_default_icon_from_file">
+<function name="gtk_menu_set_accel_group">
<description>
-Sets an icon to be used as fallback for windows that haven't
-had gtk_window_set_icon_list() called on them from a file
-on disk. Warns on failure if @err is %NULL.
-
-Since: 2.2
</description>
<parameters>
-<parameter name="filename">
-<parameter_description> location of icon file
-</parameter_description>
-</parameter>
-<parameter name="err">
-<parameter_description> location to store error, or %NULL.
+<parameter name="accel_group">
+<parameter_description>
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if setting the icon succeeded.
-
-</return>
+<return></return>
</function>
-<function name="gtk_widget_set_window">
+<function name="gtk_menu_set_accel_path">
<description>
-Sets a widget's window. This function should only be used in a
-widget's GtkWidget::realize() implementation. The %window passed is
-usually either new window created with gdk_window_new(), or the
-window of its parent widget as returned by
-gtk_widget_get_parent_window().
-
-Widgets must indicate whether they will create their own #GdkWindow
-by calling gtk_widget_set_has_window(). This is usually done in the
-widget's init() function.
+Sets an accelerator path for this menu from which accelerator paths
+for its immediate children, its menu items, can be constructed.
+The main purpose of this function is to spare the programmer the
+inconvenience of having to call gtk_menu_item_set_accel_path() on
+each menu item that should support runtime user changable accelerators.
+Instead, by just calling gtk_menu_set_accel_path() on their parent,
+each menu item of this menu, that contains a label describing its purpose,
+automatically gets an accel path assigned. For example, a menu containing
+menu items "New" and "Exit", will, after
+<literal>gtk_menu_set_accel_path (menu, "<Gnumeric-Sheet>/File");</literal>
+has been called, assign its items the accel paths:
+<literal>"<Gnumeric-Sheet>/File/New"</literal> and <literal>"<Gnumeric-Sheet>/File/Exit"</literal>.
+Assigning accel paths to menu items then enables the user to change
+their accelerators at runtime. More details about accelerator paths
+and their default setups can be found at gtk_accel_map_add_entry().
-Since: 2.18
+Note that @accel_path string will be stored in a #GQuark. Therefore, if you
+pass a static string, you can save some memory by interning it first with
+g_intern_static_string().
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="menu">
+<parameter_description> a valid #GtkMenu
</parameter_description>
</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="accel_path">
+<parameter_description> a valid accelerator path
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_label_set_selectable">
+<function name="gtk_menu_set_monitor">
<description>
-Selectable labels allow the user to select text from the label, for
-copy-and-paste.
+Informs GTK+ on which monitor a menu should be popped up.
+See gdk_screen_get_monitor_geometry().
+
+This function should be called from a #GtkMenuPositionFunc if the
+menu should not appear on the same monitor as the pointer. This
+information can't be reliably inferred from the coordinates returned
+by a #GtkMenuPositionFunc, since, for very long menus, these coordinates
+may extend beyond the monitor boundaries or even the screen boundaries.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="menu">
+<parameter_description> a #GtkMenu
</parameter_description>
</parameter>
-<parameter name="setting">
-<parameter_description> %TRUE to allow selecting text in the label
+<parameter name="monitor_num">
+<parameter_description> the number of the monitor on which the menu should
+be popped up
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_range_get_update_policy">
-<description>
-Gets the update policy of @range. See gtk_range_set_update_policy().
-
-
-</description>
-<parameters>
-<parameter name="range">
-<parameter_description> a #GtkRange
-</parameter_description>
-</parameter>
-</parameters>
-<return> the current update policy
-</return>
-</function>
-
-<function name="gtk_draw_handle">
+<function name="gtk_menu_set_reserve_toggle_size">
<description>
-Draws a handle as used in #GtkHandleBox and #GtkPaned.
+Sets whether the menu should reserve space for drawing toggles
+or icons, regardless of their actual presence.
-Deprecated: 2.0: Use gtk_paint_handle() instead.
+Since: 2.18
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
-</parameter_description>
-</parameter>
-<parameter name="shadow_type">
-<parameter_description> type of shadow to draw
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> x origin of the handle
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> y origin of the handle
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> with of the handle
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> height of the handle
+<parameter name="menu">
+<parameter_description> a #GtkMenu
</parameter_description>
</parameter>
-<parameter name="orientation">
-<parameter_description> the orientation of the handle
+<parameter name="reserve_toggle_size">
+<parameter_description> whether to reserve size for toggles
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_class_list_style_properties">
+<function name="gtk_menu_set_screen">
<description>
-Returns all style properties of a widget class.
+Sets the #GdkScreen on which the menu will be displayed.
Since: 2.2
</description>
<parameters>
-<parameter name="klass">
-<parameter_description> a #GtkWidgetClass
+<parameter name="menu">
+<parameter_description> a #GtkMenu.
</parameter_description>
</parameter>
-<parameter name="n_properties">
-<parameter_description> location to return the number of style properties found
+<parameter name="screen">
+<parameter_description> a #GdkScreen, or %NULL if the screen should be
+determined by the widget the menu is attached to.
</parameter_description>
</parameter>
</parameters>
-<return> an newly allocated array of #GParamSpec*. The array must
-be freed with g_free().
-</return>
+<return></return>
</function>
-<function name="gtk_orientable_get_orientation">
+<function name="gtk_menu_set_title">
<description>
-Retrieves the orientation of the @orientable.
-
-Since: 2.16
+Sets the title string for the menu. The title is displayed when the menu
+is shown as a tearoff menu. If @title is %NULL, the menu will see if it is
+attached to a parent menu item, and if so it will try to use the same text as
+that menu item's label.
</description>
<parameters>
-<parameter name="orientable">
-<parameter_description> a #GtkOrientable
+<parameter name="menu">
+<parameter_description> a #GtkMenu
</parameter_description>
</parameter>
-</parameters>
-<return> the orientation of the @orientable.
-
-</return>
-</function>
-
-<function name="gtk_cell_view_get_model">
-<description>
-Returns the model for @cell_view. If no model is used %NULL is
-returned.
-
-Since: 2.16
-
-</description>
-<parameters>
-<parameter name="cell_view">
-<parameter_description> a #GtkCellView
+<parameter name="title">
+<parameter_description> a string containing the title for the menu.
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkTreeModel used or %NULL
-
-</return>
+<return></return>
</function>
-<function name="gtk_window_deiconify">
+<function name="gtk_menu_shell_cancel">
<description>
-Asks to deiconify (i.e. unminimize) the specified @window. Note
-that you shouldn't assume the window is definitely deiconified
-afterward, because other entities (e.g. the user or <link
-linkend="gtk-X11-arch">window manager</link>) could iconify it
-again before your code which assumes deiconification gets to run.
+Cancels the selection within the menu shell.
-You can track iconification via the "window-state-event" signal
-on #GtkWidget.
+Since: 2.4
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="menu_shell">
+<parameter_description> a #GtkMenuShell
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_settings_get_quality">
+<function name="gtk_menu_shell_get_take_focus">
<description>
-Gets the value of %GTK_PRINT_SETTINGS_QUALITY.
+Returns %TRUE if the menu shell will take the keyboard focus on popup.
-Since: 2.10
+Since: 2.8
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="menu_shell">
+<parameter_description> a #GtkMenuShell
</parameter_description>
</parameter>
</parameters>
-<return> the print quality
+<return> %TRUE if the menu shell will take the keyboard focus on popup.
</return>
</function>
-<function name="gtk_print_unix_dialog_set_support_selection">
+<function name="gtk_menu_shell_select_first">
<description>
-Sets whether the print dialog allows user to print a selection.
+Select the first visible or selectable child of the menu shell;
+don't select tearoff items unless the only item is a tearoff
+item.
-Since: 2.18
+Since: 2.2
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter name="menu_shell">
+<parameter_description> a #GtkMenuShell
</parameter_description>
</parameter>
-<parameter name="support_selection">
-<parameter_description> %TRUE to allow print selection
+<parameter name="search_sensitive">
+<parameter_description> if %TRUE, search for the first selectable
+menu item, otherwise select nothing if
+the first item isn't sensitive. This
+should be %FALSE if the menu is being
+popped up initially.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_cell_renderer_pixbuf_new">
+<function name="gtk_menu_shell_set_take_focus">
<description>
-Creates a new #GtkCellRendererPixbuf. Adjust rendering
-parameters using object properties. Object properties can be set
-globally (with g_object_set()). Also, with #GtkTreeViewColumn, you
-can bind a property to a value in a #GtkTreeModel. For example, you
-can bind the "pixbuf" property on the cell renderer to a pixbuf value
-in the model, thus rendering a different image in each row of the
-#GtkTreeView.
+If @take_focus is %TRUE (the default) the menu shell will take the keyboard
+focus so that it will receive all keyboard events which is needed to enable
+keyboard navigation in menus.
+Setting @take_focus to %FALSE is useful only for special applications
+like virtual keyboard implementations which should not take keyboard
+focus.
-</description>
-<parameters>
-</parameters>
-<return> the new cell renderer
-</return>
-</function>
+The @take_focus state of a menu or menu bar is automatically propagated
+to submenus whenever a submenu is popped up, so you don't have to worry
+about recursively setting it for your entire menu hierarchy. Only when
+programmatically picking a submenu and popping it up manually, the
+ take_focus property of the submenu needs to be set explicitely.
-<function name="gtk_entry_set_inner_border">
-<description>
-Sets %entry's inner-border property to %border, or clears it if %NULL
-is passed. The inner-border is the area around the entry's text, but
-inside its frame.
+Note that setting it to %FALSE has side-effects:
-If set, this property overrides the inner-border style property.
-Overriding the style-provided border is useful when you want to do
-in-place editing of some text in a canvas or list widget, where
-pixel-exact positioning of the entry is important.
+If the focus is in some other app, it keeps the focus and keynav in
+the menu doesn't work. Consequently, keynav on the menu will only
+work if the focus is on some toplevel owned by the onscreen keyboard.
-Since: 2.10
+To avoid confusing the user, menus with @take_focus set to %FALSE
+should not display mnemonics or accelerators, since it cannot be
+guaranteed that they will work.
+
+See also gdk_keyboard_grab()
+
+Since: 2.8
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="menu_shell">
+<parameter_description> a #GtkMenuShell
</parameter_description>
</parameter>
-<parameter name="border">
-<parameter_description> a #GtkBorder, or %NULL
+<parameter name="take_focus">
+<parameter_description> %TRUE if the menu shell should take the keyboard focus on popup.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_column_clear">
+<function name="gtk_menu_tool_button_get_menu">
<description>
-Unsets all the mappings on all renderers on the @tree_column.
+Gets the #GtkMenu associated with #GtkMenuToolButton.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn
+<parameter name="button">
+<parameter_description> a #GtkMenuToolButton
</parameter_description>
</parameter>
</parameters>
-<return></return>
-</function>
-
-<function name="gtk_settings_get_default">
-<description>
-Gets the #GtkSettings object for the default GDK screen, creating
-it if necessary. See gtk_settings_get_for_screen().
-
+<return> the #GtkMenu associated
+with #GtkMenuToolButton
-</description>
-<parameters>
-</parameters>
-<return> a #GtkSettings object. If there is no default
-screen, then returns %NULL.
</return>
</function>
-<function name="gtk_label_get_justify">
+<function name="gtk_menu_tool_button_new">
<description>
-Returns the justification of the label. See gtk_label_set_justify().
+Creates a new #GtkMenuToolButton using @icon_widget as icon and
+ label as label.
+Since: 2.6
</description>
<parameters>
+<parameter name="icon_widget">
+<parameter_description> a widget that will be used as icon widget, or %NULL
+</parameter_description>
+</parameter>
<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter_description> a string that will be used as label, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> #GtkJustification
+<return> the new #GtkMenuToolButton
+
</return>
</function>
-<function name="gtk_tree_view_column_focus_cell">
+<function name="gtk_menu_tool_button_new_from_stock">
<description>
-Sets the current keyboard focus to be at @cell, if the column contains
-2 or more editable and activatable cells.
+Creates a new #GtkMenuToolButton.
+The new #GtkMenuToolButton will contain an icon and label from
+the stock item indicated by @stock_id.
-Since: 2.2
+Since: 2.6
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn
-</parameter_description>
-</parameter>
-<parameter name="cell">
-<parameter_description> A #GtkCellRenderer
+<parameter name="stock_id">
+<parameter_description> the name of a stock item
</parameter_description>
</parameter>
</parameters>
-<return></return>
-</function>
-
-<function name="gtk_accel_label_get_accel_widget">
-<description>
-Fetches the widget monitored by this accelerator label. See
-gtk_accel_label_set_accel_widget().
-
+<return> the new #GtkMenuToolButton
-</description>
-<parameters>
-<parameter name="accel_label">
-<parameter_description> a #GtkAccelLabel
-</parameter_description>
-</parameter>
-</parameters>
-<return> the object monitored by the accelerator label, or %NULL.
</return>
</function>
-<function name="gtk_text_buffer_insert_with_tags_by_name">
+<function name="gtk_menu_tool_button_set_arrow_tooltip">
<description>
-Same as gtk_text_buffer_insert_with_tags(), but allows you
-to pass in tag names instead of tag objects.
+Sets the #GtkTooltips object to be used for arrow button which
+pops up the menu. See gtk_tool_item_set_tooltip() for setting
+a tooltip on the whole #GtkMenuToolButton.
+
+Since: 2.6
+
+Deprecated: 2.12: Use gtk_menu_tool_button_set_arrow_tooltip_text()
+instead.
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> position in @buffer
-</parameter_description>
-</parameter>
-<parameter name="text">
-<parameter_description> UTF-8 text
+<parameter name="button">
+<parameter_description> a #GtkMenuToolButton
</parameter_description>
</parameter>
-<parameter name="len">
-<parameter_description> length of @text, or -1
+<parameter name="tooltips">
+<parameter_description> the #GtkTooltips object to be used
</parameter_description>
</parameter>
-<parameter name="first_tag_name">
-<parameter_description> name of a tag to apply to @text
+<parameter name="tip_text">
+<parameter_description> text to be used as tooltip text for tool_item
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> more tag names
+<parameter name="tip_private">
+<parameter_description> text to be used as private tooltip text
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_item_factory_create_menu_entries">
+<function name="gtk_menu_tool_button_set_arrow_tooltip_markup">
<description>
-Creates the menu items from the @entries.
+Sets the tooltip markup text to be used as tooltip for the arrow button
+which pops up the menu. See gtk_tool_item_set_tooltip() for setting a
+tooltip on the whole #GtkMenuToolButton.
-Deprecated: 2.4: Use #GtkUIManager instead.
+Since: 2.12
</description>
<parameters>
-<parameter name="n_entries">
-<parameter_description> the length of @entries
+<parameter name="button">
+<parameter_description> a #GtkMenuToolButton
</parameter_description>
</parameter>
-<parameter name="entries">
-<parameter_description> an array of #GtkMenuEntry<!-- -->s
+<parameter name="markup">
+<parameter_description> markup text to be used as tooltip text for button's arrow button
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_get_dest_row_at_pos">
+<function name="gtk_menu_tool_button_set_arrow_tooltip_text">
<description>
-Determines the destination row for a given position. @drag_x and
- drag_y are expected to be in widget coordinates. This function is only
-meaningful if @tree_view is realized. Therefore this function will always
-return %FALSE if @tree_view is not realized or does not have a model.
+Sets the tooltip text to be used as tooltip for the arrow button which
+pops up the menu. See gtk_tool_item_set_tooltip() for setting a tooltip
+on the whole #GtkMenuToolButton.
+Since: 2.12
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
-</parameter_description>
-</parameter>
-<parameter name="drag_x">
-<parameter_description> the position to determine the destination row for
-</parameter_description>
-</parameter>
-<parameter name="drag_y">
-<parameter_description> the position to determine the destination row for
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> Return location for the path of the highlighted row, or %NULL.
+<parameter name="button">
+<parameter_description> a #GtkMenuToolButton
</parameter_description>
</parameter>
-<parameter name="pos">
-<parameter_description> Return location for the drop position, or %NULL
+<parameter name="text">
+<parameter_description> text to be used as tooltip text for button's arrow button
</parameter_description>
</parameter>
</parameters>
-<return> whether there is a row at the given position, %TRUE if this
-is indeed the case.
-</return>
+<return></return>
</function>
-<function name="gtk_toolbar_set_orientation">
+<function name="gtk_menu_tool_button_set_menu">
<description>
-Sets whether a toolbar should appear horizontally or vertically.
+Sets the #GtkMenu that is popped up when the user clicks on the arrow.
+If @menu is NULL, the arrow button becomes insensitive.
-Deprecated: 2.16: Use gtk_orientable_set_orientation() instead.
+Since: 2.6
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar.
+<parameter name="button">
+<parameter_description> a #GtkMenuToolButton
</parameter_description>
</parameter>
-<parameter name="orientation">
-<parameter_description> a new #GtkOrientation.
+<parameter name="menu">
+<parameter_description> the #GtkMenu associated with #GtkMenuToolButton
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_box_set_spacing">
+<function name="gtk_message_dialog_format_secondary_markup">
<description>
-Sets the #GtkBox:spacing property of @box, which is the
-number of pixels to place between children of @box.
+Sets the secondary text of the message dialog to be @message_format (with
+printf()-style), which is marked up with the
+<link linkend="PangoMarkupFormat">Pango text markup language</link>.
-</description>
-<parameters>
-<parameter name="box">
-<parameter_description> a #GtkBox
-</parameter_description>
-</parameter>
-<parameter name="spacing">
-<parameter_description> the number of pixels to put between children
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
-</function>
+Note that setting a secondary text makes the primary text become
+bold, unless you have provided explicit markup.
-<function name="gtk_widget_get_ancestor">
-<description>
-Gets the first ancestor of @widget with type @widget_type. For example,
-<literal>gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)</literal> gets
-the first #GtkBox that's an ancestor of @widget. No reference will be
-added to the returned widget; it should not be unreferenced. See note
-about checking for a toplevel #GtkWindow in the docs for
-gtk_widget_get_toplevel().
+Due to an oversight, this function does not escape special XML characters
+like gtk_message_dialog_new_with_markup() does. Thus, if the arguments
+may contain special XML characters, you should use g_markup_printf_escaped()
+to escape it.
-Note that unlike gtk_widget_is_ancestor(), gtk_widget_get_ancestor()
-considers @widget to be an ancestor of itself.
+<informalexample><programlisting>
+gchar *msg;
+msg = g_markup_printf_escaped (message_format, ...);
+gtk_message_dialog_format_secondary_markup (message_dialog, "%s", msg);
+g_free (msg);
+</programlisting></informalexample>
+
+Since: 2.6
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="message_dialog">
+<parameter_description> a #GtkMessageDialog
</parameter_description>
</parameter>
-<parameter name="widget_type">
-<parameter_description> ancestor type
+<parameter name="message_format">
+<parameter_description> printf()-style markup string (see
+ <link linkend="PangoMarkupFormat">Pango markup format</link>), or %NULL
</parameter_description>
</parameter>
-</parameters>
-<return> the ancestor widget, or %NULL if not found
-</return>
-</function>
-
-<function name="gtk_icon_view_get_reorderable">
-<description>
-Retrieves whether the user can reorder the list via drag-and-drop.
-See gtk_icon_view_set_reorderable().
-
-Since: 2.8
-
-</description>
-<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
+<parameter name="Varargs">
+<parameter_description> arguments for @message_format
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the list can be reordered.
-
-</return>
+<return></return>
</function>
-<function name="gtk_print_settings_set_resolution">
+<function name="gtk_message_dialog_format_secondary_text">
<description>
-Sets the values of %GTK_PRINT_SETTINGS_RESOLUTION,
-%GTK_PRINT_SETTINGS_RESOLUTION_X and
-%GTK_PRINT_SETTINGS_RESOLUTION_Y.
+Sets the secondary text of the message dialog to be @message_format
+(with printf()-style).
-Since: 2.10
+Note that setting a secondary text makes the primary text become
+bold, unless you have provided explicit markup.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="message_dialog">
+<parameter_description> a #GtkMessageDialog
</parameter_description>
</parameter>
-<parameter name="resolution">
-<parameter_description> the resolution in dpi
+<parameter name="message_format">
+<parameter_description> printf()-style format string, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> arguments for @message_format
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_operation_is_finished">
+<function name="gtk_message_dialog_get_image">
<description>
-A convenience function to find out if the print operation
-is finished, either successfully (%GTK_PRINT_STATUS_FINISHED)
-or unsuccessfully (%GTK_PRINT_STATUS_FINISHED_ABORTED).
-
-Note: when you enable print status tracking the print operation
-can be in a non-finished state even after done has been called, as
-the operation status then tracks the print job status on the printer.
+Gets the dialog's image.
-Since: 2.10
+Since: 2.14
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter name="dialog">
+<parameter_description> a #GtkMessageDialog
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE, if the print operation is finished.
+<return> the dialog's image
</return>
</function>
-<function name="gtk_icon_theme_get_default">
+<function name="gtk_message_dialog_get_message_area">
<description>
-Gets the icon theme for the default screen. See
-gtk_icon_theme_get_for_screen().
+Returns the message area of the dialog. This is the box where the
+dialog's primary and secondary labels are packed. You can add your
+own extra content to that box and it will appear below those labels,
+on the right side of the dialog's image (or on the left for right-to-left
+languages). See gtk_dialog_get_content_area() for the corresponding
+function in the parent #GtkDialog.
-Since: 2.4
+Since: 2.22
</description>
<parameters>
+<parameter name="message_dialog">
+<parameter_description> a #GtkMessageDialog
+</parameter_description>
+</parameter>
</parameters>
-<return> A unique #GtkIconTheme associated with
-the default screen. This icon theme is associated with
-the screen and can be used as long as the screen
-is open. Do not ref or unref it.
+<return> A #GtkVBox corresponding to the
+"message area" in the @message_dialog.
</return>
</function>
-<function name="gtk_label_set_use_underline">
+<function name="gtk_message_dialog_new">
<description>
-If true, an underline in the text indicates the next character should be
-used for the mnemonic accelerator key.
+Creates a new message dialog, which is a simple dialog with an icon
+indicating the dialog type (error, warning, etc.) and some text the
+user may want to see. When the user clicks a button a "response"
+signal is emitted with response IDs from #GtkResponseType. See
+#GtkDialog for more details.
+
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="parent">
+<parameter_description> transient parent, or %NULL for none
</parameter_description>
</parameter>
-<parameter name="setting">
-<parameter_description> %TRUE if underlines in the text indicate mnemonics
+<parameter name="flags">
+<parameter_description> flags
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_tree_model_filter_convert_path_to_child_path">
-<description>
-Converts @filter_path to a path on the child model of @filter. That is,
- filter_path points to a location in @filter. The returned path will
-point to the same location in the model not being filtered. If @filter_path
-does not point to a location in the child model, %NULL is returned.
-
-Since: 2.4
-
-</description>
-<parameters>
-<parameter name="filter">
-<parameter_description> A #GtkTreeModelFilter.
+<parameter name="type">
+<parameter_description> type of message
</parameter_description>
</parameter>
-<parameter name="filter_path">
-<parameter_description> A #GtkTreePath to convert.
+<parameter name="buttons">
+<parameter_description> set of buttons to use
</parameter_description>
</parameter>
-</parameters>
-<return> A newly allocated #GtkTreePath, or %NULL.
-
-</return>
-</function>
-
-<function name="gtk_recent_chooser_get_current_uri">
-<description>
-Gets the URI currently selected by @chooser.
-
-Since: 2.10
-
-</description>
-<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
+<parameter name="message_format">
+<parameter_description> printf()-style format string, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> arguments for @message_format
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated string holding a URI.
-
+<return> a new #GtkMessageDialog
</return>
</function>
-<function name="gtk_builder_add_from_file">
+<function name="gtk_message_dialog_new_with_markup">
<description>
-Parses a file containing a <link linkend="BUILDER-UI">GtkBuilder
-UI definition</link> and merges it with the current contents of @builder.
+Creates a new message dialog, which is a simple dialog with an icon
+indicating the dialog type (error, warning, etc.) and some text which
+is marked up with the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
+When the user clicks a button a "response" signal is emitted with
+response IDs from #GtkResponseType. See #GtkDialog for more details.
-Upon errors 0 will be returned and @error will be assigned a
-#GError from the #GTK_BUILDER_ERROR, #G_MARKUP_ERROR or #G_FILE_ERROR
-domain.
+Special XML characters in the printf() arguments passed to this
+function will automatically be escaped as necessary.
+(See g_markup_printf_escaped() for how this is implemented.)
+Usually this is what you want, but if you have an existing
+Pango markup string that you want to use literally as the
+label, then you need to use gtk_message_dialog_set_markup()
+instead, since you can't pass the markup string either
+as the format (it might contain '%' characters) or as a string
+argument.
+|[
+GtkWidget *dialog;
+dialog = gtk_message_dialog_new (main_application_window,
+GTK_DIALOG_DESTROY_WITH_PARENT,
+GTK_MESSAGE_ERROR,
+GTK_BUTTONS_CLOSE,
+NULL);
+gtk_message_dialog_set_markup (GTK_MESSAGE_DIALOG (dialog),
+markup);
+]|
-Since: 2.12
+Since: 2.4
</description>
<parameters>
-<parameter name="builder">
-<parameter_description> a #GtkBuilder
+<parameter name="parent">
+<parameter_description> transient parent, or %NULL for none
</parameter_description>
</parameter>
-<parameter name="filename">
-<parameter_description> the name of the file to parse
+<parameter name="flags">
+<parameter_description> flags
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for an error, or %NULL
+<parameter name="type">
+<parameter_description> type of message
+</parameter_description>
+</parameter>
+<parameter name="buttons">
+<parameter_description> set of buttons to use
+</parameter_description>
+</parameter>
+<parameter name="message_format">
+<parameter_description> printf()-style format string, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> arguments for @message_format
</parameter_description>
</parameter>
</parameters>
-<return> A positive value on success, 0 if an error occurred
+<return> a new #GtkMessageDialog
</return>
</function>
-<function name="gtk_statusbar_get_has_resize_grip">
+<function name="gtk_message_dialog_set_image">
<description>
-Returns whether the statusbar has a resize grip.
+Sets the dialog's image to @image.
+Since: 2.10
</description>
<parameters>
-<parameter name="statusbar">
-<parameter_description> a #GtkStatusBar
+<parameter name="dialog">
+<parameter_description> a #GtkMessageDialog
+</parameter_description>
+</parameter>
+<parameter name="image">
+<parameter_description> the image
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the statusbar has a resize grip.
-</return>
+<return></return>
</function>
-<function name="gtk_spin_button_set_update_policy">
+<function name="gtk_message_dialog_set_markup">
<description>
-Sets the update behavior of a spin button. This determines whether the
-spin button is always updated or only when a valid value is set.
+Sets the text of the message dialog to be @str, which is marked
+up with the <link linkend="PangoMarkupFormat">Pango text markup
+language</link>.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter name="message_dialog">
+<parameter_description> a #GtkMessageDialog
</parameter_description>
</parameter>
-<parameter name="policy">
-<parameter_description> a #GtkSpinButtonUpdatePolicy value
+<parameter name="str">
+<parameter_description> markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>)
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_recent_chooser_get_show_icons">
+<function name="gtk_misc_get_alignment">
<description>
-Retrieves whether @chooser should show an icon near the resource.
-
-Since: 2.10
+Gets the X and Y alignment of the widget within its allocation.
+See gtk_misc_set_alignment().
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
+<parameter name="misc">
+<parameter_description> a #GtkMisc
+</parameter_description>
+</parameter>
+<parameter name="xalign">
+<parameter_description> location to store X alignment of @misc, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="yalign">
+<parameter_description> location to store Y alignment of @misc, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the icons should be displayed, %FALSE otherwise.
-
-</return>
+<return></return>
</function>
-<function name="gtk_calendar_display_options">
+<function name="gtk_misc_get_padding">
<description>
-Sets display options (whether to display the heading and the month headings).
-
-Deprecated: 2.4: Use gtk_calendar_set_display_options() instead
+Gets the padding in the X and Y directions of the widget.
+See gtk_misc_set_padding().
</description>
<parameters>
-<parameter name="calendar">
-<parameter_description> a #GtkCalendar.
+<parameter name="misc">
+<parameter_description> a #GtkMisc
</parameter_description>
</parameter>
-<parameter name="flags">
-<parameter_description> the display options to set.
+<parameter name="xpad">
+<parameter_description> location to store padding in the X direction, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="ypad">
+<parameter_description> location to store padding in the Y direction, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_action_new">
+<function name="gtk_mount_operation_get_parent">
<description>
-Creates a new #GtkAction object. To add the action to a
-#GtkActionGroup and set the accelerator for the action,
-call gtk_action_group_add_action_with_accel().
-See <xref linkend="XML-UI"/> for information on allowed action
-names.
+Gets the transient parent used by the #GtkMountOperation
-Since: 2.4
+Since: 2.14
</description>
<parameters>
-<parameter name="name">
-<parameter_description> A unique name for the action
-</parameter_description>
-</parameter>
-<parameter name="label">
-<parameter_description> the label displayed in menu items and on buttons, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="tooltip">
-<parameter_description> a tooltip for the action, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="stock_id">
-<parameter_description> the stock icon to display in widgets representing the
-action, or %NULL
+<parameter name="op">
+<parameter_description> a #GtkMountOperation
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkAction
+<return> the transient parent for windows shown by @op
</return>
</function>
-<function name="gtk_tree_model_filter_convert_child_iter_to_iter">
+<function name="gtk_mount_operation_get_screen">
<description>
-Sets @filter_iter to point to the row in @filter that corresponds to the
-row pointed at by @child_iter. If @filter_iter was not set, %FALSE is
-returned.
+Gets the screen on which windows of the #GtkMountOperation
+will be shown.
-Since: 2.4
+Since: 2.14
</description>
<parameters>
-<parameter name="filter">
-<parameter_description> A #GtkTreeModelFilter.
-</parameter_description>
-</parameter>
-<parameter name="filter_iter">
-<parameter_description> An uninitialized #GtkTreeIter.
-</parameter_description>
-</parameter>
-<parameter name="child_iter">
-<parameter_description> A valid #GtkTreeIter pointing to a row on the child model.
+<parameter name="op">
+<parameter_description> a #GtkMountOperation
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE, if @filter_iter was set, i.e. if @child_iter is a
-valid iterator pointing to a visible row in child model.
+<return> the screen on which windows of @op are shown
</return>
</function>
-<function name="gtk_text_layout_validate">
+<function name="gtk_mount_operation_is_showing">
<description>
-Validate regions of a #GtkTextLayout. The ::changed signal will
-be emitted for each region validated.
+Returns whether the #GtkMountOperation is currently displaying
+a window.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="tree">
-<parameter_description> a #GtkTextLayout
-</parameter_description>
-</parameter>
-<parameter name="max_pixels">
-<parameter_description> the maximum number of pixels to validate. (No more
-than one paragraph beyond this limit will be validated)
+<parameter name="op">
+<parameter_description> a #GtkMountOperation
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @op is currently displaying a window
+
+</return>
</function>
-<function name="gtk_entry_completion_new">
+<function name="gtk_mount_operation_new">
<description>
-Creates a new #GtkEntryCompletion object.
+Creates a new #GtkMountOperation
-Since: 2.4
+Since: 2.14
</description>
<parameters>
+<parameter name="parent">
+<parameter_description> transient parent of the window, or %NULL
+</parameter_description>
+</parameter>
</parameters>
-<return> A newly created #GtkEntryCompletion object.
+<return> a new #GtkMountOperation
</return>
</function>
-<function name="gtk_assistant_add_action_widget">
+<function name="gtk_mount_operation_set_parent">
<description>
-Adds a widget to the action area of a #GtkAssistant.
+Sets the transient parent for windows shown by the
+#GtkMountOperation.
-Since: 2.10
+Since: 2.14
</description>
<parameters>
-<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter name="op">
+<parameter_description> a #GtkMountOperation
</parameter_description>
</parameter>
-<parameter name="child">
-<parameter_description> a #GtkWidget
+<parameter name="parent">
+<parameter_description> transient parent of the window, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_target_table_free">
+<function name="gtk_mount_operation_set_screen">
<description>
-This function frees a target table as returned by
-gtk_target_table_new_from_list()
+Sets the screen to show windows of the #GtkMountOperation on.
-Since: 2.10
+Since: 2.14
</description>
<parameters>
-<parameter name="targets">
-<parameter_description> a #GtkTargetEntry array
+<parameter name="op">
+<parameter_description> a #GtkMountOperation
</parameter_description>
</parameter>
-<parameter name="n_targets">
-<parameter_description> the number of entries in the array
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_notebook_set_tab_label">
+<function name="gtk_notebook_append_page">
<description>
-Changes the tab label for @child. If %NULL is specified
-for @tab_label, then the page will have the label 'page N'.
+Appends a page to @notebook.
+
</description>
<parameters>
@@ -29359,511 +29315,470 @@ for @tab_label, then the page will have the label 'page N'.
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> the page
+<parameter_description> the #GtkWidget to use as the contents of the page.
</parameter_description>
</parameter>
<parameter name="tab_label">
-<parameter_description> the tab label widget to use, or %NULL for default tab
-label.
+<parameter_description> the #GtkWidget to be used as the label for the page,
+or %NULL to use the default label, 'page N'.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the index (starting from 0) of the appended
+page in the notebook, or -1 if function fails
+</return>
</function>
-<function name="gtk_file_selection_get_select_multiple">
+<function name="gtk_notebook_append_page_menu">
<description>
-Determines whether or not the user is allowed to select multiple files in
-the file list. See gtk_file_selection_set_select_multiple().
+Appends a page to @notebook, specifying the widget to use as the
+label in the popup menu.
</description>
<parameters>
-<parameter name="filesel">
-<parameter_description> a #GtkFileSelection
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> the #GtkWidget to use as the contents of the page.
+</parameter_description>
+</parameter>
+<parameter name="tab_label">
+<parameter_description> the #GtkWidget to be used as the label for the page,
+or %NULL to use the default label, 'page N'.
+</parameter_description>
+</parameter>
+<parameter name="menu_label">
+<parameter_description> the widget to use as a label for the page-switch
+menu, if that is enabled. If %NULL, and @tab_label
+is a #GtkLabel or %NULL, then the menu label will be
+a newly created label with the same text as @tab_label;
+If @tab_label is not a #GtkLabel, @menu_label must be
+specified if the page-switch menu is to be used.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the user is allowed to select multiple files in the
-file list
+<return> the index (starting from 0) of the appended
+page in the notebook, or -1 if function fails
</return>
</function>
-<function name="gtk_tree_selection_get_user_data">
+<function name="gtk_notebook_get_action_widget">
<description>
-Returns the user data for the selection function.
+Gets one of the action widgets. See gtk_notebook_set_action_widget().
+Since: 2.20
</description>
<parameters>
-<parameter name="selection">
-<parameter_description> A #GtkTreeSelection.
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
+</parameter_description>
+</parameter>
+<parameter name="pack_type">
+<parameter_description> pack type of the action widget to receive
</parameter_description>
</parameter>
</parameters>
-<return> The user data.
+<return> The action widget with the given @pack_type
+or %NULL when this action widget has not been set
+
</return>
</function>
-<function name="gtk_font_selection_get_size_entry">
+<function name="gtk_notebook_get_current_page">
<description>
-This returns the #GtkEntry used to allow the user to edit the font
-number manually instead of selecting it from the list of font sizes.
+Returns the page number of the current page.
-Since: 2.14
</description>
<parameters>
-<parameter name="fontsel">
-<parameter_description> a #GtkFontSelection
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
</parameters>
-<return> A #GtkWidget that is part of @fontsel
-
+<return> the index (starting from 0) of the current
+page in the notebook. If the notebook has no pages, then
+-1 will be returned.
</return>
</function>
-<function name="gtk_widget_get_requisition">
+<function name="gtk_notebook_get_group">
<description>
-Retrieves the widget's requisition.
-
-This function should only be used by widget implementations in
-order to figure whether the widget's requisition has actually
-changed after some internal state change (so that they can call
-gtk_widget_queue_resize() instead of gtk_widget_queue_draw()).
+Gets the current group identificator pointer for @notebook.
-Normally, gtk_widget_size_request() should be used.
+Since: 2.12
-Since: 2.20
+Deprecated: 2.24: Use gtk_notebook_get_group_name() instead
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="requisition">
-<parameter_description> a pointer to a #GtkRequisition to copy to
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the group identificator,
+or %NULL if none is set.
+
+</return>
</function>
-<function name="gtk_menu_tool_button_get_menu">
+<function name="gtk_notebook_get_group_id">
<description>
-Gets the #GtkMenu associated with #GtkMenuToolButton.
+Gets the current group identificator for @notebook.
-Since: 2.6
+Since: 2.10
+Deprecated: 2.12: use gtk_notebook_get_group_name() instead.
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkMenuToolButton
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkMenu associated with #GtkMenuToolButton
+<return> the group identificator, or -1 if none is set.
</return>
</function>
-<function name="gtk_scrolled_window_get_vscrollbar">
+<function name="gtk_notebook_get_group_name">
<description>
-Returns the vertical scrollbar of @scrolled_window.
+Gets the current group name for @notebook.
-Since: 2.8
+Note that this funtion can emphasis not be used
+together with gtk_notebook_set_group() or
+gtk_notebook_set_group_id().
+
+ Return Value: (transfer none): the group name,
+or %NULL if none is set.
+
+Since: 2.24
</description>
<parameters>
-<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
</parameters>
-<return> the vertical scrollbar of the scrolled window, or
-%NULL if it does not have one.
-
-</return>
+<return></return>
</function>
-<function name="gtk_widget_has_screen">
+<function name="gtk_notebook_get_menu_label">
<description>
-Checks whether there is a #GdkScreen is associated with
-this widget. All toplevel widgets have an associated
-screen, and all widgets added into a hierarchy with a toplevel
-window at the top.
+Retrieves the menu label widget of the page containing @child.
-Since: 2.2
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> a widget contained in a page of @notebook
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if there is a #GdkScreen associcated
-with the widget.
-
+<return> the menu label, or %NULL if the
+notebook page does not have a menu label other than the
+default (the tab label).
</return>
</function>
-<function name="gtk_scrolled_window_set_placement">
+<function name="gtk_notebook_get_menu_label_text">
<description>
-Sets the placement of the contents with respect to the scrollbars
-for the scrolled window.
-
-The default is %GTK_CORNER_TOP_LEFT, meaning the child is
-in the top left, with the scrollbars underneath and to the right.
-Other values in #GtkCornerType are %GTK_CORNER_TOP_RIGHT,
-%GTK_CORNER_BOTTOM_LEFT, and %GTK_CORNER_BOTTOM_RIGHT.
+Retrieves the text of the menu label for the page containing
+ child
-See also gtk_scrolled_window_get_placement() and
-gtk_scrolled_window_unset_placement().
</description>
<parameters>
-<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
-<parameter name="window_placement">
-<parameter_description> position of the child window
+<parameter name="child">
+<parameter_description> the child widget of a page of the notebook.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the text of the tab label, or %NULL if the
+widget does not have a menu label other than
+the default menu label, or the menu label widget
+is not a #GtkLabel. The string is owned by
+the widget and must not be freed.
+</return>
</function>
-<function name="gtk_widget_thaw_child_notify">
+<function name="gtk_notebook_get_n_pages">
<description>
-Reverts the effect of a previous call to gtk_widget_freeze_child_notify().
-This causes all queued #GtkWidget::child-notify signals on @widget to be
-emitted.
+Gets the number of pages in a notebook.
+
+Since: 2.2
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the number of pages in the notebook.
+
+</return>
</function>
-<function name="gtk_container_foreach">
+<function name="gtk_notebook_get_nth_page">
<description>
-Invokes @callback on each non-internal child of @container. See
-gtk_container_forall() for details on what constitutes an
-"internal" child. Most applications should use
-gtk_container_foreach(), rather than gtk_container_forall().
+Returns the child widget contained in page number @page_num.
+
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
-</parameter_description>
-</parameter>
-<parameter name="callback">
-<parameter_description> a callback
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
-<parameter name="callback_data">
-<parameter_description> callback user data
+<parameter name="page_num">
+<parameter_description> the index of a page in the notebook, or -1
+to get the last page.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the child widget, or %NULL if @page_num is
+out of bounds.
+</return>
</function>
-<function name="gtk_widget_region_intersect">
+<function name="gtk_notebook_get_scrollable">
<description>
-Computes the intersection of a @widget's area and @region, returning
-the intersection. The result may be empty, use gdk_region_empty() to
-check.
+Returns whether the tab label area has arrows for scrolling. See
+gtk_notebook_set_scrollable().
+
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="region">
-<parameter_description> a #GdkRegion, in the same coordinate system as
- widget->allocation. That is, relative to @widget->window
-for %NO_WINDOW widgets; relative to the parent window
-of @widget->window for widgets with their own window.
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
</parameters>
-<return> A newly allocated region holding the intersection of @widget
-and @region. The coordinates of the return value are
-relative to @widget->window for %NO_WINDOW widgets, and
-relative to the parent window of @widget->window for
-widgets with their own window.
+<return> %TRUE if arrows for scrolling are present
</return>
</function>
-<function name="gtk_widget_set_has_window">
+<function name="gtk_notebook_get_show_border">
<description>
-Specifies whether @widget has a #GdkWindow of its own. Note that
-all realized widgets have a non-%NULL "window" pointer
-(gtk_widget_get_window() never returns a %NULL window when a widget
-is realized), but for many of them it's actually the #GdkWindow of
-one of its parent widgets. Widgets that do not create a %window for
-themselves in GtkWidget::realize() must announce this by
-calling this function with @has_window = %FALSE.
-
-This function should only be called by widget implementations,
-and they should call it in their init() function.
+Returns whether a bevel will be drawn around the notebook pages. See
+gtk_notebook_set_show_border().
-Since: 2.18
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="has_window">
-<parameter_description> whether or not @widget has a window.
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the bevel is drawn
+</return>
</function>
-<function name="gtk_tree_path_prepend_index">
+<function name="gtk_notebook_get_show_tabs">
<description>
-Prepends a new index to a path. As a result, the depth of the path is
-increased.
+Returns whether the tabs of the notebook are shown. See
+gtk_notebook_set_show_tabs().
+
</description>
<parameters>
-<parameter name="path">
-<parameter_description> A #GtkTreePath.
-</parameter_description>
-</parameter>
-<parameter name="index_">
-<parameter_description> The index.
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the tabs are shown
+</return>
</function>
-<function name="gtk_file_chooser_set_preview_widget">
+<function name="gtk_notebook_get_tab_detachable">
<description>
-Sets an application-supplied widget to use to display a custom preview
-of the currently selected file. To implement a preview, after setting the
-preview widget, you connect to the #GtkFileChooser::update-preview
-signal, and call gtk_file_chooser_get_preview_filename() or
-gtk_file_chooser_get_preview_uri() on each change. If you can
-display a preview of the new file, update your widget and
-set the preview active using gtk_file_chooser_set_preview_widget_active().
-Otherwise, set the preview inactive.
-
-When there is no application-supplied preview widget, or the
-application-supplied preview widget is not active, the file chooser
-may display an internally generated preview of the current file or
-it may display no preview at all.
+Returns whether the tab contents can be detached from @notebook.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
-<parameter name="preview_widget">
-<parameter_description> widget for displaying preview.
+<parameter name="child">
+<parameter_description> a child #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> TRUE if the tab is detachable.
+
+</return>
</function>
-<function name="gtk_button_new_from_stock">
+<function name="gtk_notebook_get_tab_hborder">
<description>
-Creates a new #GtkButton containing the image and text from a stock item.
-Some stock ids have preprocessor macros like #GTK_STOCK_OK and
-#GTK_STOCK_APPLY.
-
-If @stock_id is unknown, then it will be treated as a mnemonic
-label (as for gtk_button_new_with_mnemonic()).
+Returns the horizontal width of a tab border.
+Since: 2.22
</description>
<parameters>
-<parameter name="stock_id">
-<parameter_description> the name of the stock item
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkButton
+<return> horizontal width of a tab border
+
</return>
</function>
-<function name="gtk_tool_palette_get_exclusive">
+<function name="gtk_notebook_get_tab_label">
<description>
-Gets whether @group is exclusive or not.
-See gtk_tool_palette_set_exclusive().
+Returns the tab label widget for the page @child. %NULL is returned
+if @child is not in @notebook or if no tab label has specifically
+been set for @child.
-Since: 2.20
</description>
<parameters>
-<parameter name="palette">
-<parameter_description> a #GtkToolPalette
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
-<parameter name="group">
-<parameter_description> a #GtkToolItemGroup which is a child of palette
+<parameter name="child">
+<parameter_description> the page
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @group is exclusive
-
-</return>
-</function>
-
-<function name="gtk_image_menu_item_new">
-<description>
-Creates a new #GtkImageMenuItem with an empty label.
-
-</description>
-<parameters>
-</parameters>
-<return> a new #GtkImageMenuItem.
+<return> the tab label
</return>
</function>
-<function name="gtk_combo_box_new_with_model">
+<function name="gtk_notebook_get_tab_label_text">
<description>
-Creates a new #GtkComboBox with the model initialized to @model.
+Retrieves the text of the tab label for the page containing
+ child
-Since: 2.4
</description>
<parameters>
-<parameter name="model">
-<parameter_description> A #GtkTreeModel.
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> a widget contained in a page of @notebook
</parameter_description>
</parameter>
</parameters>
-<return> A new #GtkComboBox.
-
+<return> the text of the tab label, or %NULL if the
+tab label widget is not a #GtkLabel. The
+string is owned by the widget and must not
+be freed.
</return>
</function>
-<function name="gtk_frame_get_label_widget">
+<function name="gtk_notebook_get_tab_pos">
<description>
-Retrieves the label widget for the frame. See
-gtk_frame_set_label_widget().
+Gets the edge at which the tabs for switching pages in the
+notebook are drawn.
</description>
<parameters>
-<parameter name="frame">
-<parameter_description> a #GtkFrame
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
</parameters>
-<return> the label widget, or %NULL if there is none.
+<return> the edge at which the tabs are drawn
</return>
</function>
-<function name="gtk_init_with_args">
+<function name="gtk_notebook_get_tab_reorderable">
<description>
-This function does the same work as gtk_init_check().
-Additionally, it allows you to add your own commandline options,
-and it automatically generates nicely formatted
-<option>--help</option> output. Note that your program will
-be terminated after writing out the help output.
+Gets whether the tab can be reordered via drag and drop or not.
-Since: 2.6
+Since: 2.10
</description>
<parameters>
-<parameter name="argc">
-<parameter_description> a pointer to the number of command line arguments.
-</parameter_description>
-</parameter>
-<parameter name="argv">
-<parameter_description> a pointer to the array of command line arguments.
-</parameter_description>
-</parameter>
-<parameter name="parameter_string">
-<parameter_description> a string which is displayed in
-the first line of <option>--help</option> output, after
-<literal><replaceable>programname</replaceable> [OPTION...]</literal>
-</parameter_description>
-</parameter>
-<parameter name="entries">
-<parameter_description> a %NULL-terminated array of #GOptionEntry<!-- -->s
-describing the options of your program
-</parameter_description>
-</parameter>
-<parameter name="translation_domain">
-<parameter_description> a translation domain to use for translating
-the <option>--help</option> output for the options in @entries
-with gettext(), or %NULL
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> a return location for errors
+<parameter name="child">
+<parameter_description> a child #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the GUI has been successfully initialized,
-%FALSE otherwise.
+<return> %TRUE if the tab is reorderable.
</return>
</function>
-<function name="gtk_status_icon_get_size">
+<function name="gtk_notebook_get_tab_vborder">
<description>
-Gets the size in pixels that is available for the image.
-Stock icons and named icons adapt their size automatically
-if the size of the notification area changes. For other
-storage types, the size-changed signal can be used to
-react to size changes.
-
-Note that the returned size is only meaningful while the
-status icon is embedded (see gtk_status_icon_is_embedded()).
+Returns the vertical width of a tab border.
-Since: 2.10
+Since: 2.22
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
</parameters>
-<return> the size that is available for the image
+<return> vertical width of a tab border
</return>
</function>
-<function name="gtk_stock_item_free">
+<function name="gtk_notebook_insert_page">
<description>
-Frees a stock item allocated on the heap, such as one returned by
-gtk_stock_item_copy(). Also frees the fields inside the stock item,
-if they are not %NULL.
+Insert a page into @notebook at the given position.
</description>
<parameters>
-<parameter name="item">
-<parameter_description> a #GtkStockItem
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> the #GtkWidget to use as the contents of the page.
+</parameter_description>
+</parameter>
+<parameter name="tab_label">
+<parameter_description> the #GtkWidget to be used as the label for the page,
+or %NULL to use the default label, 'page N'.
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> the index (starting at 0) at which to insert the page,
+or -1 to append the page after all other pages.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the index (starting from 0) of the inserted
+page in the notebook, or -1 if function fails
+</return>
</function>
<function name="gtk_notebook_insert_page_menu">
@@ -29907,1752 +29822,1716 @@ page in the notebook
</return>
</function>
-<function name="gtk_color_selection_get_previous_color">
+<function name="gtk_notebook_new">
<description>
-Fills @color in with the original color value.
+Creates a new #GtkNotebook widget with no pages.
+
</description>
<parameters>
-<parameter name="colorsel">
-<parameter_description> a #GtkColorSelection.
-</parameter_description>
-</parameter>
-<parameter name="color">
-<parameter_description> a #GdkColor to fill in with the original color value.
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> the newly created #GtkNotebook
+</return>
</function>
-<function name="gtk_target_list_add_text_targets">
+<function name="gtk_notebook_next_page">
<description>
-Appends the text targets supported by #GtkSelection to
-the target list. All targets are added with the same @info.
-
-Since: 2.6
+Switches to the next page. Nothing happens if the current page is
+the last page.
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GtkTargetList
-</parameter_description>
-</parameter>
-<parameter name="info">
-<parameter_description> an ID that will be passed back to the application
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_view_move_mark_onscreen">
+<function name="gtk_notebook_page_num">
<description>
-Moves a mark within the buffer so that it's
-located within the currently-visible text area.
+Finds the index of the page which contains the given child
+widget.
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
-<parameter name="mark">
-<parameter_description> a #GtkTextMark
+<parameter name="child">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the mark moved (wasn't already onscreen)
+<return> the index of the page containing @child, or
+-1 if @child is not in the notebook.
</return>
</function>
-<function name="gtk_statusbar_get_context_id">
+<function name="gtk_notebook_popup_disable">
<description>
-Returns a new context identifier, given a description
-of the actual context. Note that the description is
-<emphasis>not</emphasis> shown in the UI.
-
+Disables the popup menu.
</description>
<parameters>
-<parameter name="statusbar">
-<parameter_description> a #GtkStatusbar
-</parameter_description>
-</parameter>
-<parameter name="context_description">
-<parameter_description> textual description of what context
-the new message is being used in
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
</parameters>
-<return> an integer id
-</return>
+<return></return>
</function>
-<function name="gtk_file_chooser_set_preview_widget_active">
+<function name="gtk_notebook_popup_enable">
<description>
-Sets whether the preview widget set by
-gtk_file_chooser_set_preview_widget() should be shown for the
-current filename. When @active is set to false, the file chooser
-may display an internally generated preview of the current file
-or it may display no preview at all. See
-gtk_file_chooser_set_preview_widget() for more details.
-
-Since: 2.4
+Enables the popup menu: if the user clicks with the right mouse button on
+the tab labels, a menu with all the pages will be popped up.
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
-</parameter_description>
-</parameter>
-<parameter name="active">
-<parameter_description> whether to display the user-specified preview widget
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_combo_box_get_model">
+<function name="gtk_notebook_prepend_page">
<description>
-Returns the #GtkTreeModel which is acting as data source for @combo_box.
+Prepends a page to @notebook.
-Since: 2.4
</description>
<parameters>
-<parameter name="combo_box">
-<parameter_description> A #GtkComboBox
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> the #GtkWidget to use as the contents of the page.
+</parameter_description>
+</parameter>
+<parameter name="tab_label">
+<parameter_description> the #GtkWidget to be used as the label for the page,
+or %NULL to use the default label, 'page N'.
</parameter_description>
</parameter>
</parameters>
-<return> A #GtkTreeModel which was passed during construction.
-
+<return> the index (starting from 0) of the prepended
+page in the notebook, or -1 if function fails
</return>
</function>
-<function name="gtk_page_setup_set_paper_size">
+<function name="gtk_notebook_prepend_page_menu">
<description>
-Sets the paper size of the #GtkPageSetup without
-changing the margins. See
-gtk_page_setup_set_paper_size_and_default_margins().
+Prepends a page to @notebook, specifying the widget to use as the
+label in the popup menu.
-Since: 2.10
</description>
<parameters>
-<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> a #GtkPaperSize
+<parameter name="child">
+<parameter_description> the #GtkWidget to use as the contents of the page.
+</parameter_description>
+</parameter>
+<parameter name="tab_label">
+<parameter_description> the #GtkWidget to be used as the label for the page,
+or %NULL to use the default label, 'page N'.
+</parameter_description>
+</parameter>
+<parameter name="menu_label">
+<parameter_description> the widget to use as a label for the page-switch
+menu, if that is enabled. If %NULL, and @tab_label
+is a #GtkLabel or %NULL, then the menu label will be
+a newly created label with the same text as @tab_label;
+If @tab_label is not a #GtkLabel, @menu_label must be
+specified if the page-switch menu is to be used.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the index (starting from 0) of the prepended
+page in the notebook, or -1 if function fails
+</return>
</function>
-<function name="gtk_spin_button_set_snap_to_ticks">
+<function name="gtk_notebook_prev_page">
<description>
-Sets the policy as to whether values are corrected to the nearest step
-increment when a spin button is activated after providing an invalid value.
+Switches to the previous page. Nothing happens if the current page
+is the first page.
</description>
<parameters>
-<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
-</parameter_description>
-</parameter>
-<parameter name="snap_to_ticks">
-<parameter_description> a flag indicating if invalid values should be corrected.
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_clipboard_request_contents">
+<function name="gtk_notebook_query_tab_label_packing">
<description>
-Requests the contents of clipboard as the given target.
-When the results of the result are later received the supplied callback
-will be called.
+Query the packing attributes for the tab label of the page
+containing @child.
+
+Deprecated: 2.20: Modify the #GtkNotebook:tab-expand and
+#GtkNotebook:tab-fill child properties instead.
</description>
<parameters>
-<parameter name="clipboard">
-<parameter_description> a #GtkClipboard
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
-<parameter name="target">
-<parameter_description> an atom representing the form into which the clipboard
-owner should convert the selection.
+<parameter name="child">
+<parameter_description> the page
</parameter_description>
</parameter>
-<parameter name="callback">
-<parameter_description> A function to call when the results are received
-(or the retrieval fails). If the retrieval fails
-the length field of @selection_data will be
-negative.
+<parameter name="expand">
+<parameter_description> location to store the expand value (or NULL)
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to @callback
+<parameter name="fill">
+<parameter_description> location to store the fill value (or NULL)
+</parameter_description>
+</parameter>
+<parameter name="pack_type">
+<parameter_description> location to store the pack_type (or NULL)
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_im_context_filter_keypress">
+<function name="gtk_notebook_remove_page">
<description>
-Allow an input method to internally handle key press and release
-events. If this function returns %TRUE, then no further processing
-should be done for this key event.
-
+Removes a page from the notebook given its index
+in the notebook.
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GtkIMContext
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook.
</parameter_description>
</parameter>
-<parameter name="event">
-<parameter_description> the key event
+<parameter name="page_num">
+<parameter_description> the index of a notebook page, starting
+from 0. If -1, the last page will
+be removed.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the input method handled the key event.
-
-</return>
+<return></return>
</function>
-<function name="gtk_expander_new">
+<function name="gtk_notebook_reorder_child">
<description>
-Creates a new expander using @label as the text of the label.
-
-Since: 2.4
+Reorders the page containing @child, so that it appears in position
+ position If @position is greater than or equal to the number of
+children in the list or negative, @child will be moved to the end
+of the list.
</description>
<parameters>
-<parameter name="label">
-<parameter_description> the text of the label
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
-</parameters>
-<return> a new #GtkExpander widget.
-
-</return>
-</function>
-
-<function name="gtk_menu_bar_set_pack_direction">
-<description>
-Sets how items should be packed inside a menubar.
-
-Since: 2.8
-
-</description>
-<parameters>
-<parameter name="menubar">
-<parameter_description> a #GtkMenuBar
+<parameter name="child">
+<parameter_description> the child to move
</parameter_description>
</parameter>
-<parameter name="pack_dir">
-<parameter_description> a new #GtkPackDirection
+<parameter name="position">
+<parameter_description> the new position, or -1 to move to the end
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_begin_resize_drag">
+<function name="gtk_notebook_set_action_widget">
<description>
-Starts resizing a window. This function is used if an application
-has window resizing controls. When GDK can support it, the resize
-will be done using the standard mechanism for the <link
-linkend="gtk-X11-arch">window manager</link> or windowing
-system. Otherwise, GDK will try to emulate window resizing,
-potentially not all that well, depending on the windowing system.
+Sets @widget as one of the action widgets. Depending on the pack type
+the widget will be placed before or after the tabs. You can use
+a #GtkBox if you need to pack more than one widget on the same side.
+Note that action widgets are "internal" children of the notebook and thus
+not included in the list returned from gtk_container_foreach().
+
+Since: 2.20
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
-</parameter_description>
-</parameter>
-<parameter name="button">
-<parameter_description> mouse button that initiated the drag
-</parameter_description>
-</parameter>
-<parameter name="edge">
-<parameter_description> position of the resize control
-</parameter_description>
-</parameter>
-<parameter name="root_x">
-<parameter_description> X position where the user clicked to initiate the drag, in root window coordinates
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
-<parameter name="root_y">
-<parameter_description> Y position where the user clicked to initiate the drag
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="timestamp">
-<parameter_description> timestamp from the click event that initiated the drag
+<parameter name="pack_type">
+<parameter_description> pack type of the action widget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_about_dialog_set_documenters">
+<function name="gtk_notebook_set_current_page">
<description>
-Sets the strings which are displayed in the documenters tab
-of the secondary credits dialog.
+Switches to the page number @page_num.
-Since: 2.6
+Note that due to historical reasons, GtkNotebook refuses
+to switch to a page unless the child widget is visible.
+Therefore, it is recommended to show child widgets before
+adding them to a notebook.
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
-<parameter name="documenters">
-<parameter_description> a %NULL-terminated array of strings
+<parameter name="page_num">
+<parameter_description> index of the page to switch to, starting from 0.
+If negative, the last page will be used. If greater
+than the number of pages in the notebook, nothing
+will be done.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_layout_get_buffer">
+<function name="gtk_notebook_set_group">
<description>
-Gets the text buffer used by the layout. See
-gtk_text_layout_set_buffer().
+Sets a group identificator pointer for @notebook, notebooks sharing
+the same group identificator pointer will be able to exchange tabs
+via drag and drop. A notebook with a %NULL group identificator will
+not be able to exchange tabs with any other notebook.
+
+Since: 2.12
+Deprecated: 2.24: Use gtk_notebook_set_group_name() instead
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #GtkTextLayout
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
+</parameter_description>
+</parameter>
+<parameter name="group">
+<parameter_description> a pointer to identify the notebook group, or %NULL to unset it
</parameter_description>
</parameter>
</parameters>
-<return> the text buffer used by the layout.
-</return>
+<return></return>
</function>
-<function name="gtk_widget_get_default_visual">
+<function name="gtk_notebook_set_group_id">
<description>
-Obtains the visual of the default colormap. Not really useful;
-used to be useful before gdk_colormap_get_visual() existed.
+Sets an group identificator for @notebook, notebooks sharing
+the same group identificator will be able to exchange tabs
+via drag and drop. A notebook with group identificator -1 will
+not be able to exchange tabs with any other notebook.
+Since: 2.10
+Deprecated: 2.12: use gtk_notebook_set_group_name() instead.
</description>
<parameters>
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
+</parameter_description>
+</parameter>
+<parameter name="group_id">
+<parameter_description> a group identificator, or -1 to unset it
+</parameter_description>
+</parameter>
</parameters>
-<return> visual of the default colormap
-</return>
+<return></return>
</function>
-<function name="gtk_radio_tool_button_new_with_stock_from_widget">
+<function name="gtk_notebook_set_group_name">
<description>
-Creates a new #GtkRadioToolButton adding it to the same group as @group.
-The new #GtkRadioToolButton will contain an icon and label from the
-stock item indicated by @stock_id.
+Sets a group name for @notebook.
-Since: 2.4
+Notebooks with the same name will be able to exchange tabs
+via drag and drop. A notebook with a %NULL group name will
+not be able to exchange tabs with any other notebook.
+
+Since: 2.24
</description>
<parameters>
-<parameter name="group">
-<parameter_description> An existing #GtkRadioToolButton.
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
-<parameter name="stock_id">
-<parameter_description> the name of a stock item
+<parameter name="name">
+<parameter_description> the name of the notebook group, or %NULL to unset it
</parameter_description>
</parameter>
</parameters>
-<return> A new #GtkRadioToolButton
-
-</return>
+<return></return>
</function>
-<function name="gtk_fixed_get_has_window">
+<function name="gtk_notebook_set_homogeneous_tabs">
<description>
-Gets whether the #GtkFixed has its own #GdkWindow.
-See gtk_fixed_set_has_window().
-
-Deprecated: 2.20: Use gtk_widget_get_has_window() instead.
+Sets whether the tabs must have all the same size or not.
</description>
<parameters>
-<parameter name="fixed">
-<parameter_description> a #GtkWidget
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
+</parameter_description>
+</parameter>
+<parameter name="homogeneous">
+<parameter_description> %TRUE if all tabs should be the same size.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @fixed has its own window.
-
-</return>
+<return></return>
</function>
-<function name="gtk_entry_completion_get_popup_set_width">
+<function name="gtk_notebook_set_menu_label">
<description>
-Returns whether the completion popup window will be resized to the
-width of the entry.
-
-Since: 2.8
+Changes the menu label for the page containing @child.
</description>
<parameters>
-<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> the child widget
+</parameter_description>
+</parameter>
+<parameter name="menu_label">
+<parameter_description> the menu label, or NULL for default
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the popup window will be resized to the width of
-the entry
-
-</return>
+<return></return>
</function>
-<function name="gtk_printer_compare">
+<function name="gtk_notebook_set_menu_label_text">
<description>
-Compares two printers.
-
-Since: 2.10
+Creates a new label and sets it as the menu label of @child.
</description>
<parameters>
-<parameter name="a">
-<parameter_description> a #GtkPrinter
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
-<parameter name="b">
-<parameter_description> another #GtkPrinter
+<parameter name="child">
+<parameter_description> the child widget
+</parameter_description>
+</parameter>
+<parameter name="menu_text">
+<parameter_description> the label text
</parameter_description>
</parameter>
</parameters>
-<return> 0 if the printer match, a negative value if @a < @b,
-or a positive value if @a > @b
-
-</return>
+<return></return>
</function>
-<function name="gtk_entry_new">
+<function name="gtk_notebook_set_scrollable">
<description>
-Creates a new entry.
-
+Sets whether the tab label area will have arrows for scrolling if
+there are too many tabs to fit in the area.
</description>
<parameters>
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
+</parameter_description>
+</parameter>
+<parameter name="scrollable">
+<parameter_description> %TRUE if scroll arrows should be added
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GtkEntry.
-</return>
+<return></return>
</function>
-<function name="gtk_tool_palette_get_style">
+<function name="gtk_notebook_set_show_border">
<description>
-Gets the style (icons, text or both) of items in the tool palette.
-
-Since: 2.20
+Sets whether a bevel will be drawn around the notebook pages.
+This only has a visual effect when the tabs are not shown.
+See gtk_notebook_set_show_tabs().
</description>
<parameters>
-<parameter name="palette">
-<parameter_description> a #GtkToolPalette
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
+</parameter_description>
+</parameter>
+<parameter name="show_border">
+<parameter_description> %TRUE if a bevel should be drawn around the notebook.
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkToolbarStyle of items in the tool palette.
-
-</return>
+<return></return>
</function>
-<function name="gtk_scale_button_get_popup">
+<function name="gtk_notebook_set_show_tabs">
<description>
-Retrieves the popup of the #GtkScaleButton.
-
-Since: 2.14
+Sets whether to show the tabs for the notebook or not.
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkScaleButton
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
+</parameter_description>
+</parameter>
+<parameter name="show_tabs">
+<parameter_description> %TRUE if the tabs should be shown.
</parameter_description>
</parameter>
</parameters>
-<return> the popup of the #GtkScaleButton
-
-</return>
+<return></return>
</function>
-<function name="gtk_tree_view_create_row_drag_icon">
+<function name="gtk_notebook_set_tab_border">
<description>
-Creates a #GdkPixmap representation of the row at @path.
-This image is used for a drag icon.
-
+Sets the width the border around the tab labels
+in a notebook. This is equivalent to calling
+gtk_notebook_set_tab_hborder (@notebook, @border_width) followed
+by gtk_notebook_set_tab_vborder (@notebook, @border_width).
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> a #GtkTreePath in @tree_view
+<parameter name="border_width">
+<parameter_description> width of the border around the tab labels.
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated pixmap of the drag icon.
-</return>
+<return></return>
</function>
-<function name="gtk_print_operation_set_current_page">
+<function name="gtk_notebook_set_tab_detachable">
<description>
-Sets the current page.
+Sets whether the tab can be detached from @notebook to another
+notebook or widget.
-If this is called before gtk_print_operation_run(),
-the user will be able to select to print only the current page.
+Note that 2 notebooks must share a common group identificator
+(see gtk_notebook_set_group_id ()) to allow automatic tabs
+interchange between them.
-Note that this only makes sense for pre-paginated documents.
+If you want a widget to interact with a notebook through DnD
+(i.e.: accept dragged tabs from it) it must be set as a drop
+destination and accept the target "GTK_NOTEBOOK_TAB". The notebook
+will fill the selection with a GtkWidget** pointing to the child
+widget that corresponds to the dropped tab.
+|[
+static void
+on_drop_zone_drag_data_received (GtkWidget *widget,
+GdkDragContext *context,
+gint x,
+gint y,
+GtkSelectionData *selection_data,
+guint info,
+guint time,
+gpointer user_data)
+{
+GtkWidget *notebook;
+GtkWidget **child;
+
+notebook = gtk_drag_get_source_widget (context);
+child = (void*) selection_data->data;
+
+process_widget (*child);
+gtk_container_remove (GTK_CONTAINER (notebook), *child);
+}
+]|
+
+If you want a notebook to accept drags from other widgets,
+you will have to set your own DnD code to do it.
Since: 2.10
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
-<parameter name="current_page">
-<parameter_description> the current page, 0-based
+<parameter name="child">
+<parameter_description> a child #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="detachable">
+<parameter_description> whether the tab is detachable or not
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_file_chooser_select_filename">
+<function name="gtk_notebook_set_tab_hborder">
<description>
-Selects a filename. If the file name isn't in the current
-folder of @chooser, then the current folder of @chooser will
-be changed to the folder containing @filename.
-
-Since: 2.4
+Sets the width of the horizontal border of tab labels.
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
-<parameter name="filename">
-<parameter_description> the filename to select
+<parameter name="tab_hborder">
+<parameter_description> width of the horizontal border of tab labels.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if both the folder could be changed and the file was
-selected successfully, %FALSE otherwise.
-
-</return>
+<return></return>
</function>
-<function name="gtk_color_button_get_use_alpha">
+<function name="gtk_notebook_set_tab_label">
<description>
-Does the color selection dialog use the alpha channel?
-
-Since: 2.4
+Changes the tab label for @child. If %NULL is specified
+for @tab_label, then the page will have the label 'page N'.
</description>
<parameters>
-<parameter name="color_button">
-<parameter_description> a #GtkColorButton.
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
-</parameters>
-<return> %TRUE if the color sample uses alpha channel, %FALSE if not.
-
-</return>
-</function>
-
-<function name="gtk_radio_button_get_group">
-<description>
-Retrieves the group assigned to a radio button.
-
-
-</description>
-<parameters>
-<parameter name="radio_button">
-<parameter_description> a #GtkRadioButton.
+<parameter name="child">
+<parameter_description> the page
+</parameter_description>
+</parameter>
+<parameter name="tab_label">
+<parameter_description> the tab label widget to use, or %NULL for default tab
+label.
</parameter_description>
</parameter>
</parameters>
-<return> a linked list
-containing all the radio buttons in the same group
-as @radio_button. The returned list is owned by the radio button
-and must not be modified or freed.
-</return>
+<return></return>
</function>
-<function name="gtk_print_operation_set_use_full_page">
+<function name="gtk_notebook_set_tab_label_packing">
<description>
-If @full_page is %TRUE, the transformation for the cairo context
-obtained from #GtkPrintContext puts the origin at the top left
-corner of the page (which may not be the top left corner of the
-sheet, depending on page orientation and the number of pages per
-sheet). Otherwise, the origin is at the top left corner of the
-imageable area (i.e. inside the margins).
+Sets the packing parameters for the tab label of the page
+containing @child. See gtk_box_pack_start() for the exact meaning
+of the parameters.
-Since: 2.10
+Deprecated: 2.20: Modify the #GtkNotebook:tab-expand and
+#GtkNotebook:tab-fill child properties instead.
+Modifying the packing of the tab label is a deprecated feature and
+shouldn't be done anymore.
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
-<parameter name="full_page">
-<parameter_description> %TRUE to set up the #GtkPrintContext for the full page
+<parameter name="child">
+<parameter_description> the child widget
+</parameter_description>
+</parameter>
+<parameter name="expand">
+<parameter_description> whether to expand the tab label or not
+</parameter_description>
+</parameter>
+<parameter name="fill">
+<parameter_description> whether the tab label should fill the allocated area or not
+</parameter_description>
+</parameter>
+<parameter name="pack_type">
+<parameter_description> the position of the tab label
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_view_get_line_at_y">
+<function name="gtk_notebook_set_tab_label_text">
<description>
-Gets the #GtkTextIter at the start of the line containing
-the coordinate @y. @y is in buffer coordinates, convert from
-window coordinates with gtk_text_view_window_to_buffer_coords().
-If non-%NULL, @line_top will be filled with the coordinate of the top
-edge of the line.
+Creates a new label and sets it as the tab label for the page
+containing @child.
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
-</parameter_description>
-</parameter>
-<parameter name="target_iter">
-<parameter_description> a #GtkTextIter
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> a y coordinate
+<parameter name="child">
+<parameter_description> the page
</parameter_description>
</parameter>
-<parameter name="line_top">
-<parameter_description> return location for top coordinate of the line
+<parameter name="tab_text">
+<parameter_description> the label text
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_toolbar_new">
-<description>
-Creates a new toolbar.
-
-
-</description>
-<parameters>
-</parameters>
-<return> the newly-created toolbar.
-</return>
-</function>
-
-<function name="gtk_tree_model_sort_set_model">
+<function name="gtk_notebook_set_tab_pos">
<description>
-Sets the model of @tree_model_sort to be @model. If @model is %NULL,
-then the old model is unset. The sort function is unset as a result
-of this call. The model will be in an unsorted state until a sort
-function is set.
+Sets the edge at which the tabs for switching pages in the
+notebook are drawn.
</description>
<parameters>
-<parameter name="tree_model_sort">
-<parameter_description> The #GtkTreeModelSort.
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook.
</parameter_description>
</parameter>
-<parameter name="child_model">
-<parameter_description> A #GtkTreeModel, or %NULL.
+<parameter name="pos">
+<parameter_description> the edge to draw the tabs at.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_font_selection_dialog_set_font_name">
+<function name="gtk_notebook_set_tab_reorderable">
<description>
-Sets the currently selected font.
+Sets whether the notebook tab can be reordered
+via drag and drop or not.
+Since: 2.10
</description>
<parameters>
-<parameter name="fsd">
-<parameter_description> a #GtkFontSelectionDialog
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
</parameter_description>
</parameter>
-<parameter name="fontname">
-<parameter_description> a font name like "Helvetica 12" or "Times Bold 18"
+<parameter name="child">
+<parameter_description> a child #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="reorderable">
+<parameter_description> whether the tab is reorderable or not.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the font selected in @fsd is now the
- fontname specified, %FALSE otherwise.
-</return>
+<return></return>
</function>
-<function name="gtk_paper_size_is_custom">
+<function name="gtk_notebook_set_tab_vborder">
<description>
-Returns %TRUE if @size is not a standard paper size.
-
+Sets the width of the vertical border of tab labels.
</description>
<parameters>
-<parameter name="size">
-<parameter_description> a #GtkPaperSize object
+<parameter name="notebook">
+<parameter_description> a #GtkNotebook
+</parameter_description>
+</parameter>
+<parameter name="tab_vborder">
+<parameter_description> width of the vertical border of tab labels.
</parameter_description>
</parameter>
</parameters>
-<return> whether @size is a custom paper size.
-</return>
+<return></return>
</function>
-<function name="gtk_text_iter_in_range">
+<function name="gtk_notebook_set_window_creation_hook">
<description>
-Checks whether @iter falls in the range [ start, @end).
- start and @end must be in ascending order.
+Installs a global function used to create a window
+when a detached tab is dropped in an empty area.
+
+Since: 2.10
+Deprecated: 2.24: Use the #GtkNotebook::create-window signal instead
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="func">
+<parameter_description> the #GtkNotebookWindowCreationFunc, or %NULL
</parameter_description>
</parameter>
-<parameter name="start">
-<parameter_description> start of range
+<parameter name="data">
+<parameter_description> user data for @func
</parameter_description>
</parameter>
-<parameter name="end">
-<parameter_description> end of range
+<parameter name="destroy">
+<parameter_description> Destroy notifier for @data, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter is in the range
-</return>
+<return></return>
</function>
-<function name="gtk_table_get_default_row_spacing">
+<function name="gtk_offscreen_window_get_pixbuf">
<description>
-Gets the default row spacing for the table. This is
-the spacing that will be used for newly added rows.
-(See gtk_table_set_row_spacings())
+Retrieves a snapshot of the contained widget in the form of
+a #GdkPixbuf. This is a new pixbuf with a reference count of 1,
+and the application should unreference it once it is no longer
+needed.
+Since: 2.20
</description>
<parameters>
-<parameter name="table">
-<parameter_description> a #GtkTable
+<parameter name="offscreen">
+<parameter_description> the #GtkOffscreenWindow contained widget.
</parameter_description>
</parameter>
</parameters>
-<return> the default row spacing
+<return> A #GdkPixbuf pointer, or %NULL.
+
</return>
</function>
-<function name="gtk_label_get_angle">
+<function name="gtk_offscreen_window_get_pixmap">
<description>
-Gets the angle of rotation for the label. See
-gtk_label_set_angle().
+Retrieves a snapshot of the contained widget in the form of
+a #GdkPixmap. If you need to keep this around over window
+resizes then you should add a reference to it.
-Since: 2.6
+Since: 2.20
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="offscreen">
+<parameter_description> the #GtkOffscreenWindow contained widget.
</parameter_description>
</parameter>
</parameters>
-<return> the angle of rotation for the label
+<return> A #GdkPixmap pointer to the offscreen pixmap,
+or %NULL.
</return>
</function>
-<function name="gtk_combo_box_set_active_iter">
+<function name="gtk_offscreen_window_new">
<description>
-Sets the current active item to be the one referenced by @iter, or
-unsets the active item if @iter is %NULL.
+Creates a toplevel container widget that is used to retrieve
+snapshots of widgets without showing them on the screen. For
+widgets that are on the screen and part of a normal widget
+hierarchy, gtk_widget_get_snapshot() can be used instead.
-Since: 2.4
+Since: 2.20
</description>
<parameters>
-<parameter name="combo_box">
-<parameter_description> A #GtkComboBox
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> The #GtkTreeIter, or %NULL
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> A pointer to a #GtkWidget
+
+</return>
</function>
-<function name="gtk_tree_view_get_level_indentation">
+<function name="gtk_old_editable_changed">
<description>
-Returns the amount, in pixels, of extra indentation for child levels
-in @tree_view.
-
-Since: 2.12
+Emits the ::changed signal on @old_editable.
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView.
+<parameter name="old_editable">
+<parameter_description> a #GtkOldEditable
</parameter_description>
</parameter>
</parameters>
-<return> the amount of extra indentation for child levels in
- tree_view A return value of 0 means that this feature is disabled.
-
-</return>
+<return></return>
</function>
-<function name="gtk_list_store_insert_with_valuesv">
+<function name="gtk_old_editable_claim_selection">
<description>
-A variant of gtk_list_store_insert_with_values() which
-takes the columns and values as two arrays, instead of
-varargs. This function is mainly intended for
-language-bindings.
-
-Since: 2.6
+Claims or gives up ownership of the selection.
</description>
<parameters>
-<parameter name="list_store">
-<parameter_description> A #GtkListStore
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> An unset #GtkTreeIter to set to the new row, or %NULL.
-</parameter_description>
-</parameter>
-<parameter name="position">
-<parameter_description> position to insert the new row
-</parameter_description>
-</parameter>
-<parameter name="columns">
-<parameter_description> an array of column numbers
+<parameter name="old_editable">
+<parameter_description> a #GtkOldEditable
</parameter_description>
</parameter>
-<parameter name="values">
-<parameter_description> an array of GValues
+<parameter name="claim">
+<parameter_description> if %TRUE, claim ownership of the selection, if %FALSE, give
+up ownership
</parameter_description>
</parameter>
-<parameter name="n_values">
-<parameter_description> the length of the @columns and @values arrays
+<parameter name="time_">
+<parameter_description> timestamp for this operation
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_layout_move">
+<function name="gtk_option_menu_get_history">
<description>
-Moves a current child of @layout to a new position.
+Retrieves the index of the currently selected menu item. The menu
+items are numbered from top to bottom, starting with 0.
+Deprecated: 2.4: Use #GtkComboBox instead.
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #GtkLayout
-</parameter_description>
-</parameter>
-<parameter name="child_widget">
-<parameter_description> a current child of @layout
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> X position to move to
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> Y position to move to
+<parameter name="option_menu">
+<parameter_description> a #GtkOptionMenu
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> index of the selected menu item, or -1 if there are no menu items
+</return>
</function>
-<function name="gtk_tool_item_get_ellipsize_mode">
+<function name="gtk_orientable_get_orientation">
<description>
-Returns the ellipsize mode used for @tool_item. Custom subclasses of
-#GtkToolItem should call this function to find out how text should
-be ellipsized.
+Retrieves the orientation of the @orientable.
-Since: 2.20
+Since: 2.16
</description>
<parameters>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem
+<parameter name="orientable">
+<parameter_description> a #GtkOrientable
</parameter_description>
</parameter>
</parameters>
-<return> a #PangoEllipsizeMode indicating how text in @tool_item
-should be ellipsized.
+<return> the orientation of the @orientable.
</return>
</function>
-<function name="gtk_print_error_quark">
+<function name="gtk_orientable_set_orientation">
<description>
-Registers an error quark for #GtkPrintOperation if necessary.
+Sets the orientation of the @orientable.
-Since: 2.10
+Since: 2.16
</description>
<parameters>
+<parameter name="orientable">
+<parameter_description> a #GtkOrientable
+</parameter_description>
+</parameter>
+<parameter name="orientation">
+<parameter_description> the orientable's new orientation.
+</parameter_description>
+</parameter>
</parameters>
-<return> The error quark used for #GtkPrintOperation errors.
-
-</return>
+<return></return>
</function>
-<function name="gtk_tree_view_get_search_equal_func">
+<function name="gtk_page_setup_copy">
<description>
-Returns the compare function currently in use.
+Copies a #GtkPageSetup.
+Since: 2.10
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView
+<parameter name="other">
+<parameter_description> the #GtkPageSetup to copy
</parameter_description>
</parameter>
</parameters>
-<return> the currently used compare function for the search code.
+<return> a copy of @other
+
</return>
</function>
-<function name="gtk_activatable_sync_action_properties">
+<function name="gtk_page_setup_get_bottom_margin">
<description>
-This is called to update the activatable completely, this is called
-internally when the #GtkActivatable::related-action property is set
-or unset and by the implementing class when
-#GtkActivatable::use-action-appearance changes.
+Gets the bottom margin in units of @unit.
-Since: 2.16
+Since: 2.10
</description>
<parameters>
-<parameter name="activatable">
-<parameter_description> a #GtkActivatable
+<parameter name="setup">
+<parameter_description> a #GtkPageSetup
</parameter_description>
</parameter>
-<parameter name="action">
-<parameter_description> the related #GtkAction or %NULL
+<parameter name="unit">
+<parameter_description> the unit for the return value
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the bottom margin
+
+</return>
</function>
-<function name="gtk_text_view_move_visually">
+<function name="gtk_page_setup_get_left_margin">
<description>
-Move the iterator a given number of characters visually, treating
-it as the strong cursor position. If @count is positive, then the
-new strong cursor position will be @count positions to the right of
-the old cursor position. If @count is negative then the new strong
-cursor position will be @count positions to the left of the old
-cursor position.
-
-In the presence of bi-directional text, the correspondence
-between logical and visual order will depend on the direction
-of the current run, and there may be jumps when the cursor
-is moved off of the end of a run.
+Gets the left margin in units of @unit.
+Since: 2.10
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="setup">
+<parameter_description> a #GtkPageSetup
</parameter_description>
</parameter>
-<parameter name="count">
-<parameter_description> number of characters to move (negative moves left,
-positive moves right)
+<parameter name="unit">
+<parameter_description> the unit for the return value
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter moved and is not on the end iterator
+<return> the left margin
+
</return>
</function>
-<function name="gtk_box_pack_end_defaults">
+<function name="gtk_page_setup_get_orientation">
<description>
-Adds @widget to @box, packed with reference to the end of @box.
-The child is packed after any other child packed with reference
-to the start of @box.
-
-Parameters for how to pack the child @widget, #GtkBox:expand,
-#GtkBox:fill and #GtkBox:padding, are given their default
-values, %TRUE, %TRUE, and 0, respectively.
+Gets the page orientation of the #GtkPageSetup.
-Deprecated: 2.14: Use gtk_box_pack_end()
+Since: 2.10
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #GtkBox
-</parameter_description>
-</parameter>
-<parameter name="widget">
-<parameter_description> the #GtkWidget to be added to @box
+<parameter name="setup">
+<parameter_description> a #GtkPageSetup
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the page orientation
+
+</return>
</function>
-<function name="gtk_statusbar_pop">
+<function name="gtk_page_setup_get_page_height">
<description>
-Removes the first message in the #GtkStatusBar's stack
-with the given context id.
+Returns the page height in units of @unit.
-Note that this may not change the displayed message, if
-the message at the top of the stack has a different
-context id.
+Note that this function takes orientation and
+margins into consideration.
+See gtk_page_setup_get_paper_height().
+
+Since: 2.10
</description>
<parameters>
-<parameter name="statusbar">
-<parameter_description> a #GtkStatusBar
+<parameter name="setup">
+<parameter_description> a #GtkPageSetup
</parameter_description>
</parameter>
-<parameter name="context_id">
-<parameter_description> a context identifier
+<parameter name="unit">
+<parameter_description> the unit for the return value
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the page height.
+
+</return>
</function>
-<function name="gtk_print_settings_set_scale">
+<function name="gtk_page_setup_get_page_width">
<description>
-Sets the value of %GTK_PRINT_SETTINGS_SCALE.
+Returns the page width in units of @unit.
+
+Note that this function takes orientation and
+margins into consideration.
+See gtk_page_setup_get_paper_width().
Since: 2.10
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="setup">
+<parameter_description> a #GtkPageSetup
</parameter_description>
</parameter>
-<parameter name="scale">
-<parameter_description> the scale in percent
+<parameter name="unit">
+<parameter_description> the unit for the return value
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the page width.
+
+</return>
</function>
-<function name="gtk_clipboard_get_display">
+<function name="gtk_page_setup_get_paper_height">
<description>
-Gets the #GdkDisplay associated with @clipboard
+Returns the paper height in units of @unit.
-Since: 2.2
+Note that this function takes orientation, but
+not margins into consideration.
+See gtk_page_setup_get_page_height().
+
+Since: 2.10
</description>
<parameters>
-<parameter name="clipboard">
-<parameter_description> a #GtkClipboard
+<parameter name="setup">
+<parameter_description> a #GtkPageSetup
+</parameter_description>
+</parameter>
+<parameter name="unit">
+<parameter_description> the unit for the return value
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkDisplay associated with @clipboard
+<return> the paper height.
</return>
</function>
-<function name="gtk_range_get_upper_stepper_sensitivity">
+<function name="gtk_page_setup_get_paper_size">
<description>
-Gets the sensitivity policy for the stepper that points to the
-'upper' end of the GtkRange's adjustment.
+Gets the paper size of the #GtkPageSetup.
Since: 2.10
</description>
<parameters>
-<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter name="setup">
+<parameter_description> a #GtkPageSetup
</parameter_description>
</parameter>
</parameters>
-<return> The upper stepper's sensitivity policy.
+<return> the paper size
</return>
</function>
-<function name="gtk_color_selection_get_previous_alpha">
+<function name="gtk_page_setup_get_paper_width">
<description>
-Returns the previous alpha value.
+Returns the paper width in units of @unit.
+
+Note that this function takes orientation, but
+not margins into consideration.
+See gtk_page_setup_get_page_width().
+Since: 2.10
</description>
<parameters>
-<parameter name="colorsel">
-<parameter_description> a #GtkColorSelection.
+<parameter name="setup">
+<parameter_description> a #GtkPageSetup
+</parameter_description>
+</parameter>
+<parameter name="unit">
+<parameter_description> the unit for the return value
</parameter_description>
</parameter>
</parameters>
-<return> an integer between 0 and 65535.
+<return> the paper width.
+
</return>
</function>
-<function name="gtk_text_buffer_register_deserialize_format">
+<function name="gtk_page_setup_get_right_margin">
<description>
-This function registers a rich text deserialization @function along with
-its @mime_type with the passed @buffer.
+Gets the right margin in units of @unit.
Since: 2.10
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="mime_type">
-<parameter_description> the format's mime-type
-</parameter_description>
-</parameter>
-<parameter name="function">
-<parameter_description> the deserialize function to register
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> @function's user_data
+<parameter name="setup">
+<parameter_description> a #GtkPageSetup
</parameter_description>
</parameter>
-<parameter name="user_data_destroy">
-<parameter_description> a function to call when @user_data is no longer needed
+<parameter name="unit">
+<parameter_description> the unit for the return value
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkAtom that corresponds to the newly registered
-format's mime-type.
+<return> the right margin
</return>
</function>
-<function name="gtk_window_get_default_size">
+<function name="gtk_page_setup_get_top_margin">
<description>
-Gets the default size of the window. A value of -1 for the width or
-height indicates that a default size has not been explicitly set
-for that dimension, so the "natural" size of the window will be
-used.
+Gets the top margin in units of @unit.
+Since: 2.10
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> location to store the default width, or %NULL
+<parameter name="setup">
+<parameter_description> a #GtkPageSetup
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> location to store the default height, or %NULL
+<parameter name="unit">
+<parameter_description> the unit for the return value
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the top margin
+
+</return>
</function>
-<function name="gtk_entry_completion_complete">
+<function name="gtk_page_setup_load_file">
<description>
-Requests a completion operation, or in other words a refiltering of the
-current list with completions, using the current key. The completion list
-view will be updated accordingly.
+Reads the page setup from the file @file_name.
+See gtk_page_setup_to_file().
-Since: 2.4
+Since: 2.14
</description>
<parameters>
-<parameter name="completion">
-<parameter_description> A #GtkEntryCompletion.
+<parameter name="setup">
+<parameter_description> a #GtkPageSetup
+</parameter_description>
+</parameter>
+<parameter name="file_name">
+<parameter_description> the filename to read the page setup from
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for an error, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE on success
+
+</return>
</function>
-<function name="gtk_cell_layout_set_cell_data_func">
+<function name="gtk_page_setup_load_key_file">
<description>
-Sets the #GtkCellLayoutDataFunc to use for @cell_layout. This function
-is used instead of the standard attributes mapping for setting the
-column value, and should set the value of @cell_layout's cell renderer(s)
-as appropriate. @func may be %NULL to remove and older one.
+Reads the page setup from the group @group_name in the key file
+ key_file
-Since: 2.4
+Since: 2.14
</description>
<parameters>
-<parameter name="cell_layout">
-<parameter_description> A #GtkCellLayout.
-</parameter_description>
-</parameter>
-<parameter name="cell">
-<parameter_description> A #GtkCellRenderer.
+<parameter name="setup">
+<parameter_description> a #GtkPageSetup
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> The #GtkCellLayoutDataFunc to use.
+<parameter name="key_file">
+<parameter_description> the #GKeyFile to retrieve the page_setup from
</parameter_description>
</parameter>
-<parameter name="func_data">
-<parameter_description> The user data for @func.
+<parameter name="group_name">
+<parameter_description> the name of the group in the key_file to read, or %NULL
+to use the default name "Page Setup"
</parameter_description>
</parameter>
-<parameter name="destroy">
-<parameter_description> The destroy notification for @func_data.
+<parameter name="error">
+<parameter_description> return location for an error, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE on success
+
+</return>
</function>
-<function name="gtk_font_selection_set_preview_text">
+<function name="gtk_page_setup_new">
<description>
-Sets the text displayed in the preview area.
-The @text is used to show how the selected font looks.
+Creates a new #GtkPageSetup.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="fontsel">
-<parameter_description> a #GtkFontSelection
-</parameter_description>
-</parameter>
-<parameter name="text">
-<parameter_description> the text to display in the preview area
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> a new #GtkPageSetup.
+
+</return>
</function>
-<function name="gtk_widget_error_bell">
+<function name="gtk_page_setup_new_from_file">
<description>
-Notifies the user about an input-related error on this widget.
-If the #GtkSettings:gtk-error-bell setting is %TRUE, it calls
-gdk_window_beep(), otherwise it does nothing.
-
-Note that the effect of gdk_window_beep() can be configured in many
-ways, depending on the windowing backend and the desktop environment
-or window manager that is used.
+Reads the page setup from the file @file_name. Returns a
+new #GtkPageSetup object with the restored page setup,
+or %NULL if an error occurred. See gtk_page_setup_to_file().
Since: 2.12
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="file_name">
+<parameter_description> the filename to read the page setup from
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_accel_group_lock">
-<description>
-Locks the given accelerator group.
-
-Locking an acelerator group prevents the accelerators contained
-within it to be changed during runtime. Refer to
-gtk_accel_map_change_entry() about runtime accelerator changes.
-
-If called more than once, @accel_group remains locked until
-gtk_accel_group_unlock() has been called an equivalent number
-of times.
-
-</description>
-<parameters>
-<parameter name="accel_group">
-<parameter_description> a #GtkAccelGroup
+<parameter name="error">
+<parameter_description> return location for an error, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the restored #GtkPageSetup
+
+</return>
</function>
-<function name="gtk_list_store_set">
+<function name="gtk_page_setup_new_from_key_file">
<description>
-Sets the value of one or more cells in the row referenced by @iter.
-The variable argument list should contain integer column numbers,
-each column number followed by the value to be set.
-The list is terminated by a -1. For example, to set column 0 with type
-%G_TYPE_STRING to "Foo", you would write <literal>gtk_list_store_set (store, iter,
-0, "Foo", -1)</literal>.
+Reads the page setup from the group @group_name in the key file
+ key_file Returns a new #GtkPageSetup object with the restored
+page setup, or %NULL if an error occurred.
-The value will be referenced by the store if it is a %G_TYPE_OBJECT, and it
-will be copied if it is a %G_TYPE_STRING or %G_TYPE_BOXED.
+Since: 2.12
</description>
<parameters>
-<parameter name="list_store">
-<parameter_description> a #GtkListStore
+<parameter name="key_file">
+<parameter_description> the #GKeyFile to retrieve the page_setup from
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> row iterator
+<parameter name="group_name">
+<parameter_description> the name of the group in the key_file to read, or %NULL
+to use the default name "Page Setup"
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> pairs of column number and value, terminated with -1
+<parameter name="error">
+<parameter_description> return location for an error, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the restored #GtkPageSetup
+
+</return>
</function>
-<function name="gtk_widget_unparent">
+<function name="gtk_page_setup_set_bottom_margin">
<description>
-This function is only for use in widget implementations.
-Should be called by implementations of the remove method
-on #GtkContainer, to dissociate a child from the container.
+Sets the bottom margin of the #GtkPageSetup.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="setup">
+<parameter_description> a #GtkPageSetup
+</parameter_description>
+</parameter>
+<parameter name="margin">
+<parameter_description> the new bottom margin in units of @unit
+</parameter_description>
+</parameter>
+<parameter name="unit">
+<parameter_description> the units for @margin
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_enable_model_drag_dest">
+<function name="gtk_page_setup_set_left_margin">
<description>
-Turns @tree_view into a drop destination for automatic DND. Calling
-this method sets #GtkTreeView:reorderable to %FALSE.
+Sets the left margin of the #GtkPageSetup.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
-</parameter_description>
-</parameter>
-<parameter name="targets">
-<parameter_description> the table of targets that the drag will support
+<parameter name="setup">
+<parameter_description> a #GtkPageSetup
</parameter_description>
</parameter>
-<parameter name="n_targets">
-<parameter_description> the number of items in @targets
+<parameter name="margin">
+<parameter_description> the new left margin in units of @unit
</parameter_description>
</parameter>
-<parameter name="actions">
-<parameter_description> the bitmask of possible actions for a drag from this
-widget
+<parameter name="unit">
+<parameter_description> the units for @margin
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_unix_dialog_get_support_selection">
+<function name="gtk_page_setup_set_orientation">
<description>
-Gets the value of #GtkPrintUnixDialog::support-selection property.
+Sets the page orientation of the #GtkPageSetup.
-Since: 2.18
+Since: 2.10
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter name="setup">
+<parameter_description> a #GtkPageSetup
+</parameter_description>
+</parameter>
+<parameter name="orientation">
+<parameter_description> a #GtkPageOrientation value
</parameter_description>
</parameter>
</parameters>
-<return> whether the application supports print of selection
-
-</return>
+<return></return>
</function>
-<function name="gtk_text_iter_backward_lines">
+<function name="gtk_page_setup_set_paper_size">
<description>
-Moves @count lines backward, if possible (if @count would move
-past the start or end of the buffer, moves to the start or end of
-the buffer). The return value indicates whether the iterator moved
-onto a dereferenceable position; if the iterator didn't move, or
-moved onto the end iterator, then %FALSE is returned. If @count is 0,
-the function does nothing and returns %FALSE. If @count is negative,
-moves forward by 0 - @count lines.
+Sets the paper size of the #GtkPageSetup without
+changing the margins. See
+gtk_page_setup_set_paper_size_and_default_margins().
+Since: 2.10
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="setup">
+<parameter_description> a #GtkPageSetup
</parameter_description>
</parameter>
-<parameter name="count">
-<parameter_description> number of lines to move backward
+<parameter name="size">
+<parameter_description> a #GtkPaperSize
</parameter_description>
</parameter>
</parameters>
-<return> whether @iter moved and is dereferenceable
-</return>
+<return></return>
</function>
-<function name="gtk_notebook_get_scrollable">
+<function name="gtk_page_setup_set_paper_size_and_default_margins">
<description>
-Returns whether the tab label area has arrows for scrolling. See
-gtk_notebook_set_scrollable().
+Sets the paper size of the #GtkPageSetup and modifies
+the margins according to the new paper size.
+Since: 2.10
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="setup">
+<parameter_description> a #GtkPageSetup
+</parameter_description>
+</parameter>
+<parameter name="size">
+<parameter_description> a #GtkPaperSize
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if arrows for scrolling are present
-</return>
+<return></return>
</function>
-<function name="gtk_paned_get_handle_window">
+<function name="gtk_page_setup_set_right_margin">
<description>
-Returns the #GdkWindow of the handle. This function is
-useful when handling button or motion events because it
-enables the callback to distinguish between the window
-of the paned, a child and the handle.
+Sets the right margin of the #GtkPageSetup.
-Since: 2.20
+Since: 2.10
</description>
<parameters>
-<parameter name="panede">
-<parameter_description> a #GtkPaned
+<parameter name="setup">
+<parameter_description> a #GtkPageSetup
+</parameter_description>
+</parameter>
+<parameter name="margin">
+<parameter_description> the new right margin in units of @unit
+</parameter_description>
+</parameter>
+<parameter name="unit">
+<parameter_description> the units for @margin
</parameter_description>
</parameter>
</parameters>
-<return> the paned's handle window.
-
-</return>
+<return></return>
</function>
-<function name="gtk_print_settings_get_n_copies">
+<function name="gtk_page_setup_set_top_margin">
<description>
-Gets the value of %GTK_PRINT_SETTINGS_N_COPIES.
+Sets the top margin of the #GtkPageSetup.
Since: 2.10
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="setup">
+<parameter_description> a #GtkPageSetup
+</parameter_description>
+</parameter>
+<parameter name="margin">
+<parameter_description> the new top margin in units of @unit
+</parameter_description>
+</parameter>
+<parameter name="unit">
+<parameter_description> the units for @margin
</parameter_description>
</parameter>
</parameters>
-<return> the number of copies to print
-
-</return>
+<return></return>
</function>
-<function name="gtk_frame_get_label_align">
+<function name="gtk_page_setup_to_file">
<description>
-Retrieves the X and Y alignment of the frame's label. See
-gtk_frame_set_label_align().
+This function saves the information from @setup to @file_name.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="frame">
-<parameter_description> a #GtkFrame
+<parameter name="setup">
+<parameter_description> a #GtkPageSetup
</parameter_description>
</parameter>
-<parameter name="xalign">
-<parameter_description> location to store X alignment of frame's label, or %NULL
+<parameter name="file_name">
+<parameter_description> the file to save to
</parameter_description>
</parameter>
-<parameter name="yalign">
-<parameter_description> location to store X alignment of frame's label, or %NULL
+<parameter name="error">
+<parameter_description> return location for errors, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE on success
+
+</return>
</function>
-<function name="gtk_recent_info_unref">
+<function name="gtk_page_setup_to_key_file">
<description>
-Decreases the reference count of @info by one. If the reference
-count reaches zero, @info is deallocated, and the memory freed.
+This function adds the page setup from @setup to @key_file.
-Since: 2.10
+Since: 2.12
</description>
<parameters>
-<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter name="setup">
+<parameter_description> a #GtkPageSetup
+</parameter_description>
+</parameter>
+<parameter name="key_file">
+<parameter_description> the #GKeyFile to save the page setup to
+</parameter_description>
+</parameter>
+<parameter name="group_name">
+<parameter_description> the group to add the settings to in @key_file,
+or %NULL to use the default name "Page Setup"
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_iter_get_text">
+<function name="gtk_page_setup_unix_dialog_get_page_setup">
<description>
-Returns <emphasis>text</emphasis> in the given range. If the range
-contains non-text elements such as images, the character and byte
-offsets in the returned string will not correspond to character and
-byte offsets in the buffer. If you want offsets to correspond, see
-gtk_text_iter_get_slice ().
+Gets the currently selected page setup from the dialog.
+Since: 2.10
</description>
<parameters>
-<parameter name="start">
-<parameter_description> iterator at start of a range
-</parameter_description>
-</parameter>
-<parameter name="end">
-<parameter_description> iterator at end of a range
+<parameter name="dialog">
+<parameter_description> a #GtkPageSetupUnixDialog
</parameter_description>
</parameter>
</parameters>
-<return> array of characters from the buffer
+<return> the current page setup
+
</return>
</function>
-<function name="gtk_tree_view_get_headers_clickable">
+<function name="gtk_page_setup_unix_dialog_get_print_settings">
<description>
-Returns whether all header columns are clickable.
+Gets the current print settings from the dialog.
Since: 2.10
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView.
+<parameter name="dialog">
+<parameter_description> a #GtkPageSetupUnixDialog
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if all header columns are clickable, otherwise %FALSE
+<return> the current print settings
</return>
</function>
-<function name="gtk_tool_shell_get_text_orientation">
+<function name="gtk_page_setup_unix_dialog_new">
<description>
-Retrieves the current text orientation for the tool shell. Tool items must not
-call this function directly, but rely on gtk_tool_item_get_text_orientation()
-instead.
+Creates a new page setup dialog.
-Since: 2.20
+Since: 2.10
</description>
<parameters>
-<parameter name="shell">
-<parameter_description> a #GtkToolShell
+<parameter name="title">
+<parameter_description> the title of the dialog, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="parent">
+<parameter_description> transient parent of the dialog, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the current text orientation of @shell
+<return> the new #GtkPageSetupUnixDialog
</return>
</function>
-<function name="gtk_tree_selection_iter_is_selected">
+<function name="gtk_page_setup_unix_dialog_set_page_setup">
<description>
-Returns %TRUE if the row at @iter is currently selected.
+Sets the #GtkPageSetup from which the page setup
+dialog takes its values.
+Since: 2.10
</description>
<parameters>
-<parameter name="selection">
-<parameter_description> A #GtkTreeSelection
+<parameter name="dialog">
+<parameter_description> a #GtkPageSetupUnixDialog
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> A valid #GtkTreeIter
+<parameter name="page_setup">
+<parameter_description> a #GtkPageSetup
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE, if @iter is selected
-</return>
+<return></return>
</function>
-<function name="gtk_text_iter_forward_visible_word_end">
+<function name="gtk_page_setup_unix_dialog_set_print_settings">
<description>
-Moves forward to the next visible word end. (If @iter is currently on a
-word end, moves forward to the next one after that.) Word breaks
-are determined by Pango and should be correct for nearly any
-language (if not, the correct fix would be to the Pango word break
-algorithms).
+Sets the #GtkPrintSettings from which the page setup dialog
+takes its values.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="dialog">
+<parameter_description> a #GtkPageSetupUnixDialog
+</parameter_description>
+</parameter>
+<parameter name="print_settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter moved and is not the end iterator
-
-</return>
+<return></return>
</function>
-<function name="gtk_cell_view_set_value">
+<function name="gtk_paint_arrow">
<description>
-Sets a property of a cell renderer of @cell_view, and
-makes sure the display of @cell_view is updated.
-
-Since: 2.6
+Draws an arrow in the given rectangle on @window using the given
+parameters. @arrow_type determines the direction of the arrow.
</description>
<parameters>
-<parameter name="cell_view">
-<parameter_description> a #GtkCellView widget
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-<parameter name="renderer">
-<parameter_description> one of the renderers of @cell_view
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="property">
-<parameter_description> the name of the property of @renderer to set
+<parameter name="state_type">
+<parameter_description> a state
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> the new value to set the property to
+<parameter name="shadow_type">
+<parameter_description> the type of shadow to draw
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_spin_button_configure">
-<description>
-Changes the properties of an existing spin button. The adjustment, climb rate,
-and number of decimal places are all changed accordingly, after this function call.
-
-</description>
-<parameters>
-<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter name="area">
+<parameter_description> clip rectangle, or %NULL if the
+output should not be clipped
</parameter_description>
</parameter>
-<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment.
+<parameter name="widget">
+<parameter_description> the widget
</parameter_description>
</parameter>
-<parameter name="climb_rate">
-<parameter_description> the new climb rate.
+<parameter name="detail">
+<parameter_description> a style detail
</parameter_description>
</parameter>
-<parameter name="digits">
-<parameter_description> the number of decimal places to display in the spin button.
+<parameter name="arrow_type">
+<parameter_description> the type of arrow to draw
+</parameter_description>
+</parameter>
+<parameter name="fill">
+<parameter_description> %TRUE if the arrow tip should be filled
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> x origin of the rectangle to draw the arrow in
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y origin of the rectangle to draw the arrow in
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> width of the rectangle to draw the arrow in
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> height of the rectangle to draw the arrow in
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_view_scroll_to_iter">
+<function name="gtk_paint_box">
<description>
-Scrolls @text_view so that @iter is on the screen in the position
-indicated by @xalign and @yalign. An alignment of 0.0 indicates
-left or top, 1.0 indicates right or bottom, 0.5 means center.
-If @use_align is %FALSE, the text scrolls the minimal distance to
-get the mark onscreen, possibly not scrolling at all. The effective
-screen for purposes of this function is reduced by a margin of size
- within_margin
-
-Note that this function uses the currently-computed height of the
-lines in the text buffer. Line heights are computed in an idle
-handler; so this function may not have the desired effect if it's
-called before the height computations. To avoid oddness, consider
-using gtk_text_view_scroll_to_mark() which saves a point to be
-scrolled to after line validation.
-
+Draws a box on @window with the given parameters.
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="within_margin">
-<parameter_description> margin as a [0.0,0.5) fraction of screen size
+<parameter name="state_type">
+<parameter_description> a state
</parameter_description>
</parameter>
-<parameter name="use_align">
-<parameter_description> whether to use alignment arguments (if %FALSE,
-just get the mark onscreen)
+<parameter name="shadow_type">
+<parameter_description> the type of shadow to draw
</parameter_description>
</parameter>
-<parameter name="xalign">
-<parameter_description> horizontal alignment of mark within visible area
+<parameter name="area">
+<parameter_description> clip rectangle, or %NULL if the
+output should not be clipped
</parameter_description>
</parameter>
-<parameter name="yalign">
-<parameter_description> vertical alignment of mark within visible area
+<parameter name="widget">
+<parameter_description> the widget
</parameter_description>
</parameter>
-</parameters>
-<return> %TRUE if scrolling occurred
-</return>
-</function>
-
-<function name="gtk_entry_new_with_max_length">
-<description>
-Creates a new #GtkEntry widget with the given maximum length.
-
-Deprecated: 2.0: Use gtk_entry_set_max_length() instead.
-
-</description>
-<parameters>
-<parameter name="max">
-<parameter_description> the maximum length of the entry, or 0 for no maximum.
-(other than the maximum length of entries.) The value passed in will
-be clamped to the range 0-65536.
+<parameter name="detail">
+<parameter_description> a style detail
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> x origin of the box
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y origin of the box
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> the width of the box
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the height of the box
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkEntry
-
-</return>
+<return></return>
</function>
-<function name="gtk_style_lookup_icon_set">
+<function name="gtk_paint_box_gap">
<description>
-Looks up @stock_id in the icon factories associated with @style
-and the default icon factory, returning an icon set if found,
-otherwise %NULL.
-
+Draws a box in @window using the given style and state and shadow type,
+leaving a gap in one side.
</description>
<parameters>
@@ -31660,122 +31539,119 @@ otherwise %NULL.
<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-<parameter name="stock_id">
-<parameter_description> an icon name
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-</parameters>
-<return> icon set of @stock_id
-</return>
-</function>
-
-<function name="gtk_assistant_set_page_side_image">
-<description>
-Sets a header image for @page. This image is displayed in the side
-area of the assistant when @page is the current page.
-
-Since: 2.10
-
-</description>
-<parameters>
-<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter name="state_type">
+<parameter_description> a state
</parameter_description>
</parameter>
-<parameter name="page">
-<parameter_description> a page of @assistant
+<parameter name="shadow_type">
+<parameter_description> type of shadow to draw
</parameter_description>
</parameter>
-<parameter name="pixbuf">
-<parameter_description> the new header image @page
+<parameter name="area">
+<parameter_description> clip rectangle, or %NULL if the
+output should not be clipped
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_notebook_set_tab_vborder">
-<description>
-Sets the width of the vertical border of tab labels.
-
-</description>
-<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="widget">
+<parameter_description> the widget
</parameter_description>
</parameter>
-<parameter name="tab_vborder">
-<parameter_description> width of the vertical border of tab labels.
+<parameter name="detail">
+<parameter_description> a style detail
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_target_list_add_image_targets">
-<description>
-Appends the image targets supported by #GtkSelection to
-the target list. All targets are added with the same @info.
-
-Since: 2.6
-
-</description>
-<parameters>
-<parameter name="list">
-<parameter_description> a #GtkTargetList
+<parameter name="x">
+<parameter_description> x origin of the rectangle
</parameter_description>
</parameter>
-<parameter name="info">
-<parameter_description> an ID that will be passed back to the application
+<parameter name="y">
+<parameter_description> y origin of the rectangle
</parameter_description>
</parameter>
-<parameter name="writable">
-<parameter_description> whether to add only targets for which GTK+ knows
-how to convert a pixbuf into the format
+<parameter name="width">
+<parameter_description> width of the rectangle
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> width of the rectangle
+</parameter_description>
+</parameter>
+<parameter name="gap_side">
+<parameter_description> side in which to leave the gap
+</parameter_description>
+</parameter>
+<parameter name="gap_x">
+<parameter_description> starting position of the gap
+</parameter_description>
+</parameter>
+<parameter name="gap_width">
+<parameter_description> width of the gap
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_settings_set_paper_size">
+<function name="gtk_paint_check">
<description>
-Sets the value of %GTK_PRINT_SETTINGS_PAPER_FORMAT,
-%GTK_PRINT_SETTINGS_PAPER_WIDTH and
-%GTK_PRINT_SETTINGS_PAPER_HEIGHT.
-
-Since: 2.10
+Draws a check button indicator in the given rectangle on @window with
+the given parameters.
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-<parameter name="paper_size">
-<parameter_description> a paper size
+<parameter name="window">
+<parameter_description> a #GdkWindow
+</parameter_description>
+</parameter>
+<parameter name="state_type">
+<parameter_description> a state
+</parameter_description>
+</parameter>
+<parameter name="shadow_type">
+<parameter_description> the type of shadow to draw
+</parameter_description>
+</parameter>
+<parameter name="area">
+<parameter_description> clip rectangle, or %NULL if the
+output should not be clipped
+</parameter_description>
+</parameter>
+<parameter name="widget">
+<parameter_description> the widget
+</parameter_description>
+</parameter>
+<parameter name="detail">
+<parameter_description> a style detail
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> x origin of the rectangle to draw the check in
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y origin of the rectangle to draw the check in
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> the width of the rectangle to draw the check in
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the height of the rectangle to draw the check in
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_paper_size_get_default">
-<description>
-Returns the name of the default paper size, which
-depends on the current locale.
-
-Since: 2.10
-
-</description>
-<parameters>
-</parameters>
-<return> the name of the default paper size. The string
-is owned by GTK+ and should not be modified.
-
-</return>
-</function>
-
<function name="gtk_paint_diamond">
<description>
Draws a diamond in the given rectangle on @window using the given
@@ -31832,28 +31708,66 @@ output should not be clipped
<return></return>
</function>
-<function name="gtk_ruler_get_metric">
+<function name="gtk_paint_expander">
<description>
-Gets the units used for a #GtkRuler. See gtk_ruler_set_metric().
-
+Draws an expander as used in #GtkTreeView. @x and @y specify the
+center the expander. The size of the expander is determined by the
+"expander-size" style property of @widget. (If widget is not
+specified or doesn't have an "expander-size" property, an
+unspecified default size will be used, since the caller doesn't
+have sufficient information to position the expander, this is
+likely not useful.) The expander is expander_size pixels tall
+in the collapsed position and expander_size pixels wide in the
+expanded position.
</description>
<parameters>
-<parameter name="ruler">
-<parameter_description> a #GtkRuler
+<parameter name="style">
+<parameter_description> a #GtkStyle
+</parameter_description>
+</parameter>
+<parameter name="window">
+<parameter_description> a #GdkWindow
+</parameter_description>
+</parameter>
+<parameter name="state_type">
+<parameter_description> a state
+</parameter_description>
+</parameter>
+<parameter name="area">
+<parameter_description> clip rectangle, or %NULL if the
+output should not be clipped
+</parameter_description>
+</parameter>
+<parameter name="widget">
+<parameter_description> the widget
+</parameter_description>
+</parameter>
+<parameter name="detail">
+<parameter_description> a style detail
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> the x position to draw the expander at
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> the y position to draw the expander at
+</parameter_description>
+</parameter>
+<parameter name="expander_style">
+<parameter_description> the style to draw the expander in; determines
+whether the expander is collapsed, expanded, or in an
+intermediate state.
</parameter_description>
</parameter>
</parameters>
-<return> the units currently used for @ruler
-</return>
+<return></return>
</function>
-<function name="gtk_draw_arrow">
+<function name="gtk_paint_extension">
<description>
-Draws an arrow in the given rectangle on @window using the given
-parameters. @arrow_type determines the direction of the arrow.
-
-Deprecated: 2.0: Use gtk_paint_arrow() instead.
+Draws an extension, i.e. a notebook tab.
</description>
<parameters>
@@ -31870,161 +31784,317 @@ Deprecated: 2.0: Use gtk_paint_arrow() instead.
</parameter_description>
</parameter>
<parameter name="shadow_type">
-<parameter_description> the type of shadow to draw
+<parameter_description> type of shadow to draw
</parameter_description>
</parameter>
-<parameter name="arrow_type">
-<parameter_description> the type of arrow to draw
+<parameter name="area">
+<parameter_description> clip rectangle, or %NULL if the
+output should not be clipped
</parameter_description>
</parameter>
-<parameter name="fill">
-<parameter_description> %TRUE if the arrow tip should be filled
+<parameter name="widget">
+<parameter_description> the widget
+</parameter_description>
+</parameter>
+<parameter name="detail">
+<parameter_description> a style detail
</parameter_description>
</parameter>
<parameter name="x">
-<parameter_description> x origin of the rectangle to draw the arrow in
+<parameter_description> x origin of the extension
</parameter_description>
</parameter>
<parameter name="y">
-<parameter_description> y origin of the rectangle to draw the arrow in
+<parameter_description> y origin of the extension
</parameter_description>
</parameter>
<parameter name="width">
-<parameter_description> width of the rectangle to draw the arrow in
+<parameter_description> width of the extension
</parameter_description>
</parameter>
<parameter name="height">
-<parameter_description> height of the rectangle to draw the arrow in
+<parameter_description> width of the extension
+</parameter_description>
+</parameter>
+<parameter name="gap_side">
+<parameter_description> the side on to which the extension is attached
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_store_newv">
+<function name="gtk_paint_flat_box">
<description>
-Non vararg creation function. Used primarily by language bindings.
-
+Draws a flat box on @window with the given parameters.
</description>
<parameters>
-<parameter name="n_columns">
-<parameter_description> number of columns in the tree store
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-<parameter name="types">
-<parameter_description> an array of #GType types for the columns, from first to last
+<parameter name="window">
+<parameter_description> a #GdkWindow
+</parameter_description>
+</parameter>
+<parameter name="state_type">
+<parameter_description> a state
+</parameter_description>
+</parameter>
+<parameter name="shadow_type">
+<parameter_description> the type of shadow to draw
+</parameter_description>
+</parameter>
+<parameter name="area">
+<parameter_description> clip rectangle, or %NULL if the
+output should not be clipped
+</parameter_description>
+</parameter>
+<parameter name="widget">
+<parameter_description> the widget
+</parameter_description>
+</parameter>
+<parameter name="detail">
+<parameter_description> a style detail
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> x origin of the box
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y origin of the box
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> the width of the box
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the height of the box
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkTreeStore
-</return>
+<return></return>
</function>
-<function name="gtk_font_selection_get_font">
+<function name="gtk_paint_focus">
<description>
-Gets the currently-selected font.
-
-Deprecated: 2.0: Use gtk_font_selection_get_font_name() instead.
+Draws a focus indicator around the given rectangle on @window using the
+given style.
</description>
<parameters>
-<parameter name="fontsel">
-<parameter_description> a #GtkFontSelection
+<parameter name="style">
+<parameter_description> a #GtkStyle
+</parameter_description>
+</parameter>
+<parameter name="window">
+<parameter_description> a #GdkWindow
+</parameter_description>
+</parameter>
+<parameter name="state_type">
+<parameter_description> a state
+</parameter_description>
+</parameter>
+<parameter name="area">
+<parameter_description> clip rectangle, or %NULL if the
+output should not be clipped
+</parameter_description>
+</parameter>
+<parameter name="widget">
+<parameter_description> the widget
+</parameter_description>
+</parameter>
+<parameter name="detail">
+<parameter_description> a style detail
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> the x origin of the rectangle around which to draw a focus indicator
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> the y origin of the rectangle around which to draw a focus indicator
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> the width of the rectangle around which to draw a focus indicator
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the height of the rectangle around which to draw a focus indicator
</parameter_description>
</parameter>
</parameters>
-<return> A #GdkFont.
-
-</return>
+<return></return>
</function>
-<function name="gtk_tree_view_scroll_to_cell">
+<function name="gtk_paint_handle">
<description>
-Moves the alignments of @tree_view to the position specified by @column and
- path If @column is %NULL, then no horizontal scrolling occurs. Likewise,
-if @path is %NULL no vertical scrolling occurs. At a minimum, one of @column
-or @path need to be non-%NULL. @row_align determines where the row is
-placed, and @col_align determines where @column is placed. Both are expected
-to be between 0.0 and 1.0. 0.0 means left/top alignment, 1.0 means
-right/bottom alignment, 0.5 means center.
-
-If @use_align is %FALSE, then the alignment arguments are ignored, and the
-tree does the minimum amount of work to scroll the cell onto the screen.
-This means that the cell will be scrolled to the edge closest to its current
-position. If the cell is currently visible on the screen, nothing is done.
-
-This function only works if the model is set, and @path is a valid row on the
-model. If the model changes before the @tree_view is realized, the centered
-path will be modified to reflect this change.
+Draws a handle as used in #GtkHandleBox and #GtkPaned.
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView.
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> The path of the row to move to, or %NULL.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="column">
-<parameter_description> The #GtkTreeViewColumn to move horizontally to, or %NULL.
+<parameter name="state_type">
+<parameter_description> a state
</parameter_description>
</parameter>
-<parameter name="use_align">
-<parameter_description> whether to use alignment arguments, or %FALSE.
+<parameter name="shadow_type">
+<parameter_description> type of shadow to draw
</parameter_description>
</parameter>
-<parameter name="row_align">
-<parameter_description> The vertical alignment of the row specified by @path.
+<parameter name="area">
+<parameter_description> clip rectangle, or %NULL if the
+output should not be clipped
</parameter_description>
</parameter>
-<parameter name="col_align">
-<parameter_description> The horizontal alignment of the column specified by @column.
+<parameter name="widget">
+<parameter_description> the widget
+</parameter_description>
+</parameter>
+<parameter name="detail">
+<parameter_description> a style detail
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> x origin of the handle
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y origin of the handle
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> with of the handle
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> height of the handle
+</parameter_description>
+</parameter>
+<parameter name="orientation">
+<parameter_description> the orientation of the handle
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_path_new">
+<function name="gtk_paint_hline">
<description>
-Creates a new #GtkTreePath. This structure refers to a row.
-
+Draws a horizontal line from (@x1, @y) to (@x2, @y) in @window
+using the given style and state.
</description>
<parameters>
+<parameter name="style">
+<parameter_description> a #GtkStyle
+</parameter_description>
+</parameter>
+<parameter name="window">
+<parameter_description> a #GdkWindow
+</parameter_description>
+</parameter>
+<parameter name="state_type">
+<parameter_description> a state
+</parameter_description>
+</parameter>
+<parameter name="area">
+<parameter_description> rectangle to which the output is clipped, or %NULL if the
+output should not be clipped
+</parameter_description>
+</parameter>
+<parameter name="widget">
+<parameter_description> the widget
+</parameter_description>
+</parameter>
+<parameter name="detail">
+<parameter_description> a style detail
+</parameter_description>
+</parameter>
+<parameter name="x1">
+<parameter_description> the starting x coordinate
+</parameter_description>
+</parameter>
+<parameter name="x2">
+<parameter_description> the ending x coordinate
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> the y coordinate
+</parameter_description>
+</parameter>
</parameters>
-<return> A newly created #GtkTreePath.
-</return>
+<return></return>
</function>
-<function name="gtk_text_view_get_hadjustment">
+<function name="gtk_paint_layout">
<description>
-Gets the horizontal-scrolling #GtkAdjustment.
-
-Since: 2.22
+Draws a layout on @window using the given parameters.
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="style">
+<parameter_description> a #GtkStyle
+</parameter_description>
+</parameter>
+<parameter name="window">
+<parameter_description> a #GdkWindow
+</parameter_description>
+</parameter>
+<parameter name="state_type">
+<parameter_description> a state
+</parameter_description>
+</parameter>
+<parameter name="use_text">
+<parameter_description> whether to use the text or foreground
+graphics context of @style
+</parameter_description>
+</parameter>
+<parameter name="area">
+<parameter_description> clip rectangle, or %NULL if the
+output should not be clipped
+</parameter_description>
+</parameter>
+<parameter name="widget">
+<parameter_description> the widget
+</parameter_description>
+</parameter>
+<parameter name="detail">
+<parameter_description> a style detail
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> x origin
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y origin
+</parameter_description>
+</parameter>
+<parameter name="layout">
+<parameter_description> the layout to draw
</parameter_description>
</parameter>
</parameters>
-<return> pointer to the horizontal #GtkAdjustment
-
-</return>
+<return></return>
</function>
-<function name="gtk_draw_option">
+<function name="gtk_paint_option">
<description>
Draws a radio button indicator in the given rectangle on @window with
the given parameters.
-Deprecated: 2.0: Use gtk_paint_option() instead.
-
</description>
<parameters>
<parameter name="style">
@@ -32043,6 +32113,19 @@ Deprecated: 2.0: Use gtk_paint_option() instead.
<parameter_description> the type of shadow to draw
</parameter_description>
</parameter>
+<parameter name="area">
+<parameter_description> clip rectangle, or %NULL if the
+output should not be clipped
+</parameter_description>
+</parameter>
+<parameter name="widget">
+<parameter_description> the widget
+</parameter_description>
+</parameter>
+<parameter name="detail">
+<parameter_description> a style detail
+</parameter_description>
+</parameter>
<parameter name="x">
<parameter_description> x origin of the rectangle to draw the option in
</parameter_description>
@@ -32063,1949 +32146,2349 @@ Deprecated: 2.0: Use gtk_paint_option() instead.
<return></return>
</function>
-<function name="gtk_image_menu_item_set_use_stock">
+<function name="gtk_paint_polygon">
<description>
-If %TRUE, the label set in the menuitem is used as a
-stock id to select the stock item for the item.
-
-Since: 2.16
+Draws a polygon on @window with the given parameters.
</description>
<parameters>
-<parameter name="image_menu_item">
-<parameter_description> a #GtkImageMenuItem
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-<parameter name="use_stock">
-<parameter_description> %TRUE if the menuitem should use a stock item
+<parameter name="window">
+<parameter_description> a #GdkWindow
+</parameter_description>
+</parameter>
+<parameter name="state_type">
+<parameter_description> a state
+</parameter_description>
+</parameter>
+<parameter name="shadow_type">
+<parameter_description> type of shadow to draw
+</parameter_description>
+</parameter>
+<parameter name="area">
+<parameter_description> clip rectangle, or %NULL if the
+output should not be clipped
+</parameter_description>
+</parameter>
+<parameter name="widget">
+<parameter_description> the widget
+</parameter_description>
+</parameter>
+<parameter name="detail">
+<parameter_description> a style detail
+</parameter_description>
+</parameter>
+<parameter name="points">
+<parameter_description> an array of #GdkPoint<!-- -->s
+</parameter_description>
+</parameter>
+<parameter name="n_points">
+<parameter_description> length of @points
+</parameter_description>
+</parameter>
+<parameter name="fill">
+<parameter_description> %TRUE if the polygon should be filled
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_notebook_get_tab_detachable">
+<function name="gtk_paint_resize_grip">
<description>
-Returns whether the tab contents can be detached from @notebook.
-
-Since: 2.10
+Draws a resize grip in the given rectangle on @window using the given
+parameters.
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-<parameter name="child">
-<parameter_description> a child #GtkWidget
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-</parameters>
-<return> TRUE if the tab is detachable.
-
-</return>
-</function>
-
-<function name="gtk_combo_box_set_row_span_column">
-<description>
-Sets the column with row span information for @combo_box to be @row_span.
-The row span column contains integers which indicate how many rows
-an item should span.
-
-Since: 2.4
-
-</description>
-<parameters>
-<parameter name="combo_box">
-<parameter_description> A #GtkComboBox.
+<parameter name="state_type">
+<parameter_description> a state
</parameter_description>
</parameter>
-<parameter name="row_span">
-<parameter_description> A column in the model passed during construction.
+<parameter name="area">
+<parameter_description> clip rectangle, or %NULL if the
+output should not be clipped
+</parameter_description>
+</parameter>
+<parameter name="widget">
+<parameter_description> the widget
+</parameter_description>
+</parameter>
+<parameter name="detail">
+<parameter_description> a style detail
+</parameter_description>
+</parameter>
+<parameter name="edge">
+<parameter_description> the edge in which to draw the resize grip
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> the x origin of the rectangle in which to draw the resize grip
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> the y origin of the rectangle in which to draw the resize grip
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> the width of the rectangle in which to draw the resize grip
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the height of the rectangle in which to draw the resize grip
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_drag_source_set_icon_stock">
+<function name="gtk_paint_shadow">
<description>
-Sets the icon that will be used for drags from a particular source
-to a stock icon.
+Draws a shadow around the given rectangle in @window
+using the given style and state and shadow type.
</description>
<parameters>
+<parameter name="style">
+<parameter_description> a #GtkStyle
+</parameter_description>
+</parameter>
+<parameter name="window">
+<parameter_description> a #GdkWindow
+</parameter_description>
+</parameter>
+<parameter name="state_type">
+<parameter_description> a state
+</parameter_description>
+</parameter>
+<parameter name="shadow_type">
+<parameter_description> type of shadow to draw
+</parameter_description>
+</parameter>
+<parameter name="area">
+<parameter_description> clip rectangle or %NULL if the
+output should not be clipped
+</parameter_description>
+</parameter>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> the widget
</parameter_description>
</parameter>
-<parameter name="stock_id">
-<parameter_description> the ID of the stock icon to use
+<parameter name="detail">
+<parameter_description> a style detail
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> x origin of the rectangle
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y origin of the rectangle
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> width of the rectangle
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> width of the rectangle
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_buildable_custom_tag_end">
+<function name="gtk_paint_shadow_gap">
<description>
-This is called at the end of each custom element handled by
-the buildable.
-
-Since: 2.12
+Draws a shadow around the given rectangle in @window
+using the given style and state and shadow type, leaving a
+gap in one side.
</description>
<parameters>
-<parameter name="buildable">
-<parameter_description> A #GtkBuildable
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-<parameter name="builder">
-<parameter_description> #GtkBuilder used to construct this object
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="child">
-<parameter_description> child object or %NULL for non-child tags
+<parameter name="state_type">
+<parameter_description> a state
</parameter_description>
</parameter>
-<parameter name="tagname">
-<parameter_description> name of tag
+<parameter name="shadow_type">
+<parameter_description> type of shadow to draw
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> user data that will be passed in to parser functions
+<parameter name="area">
+<parameter_description> clip rectangle, or %NULL if the
+output should not be clipped
+</parameter_description>
+</parameter>
+<parameter name="widget">
+<parameter_description> the widget
+</parameter_description>
+</parameter>
+<parameter name="detail">
+<parameter_description> a style detail
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> x origin of the rectangle
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y origin of the rectangle
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> width of the rectangle
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> width of the rectangle
+</parameter_description>
+</parameter>
+<parameter name="gap_side">
+<parameter_description> side in which to leave the gap
+</parameter_description>
+</parameter>
+<parameter name="gap_x">
+<parameter_description> starting position of the gap
+</parameter_description>
+</parameter>
+<parameter name="gap_width">
+<parameter_description> width of the gap
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_send_expose">
+<function name="gtk_paint_slider">
<description>
-Very rarely-used function. This function is used to emit
-an expose event signals on a widget. This function is not
-normally used directly. The only time it is used is when
-propagating an expose event to a child %NO_WINDOW widget, and
-that is normally done using gtk_container_propagate_expose().
-
-If you want to force an area of a window to be redrawn,
-use gdk_window_invalidate_rect() or gdk_window_invalidate_region().
-To cause the redraw to be done immediately, follow that call
-with a call to gdk_window_process_updates().
-
+Draws a slider in the given rectangle on @window using the
+given style and orientation.
</description>
<parameters>
+<parameter name="style">
+<parameter_description> a #GtkStyle
+</parameter_description>
+</parameter>
+<parameter name="window">
+<parameter_description> a #GdkWindow
+</parameter_description>
+</parameter>
+<parameter name="state_type">
+<parameter_description> a state
+</parameter_description>
+</parameter>
+<parameter name="shadow_type">
+<parameter_description> a shadow
+</parameter_description>
+</parameter>
+<parameter name="area">
+<parameter_description> clip rectangle, or %NULL if the
+output should not be clipped
+</parameter_description>
+</parameter>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> the widget
</parameter_description>
</parameter>
-<parameter name="event">
-<parameter_description> a expose #GdkEvent
+<parameter name="detail">
+<parameter_description> a style detail
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> the x origin of the rectangle in which to draw a slider
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> the y origin of the rectangle in which to draw a slider
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> the width of the rectangle in which to draw a slider
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the height of the rectangle in which to draw a slider
+</parameter_description>
+</parameter>
+<parameter name="orientation">
+<parameter_description> the orientation to be used
</parameter_description>
</parameter>
</parameters>
-<return> return from the event signal emission (%TRUE if
-the event was handled)
-</return>
+<return></return>
</function>
-<function name="gtk_menu_set_screen">
+<function name="gtk_paint_spinner">
<description>
-Sets the #GdkScreen on which the menu will be displayed.
+Draws a spinner on @window using the given parameters.
-Since: 2.2
+Since: 2.20
</description>
<parameters>
-<parameter name="menu">
-<parameter_description> a #GtkMenu.
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-<parameter name="screen">
-<parameter_description> a #GdkScreen, or %NULL if the screen should be
-determined by the widget the menu is attached to.
+<parameter name="window">
+<parameter_description> a #GdkWindow
+</parameter_description>
+</parameter>
+<parameter name="state_type">
+<parameter_description> a state
+</parameter_description>
+</parameter>
+<parameter name="area">
+<parameter_description> clip rectangle, or %NULL if the
+output should not be clipped
+</parameter_description>
+</parameter>
+<parameter name="widget">
+<parameter_description> the widget (may be %NULL)
+</parameter_description>
+</parameter>
+<parameter name="detail">
+<parameter_description> a style detail (may be %NULL)
+</parameter_description>
+</parameter>
+<parameter name="step">
+<parameter_description> the nth step, a value between 0 and #GtkSpinner:num-steps
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> the x origin of the rectangle in which to draw the spinner
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> the y origin of the rectangle in which to draw the spinner
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> the width of the rectangle in which to draw the spinner
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the height of the rectangle in which to draw the spinner
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_recent_info_get_added">
+<function name="gtk_paint_string">
<description>
-Gets the timestamp (seconds from system's Epoch) when the resource
-was added to the recently used resources list.
+Draws a text string on @window with the given parameters.
-Since: 2.10
+Deprecated: 2.0: Use gtk_paint_layout() instead.
</description>
<parameters>
-<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter name="style">
+<parameter_description> a #GtkStyle
+</parameter_description>
+</parameter>
+<parameter name="window">
+<parameter_description> a #GdkWindow
+</parameter_description>
+</parameter>
+<parameter name="state_type">
+<parameter_description> a state
+</parameter_description>
+</parameter>
+<parameter name="area">
+<parameter_description> clip rectangle, or %NULL if the
+output should not be clipped
+</parameter_description>
+</parameter>
+<parameter name="widget">
+<parameter_description> the widget
+</parameter_description>
+</parameter>
+<parameter name="detail">
+<parameter_description> a style detail
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> x origin
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y origin
+</parameter_description>
+</parameter>
+<parameter name="string">
+<parameter_description> the string to draw
</parameter_description>
</parameter>
</parameters>
-<return> the number of seconds elapsed from system's Epoch when
-the resource was added to the list, or -1 on failure.
-
-</return>
+<return></return>
</function>
-<function name="gtk_tree_model_filter_convert_child_path_to_path">
+<function name="gtk_paint_tab">
<description>
-Converts @child_path to a path relative to @filter. That is, @child_path
-points to a path in the child model. The rerturned path will point to the
-same row in the filtered model. If @child_path isn't a valid path on the
-child model or points to a row which is not visible in @filter, then %NULL
-is returned.
-
-Since: 2.4
+Draws an option menu tab (i.e. the up and down pointing arrows)
+in the given rectangle on @window using the given parameters.
</description>
<parameters>
-<parameter name="filter">
-<parameter_description> A #GtkTreeModelFilter.
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-<parameter name="child_path">
-<parameter_description> A #GtkTreePath to convert.
+<parameter name="window">
+<parameter_description> a #GdkWindow
+</parameter_description>
+</parameter>
+<parameter name="state_type">
+<parameter_description> a state
+</parameter_description>
+</parameter>
+<parameter name="shadow_type">
+<parameter_description> the type of shadow to draw
+</parameter_description>
+</parameter>
+<parameter name="area">
+<parameter_description> clip rectangle, or %NULL if the
+output should not be clipped
+</parameter_description>
+</parameter>
+<parameter name="widget">
+<parameter_description> the widget
+</parameter_description>
+</parameter>
+<parameter name="detail">
+<parameter_description> a style detail
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> x origin of the rectangle to draw the tab in
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y origin of the rectangle to draw the tab in
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> the width of the rectangle to draw the tab in
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the height of the rectangle to draw the tab in
</parameter_description>
</parameter>
</parameters>
-<return> A newly allocated #GtkTreePath, or %NULL.
-
-</return>
+<return></return>
</function>
-<function name="gtk_toolbar_append_item">
+<function name="gtk_paint_vline">
<description>
-Inserts a new item into the toolbar. You must specify the position
-in the toolbar where it will be inserted.
-
- callback must be a pointer to a function taking a #GtkWidget and a gpointer as
-arguments. Use G_CALLBACK() to cast the function to #GCallback.
-
-Deprecated: 2.4: Use gtk_toolbar_insert() instead.
+Draws a vertical line from (@x, @y1_) to (@x, @y2_) in @window
+using the given style and state.
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar.
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> give your toolbar button a label.
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="tooltip_text">
-<parameter_description> a string that appears when the user holds the mouse over this item.
+<parameter name="state_type">
+<parameter_description> a state
</parameter_description>
</parameter>
-<parameter name="tooltip_private_text">
-<parameter_description> use with #GtkTipsQuery.
+<parameter name="area">
+<parameter_description> rectangle to which the output is clipped, or %NULL if the
+output should not be clipped
</parameter_description>
</parameter>
-<parameter name="icon">
-<parameter_description> a #GtkWidget that should be used as the button's icon.
+<parameter name="widget">
+<parameter_description> the widget
</parameter_description>
</parameter>
-<parameter name="callback">
-<parameter_description> the function to be executed when the button is pressed.
+<parameter name="detail">
+<parameter_description> a style detail
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> a pointer to any data you wish to be passed to the callback.
+<parameter name="y1_">
+<parameter_description> the starting y coordinate
+</parameter_description>
+</parameter>
+<parameter name="y2_">
+<parameter_description> the ending y coordinate
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> the x coordinate
</parameter_description>
</parameter>
</parameters>
-<return> the new toolbar item as a #GtkWidget.
-
-</return>
+<return></return>
</function>
-<function name="gtk_tool_shell_get_orientation">
+<function name="gtk_paned_get_child1">
<description>
-Retrieves the current orientation for the tool shell. Tool items must not
-call this function directly, but rely on gtk_tool_item_get_orientation()
-instead.
+Obtains the first child of the paned widget.
-Since: 2.14
+Since: 2.4
</description>
<parameters>
-<parameter name="shell">
-<parameter_description> a #GtkToolShell
+<parameter name="paned">
+<parameter_description> a #GtkPaned widget
</parameter_description>
</parameter>
</parameters>
-<return> the current orientation of @shell
+<return> first child, or %NULL if it is not set.
</return>
</function>
-<function name="gtk_text_mark_get_buffer">
+<function name="gtk_paned_get_child2">
<description>
-Gets the buffer this mark is located inside,
-or %NULL if the mark is deleted.
+Obtains the second child of the paned widget.
+Since: 2.4
</description>
<parameters>
-<parameter name="mark">
-<parameter_description> a #GtkTextMark
+<parameter name="paned">
+<parameter_description> a #GtkPaned widget
</parameter_description>
</parameter>
</parameters>
-<return> the mark's #GtkTextBuffer
+<return> second child, or %NULL if it is not set.
+
</return>
</function>
-<function name="gtk_button_set_image">
+<function name="gtk_paned_get_handle_window">
<description>
-Set the image of @button to the given widget. Note that
-it depends on the #GtkSettings:gtk-button-images setting whether the
-image will be displayed or not, you don't have to call
-gtk_widget_show() on @image yourself.
+Returns the #GdkWindow of the handle. This function is
+useful when handling button or motion events because it
+enables the callback to distinguish between the window
+of the paned, a child and the handle.
-Since: 2.6
+Since: 2.20
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkButton
-</parameter_description>
-</parameter>
-<parameter name="image">
-<parameter_description> a widget to set as the image for the button
+<parameter name="panede">
+<parameter_description> a #GtkPaned
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the paned's handle window.
+
+</return>
</function>
-<function name="gtk_text_layout_get_cursor_visible">
+<function name="gtk_paned_get_position">
<description>
-Returns whether the insertion cursor will be shown.
+Obtains the position of the divider between the two panes.
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #GtkTextLayout
+<parameter name="paned">
+<parameter_description> a #GtkPaned widget
</parameter_description>
</parameter>
</parameters>
-<return> if %FALSE, the insertion cursor will not be
-shown, even if the text is editable.
+<return> position of the divider
</return>
</function>
-<function name="gtk_status_icon_get_gicon">
+<function name="gtk_paned_new">
<description>
-Retrieves the #GIcon being displayed by the #GtkStatusIcon.
-The storage type of the status icon must be %GTK_IMAGE_EMPTY or
-%GTK_IMAGE_GICON (see gtk_status_icon_get_storage_type()).
-The caller of this function does not own a reference to the
-returned #GIcon.
-
-If this function fails, @icon is left unchanged;
+Creates a new #GtkPaned widget.
-Since: 2.14
+Since: 2.16
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
+<parameter name="orientation">
+<parameter_description> the paned's orientation.
</parameter_description>
</parameter>
</parameters>
-<return> the displayed icon, or %NULL if the image is empty
+<return> a new #GtkPaned.
</return>
</function>
-<function name="gtk_rc_reparse_all">
+<function name="gtk_paned_set_position">
<description>
-If the modification time on any previously read file for the
-default #GtkSettings has changed, discard all style information
-and then reread all previously read RC files.
-
+Sets the position of the divider between the two panes.
</description>
<parameters>
+<parameter name="paned">
+<parameter_description> a #GtkPaned widget
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> pixel position of divider, a negative value means that the position
+is unset.
+</parameter_description>
+</parameter>
</parameters>
-<return> %TRUE if the files were reread.
-</return>
+<return></return>
</function>
-<function name="gtk_text_buffer_end_user_action">
+<function name="gtk_paper_size_copy">
<description>
-Should be paired with a call to gtk_text_buffer_begin_user_action().
-See that function for a full explanation.
+Copies an existing #GtkPaperSize.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="other">
+<parameter_description> a #GtkPaperSize
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a copy of @other
+
+</return>
</function>
-<function name="gtk_text_buffer_insert_child_anchor">
+<function name="gtk_paper_size_free">
<description>
-Inserts a child widget anchor into the text buffer at @iter. The
-anchor will be counted as one character in character counts, and
-when obtaining the buffer contents as a string, will be represented
-by the Unicode "object replacement character" 0xFFFC. Note that the
-"slice" variants for obtaining portions of the buffer as a string
-include this character for child anchors, but the "text" variants do
-not. E.g. see gtk_text_buffer_get_slice() and
-gtk_text_buffer_get_text(). Consider
-gtk_text_buffer_create_child_anchor() as a more convenient
-alternative to this function. The buffer will add a reference to
-the anchor, so you can unref it after insertion.
+Free the given #GtkPaperSize object.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> location to insert the anchor
-</parameter_description>
-</parameter>
-<parameter name="anchor">
-<parameter_description> a #GtkTextChildAnchor
+<parameter name="size">
+<parameter_description> a #GtkPaperSize
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_model_row_changed">
+<function name="gtk_paper_size_get_default">
<description>
-Emits the "row-changed" signal on @tree_model.
+Returns the name of the default paper size, which
+depends on the current locale.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="tree_model">
-<parameter_description> A #GtkTreeModel
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> A #GtkTreePath pointing to the changed row
+</parameters>
+<return> the name of the default paper size. The string
+is owned by GTK+ and should not be modified.
+
+</return>
+</function>
+
+<function name="gtk_paper_size_get_default_bottom_margin">
+<description>
+Gets the default bottom margin for the #GtkPaperSize.
+
+Since: 2.10
+
+</description>
+<parameters>
+<parameter name="size">
+<parameter_description> a #GtkPaperSize object
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> A valid #GtkTreeIter pointing to the changed row
+<parameter name="unit">
+<parameter_description> the unit for the return value
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the default bottom margin
+
+</return>
</function>
-<function name="gtk_im_multicontext_get_context_id">
+<function name="gtk_paper_size_get_default_left_margin">
<description>
-Gets the id of the currently active slave of the @context.
+Gets the default left margin for the #GtkPaperSize.
-Since: 2.16
+Since: 2.10
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GtkIMMulticontext
+<parameter name="size">
+<parameter_description> a #GtkPaperSize object
+</parameter_description>
+</parameter>
+<parameter name="unit">
+<parameter_description> the unit for the return value
</parameter_description>
</parameter>
</parameters>
-<return> the id of the currently active slave
+<return> the default left margin
</return>
</function>
-<function name="gtk_style_get_style_property">
+<function name="gtk_paper_size_get_default_right_margin">
<description>
-Queries the value of a style property corresponding to a
-widget class is in the given style.
+Gets the default right margin for the #GtkPaperSize.
-Since: 2.16
+Since: 2.10
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
+<parameter name="size">
+<parameter_description> a #GtkPaperSize object
</parameter_description>
</parameter>
-<parameter name="widget_type">
-<parameter_description> the #GType of a descendant of #GtkWidget
+<parameter name="unit">
+<parameter_description> the unit for the return value
</parameter_description>
</parameter>
-<parameter name="property_name">
-<parameter_description> the name of the style property to get
+</parameters>
+<return> the default right margin
+
+</return>
+</function>
+
+<function name="gtk_paper_size_get_default_top_margin">
+<description>
+Gets the default top margin for the #GtkPaperSize.
+
+Since: 2.10
+
+</description>
+<parameters>
+<parameter name="size">
+<parameter_description> a #GtkPaperSize object
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> a #GValue where the value of the property being
-queried will be stored
+<parameter name="unit">
+<parameter_description> the unit for the return value
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the default top margin
+
+</return>
</function>
-<function name="gtk_info_bar_new_with_buttons">
+<function name="gtk_paper_size_get_display_name">
<description>
-Creates a new #GtkInfoBar with buttons. Button text/response ID
-pairs should be listed, with a %NULL pointer ending the list.
-Button text can be either a stock ID such as %GTK_STOCK_OK, or
-some arbitrary text. A response ID can be any positive number,
-or one of the values in the #GtkResponseType enumeration. If the
-user clicks one of these dialog buttons, GtkInfoBar will emit
-the "response" signal with the corresponding response ID.
+Gets the human-readable name of the #GtkPaperSize.
+Since: 2.10
</description>
<parameters>
-<parameter name="first_button_text">
-<parameter_description> stock ID or text to go in first button, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="Varargs">
-<parameter_description> response ID for first button, then additional buttons, ending
-with %NULL
+<parameter name="size">
+<parameter_description> a #GtkPaperSize object
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkInfoBar
+<return> the human-readable name of @size
+
</return>
</function>
-<function name="gtk_tree_drag_source_drag_data_delete">
+<function name="gtk_paper_size_get_height">
<description>
-Asks the #GtkTreeDragSource to delete the row at @path, because
-it was moved somewhere else via drag-and-drop. Returns %FALSE
-if the deletion fails because @path no longer exists, or for
-some model-specific reason. Should robustly handle a @path no
-longer found in the model!
+Gets the paper height of the #GtkPaperSize, in
+units of @unit.
+Since: 2.10
</description>
<parameters>
-<parameter name="drag_source">
-<parameter_description> a #GtkTreeDragSource
+<parameter name="size">
+<parameter_description> a #GtkPaperSize object
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> row that was being dragged
+<parameter name="unit">
+<parameter_description> the unit for the return value
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the row was successfully deleted
+<return> the paper height
+
</return>
</function>
-<function name="gtk_tool_item_get_relief_style">
+<function name="gtk_paper_size_get_name">
<description>
-Returns the relief style of @tool_item. See gtk_button_set_relief_style().
-Custom subclasses of #GtkToolItem should call this function in the handler
-of the #GtkToolItem::toolbar_reconfigured signal to find out the
-relief style of buttons.
+Gets the name of the #GtkPaperSize.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem
+<parameter name="size">
+<parameter_description> a #GtkPaperSize object
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkReliefStyle indicating the relief style used
-for @tool_item.
+<return> the name of @size
</return>
</function>
-<function name="gtk_text_iter_backward_word_starts">
+<function name="gtk_paper_size_get_paper_sizes">
<description>
-Calls gtk_text_iter_backward_word_start() up to @count times.
+Creates a list of known paper sizes.
+Since: 2.12
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
-</parameter_description>
-</parameter>
-<parameter name="count">
-<parameter_description> number of times to move
+<parameter name="include_custom">
+<parameter_description> whether to include custom paper sizes
+as defined in the page setup dialog
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter moved and is not the end iterator
+<return> a newly allocated list of newly
+allocated #GtkPaperSize objects
+
</return>
</function>
-<function name="gtk_status_icon_get_pixbuf">
+<function name="gtk_paper_size_get_ppd_name">
<description>
-Gets the #GdkPixbuf being displayed by the #GtkStatusIcon.
-The storage type of the status icon must be %GTK_IMAGE_EMPTY or
-%GTK_IMAGE_PIXBUF (see gtk_status_icon_get_storage_type()).
-The caller of this function does not own a reference to the
-returned pixbuf.
+Gets the PPD name of the #GtkPaperSize, which
+may be %NULL.
Since: 2.10
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
+<parameter name="size">
+<parameter_description> a #GtkPaperSize object
</parameter_description>
</parameter>
</parameters>
-<return> the displayed pixbuf, or %NULL if the image is empty.
+<return> the PPD name of @size
</return>
</function>
-<function name="gtk_tool_button_get_icon_name">
+<function name="gtk_paper_size_get_width">
<description>
-Returns the name of the themed icon for the tool button,
-see gtk_tool_button_set_icon_name().
+Gets the paper width of the #GtkPaperSize, in
+units of @unit.
-Since: 2.8
+Since: 2.10
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkToolButton
+<parameter name="size">
+<parameter_description> a #GtkPaperSize object
+</parameter_description>
+</parameter>
+<parameter name="unit">
+<parameter_description> the unit for the return value
</parameter_description>
</parameter>
</parameters>
-<return> the icon name or %NULL if the tool button has
-no themed icon
+<return> the paper width
</return>
</function>
-<function name="gtk_stock_item_copy">
+<function name="gtk_paper_size_is_custom">
<description>
-Copies a stock item, mostly useful for language bindings and not in applications.
+Returns %TRUE if @size is not a standard paper size.
</description>
<parameters>
-<parameter name="item">
-<parameter_description> a #GtkStockItem
+<parameter name="size">
+<parameter_description> a #GtkPaperSize object
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkStockItem
+<return> whether @size is a custom paper size.
</return>
</function>
-<function name="gtk_image_new_from_icon_name">
+<function name="gtk_paper_size_is_equal">
<description>
-Creates a #GtkImage displaying an icon from the current icon theme.
-If the icon name isn't known, a "broken image" icon will be
-displayed instead. If the current icon theme is changed, the icon
-will be updated appropriately.
+Compares two #GtkPaperSize objects.
-Since: 2.6
+Since: 2.10
</description>
<parameters>
-<parameter name="icon_name">
-<parameter_description> an icon name
+<parameter name="size1">
+<parameter_description> a #GtkPaperSize object
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> a stock icon size
+<parameter name="size2">
+<parameter_description> another #GtkPaperSize object
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkImage displaying the themed icon
+<return> %TRUE, if @size1 and @size2
+represent the same paper size
</return>
</function>
-<function name="gtk_rc_set_default_files">
+<function name="gtk_paper_size_new">
<description>
-Sets the list of files that GTK+ will read at the
-end of gtk_init().
+Creates a new #GtkPaperSize object by parsing a
+<ulink url="ftp://ftp.pwg.org/pub/pwg/candidates/cs-pwgmsn10-20020226-5101.1.pdf">PWG 5101.1-2002</ulink>
+paper name.
+
+If @name is %NULL, the default paper size is returned,
+see gtk_paper_size_get_default().
+
+Since: 2.10
</description>
<parameters>
-<parameter name="filenames">
-<parameter_description> A %NULL-terminated list of filenames.
+<parameter name="name">
+<parameter_description> a paper size name, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GtkPaperSize, use gtk_paper_size_free()
+to free it
+
+</return>
</function>
-<function name="gtk_text_buffer_insert_interactive">
+<function name="gtk_paper_size_new_custom">
<description>
-Like gtk_text_buffer_insert(), but the insertion will not occur if
- iter is at a non-editable location in the buffer. Usually you
-want to prevent insertions at ineditable locations if the insertion
-results from a user action (is interactive).
-
- default_editable indicates the editability of text that doesn't
-have a tag affecting editability applied to it. Typically the
-result of gtk_text_view_get_editable() is appropriate here.
+Creates a new #GtkPaperSize object with the
+given parameters.
+Since: 2.10
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="name">
+<parameter_description> the paper name
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> a position in @buffer
+<parameter name="display_name">
+<parameter_description> the human-readable name
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> some UTF-8 text
+<parameter name="width">
+<parameter_description> the paper width, in units of @unit
</parameter_description>
</parameter>
-<parameter name="len">
-<parameter_description> length of text in bytes, or -1
+<parameter name="height">
+<parameter_description> the paper height, in units of @unit
</parameter_description>
</parameter>
-<parameter name="default_editable">
-<parameter_description> default editability of buffer
+<parameter name="unit">
+<parameter_description> the unit for @width and @height
</parameter_description>
</parameter>
</parameters>
-<return> whether text was actually inserted
+<return> a new #GtkPaperSize object, use gtk_paper_size_free()
+to free it
+
</return>
</function>
-<function name="gtk_tree_path_next">
+<function name="gtk_paper_size_new_from_key_file">
<description>
-Moves the @path to point to the next node at the current depth.
+Reads a paper size from the group @group_name in the key file
+ key_file
+
+Since: 2.12
</description>
<parameters>
-<parameter name="path">
-<parameter_description> A #GtkTreePath.
+<parameter name="key_file">
+<parameter_description> the #GKeyFile to retrieve the papersize from
+</parameter_description>
+</parameter>
+<parameter name="group_name">
+<parameter_description> the name ofthe group in the key file to read,
+or %NULL to read the first group
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for an error, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GtkPaperSize object with the restored
+paper size, or %NULL if an error occurred.
+
+</return>
</function>
-<function name="gtk_print_settings_get_page_ranges">
+<function name="gtk_paper_size_new_from_ppd">
<description>
-Gets the value of %GTK_PRINT_SETTINGS_PAGE_RANGES.
+Creates a new #GtkPaperSize object by using
+PPD information.
+
+If @ppd_name is not a recognized PPD paper name,
+ ppd_display_name, @width and @height are used to
+construct a custom #GtkPaperSize object.
Since: 2.10
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="ppd_name">
+<parameter_description> a PPD paper name
</parameter_description>
</parameter>
-<parameter name="num_ranges">
-<parameter_description> return location for the length of the returned array
+<parameter name="ppd_display_name">
+<parameter_description> the corresponding human-readable name
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> the paper width, in points
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the paper height in points
</parameter_description>
</parameter>
</parameters>
-<return> an array of #GtkPageRange<!-- -->s. Use g_free()
-to free the array when it is no longer needed.
+<return> a new #GtkPaperSize, use gtk_paper_size_free()
+to free it
</return>
</function>
-<function name="gtk_accel_map_save">
+<function name="gtk_paper_size_set_size">
<description>
-Saves current accelerator specifications (accelerator path, key
-and modifiers) to @file_name.
-The file is written in a format suitable to be read back in by
-gtk_accel_map_load().
+Changes the dimensions of a @size to @width x @height.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="file_name">
-<parameter_description> the name of the file to contain accelerator specifications,
-in the GLib file name encoding
+<parameter name="size">
+<parameter_description> a custom #GtkPaperSize object
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> the new width in units of @unit
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the new height in units of @unit
+</parameter_description>
+</parameter>
+<parameter name="unit">
+<parameter_description> the unit for @width and @height
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tool_item_get_is_important">
+<function name="gtk_paper_size_to_key_file">
<description>
-Returns whether @tool_item is considered important. See
-gtk_tool_item_set_is_important()
+This function adds the paper size from @size to @key_file.
-Since: 2.4
+Since: 2.12
</description>
<parameters>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem
+<parameter name="size">
+<parameter_description> a #GtkPaperSize
+</parameter_description>
+</parameter>
+<parameter name="key_file">
+<parameter_description> the #GKeyFile to save the paper size to
+</parameter_description>
+</parameter>
+<parameter name="group_name">
+<parameter_description> the group to add the settings to in @key_file
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @tool_item is considered important.
+<return></return>
+</function>
+
+<function name="gtk_parse_args">
+<description>
+Parses command line arguments, and initializes global
+attributes of GTK+, but does not actually open a connection
+to a display. (See gdk_display_open(), gdk_get_display_arg_name())
+
+Any arguments used by GTK+ or GDK are removed from the array and
+ argc and @argv are updated accordingly.
+
+There is no need to call this function explicitely if you are using
+gtk_init(), or gtk_init_check().
+
+</description>
+<parameters>
+<parameter name="argc">
+<parameter_description> a pointer to the number of command line arguments
+</parameter_description>
+</parameter>
+<parameter name="argv">
+<parameter_description> a pointer to the array of command line arguments
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if initialization succeeded, otherwise %FALSE.
</return>
</function>
-<function name="gtk_icon_factory_add_default">
+<function name="gtk_pixmap_new">
<description>
-Adds an icon factory to the list of icon factories searched by
-gtk_style_lookup_icon_set(). This means that, for example,
-gtk_image_new_from_stock() will be able to find icons in @factory.
-There will normally be an icon factory added for each library or
-application that comes with icons. The default icon factories
-can be overridden by themes.
</description>
<parameters>
-<parameter name="factory">
-<parameter_description> a #GtkIconFactory
+<parameter name="mask">
+<parameter_description>
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_label_get_label">
+<function name="gtk_plug_construct">
<description>
-Fetches the text from a label widget including any embedded
-underlines indicating mnemonics and Pango markup. (See
-gtk_label_get_text()).
-
+Finish the initialization of @plug for a given #GtkSocket identified by
+ socket_id This function will generally only be used by classes deriving from #GtkPlug.
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="plug">
+<parameter_description> a #GtkPlug.
+</parameter_description>
+</parameter>
+<parameter name="socket_id">
+<parameter_description> the XID of the socket's window.
</parameter_description>
</parameter>
</parameters>
-<return> the text of the label widget. This string is
-owned by the widget and must not be modified or freed.
-</return>
+<return></return>
</function>
-<function name="gtk_recent_action_set_show_numbers">
+<function name="gtk_plug_construct_for_display">
<description>
-Sets whether a number should be added to the items shown by the
-widgets representing @action. The numbers are shown to provide
-a unique character for a mnemonic to be used inside the menu item's
-label. Only the first ten items get a number to avoid clashes.
+Finish the initialization of @plug for a given #GtkSocket identified by
+ socket_id which is currently displayed on @display.
+This function will generally only be used by classes deriving from #GtkPlug.
-Since: 2.12
+Since: 2.2
</description>
<parameters>
-<parameter name="action">
-<parameter_description> a #GtkRecentAction
+<parameter name="plug">
+<parameter_description> a #GtkPlug.
</parameter_description>
</parameter>
-<parameter name="show_numbers">
-<parameter_description> %TRUE if the shown items should be numbered
+<parameter name="display">
+<parameter_description> the #GdkDisplay associated with @socket_id's
+#GtkSocket.
+</parameter_description>
+</parameter>
+<parameter name="socket_id">
+<parameter_description> the XID of the socket's window.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_notebook_get_nth_page">
+<function name="gtk_plug_get_embedded">
<description>
-Returns the child widget contained in page number @page_num.
+Determines whether the plug is embedded in a socket.
+Since: 2.14
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="plug">
+<parameter_description> a #GtkPlug
</parameter_description>
</parameter>
-<parameter name="page_num">
-<parameter_description> the index of a page in the notebook, or -1
-to get the last page.
+</parameters>
+<return> %TRUE if the plug is embedded in a socket
+
+</return>
+</function>
+
+<function name="gtk_plug_get_id">
+<description>
+Gets the window ID of a #GtkPlug widget, which can then
+be used to embed this window inside another window, for
+instance with gtk_socket_add_id().
+
+
+</description>
+<parameters>
+<parameter name="plug">
+<parameter_description> a #GtkPlug.
</parameter_description>
</parameter>
</parameters>
-<return> the child widget, or %NULL if @page_num is
-out of bounds.
+<return> the window ID for the plug
</return>
</function>
-<function name="gtk_text_view_get_right_margin">
+<function name="gtk_plug_get_socket_window">
<description>
-Gets the default right margin for text in @text_view. Tags
-in the buffer may override the default.
+Retrieves the socket the plug is embedded in.
+Since: 2.14
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="plug">
+<parameter_description> a #GtkPlug
</parameter_description>
</parameter>
</parameters>
-<return> right margin in pixels
+<return> the window of the socket, or %NULL
+
</return>
</function>
-<function name="gtk_file_chooser_set_do_overwrite_confirmation">
+<function name="gtk_plug_new">
<description>
-Sets whether a file chooser in %GTK_FILE_CHOOSER_ACTION_SAVE mode will present
-a confirmation dialog if the user types a file name that already exists. This
-is %FALSE by default.
+Creates a new plug widget inside the #GtkSocket identified
+by @socket_id. If @socket_id is 0, the plug is left "unplugged" and
+can later be plugged into a #GtkSocket by gtk_socket_add_id().
-Regardless of this setting, the @chooser will emit the
-#GtkFileChooser::confirm-overwrite signal when appropriate.
-If all you need is the stock confirmation dialog, set this property to %TRUE.
-You can override the way confirmation is done by actually handling the
-#GtkFileChooser::confirm-overwrite signal; please refer to its documentation
-for the details.
+</description>
+<parameters>
+<parameter name="socket_id">
+<parameter_description> the window ID of the socket, or 0.
+</parameter_description>
+</parameter>
+</parameters>
+<return> the new #GtkPlug widget.
+</return>
+</function>
-Since: 2.8
+<function name="gtk_plug_new_for_display">
+<description>
+Create a new plug widget inside the #GtkSocket identified by socket_id.
+
+Since: 2.2
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="display">
+<parameter_description> the #GdkDisplay on which @socket_id is displayed
</parameter_description>
</parameter>
-<parameter name="do_overwrite_confirmation">
-<parameter_description> whether to confirm overwriting in save mode
+<parameter name="socket_id">
+<parameter_description> the XID of the socket's window.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the new #GtkPlug widget.
+
+</return>
</function>
-<function name="gtk_print_settings_set_print_pages">
+<function name="gtk_print_backend_get_printer_list">
<description>
-Sets the value of %GTK_PRINT_SETTINGS_PRINT_PAGES.
+
+</description>
+<parameters>
+</parameters>
+<return>
+</return>
+</function>
+
+<function name="gtk_print_context_create_pango_context">
+<description>
+Creates a new #PangoContext that can be used with the
+#GtkPrintContext.
Since: 2.10
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
-</parameter_description>
-</parameter>
-<parameter name="pages">
-<parameter_description> a #GtkPrintPages value
+<parameter name="context">
+<parameter_description> a #GtkPrintContext
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new Pango context for @context
+
+</return>
</function>
-<function name="gtk_tree_selection_unselect_path">
+<function name="gtk_print_context_create_pango_layout">
<description>
-Unselects the row at @path.
+Creates a new #PangoLayout that is suitable for use
+with the #GtkPrintContext.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="selection">
-<parameter_description> A #GtkTreeSelection.
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> The #GtkTreePath to be unselected.
+<parameter name="context">
+<parameter_description> a #GtkPrintContext
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new Pango layout for @context
+
+</return>
</function>
-<function name="gtk_widget_modify_style">
+<function name="gtk_print_context_get_cairo_context">
<description>
-Modifies style values on the widget. Modifications made using this
-technique take precedence over style values set via an RC file,
-however, they will be overriden if a style is explicitely set on
-the widget using gtk_widget_set_style(). The #GtkRcStyle structure
-is designed so each field can either be set or unset, so it is
-possible, using this function, to modify some style values and
-leave the others unchanged.
+Obtains the cairo context that is associated with the
+#GtkPrintContext.
-Note that modifications made with this function are not cumulative
-with previous calls to gtk_widget_modify_style() or with such
-functions as gtk_widget_modify_fg(). If you wish to retain
-previous values, you must first call gtk_widget_get_modifier_style(),
-make your modifications to the returned style, then call
-gtk_widget_modify_style() with that style. On the other hand,
-if you first call gtk_widget_modify_style(), subsequent calls
-to such functions gtk_widget_modify_fg() will have a cumulative
-effect with the initial modifications.
+Since: 2.10
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="context">
+<parameter_description> a #GtkPrintContext
</parameter_description>
</parameter>
-<parameter name="style">
-<parameter_description> the #GtkRcStyle holding the style modifications
+</parameters>
+<return> the cairo context of @context
+
+</return>
+</function>
+
+<function name="gtk_print_context_get_dpi_x">
+<description>
+Obtains the horizontal resolution of the #GtkPrintContext,
+in dots per inch.
+
+Since: 2.10
+
+</description>
+<parameters>
+<parameter name="context">
+<parameter_description> a #GtkPrintContext
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the horizontal resolution of @context
+
+</return>
</function>
-<function name="gtk_notebook_new">
+<function name="gtk_print_context_get_dpi_y">
<description>
-Creates a new #GtkNotebook widget with no pages.
+Obtains the vertical resolution of the #GtkPrintContext,
+in dots per inch.
+Since: 2.10
</description>
<parameters>
+<parameter name="context">
+<parameter_description> a #GtkPrintContext
+</parameter_description>
+</parameter>
</parameters>
-<return> the newly created #GtkNotebook
+<return> the vertical resolution of @context
+
</return>
</function>
-<function name="gtk_tree_view_set_cursor">
+<function name="gtk_print_context_get_hard_margins">
<description>
-Sets the current keyboard focus to be at @path, and selects it. This is
-useful when you want to focus the user's attention on a particular row. If
- focus_column is not %NULL, then focus is given to the column specified by
-it. Additionally, if @focus_column is specified, and @start_editing is
-%TRUE, then editing should be started in the specified cell.
-This function is often followed by @gtk_widget_grab_focus (@tree_view)
-in order to give keyboard focus to the widget. Please note that editing
-can only happen when the widget is realized.
+Obtains the hardware printer margins of the #GtkPrintContext, in units.
-If @path is invalid for @model, the current cursor (if any) will be unset
-and the function will return without failing.
+Since: 2.20
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView
+<parameter name="context">
+<parameter_description> a #GtkPrintContext
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> A #GtkTreePath
+<parameter name="top">
+<parameter_description> top hardware printer margin
</parameter_description>
</parameter>
-<parameter name="focus_column">
-<parameter_description> A #GtkTreeViewColumn, or %NULL
+<parameter name="bottom">
+<parameter_description> bottom hardware printer margin
</parameter_description>
</parameter>
-<parameter name="start_editing">
-<parameter_description> %TRUE if the specified cell should start being edited.
+<parameter name="left">
+<parameter_description> left hardware printer margin
+</parameter_description>
+</parameter>
+<parameter name="right">
+<parameter_description> right hardware printer margin
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the hard margins were retrieved
+
+</return>
</function>
-<function name="gtk_invisible_set_screen">
+<function name="gtk_print_context_get_height">
<description>
-Sets the #GdkScreen where the #GtkInvisible object will be displayed.
+Obtains the height of the #GtkPrintContext, in pixels.
-Since: 2.2
+Since: 2.10
</description>
<parameters>
-<parameter name="invisible">
-<parameter_description> a #GtkInvisible.
+<parameter name="context">
+<parameter_description> a #GtkPrintContext
</parameter_description>
</parameter>
-<parameter name="screen">
-<parameter_description> a #GdkScreen.
+</parameters>
+<return> the height of @context
+
+</return>
+</function>
+
+<function name="gtk_print_context_get_page_setup">
+<description>
+Obtains the #GtkPageSetup that determines the page
+dimensions of the #GtkPrintContext.
+
+Since: 2.10
+
+</description>
+<parameters>
+<parameter name="context">
+<parameter_description> a #GtkPrintContext
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the page setup of @context
+
+</return>
</function>
-<function name="gtk_check_menu_item_set_draw_as_radio">
+<function name="gtk_print_context_get_pango_fontmap">
<description>
-Sets whether @check_menu_item is drawn like a #GtkRadioMenuItem
+Returns a #PangoFontMap that is suitable for use
+with the #GtkPrintContext.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="check_menu_item">
-<parameter_description> a #GtkCheckMenuItem
+<parameter name="context">
+<parameter_description> a #GtkPrintContext
</parameter_description>
</parameter>
-<parameter name="draw_as_radio">
-<parameter_description> whether @check_menu_item is drawn like a #GtkRadioMenuItem
+</parameters>
+<return> the font map of @context
+
+</return>
+</function>
+
+<function name="gtk_print_context_get_width">
+<description>
+Obtains the width of the #GtkPrintContext, in pixels.
+
+Since: 2.10
+
+</description>
+<parameters>
+<parameter name="context">
+<parameter_description> a #GtkPrintContext
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the width of @context
+
+</return>
</function>
-<function name="gtk_cell_layout_set_attributes">
+<function name="gtk_print_context_set_cairo_context">
<description>
-Sets the attributes in list as the attributes of @cell_layout. The
-attributes should be in attribute/column order, as in
-gtk_cell_layout_add_attribute(). All existing attributes are removed, and
-replaced with the new attributes.
+Sets a new cairo context on a print context.
-Since: 2.4
+This function is intended to be used when implementing
+an internal print preview, it is not needed for printing,
+since GTK+ itself creates a suitable cairo context in that
+case.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="cell_layout">
-<parameter_description> A #GtkCellLayout.
+<parameter name="context">
+<parameter_description> a #GtkPrintContext
</parameter_description>
</parameter>
-<parameter name="cell">
-<parameter_description> A #GtkCellRenderer.
+<parameter name="cr">
+<parameter_description> the cairo context
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> A %NULL-terminated list of attributes.
+<parameter name="dpi_x">
+<parameter_description> the horizontal resolution to use with @cr
+</parameter_description>
+</parameter>
+<parameter name="dpi_y">
+<parameter_description> the vertical resolution to use with @cr
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_translate_coordinates">
+<function name="gtk_print_context_set_hard_margins">
<description>
-Translate coordinates relative to @src_widget's allocation to coordinates
-relative to @dest_widget's allocations. In order to perform this
-operation, both widgets must be realized, and must share a common
-toplevel.
-
+set the hard margins in pixel coordinates
</description>
<parameters>
-<parameter name="src_widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="dest_widget">
-<parameter_description> a #GtkWidget
+<parameter name="context">
+<parameter_description> a #GtkPrintContext
</parameter_description>
</parameter>
-<parameter name="src_x">
-<parameter_description> X position relative to @src_widget
+<parameter name="top">
+<parameter_description> top hardware printer margin
</parameter_description>
</parameter>
-<parameter name="src_y">
-<parameter_description> Y position relative to @src_widget
+<parameter name="bottom">
+<parameter_description> bottom hardware printer margin
</parameter_description>
</parameter>
-<parameter name="dest_x">
-<parameter_description> location to store X position relative to @dest_widget
+<parameter name="left">
+<parameter_description> left hardware printer margin
</parameter_description>
</parameter>
-<parameter name="dest_y">
-<parameter_description> location to store Y position relative to @dest_widget
+<parameter name="right">
+<parameter_description> right hardware printer margin
</parameter_description>
</parameter>
</parameters>
-<return> %FALSE if either widget was not realized, or there
-was no common ancestor. In this case, nothing is stored in
-* dest_x and * dest_y Otherwise %TRUE.
-</return>
+<return></return>
</function>
-<function name="gtk_text_buffer_get_line_count">
+<function name="gtk_print_error_quark">
<description>
-Obtains the number of lines in the buffer. This value is cached, so
-the function is very fast.
+Registers an error quark for #GtkPrintOperation if necessary.
+Since: 2.10
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
</parameters>
-<return> number of lines in the buffer
+<return> The error quark used for #GtkPrintOperation errors.
+
</return>
</function>
-<function name="gtk_file_chooser_set_filename">
+<function name="gtk_print_job_get_printer">
<description>
-Sets @filename as the current filename for the file chooser, by changing
-to the file's parent folder and actually selecting the file in list. If
-the @chooser is in %GTK_FILE_CHOOSER_ACTION_SAVE mode, the file's base name
-will also appear in the dialog's file name entry.
-
-If the file name isn't in the current folder of @chooser, then the current
-folder of @chooser will be changed to the folder containing @filename. This
-is equivalent to a sequence of gtk_file_chooser_unselect_all() followed by
-gtk_file_chooser_select_filename().
-
-Note that the file must exist, or nothing will be done except
-for the directory change.
-
-If you are implementing a <guimenuitem>File/Save As...</guimenuitem> dialog,
-you should use this function if you already have a file name to which the
-user may save; for example, when the user opens an existing file and then
-does <guimenuitem>File/Save As...</guimenuitem> on it. If you don't have
-a file name already — for example, if the user just created a new
-file and is saving it for the first time, do not call this function.
-Instead, use something similar to this:
-|[
-if (document_is_new)
-{
-/ * the user just created a new document * /
-gtk_file_chooser_set_current_folder (chooser, default_folder_for_saving);
-gtk_file_chooser_set_current_name (chooser, "Untitled document");
-}
-else
-{
-/ * the user edited an existing document * /
-gtk_file_chooser_set_filename (chooser, existing_filename);
-}
-]|
+Gets the #GtkPrinter of the print job.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
-</parameter_description>
-</parameter>
-<parameter name="filename">
-<parameter_description> the filename to set as current
+<parameter name="job">
+<parameter_description> a #GtkPrintJob
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if both the folder could be changed and the file was
-selected successfully, %FALSE otherwise.
+<return> the printer of @job
</return>
</function>
-<function name="gtk_text_iter_forward_chars">
+<function name="gtk_print_job_get_settings">
<description>
-Moves @count characters if possible (if @count would move past the
-start or end of the buffer, moves to the start or end of the
-buffer). The return value indicates whether the new position of
- iter is different from its original position, and dereferenceable
-(the last iterator in the buffer is not dereferenceable). If @count
-is 0, the function does nothing and returns %FALSE.
+Gets the #GtkPrintSettings of the print job.
+Since: 2.10
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
-</parameter_description>
-</parameter>
-<parameter name="count">
-<parameter_description> number of characters to move, may be negative
+<parameter name="job">
+<parameter_description> a #GtkPrintJob
</parameter_description>
</parameter>
</parameters>
-<return> whether @iter moved and is dereferenceable
+<return> the settings of @job
+
</return>
</function>
-<function name="gtk_widget_is_composited">
+<function name="gtk_print_job_get_status">
<description>
-Whether @widget can rely on having its alpha channel
-drawn correctly. On X11 this function returns whether a
-compositing manager is running for @widget's screen.
-
-Please note that the semantics of this call will change
-in the future if used on a widget that has a composited
-window in its hierarchy (as set by gdk_window_set_composited()).
+Gets the status of the print job.
Since: 2.10
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="job">
+<parameter_description> a #GtkPrintJob
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the widget can rely on its alpha
-channel being drawn correctly.
+<return> the status of @job
</return>
</function>
-<function name="gtk_label_set_width_chars">
+<function name="gtk_print_job_get_surface">
<description>
-Sets the desired width in characters of @label to @n_chars.
+Gets a cairo surface onto which the pages of
+the print job should be rendered.
-Since: 2.6
+Since: 2.10
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="job">
+<parameter_description> a #GtkPrintJob
</parameter_description>
</parameter>
-<parameter name="n_chars">
-<parameter_description> the new desired width, in characters.
+<parameter name="error">
+<parameter_description> return location for errors, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the cairo surface of @job
+
+</return>
</function>
-<function name="gtk_scale_button_get_plus_button">
+<function name="gtk_print_job_get_title">
<description>
-Retrieves the plus button of the #GtkScaleButton.
+Gets the job title.
-Since: 2.14
+Since: 2.10
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkScaleButton
+<parameter name="job">
+<parameter_description> a #GtkPrintJob
</parameter_description>
</parameter>
</parameters>
-<return> the plus button of the #GtkScaleButton.
+<return> the title of @job
</return>
</function>
-<function name="gtk_action_get_always_show_image">
+<function name="gtk_print_job_get_track_print_status">
<description>
-Returns whether @action<!-- -->'s menu item proxies will ignore the
-#GtkSettings:gtk-menu-images setting and always show their image,
-if available.
+Returns wheter jobs will be tracked after printing.
+For details, see gtk_print_job_set_track_print_status().
-Since: 2.20
+Since: 2.10
</description>
<parameters>
-<parameter name="action">
-<parameter_description> a #GtkAction
+<parameter name="job">
+<parameter_description> a #GtkPrintJob
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the menu item proxies will always show their image
+<return> %TRUE if print job status will be reported after printing
</return>
</function>
-<function name="gtk_printer_get_icon_name">
+<function name="gtk_print_job_new">
<description>
-Gets the name of the icon to use for the printer.
+Creates a new #GtkPrintJob.
Since: 2.10
</description>
<parameters>
+<parameter name="title">
+<parameter_description> the job title
+</parameter_description>
+</parameter>
<parameter name="printer">
<parameter_description> a #GtkPrinter
</parameter_description>
</parameter>
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
+</parameter_description>
+</parameter>
+<parameter name="page_setup">
+<parameter_description> a #GtkPageSetup
+</parameter_description>
+</parameter>
</parameters>
-<return> the icon name for @printer
+<return> a new #GtkPrintJob
</return>
</function>
-<function name="gtk_tree_view_set_destroy_count_func">
+<function name="gtk_print_job_send">
<description>
-This function should almost never be used. It is meant for private use by
-ATK for determining the number of visible children that are removed when the
-user collapses a row, or a row is deleted.
+Sends the print job off to the printer.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView
+<parameter name="job">
+<parameter_description> a GtkPrintJob
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> Function to be called when a view row is destroyed, or %NULL
+<parameter name="callback">
+<parameter_description> function to call when the job completes or an error occurs
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> User data to be passed to @func, or %NULL
+<parameter name="user_data">
+<parameter_description> user data that gets passed to @callback
</parameter_description>
</parameter>
-<parameter name="destroy">
-<parameter_description> Destroy notifier for @data, or %NULL
+<parameter name="dnotify">
+<parameter_description> destroy notify for @user_data
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_iter_has_tag">
+<function name="gtk_print_job_set_source_file">
<description>
-Returns %TRUE if @iter is within a range tagged with @tag.
+Make the #GtkPrintJob send an existing document to the
+printing system. The file can be in any format understood
+by the platforms printing system (typically PostScript,
+but on many platforms PDF may work too). See
+gtk_printer_accepts_pdf() and gtk_printer_accepts_ps().
+Since: 2.10
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
+<parameter name="job">
+<parameter_description> a #GtkPrintJob
</parameter_description>
</parameter>
-<parameter name="tag">
-<parameter_description> a #GtkTextTag
+<parameter name="filename">
+<parameter_description> the file to be printed
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for errors
</parameter_description>
</parameter>
</parameters>
-<return> whether @iter is tagged with @tag
+<return> %FALSE if an error occurred
+
</return>
</function>
-<function name="gtk_print_settings_set_double">
+<function name="gtk_print_job_set_track_print_status">
<description>
-Sets @key to a double value.
+If track_status is %TRUE, the print job will try to continue report
+on the status of the print job in the printer queues and printer. This
+can allow your application to show things like "out of paper" issues,
+and when the print job actually reaches the printer.
+
+This function is often implemented using some form of polling, so it should
+not be enabled unless needed.
Since: 2.10
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
+<parameter name="job">
+<parameter_description> a #GtkPrintJob
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> a double value
+<parameter name="track_status">
+<parameter_description> %TRUE to track status after printing
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_plug_construct_for_display">
+<function name="gtk_print_operation_cancel">
<description>
-Finish the initialization of @plug for a given #GtkSocket identified by
- socket_id which is currently displayed on @display.
-This function will generally only be used by classes deriving from #GtkPlug.
+Cancels a running print operation. This function may
+be called from a #GtkPrintOperation::begin-print,
+#GtkPrintOperation::paginate or #GtkPrintOperation::draw-page
+signal handler to stop the currently running print
+operation.
-Since: 2.2
+Since: 2.10
</description>
<parameters>
-<parameter name="plug">
-<parameter_description> a #GtkPlug.
-</parameter_description>
-</parameter>
-<parameter name="display">
-<parameter_description> the #GdkDisplay associated with @socket_id's
-#GtkSocket.
+<parameter name="op">
+<parameter_description> a #GtkPrintOperation
</parameter_description>
</parameter>
-<parameter name="socket_id">
-<parameter_description> the XID of the socket's window.
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_print_operation_draw_page_finish">
+<description>
+Signalize that drawing of particular page is complete.
+
+It is called after completion of page drawing (e.g. drawing in another
+thread).
+If gtk_print_operation_set_defer_drawing() was called before, then this function
+has to be called by application. In another case it is called by the library
+itself.
+
+Since: 2.16
+
+</description>
+<parameters>
+<parameter name="op">
+<parameter_description> a #GtkPrintOperation
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_view_get_selection_mode">
+<function name="gtk_print_operation_get_default_page_setup">
<description>
-Gets the selection mode of the @icon_view.
+Returns the default page setup, see
+gtk_print_operation_set_default_page_setup().
-Since: 2.6
+Since: 2.10
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> A #GtkIconView.
+<parameter name="op">
+<parameter_description> a #GtkPrintOperation
</parameter_description>
</parameter>
</parameters>
-<return> the current selection mode
+<return> the default page setup
</return>
</function>
-<function name="gtk_combo_box_new_text">
+<function name="gtk_print_operation_get_embed_page_setup">
<description>
-Convenience function which constructs a new text combo box, which is a
-#GtkComboBox just displaying strings. If you use this function to create
-a text combo box, you should only manipulate its data source with the
-following convenience functions: gtk_combo_box_append_text(),
-gtk_combo_box_insert_text(), gtk_combo_box_prepend_text() and
-gtk_combo_box_remove_text().
+Gets the value of #GtkPrintOperation::embed-page-setup property.
-Since: 2.4
+Since: 2.18
</description>
<parameters>
+<parameter name="op">
+<parameter_description> a #GtkPrintOperation
+</parameter_description>
+</parameter>
</parameters>
-<return> A new text combo box.
+<return> whether page setup selection combos are embedded
</return>
</function>
-<function name="gtk_cell_renderer_set_fixed_size">
+<function name="gtk_print_operation_get_error">
<description>
-Sets the renderer size to be explicit, independent of the properties set.
+Call this when the result of a print operation is
+%GTK_PRINT_OPERATION_RESULT_ERROR, either as returned by
+gtk_print_operation_run(), or in the #GtkPrintOperation::done signal
+handler. The returned #GError will contain more details on what went wrong.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="cell">
-<parameter_description> A #GtkCellRenderer
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> the width of the cell renderer, or -1
+<parameter name="op">
+<parameter_description> a #GtkPrintOperation
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> the height of the cell renderer, or -1
+<parameter name="error">
+<parameter_description> return location for the error
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_iter_forward_visible_cursor_positions">
+<function name="gtk_print_operation_get_has_selection">
<description>
-Moves up to @count visible cursor positions. See
-gtk_text_iter_forward_cursor_position() for details.
+Gets the value of #GtkPrintOperation::has-selection property.
-Since: 2.4
+Since: 2.18
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
-</parameter_description>
-</parameter>
-<parameter name="count">
-<parameter_description> number of positions to move
+<parameter name="op">
+<parameter_description> a #GtkPrintOperation
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if we moved and the new position is dereferenceable
+<return> whether there is a selection
</return>
</function>
-<function name="gtk_text_view_set_wrap_mode">
+<function name="gtk_print_operation_get_n_pages_to_print">
<description>
-Sets the line wrapping for the view.
+Returns the number of pages that will be printed.
+
+Note that this value is set during print preparation phase
+(%GTK_PRINT_STATUS_PREPARING), so this function should never be
+called before the data generation phase (%GTK_PRINT_STATUS_GENERATING_DATA).
+You can connect to the #GtkPrintOperation::status-changed signal
+and call gtk_print_operation_get_n_pages_to_print() when
+print status is %GTK_PRINT_STATUS_GENERATING_DATA.
+This is typically used to track the progress of print operation.
+
+Since: 2.18
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
-</parameter_description>
-</parameter>
-<parameter name="wrap_mode">
-<parameter_description> a #GtkWrapMode
+<parameter name="op">
+<parameter_description> a #GtkPrintOperation
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the number of pages that will be printed
+
+</return>
</function>
-<function name="gtk_icon_info_load_icon">
+<function name="gtk_print_operation_get_print_settings">
<description>
-Renders an icon previously looked up in an icon theme using
-gtk_icon_theme_lookup_icon(); the size will be based on the size
-passed to gtk_icon_theme_lookup_icon(). Note that the resulting
-pixbuf may not be exactly this size; an icon theme may have icons
-that differ slightly from their nominal sizes, and in addition GTK+
-will avoid scaling icons that it considers sufficiently close to the
-requested size or for which the source image would have to be scaled
-up too far. (This maintains sharpness.). This behaviour can be changed
-by passing the %GTK_ICON_LOOKUP_FORCE_SIZE flag when obtaining
-the #GtkIconInfo. If this flag has been specified, the pixbuf
-returned by this function will be scaled to the exact size.
+Returns the current print settings.
-Since: 2.4
+Note that the return value is %NULL until either
+gtk_print_operation_set_print_settings() or
+gtk_print_operation_run() have been called.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="icon_info">
-<parameter_description> a #GtkIconInfo structure from gtk_icon_theme_lookup_icon()
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> location to store error information on failure, or %NULL.
+<parameter name="op">
+<parameter_description> a #GtkPrintOperation
</parameter_description>
</parameter>
</parameters>
-<return> the rendered icon; this may be a newly created icon
-or a new reference to an internal icon, so you must not modify
-the icon. Use g_object_unref() to release your reference to the
-icon.
+<return> the current print settings of @op.
</return>
</function>
-<function name="gtk_text_layout_set_keyboard_direction">
+<function name="gtk_print_operation_get_status">
<description>
-Sets the keyboard direction; this is used as for the bidirectional
-base direction for the line with the cursor if the line contains
-only neutral characters.
+Returns the status of the print operation.
+Also see gtk_print_operation_get_status_string().
+
+Since: 2.10
</description>
<parameters>
-<parameter name="keyboard_dir">
-<parameter_description> the current direction of the keyboard.
+<parameter name="op">
+<parameter_description> a #GtkPrintOperation
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the status of the print operation
+
+</return>
</function>
-<function name="gtk_widget_set_style">
+<function name="gtk_print_operation_get_status_string">
<description>
-Sets the #GtkStyle for a widget (@widget->style). You probably don't
-want to use this function; it interacts badly with themes, because
-themes work by replacing the #GtkStyle. Instead, use
-gtk_widget_modify_style().
+Returns a string representation of the status of the
+print operation. The string is translated and suitable
+for displaying the print status e.g. in a #GtkStatusbar.
+
+Use gtk_print_operation_get_status() to obtain a status
+value that is suitable for programmatic use.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="style">
-<parameter_description> a #GtkStyle, or %NULL to remove the effect of a previous
-gtk_widget_set_style() and go back to the default style
+<parameter name="op">
+<parameter_description> a #GtkPrintOperation
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a string representation of the status
+of the print operation
+
+</return>
</function>
-<function name="gtk_tree_selection_get_selected_rows">
+<function name="gtk_print_operation_get_support_selection">
<description>
-Creates a list of path of all selected rows. Additionally, if you are
-planning on modifying the model after calling this function, you may
-want to convert the returned list into a list of #GtkTreeRowReference<!-- -->s.
-To do this, you can use gtk_tree_row_reference_new().
-
-To free the return value, use:
-|[
-g_list_foreach (list, (GFunc) gtk_tree_path_free, NULL);
-g_list_free (list);
-]|
+Gets the value of #GtkPrintOperation::support-selection property.
-Since: 2.2
+Since: 2.18
</description>
<parameters>
-<parameter name="selection">
-<parameter_description> A #GtkTreeSelection.
-</parameter_description>
-</parameter>
-<parameter name="model">
-<parameter_description> A pointer to set to the #GtkTreeModel, or %NULL.
+<parameter name="op">
+<parameter_description> a #GtkPrintOperation
</parameter_description>
</parameter>
</parameters>
-<return> A #GList containing a #GtkTreePath for each selected row.
+<return> whether the application supports print of selection
</return>
</function>
-<function name="gtk_tree_view_insert_column_with_attributes">
+<function name="gtk_print_operation_is_finished">
<description>
-Creates a new #GtkTreeViewColumn and inserts it into the @tree_view at
- position If @position is -1, then the newly created column is inserted at
-the end. The column is initialized with the attributes given. If @tree_view
-has "fixed_height" mode enabled, then the new column will have its sizing
-property set to be GTK_TREE_VIEW_COLUMN_FIXED.
+A convenience function to find out if the print operation
+is finished, either successfully (%GTK_PRINT_STATUS_FINISHED)
+or unsuccessfully (%GTK_PRINT_STATUS_FINISHED_ABORTED).
+Note: when you enable print status tracking the print operation
+can be in a non-finished state even after done has been called, as
+the operation status then tracks the print job status on the printer.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView
-</parameter_description>
-</parameter>
-<parameter name="position">
-<parameter_description> The position to insert the new column in.
-</parameter_description>
-</parameter>
-<parameter name="title">
-<parameter_description> The title to set the header to.
-</parameter_description>
-</parameter>
-<parameter name="cell">
-<parameter_description> The #GtkCellRenderer.
-</parameter_description>
-</parameter>
-<parameter name="Varargs">
-<parameter_description> A %NULL-terminated list of attributes.
+<parameter name="op">
+<parameter_description> a #GtkPrintOperation
</parameter_description>
</parameter>
</parameters>
-<return> The number of columns in @tree_view after insertion.
+<return> %TRUE, if the print operation is finished.
+
</return>
</function>
-<function name="gtk_adjustment_get_upper">
+<function name="gtk_print_operation_new">
<description>
-Retrieves the maximum value of the adjustment.
+Creates a new #GtkPrintOperation.
-Since: 2.14
+Since: 2.10
</description>
<parameters>
-<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
-</parameter_description>
-</parameter>
</parameters>
-<return> The current maximum value of the adjustment.
+<return> a new #GtkPrintOperation
</return>
</function>
-<function name="gtk_accel_group_disconnect">
+<function name="gtk_print_operation_preview_end_preview">
<description>
-Removes an accelerator previously installed through
-gtk_accel_group_connect().
+Ends a preview.
-Since 2.20 @closure can be %NULL.
+This function must be called to finish a custom print preview.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="accel_group">
-<parameter_description> the accelerator group to remove an accelerator from
-</parameter_description>
-</parameter>
-<parameter name="closure">
-<parameter_description> the closure to remove from this accelerator group, or %NULL
-to remove all closures
+<parameter name="preview">
+<parameter_description> a #GtkPrintOperationPreview
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the closure was found and got disconnected
-</return>
+<return></return>
</function>
-<function name="gtk_socket_get_plug_window">
+<function name="gtk_print_operation_preview_is_selected">
<description>
-Retrieves the window of the plug. Use this to check if the plug has
-been created inside of the socket.
+Returns whether the given page is included in the set of pages that
+have been selected for printing.
-Since: 2.14
+Since: 2.10
</description>
<parameters>
-<parameter name="socket_">
-<parameter_description> a #GtkSocket.
+<parameter name="preview">
+<parameter_description> a #GtkPrintOperationPreview
+</parameter_description>
+</parameter>
+<parameter name="page_nr">
+<parameter_description> a page number
</parameter_description>
</parameter>
</parameters>
-<return> the window of the plug if available, or %NULL
+<return> %TRUE if the page has been selected for printing
</return>
</function>
-<function name="gtk_tree_view_column_set_max_width">
+<function name="gtk_print_operation_preview_render_page">
<description>
-Sets the maximum width of the @tree_column. If @max_width is -1, then the
-maximum width is unset. Note, the column can actually be wider than max
-width if it's the last column in a view. In this case, the column expands to
-fill any extra space.
+Renders a page to the preview, using the print context that
+was passed to the #GtkPrintOperation::preview handler together
+with @preview.
+
+A custom iprint preview should use this function in its ::expose
+handler to render the currently selected page.
+
+Note that this function requires a suitable cairo context to
+be associated with the print context.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn.
+<parameter name="preview">
+<parameter_description> a #GtkPrintOperationPreview
</parameter_description>
</parameter>
-<parameter name="max_width">
-<parameter_description> The maximum width of the column in pixels, or -1.
+<parameter name="page_nr">
+<parameter_description> the page to render
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_child_anchor_get_deleted">
+<function name="gtk_print_operation_run">
<description>
-Determines whether a child anchor has been deleted from
-the buffer. Keep in mind that the child anchor will be
-unreferenced when removed from the buffer, so you need to
-hold your own reference (with g_object_ref()) if you plan
-to use this function — otherwise all deleted child anchors
-will also be finalized.
+Runs the print operation, by first letting the user modify
+print settings in the print dialog, and then print the document.
+
+Normally that this function does not return until the rendering of all
+pages is complete. You can connect to the
+#GtkPrintOperation::status-changed signal on @op to obtain some
+information about the progress of the print operation.
+Furthermore, it may use a recursive mainloop to show the print dialog.
+
+If you call gtk_print_operation_set_allow_async() or set the
+#GtkPrintOperation:allow-async property the operation will run
+asynchronously if this is supported on the platform. The
+#GtkPrintOperation::done signal will be emitted with the result of the
+operation when the it is done (i.e. when the dialog is canceled, or when
+the print succeeds or fails).
+|[
+if (settings != NULL)
+gtk_print_operation_set_print_settings (print, settings);
+
+if (page_setup != NULL)
+gtk_print_operation_set_default_page_setup (print, page_setup);
+
+g_signal_connect (print, "begin-print",
+G_CALLBACK (begin_print), &data);
+g_signal_connect (print, "draw-page",
+G_CALLBACK (draw_page), &data);
+
+res = gtk_print_operation_run (print,
+GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG,
+parent,
+&error);
+
+if (res == GTK_PRINT_OPERATION_RESULT_ERROR)
+{
+error_dialog = gtk_message_dialog_new (GTK_WINDOW (parent),
+GTK_DIALOG_DESTROY_WITH_PARENT,
+GTK_MESSAGE_ERROR,
+GTK_BUTTONS_CLOSE,
+"Error printing file:\n%s",
+error->message);
+g_signal_connect (error_dialog, "response",
+G_CALLBACK (gtk_widget_destroy), NULL);
+gtk_widget_show (error_dialog);
+g_error_free (error);
+}
+else if (res == GTK_PRINT_OPERATION_RESULT_APPLY)
+{
+if (settings != NULL)
+g_object_unref (settings);
+settings = g_object_ref (gtk_print_operation_get_print_settings (print));
+}
+]|
+Note that gtk_print_operation_run() can only be called once on a
+given #GtkPrintOperation.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="anchor">
-<parameter_description> a #GtkTextChildAnchor
+<parameter name="op">
+<parameter_description> a #GtkPrintOperation
+</parameter_description>
+</parameter>
+<parameter name="action">
+<parameter_description> the action to start
+</parameter_description>
+</parameter>
+<parameter name="parent">
+<parameter_description> Transient parent of the dialog
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> Return location for errors, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the child anchor has been deleted from its buffer
+<return> the result of the print operation. A return value of
+%GTK_PRINT_OPERATION_RESULT_APPLY indicates that the printing was
+completed successfully. In this case, it is a good idea to obtain
+the used print settings with gtk_print_operation_get_print_settings()
+and store them for reuse with the next print operation. A value of
+%GTK_PRINT_OPERATION_RESULT_IN_PROGRESS means the operation is running
+asynchronously, and will emit the #GtkPrintOperation::done signal when
+done.
+
</return>
</function>
-<function name="gtk_file_chooser_get_current_folder">
+<function name="gtk_print_operation_set_allow_async">
<description>
-Gets the current folder of @chooser as a local filename.
-See gtk_file_chooser_set_current_folder().
-
-Note that this is the folder that the file chooser is currently displaying
-(e.g. "/home/username/Documents"), which is <emphasis>not the same</emphasis>
-as the currently-selected folder if the chooser is in
-%GTK_FILE_CHOOSER_SELECT_FOLDER mode
-(e.g. "/home/username/Documents/selected-folder/". To get the
-currently-selected folder in that mode, use gtk_file_chooser_get_uri() as the
-usual way to get the selection.
+Sets whether the gtk_print_operation_run() may return
+before the print operation is completed. Note that
+some platforms may not allow asynchronous operation.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="op">
+<parameter_description> a #GtkPrintOperation
+</parameter_description>
+</parameter>
+<parameter name="allow_async">
+<parameter_description> %TRUE to allow asynchronous operation
</parameter_description>
</parameter>
</parameters>
-<return> the full path of the current folder, or %NULL if the current
-path cannot be represented as a local filename. Free with g_free(). This
-function will also return %NULL if the file chooser was unable to load the
-last folder that was requested from it; for example, as would be for calling
-gtk_file_chooser_set_current_folder() on a nonexistent folder.
-
-</return>
+<return></return>
</function>
-<function name="gtk_accel_group_find">
+<function name="gtk_print_operation_set_current_page">
<description>
-Finds the first entry in an accelerator group for which
- find_func returns %TRUE and returns its #GtkAccelKey.
+Sets the current page.
+If this is called before gtk_print_operation_run(),
+the user will be able to select to print only the current page.
+
+Note that this only makes sense for pre-paginated documents.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="accel_group">
-<parameter_description> a #GtkAccelGroup
-</parameter_description>
-</parameter>
-<parameter name="find_func">
-<parameter_description> a function to filter the entries of @accel_group with
+<parameter name="op">
+<parameter_description> a #GtkPrintOperation
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to pass to @find_func
+<parameter name="current_page">
+<parameter_description> the current page, 0-based
</parameter_description>
</parameter>
</parameters>
-<return> the key of the first entry passing @find_func. The key is
-owned by GTK+ and must not be freed.
-</return>
+<return></return>
</function>
-<function name="gtk_im_context_set_surrounding">
+<function name="gtk_print_operation_set_custom_tab_label">
<description>
-Sets surrounding context around the insertion point and preedit
-string. This function is expected to be called in response to the
-GtkIMContext::retrieve_surrounding signal, and will likely have no
-effect if called at other times.
+Sets the label for the tab holding custom widgets.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GtkIMContext
-</parameter_description>
-</parameter>
-<parameter name="text">
-<parameter_description> text surrounding the insertion point, as UTF-8.
-the preedit string should not be included within
- text
-</parameter_description>
-</parameter>
-<parameter name="len">
-<parameter_description> the length of @text, or -1 if @text is nul-terminated
+<parameter name="op">
+<parameter_description> a #GtkPrintOperation
</parameter_description>
</parameter>
-<parameter name="cursor_index">
-<parameter_description> the byte index of the insertion cursor within @text.
+<parameter name="label">
+<parameter_description> the label to use, or %NULL to use the default label
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_recent_manager_remove_item">
+<function name="gtk_print_operation_set_default_page_setup">
<description>
-Removes a resource pointed by @uri from the recently used resources
-list handled by a recent manager.
+Makes @default_page_setup the default page setup for @op.
+
+This page setup will be used by gtk_print_operation_run(),
+but it can be overridden on a per-page basis by connecting
+to the #GtkPrintOperation::request-page-setup signal.
Since: 2.10
</description>
<parameters>
-<parameter name="manager">
-<parameter_description> a #GtkRecentManager
-</parameter_description>
-</parameter>
-<parameter name="uri">
-<parameter_description> the URI of the item you wish to remove
+<parameter name="op">
+<parameter_description> a #GtkPrintOperation
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL
+<parameter name="default_page_setup">
+<parameter_description> a #GtkPageSetup, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the item pointed by @uri has been successfully
-removed by the recently used resources list, and %FALSE otherwise.
-
-</return>
+<return></return>
</function>
-<function name="gtk_accel_map_load_scanner">
+<function name="gtk_print_operation_set_defer_drawing">
<description>
-#GScanner variant of gtk_accel_map_load().
+Sets up the #GtkPrintOperation to wait for calling of
+gtk_print_operation_draw_page_finish() from application. It can
+be used for drawing page in another thread.
+
+This function must be called in the callback of "draw-page" signal.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="scanner">
-<parameter_description> a #GScanner which has already been provided with an input file
+<parameter name="op">
+<parameter_description> a #GtkPrintOperation
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_iter_forward_visible_word_ends">
+<function name="gtk_print_operation_set_embed_page_setup">
<description>
-Calls gtk_text_iter_forward_visible_word_end() up to @count times.
+Embed page size combo box and orientation combo box into page setup page.
+Selected page setup is stored as default page setup in #GtkPrintOperation.
-Since: 2.4
+Since: 2.18
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="op">
+<parameter_description> a #GtkPrintOperation
</parameter_description>
</parameter>
-<parameter name="count">
-<parameter_description> number of times to move
+<parameter name="embed">
+<parameter_description> %TRUE to embed page setup selection in the #GtkPrintDialog
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter moved and is not the end iterator
-
-</return>
+<return></return>
</function>
<function name="gtk_print_operation_set_export_filename">
@@ -34035,1803 +34518,1686 @@ Since: 2.10
<return></return>
</function>
-<function name="gtk_tree_view_get_hadjustment">
+<function name="gtk_print_operation_set_has_selection">
<description>
-Gets the #GtkAdjustment currently being used for the horizontal aspect.
+Sets whether there is a selection to print.
+Application has to set number of pages to which the selection
+will draw by gtk_print_operation_set_n_pages() in a callback of
+#GtkPrintOperation::begin-print.
+
+Since: 2.18
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView
+<parameter name="op">
+<parameter_description> a #GtkPrintOperation
</parameter_description>
</parameter>
-</parameters>
-<return> A #GtkAdjustment object, or %NULL if none is currently being
-used.
-</return>
-</function>
-
-<function name="gtk_file_chooser_get_local_only">
-<description>
-Gets whether only local files can be selected in the
-file selector. See gtk_file_chooser_set_local_only()
-
-Since: 2.4
-
-</description>
-<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChoosre
+<parameter name="has_selection">
+<parameter_description> %TRUE indicates that a selection exists
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if only local files can be selected.
-
-</return>
+<return></return>
</function>
-<function name="gtk_print_operation_preview_end_preview">
+<function name="gtk_print_operation_set_job_name">
<description>
-Ends a preview.
+Sets the name of the print job. The name is used to identify
+the job (e.g. in monitoring applications like eggcups).
-This function must be called to finish a custom print preview.
+If you don't set a job name, GTK+ picks a default one by
+numbering successive print jobs.
Since: 2.10
</description>
<parameters>
-<parameter name="preview">
-<parameter_description> a #GtkPrintOperationPreview
+<parameter name="op">
+<parameter_description> a #GtkPrintOperation
+</parameter_description>
+</parameter>
+<parameter name="job_name">
+<parameter_description> a string that identifies the print job
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_settings_get_orientation">
+<function name="gtk_print_operation_set_n_pages">
<description>
-Get the value of %GTK_PRINT_SETTINGS_ORIENTATION,
-converted to a #GtkPageOrientation.
+Sets the number of pages in the document.
+
+This <emphasis>must</emphasis> be set to a positive number
+before the rendering starts. It may be set in a
+#GtkPrintOperation::begin-print signal hander.
+
+Note that the page numbers passed to the
+#GtkPrintOperation::request-page-setup
+and #GtkPrintOperation::draw-page signals are 0-based, i.e. if
+the user chooses to print all pages, the last ::draw-page signal
+will be for page @n_pages - 1.
Since: 2.10
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="op">
+<parameter_description> a #GtkPrintOperation
+</parameter_description>
+</parameter>
+<parameter name="n_pages">
+<parameter_description> the number of pages
</parameter_description>
</parameter>
</parameters>
-<return> the orientation
-
-</return>
+<return></return>
</function>
-<function name="gtk_accel_group_activate">
+<function name="gtk_print_operation_set_print_settings">
<description>
-Finds the first accelerator in @accel_group
-that matches @accel_key and @accel_mods, and
-activates it.
+Sets the print settings for @op. This is typically used to
+re-establish print settings from a previous print operation,
+see gtk_print_operation_run().
+Since: 2.10
</description>
<parameters>
-<parameter name="accel_group">
-<parameter_description> a #GtkAccelGroup
-</parameter_description>
-</parameter>
-<parameter name="accel_quark">
-<parameter_description> the quark for the accelerator name
-</parameter_description>
-</parameter>
-<parameter name="acceleratable">
-<parameter_description> the #GObject, usually a #GtkWindow, on which
-to activate the accelerator.
-</parameter_description>
-</parameter>
-<parameter name="accel_key">
-<parameter_description> accelerator keyval from a key event
+<parameter name="op">
+<parameter_description> a #GtkPrintOperation
</parameter_description>
</parameter>
-<parameter name="accel_mods">
-<parameter_description> keyboard state mask from a key event
+<parameter name="print_settings">
+<parameter_description> #GtkPrintSettings
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if an accelerator was activated and handled this keypress
-</return>
+<return></return>
</function>
-<function name="gtk_file_filter_add_pixbuf_formats">
+<function name="gtk_print_operation_set_show_progress">
<description>
-Adds a rule allowing image files in the formats supported
-by GdkPixbuf.
+If @show_progress is %TRUE, the print operation will show a
+progress dialog during the print operation.
-Since: 2.6
+Since: 2.10
</description>
<parameters>
-<parameter name="filter">
-<parameter_description> a #GtkFileFilter
+<parameter name="op">
+<parameter_description> a #GtkPrintOperation
+</parameter_description>
+</parameter>
+<parameter name="show_progress">
+<parameter_description> %TRUE to show a progress dialog
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_layout_set_size">
+<function name="gtk_print_operation_set_support_selection">
<description>
-Sets the size of the scrollable area of the layout.
+Sets whether selection is supported by #GtkPrintOperation.
+Since: 2.18
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #GtkLayout
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> width of entire scrollable area
+<parameter name="op">
+<parameter_description> a #GtkPrintOperation
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> height of entire scrollable area
+<parameter name="support_selection">
+<parameter_description> %TRUE to support selection
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_printer_get_name">
+<function name="gtk_print_operation_set_track_print_status">
<description>
-Returns the name of the printer.
+If track_status is %TRUE, the print operation will try to continue report
+on the status of the print job in the printer queues and printer. This
+can allow your application to show things like "out of paper" issues,
+and when the print job actually reaches the printer.
+
+This function is often implemented using some form of polling, so it should
+not be enabled unless needed.
Since: 2.10
</description>
<parameters>
-<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter name="op">
+<parameter_description> a #GtkPrintOperation
</parameter_description>
</parameter>
-</parameters>
-<return> the name of @printer
-
-</return>
-</function>
-
-<function name="gtk_widget_has_focus">
-<description>
-Determines if the widget has the global input focus. See
-gtk_widget_is_focus() for the difference between having the global
-input focus, and only having the focus within a toplevel.
-
-Since: 2.18
-
-</description>
-<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="track_status">
+<parameter_description> %TRUE to track status after printing
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the widget has the global input focus.
-
-</return>
+<return></return>
</function>
-<function name="gtk_image_new_from_pixbuf">
+<function name="gtk_print_operation_set_unit">
<description>
-Creates a new #GtkImage displaying @pixbuf.
-The #GtkImage does not assume a reference to the
-pixbuf; you still need to unref it if you own references.
-#GtkImage will add its own reference rather than adopting yours.
-
-Note that this function just creates an #GtkImage from the pixbuf. The
-#GtkImage created will not react to state changes. Should you want that,
-you should use gtk_image_new_from_icon_set().
+Sets up the transformation for the cairo context obtained from
+#GtkPrintContext in such a way that distances are measured in
+units of @unit.
+Since: 2.10
</description>
<parameters>
-<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf, or %NULL
+<parameter name="op">
+<parameter_description> a #GtkPrintOperation
</parameter_description>
</parameter>
-</parameters>
-<return> a new #GtkImage
-</return>
-</function>
-
-<function name="spin_button_get_shadow_type">
-<description>
-Convenience function to Get the shadow type from the underlying widget's
-style.
-
-
-</description>
-<parameters>
-<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter name="unit">
+<parameter_description> the unit to use
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkShadowType
-</return>
+<return></return>
</function>
-<function name="gtk_notebook_set_show_border">
+<function name="gtk_print_operation_set_use_full_page">
<description>
-Sets whether a bevel will be drawn around the notebook pages.
-This only has a visual effect when the tabs are not shown.
-See gtk_notebook_set_show_tabs().
+If @full_page is %TRUE, the transformation for the cairo context
+obtained from #GtkPrintContext puts the origin at the top left
+corner of the page (which may not be the top left corner of the
+sheet, depending on page orientation and the number of pages per
+sheet). Otherwise, the origin is at the top left corner of the
+imageable area (i.e. inside the margins).
+
+Since: 2.10
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="op">
+<parameter_description> a #GtkPrintOperation
</parameter_description>
</parameter>
-<parameter name="show_border">
-<parameter_description> %TRUE if a bevel should be drawn around the notebook.
+<parameter name="full_page">
+<parameter_description> %TRUE to set up the #GtkPrintContext for the full page
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="add_file">
+<function name="gtk_print_run_page_setup_dialog">
<description>
-Adds the given @file with its associated @info to the @model.
-If the model is frozen, the file will only show up after it is thawn.
+Runs a page setup dialog, letting the user modify the values from
+ page_setup If the user cancels the dialog, the returned #GtkPageSetup
+is identical to the passed in @page_setup, otherwise it contains the
+modifications done in the dialog.
+
+Note that this function may use a recursive mainloop to show the page
+setup dialog. See gtk_print_run_page_setup_dialog_async() if this is
+a problem.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="model">
-<parameter_description> the model
+<parameter name="parent">
+<parameter_description> transient parent
</parameter_description>
</parameter>
-<parameter name="file">
-<parameter_description> the file to add
+<parameter name="page_setup">
+<parameter_description> an existing #GtkPageSetup
</parameter_description>
</parameter>
-<parameter name="info">
-<parameter_description> the information to associate with the file
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GtkPageSetup
+
+</return>
</function>
-<function name="gtk_ruler_get_range">
+<function name="gtk_print_run_page_setup_dialog_async">
<description>
-Retrieves values indicating the range and current position of a #GtkRuler.
-See gtk_ruler_set_range().
+Runs a page setup dialog, letting the user modify the values from @page_setup.
+
+In contrast to gtk_print_run_page_setup_dialog(), this function returns after
+showing the page setup dialog on platforms that support this, and calls @done_cb
+from a signal handler for the ::response signal of the dialog.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="ruler">
-<parameter_description> a #GtkRuler
+<parameter name="parent">
+<parameter_description> transient parent, or %NULL
</parameter_description>
</parameter>
-<parameter name="lower">
-<parameter_description> location to store lower limit of the ruler, or %NULL
+<parameter name="page_setup">
+<parameter_description> an existing #GtkPageSetup, or %NULL
</parameter_description>
</parameter>
-<parameter name="upper">
-<parameter_description> location to store upper limit of the ruler, or %NULL
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> location to store the current position of the mark on the ruler, or %NULL
+<parameter name="done_cb">
+<parameter_description> a function to call when the user saves the modified page setup
</parameter_description>
</parameter>
-<parameter name="max_size">
-<parameter_description> location to store the maximum size of the ruler used when calculating
-the space to leave for the text, or %NULL.
+<parameter name="data">
+<parameter_description> user data to pass to @done_cb
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_is_focus">
+<function name="gtk_print_settings_copy">
<description>
-Determines if the widget is the focus widget within its
-toplevel. (This does not mean that the %HAS_FOCUS flag is
-necessarily set; %HAS_FOCUS will only be set if the
-toplevel widget additionally has the global input focus.)
+Copies a #GtkPrintSettings object.
+Since: 2.10
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="other">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the widget is the focus widget.
+<return> a newly allocated copy of @other
+
</return>
</function>
-<function name="gtk_tree_view_expand_to_path">
+<function name="gtk_print_settings_foreach">
<description>
-Expands the row at @path. This will also expand all parent rows of
- path as necessary.
+Calls @func for each key-value pair of @settings.
-Since: 2.2
+Since: 2.10
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView.
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> path to a row.
+<parameter name="func">
+<parameter_description> the function to call
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data for @func
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_iter_toggles_tag">
+<function name="gtk_print_settings_get">
<description>
-This is equivalent to (gtk_text_iter_begins_tag () ||
-gtk_text_iter_ends_tag ()), i.e. it tells you whether a range with
- tag applied to it begins <emphasis>or</emphasis> ends at @iter.
+Looks up the string value associated with @key.
+Since: 2.10
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="tag">
-<parameter_description> a #GtkTextTag, or %NULL
+<parameter name="key">
+<parameter_description> a key
</parameter_description>
</parameter>
</parameters>
-<return> whether @tag is toggled on or off at @iter
+<return> the string value for @key
+
</return>
</function>
-<function name="gtk_tree_view_get_column">
+<function name="gtk_print_settings_get_bool">
<description>
-Gets the #GtkTreeViewColumn at the given position in the #tree_view.
+Returns the boolean represented by the value
+that is associated with @key.
+The string "true" represents %TRUE, any other
+string %FALSE.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView.
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="n">
-<parameter_description> The position of the column, counting from 0.
+<parameter name="key">
+<parameter_description> a key
</parameter_description>
</parameter>
</parameters>
-<return> The #GtkTreeViewColumn, or %NULL if the position is outside the
-range of columns.
+<return> %TRUE, if @key maps to a true value.
+
</return>
</function>
-<function name="gtk_viewport_get_bin_window">
+<function name="gtk_print_settings_get_bool_with_default">
<description>
-Gets the bin window of the #GtkViewport.
+Returns the boolean represented by the value
+that is associated with @key, or @default_val
+if the value does not represent a boolean.
-Since: 2.20
+The string "true" represents %TRUE, the string
+"false" represents %FALSE.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="viewport">
-<parameter_description> a #GtkViewport
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="default_val">
+<parameter_description> the default value
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkWindow
+<return> the boolean value associated with @key
</return>
</function>
-<function name="gtk_action_group_get_name">
+<function name="gtk_print_settings_get_collate">
<description>
-Gets the name of the action group.
+Gets the value of %GTK_PRINT_SETTINGS_COLLATE.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="action_group">
-<parameter_description> the action group
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
</parameters>
-<return> the name of the action group.
+<return> whether to collate the printed pages
</return>
</function>
-<function name="gtk_radio_action_get_group">
+<function name="gtk_print_settings_get_default_source">
<description>
-Returns the list representing the radio group for this object.
-Note that the returned list is only valid until the next change
-to the group.
-
-A common way to set up a group of radio group is the following:
-|[
-GSList *group = NULL;
-GtkRadioAction *action;
-
-while (/ * more actions to add * /)
-{
-action = gtk_radio_action_new (...);
-
-gtk_radio_action_set_group (action, group);
-group = gtk_radio_action_get_group (action);
-}
-]|
+Gets the value of %GTK_PRINT_SETTINGS_DEFAULT_SOURCE.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="action">
-<parameter_description> the action object
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
</parameters>
-<return> the list representing the radio group for this object
+<return> the default source
</return>
</function>
-<function name="gtk_text_iter_get_chars_in_line">
+<function name="gtk_print_settings_get_dither">
<description>
-Returns the number of characters in the line containing @iter,
-including the paragraph delimiters.
+Gets the value of %GTK_PRINT_SETTINGS_DITHER.
+Since: 2.10
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
</parameters>
-<return> number of characters in the line
+<return> the dithering that is used
+
</return>
</function>
-<function name="gtk_widget_ref">
+<function name="gtk_print_settings_get_double">
<description>
-Adds a reference to a widget. This function is exactly the same
-as calling g_object_ref(), and exists mostly for historical
-reasons. It can still be convenient to avoid casting a widget
-to a #GObject, it saves a small amount of typing.
+Returns the double value associated with @key, or 0.
-Deprecated: 2.12: Use g_object_ref() instead.
+Since: 2.10
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
</parameter_description>
</parameter>
</parameters>
-<return> the widget that was referenced
+<return> the double value of @key
</return>
</function>
-<function name="gtk_tree_store_append">
+<function name="gtk_print_settings_get_double_with_default">
<description>
-Appends a new row to @tree_store. If @parent is non-%NULL, then it will append the
-new row after the last child of @parent, otherwise it will append a row to
-the top level. @iter will be changed to point to this new row. The row will
-be empty after this function is called. To fill in values, you need to call
-gtk_tree_store_set() or gtk_tree_store_set_value().
+Returns the floating point number represented by
+the value that is associated with @key, or @default_val
+if the value does not represent a floating point number.
+
+Floating point numbers are parsed with g_ascii_strtod().
+
+Since: 2.10
</description>
<parameters>
-<parameter name="tree_store">
-<parameter_description> A #GtkTreeStore
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> An unset #GtkTreeIter to set to the appended row
+<parameter name="key">
+<parameter_description> a key
</parameter_description>
</parameter>
-<parameter name="parent">
-<parameter_description> A valid #GtkTreeIter, or %NULL
+<parameter name="def">
+<parameter_description> the default value
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the floating point number associated with @key
+
+</return>
</function>
-<function name="gtk_expander_set_use_markup">
+<function name="gtk_print_settings_get_duplex">
<description>
-Sets whether the text of the label contains markup in <link
-linkend="PangoMarkupFormat">Pango's text markup
-language</link>. See gtk_label_set_markup().
+Gets the value of %GTK_PRINT_SETTINGS_DUPLEX.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="expander">
-<parameter_description> a #GtkExpander
-</parameter_description>
-</parameter>
-<parameter name="use_markup">
-<parameter_description> %TRUE if the label's text should be parsed for markup
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether to print the output in duplex.
+
+</return>
</function>
-<function name="gtk_icon_view_set_margin">
+<function name="gtk_print_settings_get_finishings">
<description>
-Sets the ::margin property which specifies the space
-which is inserted at the top, bottom, left and right
-of the icon view.
+Gets the value of %GTK_PRINT_SETTINGS_FINISHINGS.
-Since: 2.6
+Since: 2.10
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
-</parameter_description>
-</parameter>
-<parameter name="margin">
-<parameter_description> the margin
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the finishings
+
+</return>
</function>
-<function name="gtk_vscale_new_with_range">
+<function name="gtk_print_settings_get_int">
<description>
-Creates a new vertical scale widget that lets the user input a
-number between @min and @max (including @min and @max) with the
-increment @step. @step must be nonzero; it's the distance the
-slider moves when using the arrow keys to adjust the scale value.
-
-Note that the way in which the precision is derived works best if @step
-is a power of ten. If the resulting precision is not suitable for your
-needs, use gtk_scale_set_digits() to correct it.
+Returns the integer value of @key, or 0.
+Since: 2.10
</description>
<parameters>
-<parameter name="min">
-<parameter_description> minimum value
-</parameter_description>
-</parameter>
-<parameter name="max">
-<parameter_description> maximum value
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="step">
-<parameter_description> step increment (tick size) used with keyboard shortcuts
+<parameter name="key">
+<parameter_description> a key
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkVScale
+<return> the integer value of @key
+
</return>
</function>
-<function name="gtk_menu_item_set_right_justified">
+<function name="gtk_print_settings_get_int_with_default">
<description>
-Sets whether the menu item appears justified at the right
-side of a menu bar. This was traditionally done for "Help" menu
-items, but is now considered a bad idea. (If the widget
-layout is reversed for a right-to-left language like Hebrew
-or Arabic, right-justified-menu-items appear at the left.)
+Returns the value of @key, interpreted as
+an integer, or the default value.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="menu_item">
-<parameter_description> a #GtkMenuItem.
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="right_justified">
-<parameter_description> if %TRUE the menu item will appear at the
-far right if added to a menu bar.
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="def">
+<parameter_description> the default value
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the integer value of @key
+
+</return>
</function>
-<function name="gtk_entry_get_icon_tooltip_markup">
+<function name="gtk_print_settings_get_length">
<description>
-Gets the contents of the tooltip on the icon at the specified
-position in @entry.
+Returns the value associated with @key, interpreted
+as a length. The returned value is converted to @units.
-Since: 2.16
+Since: 2.10
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="icon_pos">
-<parameter_description> the icon position
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="unit">
+<parameter_description> the unit of the return value
</parameter_description>
</parameter>
</parameters>
-<return> the tooltip text, or %NULL. Free the returned string
-with g_free() when done.
+<return> the length value of @key, converted to @unit
</return>
</function>
-<function name="gtk_text_buffer_unregister_deserialize_format">
+<function name="gtk_print_settings_get_media_type">
<description>
-This function unregisters a rich text format that was previously
-registered using gtk_text_buffer_register_deserialize_format() or
-gtk_text_buffer_register_deserialize_tagset().
+Gets the value of %GTK_PRINT_SETTINGS_MEDIA_TYPE.
+
+The set of media types is defined in PWG 5101.1-2002 PWG.
+<!-- FIXME link here -->
Since: 2.10
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="format">
-<parameter_description> a #GdkAtom representing a registered rich text format.
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the media type
+
+</return>
</function>
-<function name="gtk_notebook_get_n_pages">
+<function name="gtk_print_settings_get_n_copies">
<description>
-Gets the number of pages in a notebook.
+Gets the value of %GTK_PRINT_SETTINGS_N_COPIES.
-Since: 2.2
+Since: 2.10
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
</parameters>
-<return> the number of pages in the notebook.
+<return> the number of copies to print
</return>
</function>
-<function name="gtk_widget_show">
+<function name="gtk_print_settings_get_number_up">
<description>
-Flags a widget to be displayed. Any widget that isn't shown will
-not appear on the screen. If you want to show all the widgets in a
-container, it's easier to call gtk_widget_show_all() on the
-container, instead of individually showing the widgets.
-
-Remember that you have to show the containers containing a widget,
-in addition to the widget itself, before it will appear onscreen.
+Gets the value of %GTK_PRINT_SETTINGS_NUMBER_UP.
-When a toplevel container is shown, it is immediately realized and
-mapped; other shown widgets are realized and mapped when their
-toplevel container is realized and mapped.
+Since: 2.10
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the number of pages per sheet
+
+</return>
</function>
-<function name="gtk_menu_set_reserve_toggle_size">
+<function name="gtk_print_settings_get_number_up_layout">
<description>
-Sets whether the menu should reserve space for drawing toggles
-or icons, regardless of their actual presence.
+Gets the value of %GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT.
-Since: 2.18
+Since: 2.14
</description>
<parameters>
-<parameter name="menu">
-<parameter_description> a #GtkMenu
-</parameter_description>
-</parameter>
-<parameter name="reserve_toggle_size">
-<parameter_description> whether to reserve size for toggles
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> layout of page in number-up mode
+
+</return>
</function>
-<function name="gtk_recent_manager_add_item">
+<function name="gtk_print_settings_get_orientation">
<description>
-Adds a new resource, pointed by @uri, into the recently used
-resources list.
-
-This function automatically retrieves some of the needed
-metadata and setting other metadata to common default values; it
-then feeds the data to gtk_recent_manager_add_full().
-
-See gtk_recent_manager_add_full() if you want to explicitly
-define the metadata for the resource pointed by @uri.
+Get the value of %GTK_PRINT_SETTINGS_ORIENTATION,
+converted to a #GtkPageOrientation.
Since: 2.10
</description>
<parameters>
-<parameter name="manager">
-<parameter_description> a #GtkRecentManager
-</parameter_description>
-</parameter>
-<parameter name="uri">
-<parameter_description> a valid URI
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the new item was successfully added
-to the recently used resources list
+<return> the orientation
</return>
</function>
-<function name="gtk_tool_item_group_get_header_relief">
+<function name="gtk_print_settings_get_output_bin">
<description>
-Gets the relief mode of the header button of @group.
+Gets the value of %GTK_PRINT_SETTINGS_OUTPUT_BIN.
-Since: 2.20
+Since: 2.10
</description>
<parameters>
-<parameter name="group">
-<parameter_description> a #GtkToolItemGroup
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkReliefStyle
+<return> the output bin
</return>
</function>
-<function name="gtk_tool_item_group_get_nth_item">
+<function name="gtk_print_settings_get_page_ranges">
<description>
-Gets the tool item at @index in group.
+Gets the value of %GTK_PRINT_SETTINGS_PAGE_RANGES.
-Since: 2.20
+Since: 2.10
</description>
<parameters>
-<parameter name="group">
-<parameter_description> a #GtkToolItemGroup
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="index">
-<parameter_description> the index
+<parameter name="num_ranges">
+<parameter_description> return location for the length of the returned array
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkToolItem at index
+<return> an array of #GtkPageRange<!-- -->s.
+Use g_free() to free the array when it is no longer needed.
</return>
</function>
-<function name="gtk_menu_get_reserve_toggle_size">
+<function name="gtk_print_settings_get_page_set">
<description>
-Returns whether the menu reserves space for toggles and
-icons, regardless of their actual presence.
+Gets the value of %GTK_PRINT_SETTINGS_PAGE_SET.
-Since: 2.18
+Since: 2.10
</description>
<parameters>
-<parameter name="menu">
-<parameter_description> a #GtkMenu
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
</parameters>
-<return> Whether the menu reserves toggle space
+<return> the set of pages to print
</return>
</function>
-<function name="gtk_file_selection_get_selections">
+<function name="gtk_print_settings_get_paper_height">
<description>
-Retrieves the list of file selections the user has made in the dialog box.
-This function is intended for use when the user can select multiple files
-in the file list.
-
-The filenames are in the GLib file name encoding. To convert to
-UTF-8, call g_filename_to_utf8() on each string.
+Gets the value of %GTK_PRINT_SETTINGS_PAPER_HEIGHT,
+converted to @unit.
+Since: 2.10
</description>
<parameters>
-<parameter name="filesel">
-<parameter_description> a #GtkFileSelection
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
+</parameter_description>
+</parameter>
+<parameter name="unit">
+<parameter_description> the unit for the return value
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated %NULL-terminated array of strings. Use
-g_strfreev() to free it.
+<return> the paper height, in units of @unit
+
</return>
</function>
-<function name="gtk_drag_check_threshold">
+<function name="gtk_print_settings_get_paper_size">
<description>
-Checks to see if a mouse drag starting at (@start_x, @start_y) and ending
-at (@current_x, @current_y) has passed the GTK+ drag threshold, and thus
-should trigger the beginning of a drag-and-drop operation.
+Gets the value of %GTK_PRINT_SETTINGS_PAPER_FORMAT,
+converted to a #GtkPaperSize.
+Since: 2.10
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="start_x">
-<parameter_description> X coordinate of start of drag
-</parameter_description>
-</parameter>
-<parameter name="start_y">
-<parameter_description> Y coordinate of start of drag
-</parameter_description>
-</parameter>
-<parameter name="current_x">
-<parameter_description> current X coordinate
-</parameter_description>
-</parameter>
-<parameter name="current_y">
-<parameter_description> current Y coordinate
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the drag threshold has been passed.
+<return> the paper size
+
</return>
</function>
-<function name="gtk_label_set_line_wrap_mode">
+<function name="gtk_print_settings_get_paper_width">
<description>
-If line wrapping is on (see gtk_label_set_line_wrap()) this controls how
-the line wrapping is done. The default is %PANGO_WRAP_WORD which means
-wrap on word boundaries.
+Gets the value of %GTK_PRINT_SETTINGS_PAPER_WIDTH,
+converted to @unit.
Since: 2.10
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="wrap_mode">
-<parameter_description> the line wrapping mode
+<parameter name="unit">
+<parameter_description> the unit for the return value
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the paper width, in units of @unit
+
+</return>
</function>
-<function name="gtk_about_dialog_new">
+<function name="gtk_print_settings_get_print_pages">
<description>
-Creates a new #GtkAboutDialog.
+Gets the value of %GTK_PRINT_SETTINGS_PRINT_PAGES.
-Since: 2.6
+Since: 2.10
</description>
<parameters>
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
+</parameter_description>
+</parameter>
</parameters>
-<return> a newly created #GtkAboutDialog
+<return> which pages to print
</return>
</function>
-<function name="gtk_window_group_list_windows">
+<function name="gtk_print_settings_get_printer">
<description>
-Returns a list of the #GtkWindows that belong to @window_group.
+Convenience function to obtain the value of
+%GTK_PRINT_SETTINGS_PRINTER.
-Since: 2.14
+Since: 2.10
</description>
<parameters>
-<parameter name="window_group">
-<parameter_description> a #GtkWindowGroup
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
</parameters>
-<return> A newly-allocated list of
-windows inside the group.
+<return> the printer name
</return>
</function>
-<function name="gtk_text_view_get_line_yrange">
+<function name="gtk_print_settings_get_printer_lpi">
<description>
-Gets the y coordinate of the top of the line containing @iter,
-and the height of the line. The coordinate is a buffer coordinate;
-convert to window coordinates with gtk_text_view_buffer_to_window_coords().
+Gets the value of %GTK_PRINT_SETTINGS_PRINTER_LPI.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> return location for a y coordinate
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> return location for a height
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the resolution in lpi (lines per inch)
+
+</return>
</function>
-<function name="gtk_entry_buffer_get_bytes">
+<function name="gtk_print_settings_get_quality">
<description>
-Retrieves the length in bytes of the buffer.
-See gtk_entry_buffer_get_length().
+Gets the value of %GTK_PRINT_SETTINGS_QUALITY.
-Since: 2.18
+Since: 2.10
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkEntryBuffer
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
</parameters>
-<return> The byte length of the buffer.
+<return> the print quality
</return>
</function>
-<function name="gtk_layout_set_hadjustment">
+<function name="gtk_print_settings_get_resolution">
<description>
-Sets the horizontal scroll adjustment for the layout.
-
-See #GtkScrolledWindow, #GtkScrollbar, #GtkAdjustment for details.
+Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION.
+Since: 2.10
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #GtkLayout
-</parameter_description>
-</parameter>
-<parameter name="adjustment">
-<parameter_description> new scroll adjustment
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the resolution in dpi
+
+</return>
</function>
-<function name="gtk_tree_view_column_pack_end">
+<function name="gtk_print_settings_get_resolution_x">
<description>
-Adds the @cell to end of the column. If @expand is %FALSE, then the @cell
-is allocated no more space than it needs. Any unused space is divided
-evenly between cells for which @expand is %TRUE.
+Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION_X.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn.
-</parameter_description>
-</parameter>
-<parameter name="cell">
-<parameter_description> The #GtkCellRenderer.
-</parameter_description>
-</parameter>
-<parameter name="expand">
-<parameter_description> %TRUE if @cell is to be given extra space allocated to @tree_column.
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the horizontal resolution in dpi
+
+</return>
</function>
-<function name="gtk_label_set_label">
+<function name="gtk_print_settings_get_resolution_y">
<description>
-Sets the text of the label. The label is interpreted as
-including embedded underlines and/or Pango markup depending
-on the values of the #GtkLabel:use-underline" and
-#GtkLabel:use-markup properties.
+Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION_Y.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
-</parameter_description>
-</parameter>
-<parameter name="str">
-<parameter_description> the new text to set for the label
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the vertical resolution in dpi
+
+</return>
</function>
-<function name="gtk_container_child_set">
+<function name="gtk_print_settings_get_reverse">
<description>
-Sets one or more child properties for @child and @container.
+Gets the value of %GTK_PRINT_SETTINGS_REVERSE.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
-</parameter_description>
-</parameter>
-<parameter name="child">
-<parameter_description> a widget which is a child of @container
-</parameter_description>
-</parameter>
-<parameter name="first_prop_name">
-<parameter_description> the name of the first property to set
-</parameter_description>
-</parameter>
-<parameter name="Varargs">
-<parameter_description> a %NULL-terminated list of property names and values, starting
-with @first_prop_name
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether to reverse the order of the printed pages
+
+</return>
</function>
-<function name="gtk_text_view_set_accepts_tab">
+<function name="gtk_print_settings_get_scale">
<description>
-Sets the behavior of the text widget when the Tab key is pressed.
-If @accepts_tab is %TRUE, a tab character is inserted. If @accepts_tab
-is %FALSE the keyboard focus is moved to the next widget in the focus
-chain.
+Gets the value of %GTK_PRINT_SETTINGS_SCALE.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> A #GtkTextView
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="accepts_tab">
-<parameter_description> %TRUE if pressing the Tab key should insert a tab
-character, %FALSE, if pressing the Tab key should move the
-keyboard focus.
+</parameters>
+<return> the scale in percent
+
+</return>
+</function>
+
+<function name="gtk_print_settings_get_use_color">
+<description>
+Gets the value of %GTK_PRINT_SETTINGS_USE_COLOR.
+
+Since: 2.10
+
+</description>
+<parameters>
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether to use color
+
+</return>
</function>
-<function name="gtk_recent_info_get_short_name">
+<function name="gtk_print_settings_has_key">
<description>
-Computes a valid UTF-8 string that can be used as the name of the item in a
-menu or list. For example, calling this function on an item that refers to
-"file:///foo/bar.txt" will yield "bar.txt".
+Returns %TRUE, if a value is associated with @key.
Since: 2.10
</description>
<parameters>
-<parameter name="info">
-<parameter_description> an #GtkRecentInfo
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
</parameter_description>
</parameter>
</parameters>
-<return> A newly-allocated string in UTF-8 encoding; free it with
-g_free().
+<return> %TRUE, if @key has a value
</return>
</function>
-<function name="gtk_accelerator_valid">
+<function name="gtk_print_settings_load_file">
<description>
-Determines whether a given keyval and modifier mask constitute
-a valid keyboard accelerator. For example, the #GDK_a keyval
-plus #GDK_CONTROL_MASK is valid - this is a "Ctrl+a" accelerator.
-But, you can't, for instance, use the #GDK_Control_L keyval
-as an accelerator.
+Reads the print settings from @file_name. If the file could not be loaded
+then error is set to either a #GFileError or #GKeyFileError.
+See gtk_print_settings_to_file().
+
+Since: 2.14
</description>
<parameters>
-<parameter name="keyval">
-<parameter_description> a GDK keyval
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="modifiers">
-<parameter_description> modifier mask
+<parameter name="file_name">
+<parameter_description> the filename to read the settings from
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for errors, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the accelerator is valid
+<return> %TRUE on success
+
</return>
</function>
-<function name="gtk_recent_chooser_set_sort_func">
+<function name="gtk_print_settings_load_key_file">
<description>
-Sets the comparison function used when sorting to be @sort_func. If
-the @chooser has the sort type set to #GTK_RECENT_SORT_CUSTOM then
-the chooser will sort using this function.
-
-To the comparison function will be passed two #GtkRecentInfo structs and
- sort_data; @sort_func should return a positive integer if the first
-item comes before the second, zero if the two items are equal and
-a negative integer if the first item comes after the second.
+Reads the print settings from the group @group_name in @key_file. If the
+file could not be loaded then error is set to either a #GFileError or
+#GKeyFileError.
-Since: 2.10
+Since: 2.14
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="sort_func">
-<parameter_description> the comparison function
+<parameter name="key_file">
+<parameter_description> the #GKeyFile to retrieve the settings from
</parameter_description>
</parameter>
-<parameter name="sort_data">
-<parameter_description> user data to pass to @sort_func, or %NULL
+<parameter name="group_name">
+<parameter_description> the name of the group to use, or %NULL to use the default
+"Print Settings"
</parameter_description>
</parameter>
-<parameter name="data_destroy">
-<parameter_description> destroy notifier for @sort_data, or %NULL
+<parameter name="error">
+<parameter_description> return location for errors, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE on success
+
+</return>
</function>
-<function name="gtk_accel_map_get">
+<function name="gtk_print_settings_new">
<description>
-Gets the singleton global #GtkAccelMap object. This object
-is useful only for notification of changes to the accelerator
-map via the ::changed signal; it isn't a parameter to the
-other accelerator map functions.
+Creates a new #GtkPrintSettings object.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
</parameters>
-<return> the global #GtkAccelMap object
+<return> a new #GtkPrintSettings object
</return>
</function>
-<function name="gtk_toolbar_prepend_element">
+<function name="gtk_print_settings_new_from_file">
<description>
-Adds a new element to the beginning of a toolbar.
-
-If @type == %GTK_TOOLBAR_CHILD_WIDGET, @widget is used as the new element.
-If @type == %GTK_TOOLBAR_CHILD_RADIOBUTTON, @widget is used to determine
-the radio group for the new element. In all other cases, @widget must
-be %NULL.
-
- callback must be a pointer to a function taking a #GtkWidget and a gpointer as
-arguments. Use G_CALLBACK() to cast the function to #GCallback.
+Reads the print settings from @file_name. Returns a new #GtkPrintSettings
+object with the restored settings, or %NULL if an error occurred. If the
+file could not be loaded then error is set to either a #GFileError or
+#GKeyFileError. See gtk_print_settings_to_file().
-Deprecated: 2.4: Use gtk_toolbar_insert() instead.
+Since: 2.12
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar.
-</parameter_description>
-</parameter>
-<parameter name="type">
-<parameter_description> a value of type #GtkToolbarChildType that determines what @widget will be.
-</parameter_description>
-</parameter>
-<parameter name="widget">
-<parameter_description> a #GtkWidget, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="text">
-<parameter_description> the element's label.
-</parameter_description>
-</parameter>
-<parameter name="tooltip_text">
-<parameter_description> the element's tooltip.
+<parameter name="file_name">
+<parameter_description> the filename to read the settings from
</parameter_description>
</parameter>
-<parameter name="tooltip_private_text">
-<parameter_description> used for context-sensitive help about this toolbar element.
+<parameter name="error">
+<parameter_description> return location for errors, or %NULL
</parameter_description>
</parameter>
-<parameter name="icon">
-<parameter_description> a #GtkWidget that provides pictorial representation of the element's function.
+</parameters>
+<return> the restored #GtkPrintSettings
+
+</return>
+</function>
+
+<function name="gtk_print_settings_new_from_key_file">
+<description>
+Reads the print settings from the group @group_name in @key_file. Returns a
+new #GtkPrintSettings object with the restored settings, or %NULL if an
+error occurred. If the file could not be loaded then error is set to either
+a #GFileError or #GKeyFileError.
+
+Since: 2.12
+
+</description>
+<parameters>
+<parameter name="key_file">
+<parameter_description> the #GKeyFile to retrieve the settings from
</parameter_description>
</parameter>
-<parameter name="callback">
-<parameter_description> the function to be executed when the button is pressed.
+<parameter name="group_name">
+<parameter_description> the name of the group to use, or %NULL to use
+the default "Print Settings"
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> any data you wish to pass to the callback.
+<parameter name="error">
+<parameter_description> return location for errors, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the new toolbar element as a #GtkWidget.
+<return> the restored #GtkPrintSettings
</return>
</function>
-<function name="gtk_print_unix_dialog_get_has_selection">
+<function name="gtk_print_settings_set">
<description>
-Gets the value of #GtkPrintUnixDialog::has-selection property.
+Associates @value with @key.
-Since: 2.18
+Since: 2.10
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> a string value, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> whether there is a selection
-
-</return>
+<return></return>
</function>
-<function name="gtk_tree_model_get_valist">
+<function name="gtk_print_settings_set_bool">
<description>
-See gtk_tree_model_get(), this version takes a <type>va_list</type>
-for language bindings to use.
+Sets @key to a boolean value.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="tree_model">
-<parameter_description> a #GtkTreeModel
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> a row in @tree_model
+<parameter name="key">
+<parameter_description> a key
</parameter_description>
</parameter>
-<parameter name="var_args">
-<parameter_description> <type>va_list</type> of column/return location pairs
+<parameter name="value">
+<parameter_description> a boolean
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_calendar_unmark_day">
+<function name="gtk_print_settings_set_collate">
<description>
-Removes the visual marker from a particular day.
-
-Note that this function always returns %TRUE, and you should
-ignore the return value. In GTK+ 3, this function will not
-return a value.
+Sets the value of %GTK_PRINT_SETTINGS_COLLATE.
+Since: 2.10
</description>
<parameters>
-<parameter name="calendar">
-<parameter_description> a #GtkCalendar.
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="day">
-<parameter_description> the day number to unmark between 1 and 31.
+<parameter name="collate">
+<parameter_description> whether to collate the output
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE, always
-</return>
+<return></return>
</function>
-<function name="gtk_label_set_markup_with_mnemonic">
+<function name="gtk_print_settings_set_default_source">
<description>
-Parses @str which is marked up with the <link linkend="PangoMarkupFormat">Pango text markup language</link>,
-setting the label's text and attribute list based on the parse results.
-If characters in @str are preceded by an underscore, they are underlined
-indicating that they represent a keyboard accelerator called a mnemonic.
+Sets the value of %GTK_PRINT_SETTINGS_DEFAULT_SOURCE.
-The mnemonic key can be used to activate another widget, chosen
-automatically, or explicitly using gtk_label_set_mnemonic_widget().
+Since: 2.10
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="str">
-<parameter_description> a markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>)
+<parameter name="default_source">
+<parameter_description> the default source
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_accel_map_lock_path">
+<function name="gtk_print_settings_set_dither">
<description>
-Locks the given accelerator path. If the accelerator map doesn't yet contain
-an entry for @accel_path, a new one is created.
-
-Locking an accelerator path prevents its accelerator from being changed
-during runtime. A locked accelerator path can be unlocked by
-gtk_accel_map_unlock_path(). Refer to gtk_accel_map_change_entry()
-for information about runtime accelerator changes.
-
-If called more than once, @accel_path remains locked until
-gtk_accel_map_unlock_path() has been called an equivalent number
-of times.
-
-Note that locking of individual accelerator paths is independent from
-locking the #GtkAccelGroup containing them. For runtime accelerator
-changes to be possible both the accelerator path and its #GtkAccelGroup
-have to be unlocked.
+Sets the value of %GTK_PRINT_SETTINGS_DITHER.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="accel_path">
-<parameter_description> a valid accelerator path
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
+</parameter_description>
+</parameter>
+<parameter name="dither">
+<parameter_description> the dithering that is used
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_about_dialog_set_url_hook">
+<function name="gtk_print_settings_set_double">
<description>
-Installs a global function to be called whenever the user activates a
-URL link in an about dialog.
-
-Since 2.18 there exists a default function which uses gtk_show_uri(). To
-deactivate it, you can pass %NULL for @func.
+Sets @key to a double value.
-Since: 2.6
+Since: 2.10
</description>
<parameters>
-<parameter name="func">
-<parameter_description> a function to call when a URL link is activated.
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to pass to @func
+<parameter name="key">
+<parameter_description> a key
</parameter_description>
</parameter>
-<parameter name="destroy">
-<parameter_description> #GDestroyNotify for @data
+<parameter name="value">
+<parameter_description> a double value
</parameter_description>
</parameter>
</parameters>
-<return> the previous URL hook.
-
-</return>
+<return></return>
</function>
-<function name="gtk_builder_get_object">
+<function name="gtk_print_settings_set_duplex">
<description>
-Gets the object named @name. Note that this function does not
-increment the reference count of the returned object.
+Sets the value of %GTK_PRINT_SETTINGS_DUPLEX.
-Since: 2.12
+Since: 2.10
</description>
<parameters>
-<parameter name="builder">
-<parameter_description> a #GtkBuilder
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="name">
-<parameter_description> name of object to get
+<parameter name="duplex">
+<parameter_description> a #GtkPrintDuplex value
</parameter_description>
</parameter>
</parameters>
-<return> the object named @name or %NULL if
-it could not be found in the object tree.
-
-</return>
+<return></return>
</function>
-<function name="gtk_status_icon_get_stock">
+<function name="gtk_print_settings_set_finishings">
<description>
-Gets the id of the stock icon being displayed by the #GtkStatusIcon.
-The storage type of the status icon must be %GTK_IMAGE_EMPTY or
-%GTK_IMAGE_STOCK (see gtk_status_icon_get_storage_type()).
-The returned string is owned by the #GtkStatusIcon and should not
-be freed or modified.
+Sets the value of %GTK_PRINT_SETTINGS_FINISHINGS.
Since: 2.10
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
+</parameter_description>
+</parameter>
+<parameter name="finishings">
+<parameter_description> the finishings
</parameter_description>
</parameter>
</parameters>
-<return> stock id of the displayed stock icon,
-or %NULL if the image is empty.
-
-</return>
+<return></return>
</function>
-<function name="gtk_paper_size_get_paper_sizes">
+<function name="gtk_print_settings_set_int">
<description>
-Creates a list of known paper sizes.
+Sets @key to an integer value.
-Since: 2.12
+Since: 2.10
</description>
<parameters>
-<parameter name="include_custom">
-<parameter_description> whether to include custom paper sizes
-as defined in the page setup dialog
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
+</parameter_description>
+</parameter>
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> an integer
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated list of newly
-allocated #GtkPaperSize objects
-
-</return>
+<return></return>
</function>
-<function name="gtk_tool_button_set_use_underline">
+<function name="gtk_print_settings_set_length">
<description>
-If set, an underline in the label property indicates that the next character
-should be used for the mnemonic accelerator key in the overflow menu. For
-example, if the label property is "_Open" and @use_underline is %TRUE,
-the label on the tool button will be "Open" and the item on the overflow
-menu will have an underlined 'O'.
-
-Labels shown on tool buttons never have mnemonics on them; this property
-only affects the menu item on the overflow menu.
+Associates a length in units of @unit with @key.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkToolButton
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="use_underline">
-<parameter_description> whether the button label has the form "_Open"
+<parameter name="key">
+<parameter_description> a key
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> a length
+</parameter_description>
+</parameter>
+<parameter name="unit">
+<parameter_description> the unit of @length
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_drag_dest_add_image_targets">
+<function name="gtk_print_settings_set_media_type">
<description>
-Add the image targets supported by #GtkSelection to
-the target list of the drag destination. The targets
-are added with @info = 0. If you need another value,
-use gtk_target_list_add_image_targets() and
-gtk_drag_dest_set_target_list().
+Sets the value of %GTK_PRINT_SETTINGS_MEDIA_TYPE.
-Since: 2.6
+The set of media types is defined in PWG 5101.1-2002 PWG.
+<!-- FIXME link here -->
+
+Since: 2.10
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget that's a drag destination
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
+</parameter_description>
+</parameter>
+<parameter name="media_type">
+<parameter_description> the media type
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_remove_mnemonic_label">
+<function name="gtk_print_settings_set_n_copies">
<description>
-Removes a widget from the list of mnemonic labels for
-this widget. (See gtk_widget_list_mnemonic_labels()). The widget
-must have previously been added to the list with
-gtk_widget_add_mnemonic_label().
+Sets the value of %GTK_PRINT_SETTINGS_N_COPIES.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="label">
-<parameter_description> a #GtkWidget that was previously set as a mnemnic label for
- widget with gtk_widget_add_mnemonic_label().
+<parameter name="num_copies">
+<parameter_description> the number of copies
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_drag_source_add_uri_targets">
+<function name="gtk_print_settings_set_number_up">
<description>
-Add the URI targets supported by #GtkSelection to
-the target list of the drag source. The targets
-are added with @info = 0. If you need another value,
-use gtk_target_list_add_uri_targets() and
-gtk_drag_source_set_target_list().
+Sets the value of %GTK_PRINT_SETTINGS_NUMBER_UP.
-Since: 2.6
+Since: 2.10
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget that's is a drag source
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
+</parameter_description>
+</parameter>
+<parameter name="number_up">
+<parameter_description> the number of pages per sheet
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_container_child_get">
+<function name="gtk_print_settings_set_number_up_layout">
<description>
-Gets the values of one or more child properties for @child and @container.
+Sets the value of %GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="child">
-<parameter_description> a widget which is a child of @container
+<parameter name="number_up_layout">
+<parameter_description> a #GtkNumberUpLayout value
</parameter_description>
</parameter>
-<parameter name="first_prop_name">
-<parameter_description> the name of the first property to get
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_print_settings_set_orientation">
+<description>
+Sets the value of %GTK_PRINT_SETTINGS_ORIENTATION.
+
+Since: 2.10
+
+</description>
+<parameters>
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> return location for the first property, followed
-optionally by more name/return location pairs, followed by %NULL
+<parameter name="orientation">
+<parameter_description> a page orientation
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_button_set_use_underline">
+<function name="gtk_print_settings_set_output_bin">
<description>
-If true, an underline in the text of the button label indicates
-the next character should be used for the mnemonic accelerator key.
+Sets the value of %GTK_PRINT_SETTINGS_OUTPUT_BIN.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkButton
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="use_underline">
-<parameter_description> %TRUE if underlines in the text indicate mnemonics
+<parameter name="output_bin">
+<parameter_description> the output bin
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_box_reorder_child">
+<function name="gtk_print_settings_set_page_ranges">
<description>
-Moves @child to a new @position in the list of @box children.
-The list is the <structfield>children</structfield> field of
-#GtkBox-struct, and contains both widgets packed #GTK_PACK_START
-as well as widgets packed #GTK_PACK_END, in the order that these
-widgets were added to @box.
+Sets the value of %GTK_PRINT_SETTINGS_PAGE_RANGES.
-A widget's position in the @box children list determines where
-the widget is packed into @box. A child widget at some position
-in the list will be packed just after all other widgets of the
-same packing type that appear earlier in the list.
+Since: 2.10
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #GtkBox
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="child">
-<parameter_description> the #GtkWidget to move
+<parameter name="page_ranges">
+<parameter_description> an array of #GtkPageRange<!-- -->s
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> the new position for @child in the list of children
-of @box, starting from 0. If negative, indicates the end of
-the list
+<parameter name="num_ranges">
+<parameter_description> the length of @page_ranges
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_font_button_get_show_style">
+<function name="gtk_print_settings_set_page_set">
<description>
-Returns whether the name of the font style will be shown in the label.
+Sets the value of %GTK_PRINT_SETTINGS_PAGE_SET.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="font_button">
-<parameter_description> a #GtkFontButton
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
+</parameter_description>
+</parameter>
+<parameter name="page_set">
+<parameter_description> a #GtkPageSet value
</parameter_description>
</parameter>
</parameters>
-<return> whether the font style will be shown in the label.
-
-</return>
+<return></return>
</function>
-<function name="gtk_recent_manager_new">
+<function name="gtk_print_settings_set_paper_height">
<description>
-Creates a new recent manager object. Recent manager objects are used to
-handle the list of recently used resources. A #GtkRecentManager object
-monitors the recently used resources list, and emits the "changed" signal
-each time something inside the list changes.
-
-#GtkRecentManager objects are expensive: be sure to create them only when
-needed. You should use gtk_recent_manager_get_default() instead.
+Sets the value of %GTK_PRINT_SETTINGS_PAPER_HEIGHT.
Since: 2.10
</description>
<parameters>
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> the paper height
+</parameter_description>
+</parameter>
+<parameter name="unit">
+<parameter_description> the units of @height
+</parameter_description>
+</parameter>
</parameters>
-<return> A newly created #GtkRecentManager object.
-
-</return>
+<return></return>
</function>
-<function name="gtk_tree_path_new_from_indices">
+<function name="gtk_print_settings_set_paper_size">
<description>
-Creates a new path with @first_index and @varargs as indices.
+Sets the value of %GTK_PRINT_SETTINGS_PAPER_FORMAT,
+%GTK_PRINT_SETTINGS_PAPER_WIDTH and
+%GTK_PRINT_SETTINGS_PAPER_HEIGHT.
-Since: 2.2
+Since: 2.10
</description>
<parameters>
-<parameter name="first_index">
-<parameter_description> first integer
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="varargs">
-<parameter_description> list of integers terminated by -1
+<parameter name="paper_size">
+<parameter_description> a paper size
</parameter_description>
</parameter>
</parameters>
-<return> A newly created #GtkTreePath.
-
-</return>
+<return></return>
</function>
-<function name="gtk_text_tag_event">
+<function name="gtk_print_settings_set_paper_width">
<description>
-Emits the "event" signal on the #GtkTextTag.
+Sets the value of %GTK_PRINT_SETTINGS_PAPER_WIDTH.
+Since: 2.10
</description>
<parameters>
-<parameter name="tag">
-<parameter_description> a #GtkTextTag
-</parameter_description>
-</parameter>
-<parameter name="event_object">
-<parameter_description> object that received the event, such as a widget
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="event">
-<parameter_description> the event
+<parameter name="width">
+<parameter_description> the paper width
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> location where the event was received
+<parameter name="unit">
+<parameter_description> the units of @width
</parameter_description>
</parameter>
</parameters>
-<return> result of signal emission (whether the event was handled)
-</return>
+<return></return>
</function>
-<function name="gtk_text_buffer_create_mark">
+<function name="gtk_print_settings_set_print_pages">
<description>
-Creates a mark at position @where. If @mark_name is %NULL, the mark
-is anonymous; otherwise, the mark can be retrieved by name using
-gtk_text_buffer_get_mark(). If a mark has left gravity, and text is
-inserted at the mark's current location, the mark will be moved to
-the left of the newly-inserted text. If the mark has right gravity
-(@left_gravity = %FALSE), the mark will end up on the right of
-newly-inserted text. The standard left-to-right cursor is a mark
-with right gravity (when you type, the cursor stays on the right
-side of the text you're typing).
-
-The caller of this function does <emphasis>not</emphasis> own a
-reference to the returned #GtkTextMark, so you can ignore the
-return value if you like. Marks are owned by the buffer and go
-away when the buffer does.
-
-Emits the "mark-set" signal as notification of the mark's initial
-placement.
+Sets the value of %GTK_PRINT_SETTINGS_PRINT_PAGES.
+Since: 2.10
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="mark_name">
-<parameter_description> name for mark, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="where">
-<parameter_description> location to place mark
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="left_gravity">
-<parameter_description> whether the mark has left gravity
+<parameter name="pages">
+<parameter_description> a #GtkPrintPages value
</parameter_description>
</parameter>
</parameters>
-<return> the new #GtkTextMark object
-</return>
+<return></return>
</function>
-<function name="gtk_frame_set_label_align">
+<function name="gtk_print_settings_set_printer">
<description>
-Sets the alignment of the frame widget's label. The
-default values for a newly created frame are 0.0 and 0.5.
+Convenience function to set %GTK_PRINT_SETTINGS_PRINTER
+to @printer.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="frame">
-<parameter_description> a #GtkFrame
-</parameter_description>
-</parameter>
-<parameter name="xalign">
-<parameter_description> The position of the label along the top edge
-of the widget. A value of 0.0 represents left alignment;
-1.0 represents right alignment.
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="yalign">
-<parameter_description> The y alignment of the label. A value of 0.0 aligns under
-the frame; 1.0 aligns above the frame. If the values are exactly
-0.0 or 1.0 the gap in the frame won't be painted because the label
-will be completely above or below the frame.
+<parameter name="printer">
+<parameter_description> the printer name
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_settings_get_number_up_layout">
+<function name="gtk_print_settings_set_printer_lpi">
<description>
-Gets the value of %GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT.
+Sets the value of %GTK_PRINT_SETTINGS_PRINTER_LPI.
-Since: 2.14
+Since: 2.16
</description>
<parameters>
@@ -35839,76 +36205,85 @@ Since: 2.14
<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
+<parameter name="lpi">
+<parameter_description> the resolution in lpi (lines per inch)
+</parameter_description>
+</parameter>
</parameters>
-<return> layout of page in number-up mode
-
-</return>
+<return></return>
</function>
-<function name="gtk_check_menu_item_get_inconsistent">
+<function name="gtk_print_settings_set_quality">
<description>
-Retrieves the value set by gtk_check_menu_item_set_inconsistent().
+Sets the value of %GTK_PRINT_SETTINGS_QUALITY.
+Since: 2.10
</description>
<parameters>
-<parameter name="check_menu_item">
-<parameter_description> a #GtkCheckMenuItem
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
+</parameter_description>
+</parameter>
+<parameter name="quality">
+<parameter_description> a #GtkPrintQuality value
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if inconsistent
-</return>
+<return></return>
</function>
-<function name="gtk_spin_button_get_snap_to_ticks">
+<function name="gtk_print_settings_set_resolution">
<description>
-Returns whether the values are corrected to the nearest step. See
-gtk_spin_button_set_snap_to_ticks().
+Sets the values of %GTK_PRINT_SETTINGS_RESOLUTION,
+%GTK_PRINT_SETTINGS_RESOLUTION_X and
+%GTK_PRINT_SETTINGS_RESOLUTION_Y.
+Since: 2.10
</description>
<parameters>
-<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
+</parameter_description>
+</parameter>
+<parameter name="resolution">
+<parameter_description> the resolution in dpi
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if values are snapped to the nearest step.
-</return>
+<return></return>
</function>
-<function name="gtk_window_iconify">
+<function name="gtk_print_settings_set_resolution_xy">
<description>
-Asks to iconify (i.e. minimize) the specified @window. Note that
-you shouldn't assume the window is definitely iconified afterward,
-because other entities (e.g. the user or <link
-linkend="gtk-X11-arch">window manager</link>) could deiconify it
-again, or there may not be a window manager in which case
-iconification isn't possible, etc. But normally the window will end
-up iconified. Just don't write code that crashes if not.
-
-It's permitted to call this function before showing a window,
-in which case the window will be iconified before it ever appears
-onscreen.
-
-You can track iconification via the "window-state-event" signal
-on #GtkWidget.
+Sets the values of %GTK_PRINT_SETTINGS_RESOLUTION,
+%GTK_PRINT_SETTINGS_RESOLUTION_X and
+%GTK_PRINT_SETTINGS_RESOLUTION_Y.
+Since: 2.16
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
+</parameter_description>
+</parameter>
+<parameter name="resolution_x">
+<parameter_description> the horizontal resolution in dpi
+</parameter_description>
+</parameter>
+<parameter name="resolution_y">
+<parameter_description> the vertical resolution in dpi
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_settings_get_reverse">
+<function name="gtk_print_settings_set_reverse">
<description>
-Gets the value of %GTK_PRINT_SETTINGS_REVERSE.
+Sets the value of %GTK_PRINT_SETTINGS_REVERSE.
Since: 2.10
@@ -35918,402 +36293,394 @@ Since: 2.10
<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
+<parameter name="reverse">
+<parameter_description> whether to reverse the output
+</parameter_description>
+</parameter>
</parameters>
-<return> whether to reverse the order of the printed pages
-
-</return>
+<return></return>
</function>
-<function name="gtk_text_view_set_buffer">
+<function name="gtk_print_settings_set_scale">
<description>
-Sets @buffer as the buffer being displayed by @text_view. The previous
-buffer displayed by the text view is unreferenced, and a reference is
-added to @buffer. If you owned a reference to @buffer before passing it
-to this function, you must remove that reference yourself; #GtkTextView
-will not "adopt" it.
+Sets the value of %GTK_PRINT_SETTINGS_SCALE.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="scale">
+<parameter_description> the scale in percent
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_row_reference_reordered">
+<function name="gtk_print_settings_set_use_color">
<description>
-Lets a set of row reference created by gtk_tree_row_reference_new_proxy()
-know that the model emitted the "rows_reordered" signal.
+Sets the value of %GTK_PRINT_SETTINGS_USE_COLOR.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="proxy">
-<parameter_description> A #GObject
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> The parent path of the reordered signal
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> The iter pointing to the parent of the reordered
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="new_order">
-<parameter_description> The new order of rows
+<parameter name="use_color">
+<parameter_description> whether to use color
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_color_selection_set_change_palette_with_screen_hook">
+<function name="gtk_print_settings_to_file">
<description>
-Installs a global function to be called whenever the user tries to
-modify the palette in a color selection. This function should save
-the new palette contents, and update the GtkSettings property
-"gtk-color-palette" so all GtkColorSelection widgets will be modified.
+This function saves the print settings from @settings to @file_name. If the
+file could not be loaded then error is set to either a #GFileError or
+#GKeyFileError.
-Since: 2.2
+Since: 2.12
</description>
<parameters>
-<parameter name="func">
-<parameter_description> a function to call when the custom palette needs saving.
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
+</parameter_description>
+</parameter>
+<parameter name="file_name">
+<parameter_description> the file to save to
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for errors, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the previous change palette hook (that was replaced).
+<return> %TRUE on success
</return>
</function>
-<function name="gtk_tree_selection_selected_foreach">
+<function name="gtk_print_settings_to_key_file">
<description>
-Calls a function for each selected node. Note that you cannot modify
-the tree or selection from within this function. As a result,
-gtk_tree_selection_get_selected_rows() might be more useful.
+This function adds the print settings from @settings to @key_file.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="selection">
-<parameter_description> A #GtkTreeSelection.
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> The function to call for each selected node.
+<parameter name="key_file">
+<parameter_description> the #GKeyFile to save the print settings to
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> user data to pass to the function.
+<parameter name="group_name">
+<parameter_description> the group to add the settings to in @key_file, or
+%NULL to use the default "Print Settings"
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_color_selection_get_current_color">
+<function name="gtk_print_settings_unset">
<description>
-Sets @color to be the current color in the GtkColorSelection widget.
+Removes any value associated with @key.
+This has the same effect as setting the value to %NULL.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="colorsel">
-<parameter_description> a #GtkColorSelection.
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> a #GdkColor to fill in with the current color.
+<parameter name="key">
+<parameter_description> a key
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_editable_get_editable">
+<function name="gtk_print_unix_dialog_add_custom_tab">
<description>
-Retrieves whether @editable is editable. See
-gtk_editable_set_editable().
+Adds a custom tab to the print dialog.
+Since: 2.10
</description>
<parameters>
-<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter name="dialog">
+<parameter_description> a #GtkPrintUnixDialog
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> the widget to put in the custom tab
+</parameter_description>
+</parameter>
+<parameter name="tab_label">
+<parameter_description> the widget to use as tab label
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @editable is editable.
-</return>
+<return></return>
</function>
-<function name="gtk_widget_can_activate_accel">
+<function name="gtk_print_unix_dialog_get_current_page">
<description>
-Determines whether an accelerator that activates the signal
-identified by @signal_id can currently be activated.
-This is done by emitting the #GtkWidget::can-activate-accel
-signal on @widget; if the signal isn't overridden by a
-handler or in a derived widget, then the default check is
-that the widget must be sensitive, and the widget and all
-its ancestors mapped.
+Gets the current page of the #GtkPrintDialog.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="signal_id">
-<parameter_description> the ID of a signal installed on @widget
+<parameter name="dialog">
+<parameter_description> a #GtkPrintUnixDialog
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the accelerator can be activated.
+<return> the current page of @dialog
</return>
</function>
-<function name="gtk_tree_path_new_first">
+<function name="gtk_print_unix_dialog_get_embed_page_setup">
<description>
-Creates a new #GtkTreePath. The string representation of this path is "0"
+Gets the value of #GtkPrintUnixDialog::embed-page-setup property.
+Since: 2.18
</description>
<parameters>
+<parameter name="dialog">
+<parameter_description> a #GtkPrintUnixDialog
+</parameter_description>
+</parameter>
</parameters>
-<return> A new #GtkTreePath.
+<return> whether there is a selection
+
</return>
</function>
-<function name="gtk_widget_class_install_style_property">
+<function name="gtk_print_unix_dialog_get_has_selection">
<description>
-Installs a style property on a widget class. The parser for the
-style property is determined by the value type of @pspec.
+Gets the value of #GtkPrintUnixDialog::has-selection property.
+
+Since: 2.18
</description>
<parameters>
-<parameter name="klass">
-<parameter_description> a #GtkWidgetClass
-</parameter_description>
-</parameter>
-<parameter name="pspec">
-<parameter_description> the #GParamSpec for the property
+<parameter name="dialog">
+<parameter_description> a #GtkPrintUnixDialog
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether there is a selection
+
+</return>
</function>
-<function name="gtk_tree_path_to_string">
+<function name="gtk_print_unix_dialog_get_manual_capabilities">
<description>
-Generates a string representation of the path. This string is a ':'
-separated list of numbers. For example, "4:10:0:3" would be an acceptable return value for this string.
+Gets the value of #GtkPrintUnixDialog::manual-capabilities property.
+Since: 2.18
</description>
<parameters>
-<parameter name="path">
-<parameter_description> A #GtkTreePath
+<parameter name="dialog">
+<parameter_description> a #GtkPrintUnixDialog
</parameter_description>
</parameter>
</parameters>
-<return> A newly-allocated string. Must be freed with g_free().
+<return> the printing capabilities
+
</return>
</function>
-<function name="gtk_drag_set_default_icon">
+<function name="gtk_print_unix_dialog_get_page_setup">
<description>
-Changes the default drag icon. GTK+ retains references for the
-arguments, and will release them when they are no longer needed.
+Gets the page setup that is used by the #GtkPrintUnixDialog.
-Deprecated: Change the default drag icon via the stock system by
-changing the stock pixbuf for #GTK_STOCK_DND instead.
+Since: 2.10
</description>
<parameters>
-<parameter name="colormap">
-<parameter_description> the colormap of the icon
-</parameter_description>
-</parameter>
-<parameter name="pixmap">
-<parameter_description> the image data for the icon
-</parameter_description>
-</parameter>
-<parameter name="mask">
-<parameter_description> the transparency mask for an image, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="hot_x">
-<parameter_description> The X offset within @widget of the hotspot.
-</parameter_description>
-</parameter>
-<parameter name="hot_y">
-<parameter_description> The Y offset within @widget of the hotspot.
+<parameter name="dialog">
+<parameter_description> a #GtkPrintUnixDialog
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the page setup of @dialog.
+
+</return>
</function>
-<function name="gtk_tree_model_row_inserted">
+<function name="gtk_print_unix_dialog_get_page_setup_set">
<description>
-Emits the "row-inserted" signal on @tree_model
+Gets the page setup that is used by the #GtkPrintUnixDialog.
+
+Since: 2.18
</description>
<parameters>
-<parameter name="tree_model">
-<parameter_description> A #GtkTreeModel
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> A #GtkTreePath pointing to the inserted row
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> A valid #GtkTreeIter pointing to the inserted row
+<parameter name="dialog">
+<parameter_description> a #GtkPrintUnixDialog
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether a page setup was set by user.
+
+</return>
</function>
-<function name="gtk_combo_box_get_active">
+<function name="gtk_print_unix_dialog_get_selected_printer">
<description>
-Returns the index of the currently active item, or -1 if there's no
-active item. If the model is a non-flat treemodel, and the active item
-is not an immediate child of the root of the tree, this function returns
-<literal>gtk_tree_path_get_indices (path)[0]</literal>, where
-<literal>path</literal> is the #GtkTreePath of the active item.
+Gets the currently selected printer.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="combo_box">
-<parameter_description> A #GtkComboBox
+<parameter name="dialog">
+<parameter_description> a #GtkPrintUnixDialog
</parameter_description>
</parameter>
</parameters>
-<return> An integer which is the index of the currently active item,
-or -1 if there's no active item.
+<return> the currently selected printer
</return>
</function>
-<function name="gtk_widget_has_default">
+<function name="gtk_print_unix_dialog_get_settings">
<description>
-Determines whether @widget is the current default widget within its
-toplevel. See gtk_widget_set_can_default().
+Gets a new #GtkPrintSettings object that represents the
+current values in the print dialog. Note that this creates a
+<emphasis>new object</emphasis>, and you need to unref it
+if don't want to keep it.
-Since: 2.18
+Since: 2.10
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="dialog">
+<parameter_description> a #GtkPrintUnixDialog
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @widget is the current default widget within
-its toplevel, %FALSE otherwise
+<return> a new #GtkPrintSettings object with the values from @dialog
</return>
</function>
-<function name="gtk_recent_chooser_get_sort_type">
+<function name="gtk_print_unix_dialog_get_support_selection">
<description>
-Gets the value set by gtk_recent_chooser_set_sort_type().
+Gets the value of #GtkPrintUnixDialog::support-selection property.
-Since: 2.10
+Since: 2.18
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
+<parameter name="dialog">
+<parameter_description> a #GtkPrintUnixDialog
</parameter_description>
</parameter>
</parameters>
-<return> the sorting order of the @chooser.
+<return> whether the application supports print of selection
</return>
</function>
-<function name="gtk_toolbar_append_element">
+<function name="gtk_print_unix_dialog_new">
<description>
-Adds a new element to the end of a toolbar.
-
-If @type == %GTK_TOOLBAR_CHILD_WIDGET, @widget is used as the new element.
-If @type == %GTK_TOOLBAR_CHILD_RADIOBUTTON, @widget is used to determine
-the radio group for the new element. In all other cases, @widget must
-be %NULL.
-
- callback must be a pointer to a function taking a #GtkWidget and a gpointer as
-arguments. Use G_CALLBACK() to cast the function to #GCallback.
+Creates a new #GtkPrintUnixDialog.
-Deprecated: 2.4: Use gtk_toolbar_insert() instead.
+Since: 2.10
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar.
-</parameter_description>
-</parameter>
-<parameter name="type">
-<parameter_description> a value of type #GtkToolbarChildType that determines what @widget will be.
-</parameter_description>
-</parameter>
-<parameter name="widget">
-<parameter_description> a #GtkWidget, or %NULL.
-</parameter_description>
-</parameter>
-<parameter name="text">
-<parameter_description> the element's label.
+<parameter name="title">
+<parameter_description> Title of the dialog, or %NULL
</parameter_description>
</parameter>
-<parameter name="tooltip_text">
-<parameter_description> the element's tooltip.
+<parameter name="parent">
+<parameter_description> Transient parent of the dialog, or %NULL
</parameter_description>
</parameter>
-<parameter name="tooltip_private_text">
-<parameter_description> used for context-sensitive help about this toolbar element.
+</parameters>
+<return> a new #GtkPrintUnixDialog
+
+</return>
+</function>
+
+<function name="gtk_print_unix_dialog_set_current_page">
+<description>
+Sets the current page number. If @current_page is not -1, this enables
+the current page choice for the range of pages to print.
+
+Since: 2.10
+
+</description>
+<parameters>
+<parameter name="dialog">
+<parameter_description> a #GtkPrintUnixDialog
</parameter_description>
</parameter>
-<parameter name="icon">
-<parameter_description> a #GtkWidget that provides pictorial representation of the element's function.
+<parameter name="current_page">
+<parameter_description> the current page number.
</parameter_description>
</parameter>
-<parameter name="callback">
-<parameter_description> the function to be executed when the button is pressed.
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_print_unix_dialog_set_embed_page_setup">
+<description>
+Embed page size combo box and orientation combo box into page setup page.
+
+Since: 2.18
+
+</description>
+<parameters>
+<parameter name="dialog">
+<parameter_description> a #GtkPrintUnixDialog
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> any data you wish to pass to the callback.
+<parameter name="embed">
+<parameter_description> embed page setup selection
</parameter_description>
</parameter>
</parameters>
-<return> the new toolbar element as a #GtkWidget.
-
-</return>
+<return></return>
</function>
-<function name="gtk_widget_set_default_direction">
+<function name="gtk_print_unix_dialog_set_has_selection">
<description>
-Sets the default reading direction for widgets where the
-direction has not been explicitly set by gtk_widget_set_direction().
+Sets whether a selection exists.
+
+Since: 2.18
</description>
<parameters>
-<parameter name="dir">
-<parameter_description> the new default direction. This cannot be
-%GTK_TEXT_DIR_NONE.
+<parameter name="dialog">
+<parameter_description> a #GtkPrintUnixDialog
+</parameter_description>
+</parameter>
+<parameter name="has_selection">
+<parameter_description> %TRUE indicates that a selection exists
</parameter_description>
</parameter>
</parameters>
@@ -36344,8161 +36711,8715 @@ Since: 2.10
<return></return>
</function>
-<function name="gtk_viewport_get_hadjustment">
+<function name="gtk_print_unix_dialog_set_page_setup">
<description>
-Returns the horizontal adjustment of the viewport.
+Sets the page setup of the #GtkPrintUnixDialog.
+Since: 2.10
</description>
<parameters>
-<parameter name="viewport">
-<parameter_description> a #GtkViewport.
+<parameter name="dialog">
+<parameter_description> a #GtkPrintUnixDialog
+</parameter_description>
+</parameter>
+<parameter name="page_setup">
+<parameter_description> a #GtkPageSetup
</parameter_description>
</parameter>
</parameters>
-<return> the horizontal adjustment of @viewport.
-</return>
+<return></return>
</function>
-<function name="gtk_icon_theme_set_search_path">
+<function name="gtk_print_unix_dialog_set_settings">
<description>
-Sets the search path for the icon theme object. When looking
-for an icon theme, GTK+ will search for a subdirectory of
-one or more of the directories in @path with the same name
-as the icon theme. (Themes from multiple of the path elements
-are combined to allow themes to be extended by adding icons
-in the user's home directory.)
-
-In addition if an icon found isn't found either in the current
-icon theme or the default icon theme, and an image file with
-the right name is found directly in one of the elements of
- path, then that image will be used for the icon name.
-(This is legacy feature, and new icons should be put
-into the default icon theme, which is called DEFAULT_THEME_NAME,
-rather than directly on the icon path.)
+Sets the #GtkPrintSettings for the #GtkPrintUnixDialog. Typically,
+this is used to restore saved print settings from a previous print
+operation before the print dialog is shown.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="icon_theme">
-<parameter_description> a #GtkIconTheme
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> array of directories that are searched for icon themes
+<parameter name="dialog">
+<parameter_description> a #GtkPrintUnixDialog
</parameter_description>
</parameter>
-<parameter name="n_elements">
-<parameter_description> number of elements in @path.
+<parameter name="settings">
+<parameter_description> a #GtkPrintSettings, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_paper_size_get_default_left_margin">
+<function name="gtk_print_unix_dialog_set_support_selection">
<description>
-Gets the default left margin for the #GtkPaperSize.
+Sets whether the print dialog allows user to print a selection.
-Since: 2.10
+Since: 2.18
</description>
<parameters>
-<parameter name="size">
-<parameter_description> a #GtkPaperSize object
+<parameter name="dialog">
+<parameter_description> a #GtkPrintUnixDialog
</parameter_description>
</parameter>
-<parameter name="unit">
-<parameter_description> the unit for the return value
+<parameter name="support_selection">
+<parameter_description> %TRUE to allow print selection
</parameter_description>
</parameter>
</parameters>
-<return> the default left margin
-
-</return>
+<return></return>
</function>
-<function name="gtk_text_iter_is_end">
+<function name="gtk_printer_accepts_pdf">
<description>
-Returns %TRUE if @iter is the end iterator, i.e. one past the last
-dereferenceable iterator in the buffer. gtk_text_iter_is_end () is
-the most efficient way to check whether an iterator is the end
-iterator.
+Returns whether the printer accepts input in
+PDF format.
+Since: 2.10
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
+<parameter name="printer">
+<parameter_description> a #GtkPrinter
</parameter_description>
</parameter>
</parameters>
-<return> whether @iter is the end iterator
+<return> %TRUE if @printer accepts PDF
+
</return>
</function>
-<function name="gtk_stock_lookup">
+<function name="gtk_printer_accepts_ps">
<description>
-Fills @item with the registered values for @stock_id, returning %TRUE
-if @stock_id was known.
-
+Returns whether the printer accepts input in
+PostScript format.
+Since: 2.10
</description>
<parameters>
-<parameter name="stock_id">
-<parameter_description> a stock item name
-</parameter_description>
-</parameter>
-<parameter name="item">
-<parameter_description> stock item to initialize with values
+<parameter name="printer">
+<parameter_description> a #GtkPrinter
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @item was initialized
+<return> %TRUE if @printer accepts PostScript
+
</return>
</function>
-<function name="gtk_menu_item_new_with_mnemonic">
+<function name="gtk_printer_backend_load_modules">
<description>
-Creates a new #GtkMenuItem containing a label. The label
-will be created using gtk_label_new_with_mnemonic(), so underscores
-in @label indicate the mnemonic for the menu item.
</description>
<parameters>
-<parameter name="label">
-<parameter_description> The text of the button, with an underscore in front of the
-mnemonic character
-</parameter_description>
-</parameter>
</parameters>
-<return> a new #GtkMenuItem
+<return>
</return>
</function>
-<function name="gtk_progress_bar_set_orientation">
+<function name="gtk_printer_compare">
<description>
-Causes the progress bar to switch to a different orientation
-(left-to-right, right-to-left, top-to-bottom, or bottom-to-top).
+Compares two printers.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="pbar">
-<parameter_description> a #GtkProgressBar
+<parameter name="a">
+<parameter_description> a #GtkPrinter
</parameter_description>
</parameter>
-<parameter name="orientation">
-<parameter_description> orientation of the progress bar
+<parameter name="b">
+<parameter_description> another #GtkPrinter
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> 0 if the printer match, a negative value if @a < @b,
+or a positive value if @a > @b
+
+</return>
</function>
-<function name="gtk_recent_info_get_private_hint">
+<function name="gtk_printer_get_backend">
<description>
-Gets the value of the "private" flag. Resources in the recently used
-list that have this flag set to %TRUE should only be displayed by the
-applications that have registered them.
+Returns the backend of the printer.
Since: 2.10
</description>
<parameters>
-<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter name="printer">
+<parameter_description> a #GtkPrinter
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the private flag was found, %FALSE otherwise.
+<return> the backend of @printer
</return>
</function>
-<function name="gtk_volume_button_new">
+<function name="gtk_printer_get_capabilities">
<description>
-Creates a #GtkVolumeButton, with a range between 0.0 and 1.0, with
-a stepping of 0.02. Volume values can be obtained and modified using
-the functions from #GtkScaleButton.
+Returns the printer's capabilities.
+
+This is useful when you're using #GtkPrintUnixDialog's manual-capabilities
+setting and need to know which settings the printer can handle and which
+you must handle yourself.
+
+This will return 0 unless the printer's details are available, see
+gtk_printer_has_details() and gtk_printer_request_details().
Since: 2.12
</description>
<parameters>
+<parameter name="printer">
+<parameter_description> a #GtkPrinter
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GtkVolumeButton
+<return> the printer's capabilities
</return>
</function>
-<function name="gtk_calendar_clear_marks">
+<function name="gtk_printer_get_default_page_size">
<description>
-Remove all visual markers.
+Returns default page size of @printer.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="calendar">
-<parameter_description> a #GtkCalendar
+<parameter name="printer">
+<parameter_description> a #GtkPrinter
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a newly allocated #GtkPageSetup with default page size of the printer.
+
+</return>
</function>
-<function name="gtk_recent_action_new_for_manager">
+<function name="gtk_printer_get_description">
<description>
-Creates a new #GtkRecentAction object. To add the action to
-a #GtkActionGroup and set the accelerator for the action,
-call gtk_action_group_add_action_with_accel().
+Gets the description of the printer.
-Since: 2.12
+Since: 2.10
</description>
<parameters>
-<parameter name="name">
-<parameter_description> a unique name for the action
+<parameter name="printer">
+<parameter_description> a #GtkPrinter
</parameter_description>
</parameter>
-<parameter name="label">
-<parameter_description> the label displayed in menu items and on buttons, or %NULL
+</parameters>
+<return> the description of @printer
+
+</return>
+</function>
+
+<function name="gtk_printer_get_hard_margins">
+<description>
+Retrieve the hard margins of @printer, i.e. the margins that define
+the area at the borders of the paper that the printer cannot print to.
+
+Note: This will not succeed unless the printer's details are available,
+see gtk_printer_has_details() and gtk_printer_request_details().
+
+Since: 2.20
+
+</description>
+<parameters>
+<parameter name="printer">
+<parameter_description> a #GtkPrinter
</parameter_description>
</parameter>
-<parameter name="tooltip">
-<parameter_description> a tooltip for the action, or %NULL
+<parameter name="top">
+<parameter_description> a location to store the top margin in
</parameter_description>
</parameter>
-<parameter name="stock_id">
-<parameter_description> the stock icon to display in widgets representing the
-action, or %NULL
+<parameter name="bottom">
+<parameter_description> a location to store the bottom margin in
</parameter_description>
</parameter>
-<parameter name="manager">
-<parameter_description> a #GtkRecentManager, or %NULL for using the default
-#GtkRecentManager
+<parameter name="left">
+<parameter_description> a location to store the left margin in
+</parameter_description>
+</parameter>
+<parameter name="right">
+<parameter_description> a location to store the right margin in
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #GtkRecentAction
+<return> %TRUE iff the hard margins were retrieved
</return>
</function>
-<function name="gtk_tree_view_set_enable_tree_lines">
+<function name="gtk_printer_get_icon_name">
<description>
-Sets whether to draw lines interconnecting the expanders in @tree_view.
-This does not have any visible effects for lists.
+Gets the name of the icon to use for the printer.
Since: 2.10
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
-</parameter_description>
-</parameter>
-<parameter name="enabled">
-<parameter_description> %TRUE to enable tree line drawing, %FALSE otherwise.
+<parameter name="printer">
+<parameter_description> a #GtkPrinter
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the icon name for @printer
+
+</return>
</function>
-<function name="gtk_about_dialog_get_documenters">
+<function name="gtk_printer_get_job_count">
<description>
-Returns the string which are displayed in the documenters
-tab of the secondary credits dialog.
+Gets the number of jobs currently queued on the printer.
-Since: 2.6
+Since: 2.10
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter name="printer">
+<parameter_description> a #GtkPrinter
</parameter_description>
</parameter>
</parameters>
-<return> A %NULL-terminated string array containing
-the documenters. The array is owned by the about dialog
-and must not be modified.
+<return> the number of jobs on @printer
</return>
</function>
-<function name="gtk_print_settings_to_file">
+<function name="gtk_printer_get_location">
<description>
-This function saves the print settings from @settings to @file_name. If the
-file could not be loaded then error is set to either a #GFileError or
-#GKeyFileError.
+Returns a description of the location of the printer.
-Since: 2.12
+Since: 2.10
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
-</parameter_description>
-</parameter>
-<parameter name="file_name">
-<parameter_description> the file to save to
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for errors, or %NULL
+<parameter name="printer">
+<parameter_description> a #GtkPrinter
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success
+<return> the location of @printer
</return>
</function>
-<function name="gtk_builder_add_objects_from_file">
+<function name="gtk_printer_get_name">
<description>
-Parses a file containing a <link linkend="BUILDER-UI">GtkBuilder
-UI definition</link> building only the requested objects and merges
-them with the current contents of @builder.
-
-Upon errors 0 will be returned and @error will be assigned a
-#GError from the #GTK_BUILDER_ERROR, #G_MARKUP_ERROR or #G_FILE_ERROR
-domain.
-
-<note><para>
-If you are adding an object that depends on an object that is not
-its child (for instance a #GtkTreeView that depends on its
-#GtkTreeModel), you have to explicitely list all of them in @object_ids.
-</para></note>
+Returns the name of the printer.
-Since: 2.14
+Since: 2.10
</description>
<parameters>
-<parameter name="builder">
-<parameter_description> a #GtkBuilder
-</parameter_description>
-</parameter>
-<parameter name="filename">
-<parameter_description> the name of the file to parse
-</parameter_description>
-</parameter>
-<parameter name="object_ids">
-<parameter_description> nul-terminated array of objects to build
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for an error, or %NULL
+<parameter name="printer">
+<parameter_description> a #GtkPrinter
</parameter_description>
</parameter>
</parameters>
-<return> A positive value on success, 0 if an error occurred
+<return> the name of @printer
</return>
</function>
-<function name="gtk_widget_get_accessible">
+<function name="gtk_printer_get_state_message">
<description>
-Returns the accessible object that describes the widget to an
-assistive technology.
-
-If no accessibility library is loaded (i.e. no ATK implementation library is
-loaded via <envar>GTK_MODULES</envar> or via another application library,
-such as libgnome), then this #AtkObject instance may be a no-op. Likewise,
-if no class-specific #AtkObject implementation is available for the widget
-instance in question, it will inherit an #AtkObject implementation from the
-first ancestor class for which such an implementation is defined.
-
-The documentation of the <ulink url="http://developer.gnome.org/doc/API/2.0/atk/index.html">ATK</ulink>
-library contains more information about accessible objects and their uses.
+Returns the state message describing the current state
+of the printer.
+Since: 2.10
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="printer">
+<parameter_description> a #GtkPrinter
</parameter_description>
</parameter>
</parameters>
-<return> the #AtkObject associated with @widget
+<return> the state message of @printer
+
</return>
</function>
-<function name="gtk_window_is_active">
+<function name="gtk_printer_has_details">
<description>
-Returns whether the window is part of the current active toplevel.
-(That is, the toplevel window receiving keystrokes.)
-The return value is %TRUE if the window is active toplevel
-itself, but also if it is, say, a #GtkPlug embedded in the active toplevel.
-You might use this function if you wanted to draw a widget
-differently in an active window from a widget in an inactive window.
-See gtk_window_has_toplevel_focus()
+Returns whether the printer details are available.
-Since: 2.4
+Since: 2.12
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="printer">
+<parameter_description> a #GtkPrinter
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the window part of the current active window.
+<return> %TRUE if @printer details are available
</return>
</function>
-<function name="gtk_text_iter_editable">
+<function name="gtk_printer_is_accepting_jobs">
<description>
-Returns whether the character at @iter is within an editable region
-of text. Non-editable text is "locked" and can't be changed by the
-user via #GtkTextView. This function is simply a convenience
-wrapper around gtk_text_iter_get_attributes (). If no tags applied
-to this text affect editability, @default_setting will be returned.
-
-You don't want to use this function to decide whether text can be
-inserted at @iter, because for insertion you don't want to know
-whether the char at @iter is inside an editable range, you want to
-know whether a new character inserted at @iter would be inside an
-editable range. Use gtk_text_iter_can_insert() to handle this
-case.
+Returns whether the printer is accepting jobs
+Since: 2.14
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
-</parameter_description>
-</parameter>
-<parameter name="default_setting">
-<parameter_description> %TRUE if text is editable by default
+<parameter name="printer">
+<parameter_description> a #GtkPrinter
</parameter_description>
</parameter>
</parameters>
-<return> whether @iter is inside an editable range
+<return> %TRUE if @printer is accepting jobs
+
</return>
</function>
-<function name="gtk_entry_set_icon_from_stock">
+<function name="gtk_printer_is_active">
<description>
-Sets the icon shown in the entry at the specified position from
-a stock image.
-
-If @stock_id is %NULL, no icon will be shown in the specified position.
+Returns whether the printer is currently active (i.e.
+accepts new jobs).
-Since: 2.16
+Since: 2.10
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> A #GtkEntry
-</parameter_description>
-</parameter>
-<parameter name="icon_pos">
-<parameter_description> Icon position
-</parameter_description>
-</parameter>
-<parameter name="stock_id">
-<parameter_description> The name of the stock item, or %NULL
+<parameter name="printer">
+<parameter_description> a #GtkPrinter
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @printer is active
+
+</return>
</function>
-<function name="gtk_tree_store_insert">
+<function name="gtk_printer_is_default">
<description>
-Creates a new row at @position. If parent is non-%NULL, then the row will be
-made a child of @parent. Otherwise, the row will be created at the toplevel.
-If @position is larger than the number of rows at that level, then the new
-row will be inserted to the end of the list. @iter will be changed to point
-to this new row. The row will be empty after this function is called. To
-fill in values, you need to call gtk_tree_store_set() or
-gtk_tree_store_set_value().
+Returns whether the printer is the default printer.
+Since: 2.10
</description>
<parameters>
-<parameter name="tree_store">
-<parameter_description> A #GtkTreeStore
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> An unset #GtkTreeIter to set to the new row
-</parameter_description>
-</parameter>
-<parameter name="parent">
-<parameter_description> A valid #GtkTreeIter, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="position">
-<parameter_description> position to insert the new row
+<parameter name="printer">
+<parameter_description> a #GtkPrinter
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @printer is the default
+
+</return>
</function>
-<function name="gtk_text_view_move_child">
+<function name="gtk_printer_is_paused">
<description>
-Updates the position of a child, as for gtk_text_view_add_child_in_window().
+Returns whether the printer is currently paused.
+A paused printer still accepts jobs, but it is not
+printing them.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
-</parameter_description>
-</parameter>
-<parameter name="child">
-<parameter_description> child widget already added to the text view
-</parameter_description>
-</parameter>
-<parameter name="xpos">
-<parameter_description> new X position in window coordinates
-</parameter_description>
-</parameter>
-<parameter name="ypos">
-<parameter_description> new Y position in window coordinates
+<parameter name="printer">
+<parameter_description> a #GtkPrinter
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @printer is paused
+
+</return>
</function>
-<function name="gtk_tool_palette_get_icon_size">
+<function name="gtk_printer_is_virtual">
<description>
-Gets the size of icons in the tool palette.
-See gtk_tool_palette_set_icon_size().
+Returns whether the printer is virtual (i.e. does not
+represent actual printer hardware, but something like
+a CUPS class).
-Since: 2.20
+Since: 2.10
</description>
<parameters>
-<parameter name="palette">
-<parameter_description> a #GtkToolPalette
+<parameter name="printer">
+<parameter_description> a #GtkPrinter
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkIconSize of icons in the tool palette
+<return> %TRUE if @printer is virtual
</return>
</function>
-<function name="gtk_progress_bar_get_orientation">
+<function name="gtk_printer_list_papers">
<description>
-Retrieves the current progress bar orientation.
+Lists all the paper sizes @printer supports.
+This will return and empty list unless the printer's details are
+available, see gtk_printer_has_details() and gtk_printer_request_details().
+Since: 2.12
</description>
<parameters>
-<parameter name="pbar">
-<parameter_description> a #GtkProgressBar
+<parameter name="printer">
+<parameter_description> a #GtkPrinter
</parameter_description>
</parameter>
</parameters>
-<return> orientation of the progress bar
+<return> a newly allocated list of newly allocated #GtkPageSetup s.
+
</return>
</function>
-<function name="gtk_list_store_iter_is_valid">
+<function name="gtk_printer_new">
<description>
-<warning>This function is slow. Only use it for debugging and/or testing
-purposes.</warning>
-
-Checks if the given iter is a valid iter for this #GtkListStore.
+Creates a new #GtkPrinter.
-Since: 2.2
+Since: 2.10
</description>
<parameters>
-<parameter name="list_store">
-<parameter_description> A #GtkListStore.
+<parameter name="name">
+<parameter_description> the name of the printer
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> A #GtkTreeIter.
+<parameter name="backend">
+<parameter_description> a #GtkPrintBackend
+</parameter_description>
+</parameter>
+<parameter name="virtual_">
+<parameter_description> whether the printer is virtual
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the iter is valid, %FALSE if the iter is invalid.
+<return> a new #GtkPrinter
</return>
</function>
-<function name="gtk_entry_get_buffer">
+<function name="gtk_printer_option_set_get_groups">
<description>
-Get the #GtkEntryBuffer object which holds the text for
-this widget.
-
-Since: 2.18
-
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
-</parameter_description>
-</parameter>
</parameters>
-<return> A #GtkEntryBuffer object.
+<return>
</return>
</function>
-<function name="gtk_widget_hide_all">
+<function name="gtk_printer_request_details">
<description>
-Recursively hides a widget and any child widgets.
+Requests the printer details. When the details are available,
+the #GtkPrinter::details-acquired signal will be emitted on @printer.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="printer">
+<parameter_description> a #GtkPrinter
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_page_setup_load_key_file">
+<function name="gtk_progress_bar_get_ellipsize">
<description>
-Reads the page setup from the group @group_name in the key file
- key_file
+Returns the ellipsizing position of the progressbar.
+See gtk_progress_bar_set_ellipsize().
-Since: 2.14
+Since: 2.6
</description>
<parameters>
-<parameter name="setup">
-<parameter_description> a #GtkPageSetup
-</parameter_description>
-</parameter>
-<parameter name="key_file">
-<parameter_description> the #GKeyFile to retrieve the page_setup from
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> the name of the group in the key_file to read, or %NULL
-to use the default name "Page Setup"
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for an error, or %NULL
+<parameter name="pbar">
+<parameter_description> a #GtkProgressBar
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success
+<return> #PangoEllipsizeMode
</return>
</function>
-<function name="gtk_combo_box_get_wrap_width">
+<function name="gtk_progress_bar_get_fraction">
<description>
-Returns the wrap width which is used to determine the number of columns
-for the popup menu. If the wrap width is larger than 1, the combo box
-is in table mode.
+Returns the current fraction of the task that's been completed.
-Since: 2.6
</description>
<parameters>
-<parameter name="combo_box">
-<parameter_description> A #GtkComboBox
+<parameter name="pbar">
+<parameter_description> a #GtkProgressBar
</parameter_description>
</parameter>
</parameters>
-<return> the wrap width.
-
+<return> a fraction from 0.0 to 1.0
</return>
</function>
-<function name="gtk_entry_get_layout">
+<function name="gtk_progress_bar_get_orientation">
<description>
-Gets the #PangoLayout used to display the entry.
-The layout is useful to e.g. convert text positions to
-pixel positions, in combination with gtk_entry_get_layout_offsets().
-The returned layout is owned by the entry and must not be
-modified or freed by the caller.
-
-Keep in mind that the layout text may contain a preedit string, so
-gtk_entry_layout_index_to_text_index() and
-gtk_entry_text_index_to_layout_index() are needed to convert byte
-indices in the layout to byte indices in the entry contents.
+Retrieves the current progress bar orientation.
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="pbar">
+<parameter_description> a #GtkProgressBar
</parameter_description>
</parameter>
</parameters>
-<return> the #PangoLayout for this entry
+<return> orientation of the progress bar
</return>
</function>
-<function name="gtk_selection_data_get_text">
+<function name="gtk_progress_bar_get_pulse_step">
<description>
-Gets the contents of the selection data as a UTF-8 string.
+Retrieves the pulse step set with gtk_progress_bar_set_pulse_step()
</description>
<parameters>
-<parameter name="selection_data">
-<parameter_description> a #GtkSelectionData
+<parameter name="pbar">
+<parameter_description> a #GtkProgressBar
</parameter_description>
</parameter>
</parameters>
-<return> if the selection data contained a recognized
-text type and it could be converted to UTF-8, a newly allocated
-string containing the converted text, otherwise %NULL.
-If the result is non-%NULL it must be freed with g_free().
+<return> a fraction from 0.0 to 1.0
</return>
</function>
-<function name="gtk_builder_add_objects_from_string">
+<function name="gtk_progress_bar_get_text">
<description>
-Parses a string containing a <link linkend="BUILDER-UI">GtkBuilder
-UI definition</link> building only the requested objects and merges
-them with the current contents of @builder.
-
-Upon errors 0 will be returned and @error will be assigned a
-#GError from the #GTK_BUILDER_ERROR or #G_MARKUP_ERROR domain.
-
-<note><para>
-If you are adding an object that depends on an object that is not
-its child (for instance a #GtkTreeView that depends on its
-#GtkTreeModel), you have to explicitely list all of them in @object_ids.
-</para></note>
+Retrieves the text displayed superimposed on the progress bar,
+if any, otherwise %NULL. The return value is a reference
+to the text, not a copy of it, so will become invalid
+if you change the text in the progress bar.
-Since: 2.14
</description>
<parameters>
-<parameter name="builder">
-<parameter_description> a #GtkBuilder
-</parameter_description>
-</parameter>
-<parameter name="buffer">
-<parameter_description> the string to parse
-</parameter_description>
-</parameter>
-<parameter name="length">
-<parameter_description> the length of @buffer (may be -1 if @buffer is nul-terminated)
-</parameter_description>
-</parameter>
-<parameter name="object_ids">
-<parameter_description> nul-terminated array of objects to build
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for an error, or %NULL
+<parameter name="pbar">
+<parameter_description> a #GtkProgressBar
</parameter_description>
</parameter>
</parameters>
-<return> A positive value on success, 0 if an error occurred
-
+<return> text, or %NULL; this string is owned by the widget
+and should not be modified or freed.
</return>
</function>
-<function name="gtk_mount_operation_set_parent">
+<function name="gtk_progress_bar_new_with_adjustment">
<description>
-Sets the transient parent for windows shown by the
-#GtkMountOperation.
+Creates a new #GtkProgressBar with an associated #GtkAdjustment.
-Since: 2.14
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkMountOperation
-</parameter_description>
-</parameter>
-<parameter name="parent">
-<parameter_description> transient parent of the window, or %NULL
+<parameter name="adjustment">
+<parameter_description>
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #GtkProgressBar.
+</return>
</function>
-<function name="gtk_layout_get_vadjustment">
+<function name="gtk_progress_bar_pulse">
<description>
-This function should only be called after the layout has been
-placed in a #GtkScrolledWindow or otherwise configured for
-scrolling. It returns the #GtkAdjustment used for communication
-between the vertical scrollbar and @layout.
-
-See #GtkScrolledWindow, #GtkScrollbar, #GtkAdjustment for details.
-
+Indicates that some progress is made, but you don't know how much.
+Causes the progress bar to enter "activity mode," where a block
+bounces back and forth. Each call to gtk_progress_bar_pulse()
+causes the block to move by a little bit (the amount of movement
+per pulse is determined by gtk_progress_bar_set_pulse_step()).
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #GtkLayout
+<parameter name="pbar">
+<parameter_description> a #GtkProgressBar
</parameter_description>
</parameter>
</parameters>
-<return> vertical scroll adjustment
-</return>
+<return></return>
</function>
-<function name="gtk_accel_map_add_filter">
+<function name="gtk_progress_bar_set_ellipsize">
<description>
-Adds a filter to the global list of accel path filters.
-
-Accel map entries whose accel path matches one of the filters
-are skipped by gtk_accel_map_foreach().
+Sets the mode used to ellipsize (add an ellipsis: "...") the text
+if there is not enough space to render the entire string.
-This function is intended for GTK+ modules that create their own
-menus, but don't want them to be saved into the applications accelerator
-map dump.
+Since: 2.6
</description>
<parameters>
-<parameter name="filter_pattern">
-<parameter_description> a pattern (see #GPatternSpec)
+<parameter name="pbar">
+<parameter_description> a #GtkProgressBar
+</parameter_description>
+</parameter>
+<parameter name="mode">
+<parameter_description> a #PangoEllipsizeMode
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_notebook_set_menu_label">
+<function name="gtk_progress_bar_set_fraction">
<description>
-Changes the menu label for the page containing @child.
+Causes the progress bar to "fill in" the given fraction
+of the bar. The fraction should be between 0.0 and 1.0,
+inclusive.
+
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
-</parameter_description>
-</parameter>
-<parameter name="child">
-<parameter_description> the child widget
+<parameter name="pbar">
+<parameter_description> a #GtkProgressBar
</parameter_description>
</parameter>
-<parameter name="menu_label">
-<parameter_description> the menu label, or NULL for default
+<parameter name="fraction">
+<parameter_description> fraction of the task that's been completed
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_action_set_short_label">
+<function name="gtk_progress_bar_set_orientation">
<description>
-Sets a shorter label text on @action.
-
-Since: 2.16
+Causes the progress bar to switch to a different orientation
+(left-to-right, right-to-left, top-to-bottom, or bottom-to-top).
</description>
<parameters>
-<parameter name="action">
-<parameter_description> a #GtkAction
+<parameter name="pbar">
+<parameter_description> a #GtkProgressBar
</parameter_description>
</parameter>
-<parameter name="short_label">
-<parameter_description> the label text to set
+<parameter name="orientation">
+<parameter_description> orientation of the progress bar
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_store_insert_before">
+<function name="gtk_progress_bar_set_pulse_step">
<description>
-Inserts a new row before @sibling. If @sibling is %NULL, then the row will
-be appended to @parent 's children. If @parent and @sibling are %NULL, then
-the row will be appended to the toplevel. If both @sibling and @parent are
-set, then @parent must be the parent of @sibling. When @sibling is set,
- parent is optional.
-
- iter will be changed to point to this new row. The row will be empty after
-this function is called. To fill in values, you need to call
-gtk_tree_store_set() or gtk_tree_store_set_value().
-
+Sets the fraction of total progress bar length to move the
+bouncing block for each call to gtk_progress_bar_pulse().
</description>
<parameters>
-<parameter name="tree_store">
-<parameter_description> A #GtkTreeStore
+<parameter name="pbar">
+<parameter_description> a #GtkProgressBar
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> An unset #GtkTreeIter to set to the new row
+<parameter name="fraction">
+<parameter_description> fraction between 0.0 and 1.0
</parameter_description>
</parameter>
-<parameter name="parent">
-<parameter_description> A valid #GtkTreeIter, or %NULL
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_progress_bar_set_text">
+<description>
+Causes the given @text to appear superimposed on the progress bar.
+
+</description>
+<parameters>
+<parameter name="pbar">
+<parameter_description> a #GtkProgressBar
</parameter_description>
</parameter>
-<parameter name="sibling">
-<parameter_description> A valid #GtkTreeIter, or %NULL
+<parameter name="text">
+<parameter_description> a UTF-8 string, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_parse_geometry">
+<function name="gtk_propagate_event">
<description>
-Parses a standard X Window System geometry string - see the
-manual page for X (type 'man X') for details on this.
-gtk_window_parse_geometry() does work on all GTK+ ports
-including Win32 but is primarily intended for an X environment.
+Sends an event to a widget, propagating the event to parent widgets
+if the event remains unhandled. Events received by GTK+ from GDK
+normally begin in gtk_main_do_event(). Depending on the type of
+event, existence of modal dialogs, grabs, etc., the event may be
+propagated; if so, this function is used. gtk_propagate_event()
+calls gtk_widget_event() on each widget it decides to send the
+event to. So gtk_widget_event() is the lowest-level function; it
+simply emits the "event" and possibly an event-specific signal on a
+widget. gtk_propagate_event() is a bit higher-level, and
+gtk_main_do_event() is the highest level.
-If either a size or a position can be extracted from the
-geometry string, gtk_window_parse_geometry() returns %TRUE
-and calls gtk_window_set_default_size() and/or gtk_window_move()
-to resize/move the window.
+All that said, you most likely don't want to use any of these
+functions; synthesizing events is rarely needed. Consider asking on
+the mailing list for better ways to achieve your goals. For
+example, use gdk_window_invalidate_rect() or
+gtk_widget_queue_draw() instead of making up expose events.
-If gtk_window_parse_geometry() returns %TRUE, it will also
-set the #GDK_HINT_USER_POS and/or #GDK_HINT_USER_SIZE hints
-indicating to the window manager that the size/position of
-the window was user-specified. This causes most window
-managers to honor the geometry.
-Note that for gtk_window_parse_geometry() to work as expected, it has
-to be called when the window has its "final" size, i.e. after calling
-gtk_widget_show_all() on the contents and gtk_window_set_geometry_hints()
-on the window.
-|[
-#include <gtk/gtk.h>
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="event">
+<parameter_description> an event
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-static void
-fill_with_content (GtkWidget *vbox)
-{
-/ * fill with content... * /
-}
+<function name="gtk_radio_action_get_current_value">
+<description>
+Obtains the value property of the currently active member of
+the group to which @action belongs.
-int
-main (int argc, char *argv[])
-{
-GtkWidget *window, *vbox;
-GdkGeometry size_hints = {
-100, 50, 0, 0, 100, 50, 10, 10, 0.0, 0.0, GDK_GRAVITY_NORTH_WEST
-};
+Since: 2.4
-gtk_init (&argc, &argv);
+</description>
+<parameters>
+<parameter name="action">
+<parameter_description> a #GtkRadioAction
+</parameter_description>
+</parameter>
+</parameters>
+<return> The value of the currently active group member
-window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
-vbox = gtk_vbox_new (FALSE, 0);
+</return>
+</function>
-gtk_container_add (GTK_CONTAINER (window), vbox);
-fill_with_content (vbox);
-gtk_widget_show_all (vbox);
+<function name="gtk_radio_action_get_group">
+<description>
+Returns the list representing the radio group for this object.
+Note that the returned list is only valid until the next change
+to the group.
-gtk_window_set_geometry_hints (GTK_WINDOW (window),
-window,
-&size_hints,
-GDK_HINT_MIN_SIZE |
-GDK_HINT_BASE_SIZE |
-GDK_HINT_RESIZE_INC);
+A common way to set up a group of radio group is the following:
+|[
+GSList *group = NULL;
+GtkRadioAction *action;
-if (argc > 1)
+while (/ * more actions to add * /)
{
-if (!gtk_window_parse_geometry (GTK_WINDOW (window), argv[1]))
-fprintf (stderr, "Failed to parse '%s'\n", argv[1]);
-}
-
-gtk_widget_show_all (window);
-gtk_main ();
+action = gtk_radio_action_new (...);
-return 0;
+gtk_radio_action_set_group (action, group);
+group = gtk_radio_action_get_group (action);
}
]|
+Since: 2.4
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
-</parameter_description>
-</parameter>
-<parameter name="geometry">
-<parameter_description> geometry string
+<parameter name="action">
+<parameter_description> the action object
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if string was parsed successfully
+<return> the list representing the radio group for this object
+
</return>
</function>
-<function name="gtk_icon_size_from_name">
+<function name="gtk_radio_action_new">
<description>
-Looks up the icon size associated with @name.
+Creates a new #GtkRadioAction object. To add the action to
+a #GtkActionGroup and set the accelerator for the action,
+call gtk_action_group_add_action_with_accel().
+Since: 2.4
</description>
<parameters>
<parameter name="name">
-<parameter_description> the name to look up.
+<parameter_description> A unique name for the action
+</parameter_description>
+</parameter>
+<parameter name="label">
+<parameter_description> The label displayed in menu items and on buttons, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="tooltip">
+<parameter_description> A tooltip for this action, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="stock_id">
+<parameter_description> The stock icon to display in widgets representing this
+action, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> The value which gtk_radio_action_get_current_value() should
+return if this action is selected.
</parameter_description>
</parameter>
</parameters>
-<return> the icon size
+<return> a new #GtkRadioAction
+
</return>
</function>
-<function name="gtk_scale_button_set_adjustment">
+<function name="gtk_radio_action_set_current_value">
<description>
-Sets the #GtkAdjustment to be used as a model
-for the #GtkScaleButton's scale.
-See gtk_range_set_adjustment() for details.
+Sets the currently active group member to the member with value
+property @current_value.
-Since: 2.12
+Since: 2.10
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkScaleButton
+<parameter name="action">
+<parameter_description> a #GtkRadioAction
</parameter_description>
</parameter>
-<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
+<parameter name="current_value">
+<parameter_description> the new value
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_combo_box_get_column_span_column">
+<function name="gtk_radio_action_set_group">
<description>
-Returns the column with column span information for @combo_box.
+Sets the radio group for the radio action object.
-Since: 2.6
+Since: 2.4
</description>
<parameters>
-<parameter name="combo_box">
-<parameter_description> A #GtkComboBox
+<parameter name="action">
+<parameter_description> the action object
+</parameter_description>
+</parameter>
+<parameter name="group">
+<parameter_description> a list representing a radio group
</parameter_description>
</parameter>
</parameters>
-<return> the column span column.
-
-</return>
+<return></return>
</function>
-<function name="gtk_progress_bar_get_ellipsize">
+<function name="gtk_radio_button_get_group">
<description>
-Returns the ellipsizing position of the progressbar.
-See gtk_progress_bar_set_ellipsize().
+Retrieves the group assigned to a radio button.
-Since: 2.6
</description>
<parameters>
-<parameter name="pbar">
-<parameter_description> a #GtkProgressBar
+<parameter name="radio_button">
+<parameter_description> a #GtkRadioButton.
</parameter_description>
</parameter>
</parameters>
-<return> #PangoEllipsizeMode
-
+<return> a linked list
+containing all the radio buttons in the same group
+as @radio_button. The returned list is owned by the radio button
+and must not be modified or freed.
</return>
</function>
-<function name="gtk_printer_backend_load_modules">
+<function name="gtk_radio_button_new">
<description>
+Creates a new #GtkRadioButton. To be of any practical value, a widget should
+then be packed into the radio button.
+
</description>
<parameters>
+<parameter name="group">
+<parameter_description> an existing radio button group, or %NULL if you are
+creating a new group.
+</parameter_description>
+</parameter>
</parameters>
-<return>
+<return> a new radio button
</return>
</function>
-<function name="gtk_window_set_frame_dimensions">
+<function name="gtk_radio_button_new_from_widget">
<description>
-(Note: this is a special-purpose function intended for the framebuffer
-port; see gtk_window_set_has_frame(). It will have no effect on the
-window border drawn by the window manager, which is the normal
-case when using the X Window system.)
+Creates a new #GtkRadioButton, adding it to the same group as
+ radio_group_member As with gtk_radio_button_new(), a widget
+should be packed into the radio button.
-For windows with frames (see gtk_window_set_has_frame()) this function
-can be used to change the size of the frame border.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow that has a frame
-</parameter_description>
-</parameter>
-<parameter name="left">
-<parameter_description> The width of the left border
-</parameter_description>
-</parameter>
-<parameter name="top">
-<parameter_description> The height of the top border
-</parameter_description>
-</parameter>
-<parameter name="right">
-<parameter_description> The width of the right border
-</parameter_description>
-</parameter>
-<parameter name="bottom">
-<parameter_description> The height of the bottom border
+<parameter name="radio_group_member">
+<parameter_description> an existing #GtkRadioButton.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new radio button.
+</return>
</function>
-<function name="gtk_window_set_icon">
+<function name="gtk_radio_button_new_with_label">
<description>
-Sets up the icon representing a #GtkWindow. This icon is used when
-the window is minimized (also known as iconified). Some window
-managers or desktop environments may also place it in the window
-frame, or display it in other contexts.
-
-The icon should be provided in whatever size it was naturally
-drawn; that is, don't scale the image before passing it to
-GTK+. Scaling is postponed until the last minute, when the desired
-final size is known, to allow best quality.
+Creates a new #GtkRadioButton with a text label.
-If you have your icon hand-drawn in multiple sizes, use
-gtk_window_set_icon_list(). Then the best size will be used.
-
-This function is equivalent to calling gtk_window_set_icon_list()
-with a 1-element list.
-
-See also gtk_window_set_default_icon_list() to set the icon
-for all windows in your application in one go.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="group">
+<parameter_description> an existing radio button group, or %NULL if you are
+creating a new group.
</parameter_description>
</parameter>
-<parameter name="icon">
-<parameter_description> icon image, or %NULL
+<parameter name="label">
+<parameter_description> the text label to display next to the radio button.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new radio button.
+</return>
</function>
-<function name="gtk_cell_renderer_set_visible">
+<function name="gtk_radio_button_new_with_label_from_widget">
<description>
-Sets the cell renderer's visibility.
+Creates a new #GtkRadioButton with a text label, adding it to
+the same group as @radio_group_member.
-Since: 2.18
</description>
<parameters>
-<parameter name="cell">
-<parameter_description> A #GtkCellRenderer
+<parameter name="radio_group_member">
+<parameter_description> widget to get radio group from or %NULL
</parameter_description>
</parameter>
-<parameter name="visible">
-<parameter_description> the visibility of the cell
+<parameter name="label">
+<parameter_description> a text string to display next to the radio button.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new radio button.
+</return>
</function>
-<function name="gtk_cell_view_set_displayed_row">
+<function name="gtk_radio_button_new_with_mnemonic">
<description>
-Sets the row of the model that is currently displayed
-by the #GtkCellView. If the path is unset, then the
-contents of the cellview "stick" at their last value;
-this is not normally a desired result, but may be
-a needed intermediate state if say, the model for
-the #GtkCellView becomes temporarily empty.
+Creates a new #GtkRadioButton containing a label, adding it to the same
+group as @group. The label will be created using
+gtk_label_new_with_mnemonic(), so underscores in @label indicate the
+mnemonic for the button.
-Since: 2.6
</description>
<parameters>
-<parameter name="cell_view">
-<parameter_description> a #GtkCellView
+<parameter name="group">
+<parameter_description> the radio button group
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> a #GtkTreePath or %NULL to unset.
+<parameter name="label">
+<parameter_description> the text of the button, with an underscore in front of the
+mnemonic character
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GtkRadioButton
+</return>
</function>
-<function name="gtk_action_set_accel_group">
+<function name="gtk_radio_button_new_with_mnemonic_from_widget">
<description>
-Sets the #GtkAccelGroup in which the accelerator for this action
-will be installed.
+Creates a new #GtkRadioButton containing a label. The label
+will be created using gtk_label_new_with_mnemonic(), so underscores
+in @label indicate the mnemonic for the button.
-Since: 2.4
</description>
<parameters>
-<parameter name="action">
-<parameter_description> the action object
+<parameter name="radio_group_member">
+<parameter_description> widget to get radio group from or %NULL
</parameter_description>
</parameter>
-<parameter name="accel_group">
-<parameter_description> a #GtkAccelGroup or %NULL
+<parameter name="label">
+<parameter_description> the text of the button, with an underscore in front of the
+mnemonic character
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GtkRadioButton
+</return>
</function>
-<function name="gtk_calendar_get_date">
+<function name="gtk_radio_button_set_group">
<description>
-Obtains the selected date from a #GtkCalendar.
+Sets a #GtkRadioButton's group. It should be noted that this does not change
+the layout of your interface in any way, so if you are changing the group,
+it is likely you will need to re-arrange the user interface to reflect these
+changes.
</description>
<parameters>
-<parameter name="calendar">
-<parameter_description> a #GtkCalendar
-</parameter_description>
-</parameter>
-<parameter name="year">
-<parameter_description> location to store the year number, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="month">
-<parameter_description> location to store the month number (between 0 and 11), or %NULL
+<parameter name="radio_button">
+<parameter_description> a #GtkRadioButton.
</parameter_description>
</parameter>
-<parameter name="day">
-<parameter_description> location to store the day number (between 1 and 31), or %NULL
+<parameter name="group">
+<parameter_description> an existing radio
+button group, such as one returned from gtk_radio_button_get_group().
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_editable_delete_text">
+<function name="gtk_radio_menu_item_get_group">
<description>
-Deletes a sequence of characters. The characters that are deleted are
-those characters at positions from @start_pos up to, but not including
- end_pos If @end_pos is negative, then the the characters deleted
-are those from @start_pos to the end of the text.
+Returns the group to which the radio menu item belongs, as a #GList of
+#GtkRadioMenuItem. The list belongs to GTK+ and should not be freed.
-Note that the positions are specified in characters, not bytes.
</description>
<parameters>
-<parameter name="editable">
-<parameter_description> a #GtkEditable
-</parameter_description>
-</parameter>
-<parameter name="start_pos">
-<parameter_description> start position
-</parameter_description>
-</parameter>
-<parameter name="end_pos">
-<parameter_description> end position
+<parameter name="radio_menu_item">
+<parameter_description> a #GtkRadioMenuItem
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the group of @radio_menu_item
+</return>
</function>
-<function name="gtk_icon_view_get_cursor">
+<function name="gtk_radio_menu_item_new_from_widget">
<description>
-Fills in @path and @cell with the current cursor path and cell.
-If the cursor isn't currently set, then * path will be %NULL.
-If no cell currently has focus, then * cell will be %NULL.
-
-The returned #GtkTreePath must be freed with gtk_tree_path_free().
+Creates a new #GtkRadioMenuItem adding it to the same group as @group.
-Since: 2.8
+Since: 2.4
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> A #GtkIconView
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> Return location for the current cursor path, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="cell">
-<parameter_description> Return location the current focus cell, or %NULL
+<parameter name="group">
+<parameter_description> An existing #GtkRadioMenuItem
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the cursor is set.
+<return> The new #GtkRadioMenuItem
</return>
</function>
-<function name="gtk_entry_buffer_delete_text">
+<function name="gtk_radio_menu_item_new_with_label">
<description>
-Deletes a sequence of characters from the buffer. @n_chars characters are
-deleted starting at @position. If @n_chars is negative, then all characters
-until the end of the text are deleted.
-
-If @position or @n_chars are out of bounds, then they are coerced to sane
-values.
+Creates a new #GtkRadioMenuItem whose child is a simple #GtkLabel.
-Note that the positions are specified in characters, not bytes.
-
-Since: 2.18
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkEntryBuffer
-</parameter_description>
-</parameter>
-<parameter name="position">
-<parameter_description> position at which to delete text
+<parameter name="group">
+<parameter_description>
</parameter_description>
</parameter>
-<parameter name="n_chars">
-<parameter_description> number of characters to delete
+<parameter name="label">
+<parameter_description> the text for the label
</parameter_description>
</parameter>
</parameters>
-<return> The number of characters deleted.
-
+<return> A new #GtkRadioMenuItem
</return>
</function>
-<function name="gtk_tree_path_up">
+<function name="gtk_radio_menu_item_new_with_label_from_widget">
<description>
-Moves the @path to point to its parent node, if it has a parent.
+Creates a new GtkRadioMenuItem whose child is a simple GtkLabel.
+The new #GtkRadioMenuItem is added to the same group as @group.
+Since: 2.4
</description>
<parameters>
-<parameter name="path">
-<parameter_description> A #GtkTreePath.
+<parameter name="group">
+<parameter_description> an existing #GtkRadioMenuItem
+</parameter_description>
+</parameter>
+<parameter name="label">
+<parameter_description> the text for the label
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @path has a parent, and the move was made.
+<return> The new #GtkRadioMenuItem
+
</return>
</function>
-<function name="gtk_text_iter_get_marks">
+<function name="gtk_radio_menu_item_new_with_mnemonic">
<description>
-Returns a list of all #GtkTextMark at this location. Because marks
-are not iterable (they don't take up any "space" in the buffer,
-they are just marks in between iterable locations), multiple marks
-can exist in the same place. The returned list is not in any
-meaningful order.
-
+Creates a new #GtkRadioMenuItem containing a label. The label
+will be created using gtk_label_new_with_mnemonic(), so underscores
+in @label indicate the mnemonic for the menu item.
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
+<parameter name="group">
+<parameter_description> group the radio menu item is inside
+</parameter_description>
+</parameter>
+<parameter name="label">
+<parameter_description> the text of the button, with an underscore in front of the
+mnemonic character
</parameter_description>
</parameter>
</parameters>
-<return> list of #GtkTextMark
+<return> a new #GtkRadioMenuItem
</return>
</function>
-<function name="gtk_icon_view_get_drag_dest_item">
+<function name="gtk_radio_menu_item_new_with_mnemonic_from_widget">
<description>
-Gets information about the item that is highlighted for feedback.
+Creates a new GtkRadioMenuItem containing a label. The label will be
+created using gtk_label_new_with_mnemonic(), so underscores in label
+indicate the mnemonic for the menu item.
-Since: 2.8
+The new #GtkRadioMenuItem is added to the same group as @group.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> Return location for the path of the highlighted item, or %NULL.
+<parameter name="group">
+<parameter_description> An existing #GtkRadioMenuItem
</parameter_description>
</parameter>
-<parameter name="pos">
-<parameter_description> Return location for the drop position, or %NULL
+<parameter name="label">
+<parameter_description> the text of the button, with an underscore in front of the
+mnemonic character
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The new #GtkRadioMenuItem
+
+</return>
</function>
-<function name="gtk_assistant_new">
+<function name="gtk_radio_tool_button_get_group">
<description>
-Creates a new #GtkAssistant.
+Returns the radio button group @button belongs to.
-Since: 2.10
+Since: 2.4
</description>
<parameters>
+<parameter name="button">
+<parameter_description> a #GtkRadioToolButton
+</parameter_description>
+</parameter>
</parameters>
-<return> a newly created #GtkAssistant
+<return> The group @button belongs to.
</return>
</function>
-<function name="gtk_targets_include_image">
+<function name="gtk_radio_tool_button_new">
<description>
-Determines if any of the targets in @targets can be used to
-provide a #GdkPixbuf.
+Creates a new #GtkRadioToolButton, adding it to @group.
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="targets">
-<parameter_description> an array of #GdkAtom<!-- -->s
+<parameter name="group">
+<parameter_description> An existing radio button group, or %NULL if you are creating a new group
</parameter_description>
</parameter>
-<parameter name="n_targets">
-<parameter_description> the length of @targets
+</parameters>
+<return> The new #GtkRadioToolButton
+
+</return>
+</function>
+
+<function name="gtk_radio_tool_button_new_from_stock">
+<description>
+Creates a new #GtkRadioToolButton, adding it to @group.
+The new #GtkRadioToolButton will contain an icon and label from the
+stock item indicated by @stock_id.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="group">
+<parameter_description> an existing radio button group, or %NULL if you are creating a new group
</parameter_description>
</parameter>
-<parameter name="writable">
-<parameter_description> whether to accept only targets for which GTK+ knows
-how to convert a pixbuf into the format
+<parameter name="stock_id">
+<parameter_description> the name of a stock item
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @targets include a suitable target for images,
-otherwise %FALSE.
+<return> The new #GtkRadioToolItem
</return>
</function>
-<function name="gtk_dialog_set_alternative_button_order">
+<function name="gtk_radio_tool_button_new_from_widget">
<description>
-Sets an alternative button order. If the
-#GtkSettings:gtk-alternative-button-order setting is set to %TRUE,
-the dialog buttons are reordered according to the order of the
-response ids passed to this function.
-
-By default, GTK+ dialogs use the button order advocated by the Gnome
-<ulink url="http://developer.gnome.org/projects/gup/hig/2.0/">Human
-Interface Guidelines</ulink> with the affirmative button at the far
-right, and the cancel button left of it. But the builtin GTK+ dialogs
-and #GtkMessageDialog<!-- -->s do provide an alternative button order,
-which is more suitable on some platforms, e.g. Windows.
-
-Use this function after adding all the buttons to your dialog, as the
-following example shows:
-|[
-cancel_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
-GTK_STOCK_CANCEL,
-GTK_RESPONSE_CANCEL);
+Creates a new #GtkRadioToolButton adding it to the same group as @gruup
-ok_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
-GTK_STOCK_OK,
-GTK_RESPONSE_OK);
+Since: 2.4
-gtk_widget_grab_default (ok_button);
+</description>
+<parameters>
+<parameter name="group">
+<parameter_description> An existing #GtkRadioToolButton
+</parameter_description>
+</parameter>
+</parameters>
+<return> The new #GtkRadioToolButton
-help_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
-GTK_STOCK_HELP,
-GTK_RESPONSE_HELP);
+</return>
+</function>
-gtk_dialog_set_alternative_button_order (GTK_DIALOG (dialog),
-GTK_RESPONSE_OK,
-GTK_RESPONSE_CANCEL,
-GTK_RESPONSE_HELP,
--1);
-]|
+<function name="gtk_radio_tool_button_new_with_stock_from_widget">
+<description>
+Creates a new #GtkRadioToolButton adding it to the same group as @group.
+The new #GtkRadioToolButton will contain an icon and label from the
+stock item indicated by @stock_id.
-Since: 2.6
+Since: 2.4
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkDialog
-</parameter_description>
-</parameter>
-<parameter name="first_response_id">
-<parameter_description> a response id used by one @dialog's buttons
+<parameter name="group">
+<parameter_description> An existing #GtkRadioToolButton.
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> a list of more response ids of @dialog's buttons, terminated by -1
+<parameter name="stock_id">
+<parameter_description> the name of a stock item
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A new #GtkRadioToolButton
+
+</return>
</function>
-<function name="gtk_about_dialog_set_version">
+<function name="gtk_radio_tool_button_set_group">
<description>
-Sets the version string to display in the about dialog.
+Adds @button to @group, removing it from the group it belonged to before.
-Since: 2.6
+Since: 2.4
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter name="button">
+<parameter_description> a #GtkRadioToolButton
</parameter_description>
</parameter>
-<parameter name="version">
-<parameter_description> the version string
+<parameter name="group">
+<parameter_description> an existing radio button group
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_get_option_group">
+<function name="gtk_range_get_adjustment">
<description>
-Returns a #GOptionGroup for the commandline arguments recognized
-by GTK+ and GDK. You should add this group to your #GOptionContext
-with g_option_context_add_group(), if you are using
-g_option_context_parse() to parse your commandline arguments.
+Get the #GtkAdjustment which is the "model" object for #GtkRange.
+See gtk_range_set_adjustment() for details.
+The return value does not have a reference added, so should not
+be unreferenced.
-Since: 2.6
</description>
<parameters>
-<parameter name="open_default_display">
-<parameter_description> whether to open the default display
-when parsing the commandline arguments
+<parameter name="range">
+<parameter_description> a #GtkRange
</parameter_description>
</parameter>
</parameters>
-<return> a #GOptionGroup for the commandline arguments recognized
-by GTK+
-
+<return> a #GtkAdjustment
</return>
</function>
-<function name="gtk_rc_parse_color_full">
+<function name="gtk_range_get_fill_level">
<description>
-Parses a color in the <link linkend="color=format">format</link> expected
-in a RC file. If @style is not %NULL, it will be consulted to resolve
-references to symbolic colors.
+Gets the current position of the fill level indicator.
Since: 2.12
</description>
<parameters>
-<parameter name="scanner">
-<parameter_description> a #GScanner
-</parameter_description>
-</parameter>
-<parameter name="style">
-<parameter_description> a #GtkRcStyle, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="color">
-<parameter_description> a pointer to a #GdkColor structure in which to store the result
+<parameter name="range">
+<parameter_description> A #GtkRange
</parameter_description>
</parameter>
</parameters>
-<return> %G_TOKEN_NONE if parsing succeeded, otherwise the token
-that was expected but not found
+<return> The current fill level
</return>
</function>
-<function name="gtk_paint_layout">
+<function name="gtk_range_get_flippable">
<description>
-Draws a layout on @window using the given parameters.
+Gets the value set by gtk_range_set_flippable().
+
+Since: 2.18
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
-</parameter_description>
-</parameter>
-<parameter name="use_text">
-<parameter_description> whether to use the text or foreground
-graphics context of @style
-</parameter_description>
-</parameter>
-<parameter name="area">
-<parameter_description> clip rectangle, or %NULL if the
-output should not be clipped
-</parameter_description>
-</parameter>
-<parameter name="widget">
-<parameter_description> the widget
-</parameter_description>
-</parameter>
-<parameter name="detail">
-<parameter_description> a style detail
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> x origin
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> y origin
-</parameter_description>
-</parameter>
-<parameter name="layout">
-<parameter_description> the layout to draw
+<parameter name="range">
+<parameter_description> a #GtkRange
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the range is flippable
+
+</return>
</function>
-<function name="gtk_container_class_list_child_properties">
+<function name="gtk_range_get_inverted">
<description>
-Returns all child properties of a container class.
+Gets the value set by gtk_range_set_inverted().
+
</description>
<parameters>
-<parameter name="cclass">
-<parameter_description> a #GtkContainerClass
-</parameter_description>
-</parameter>
-<parameter name="n_properties">
-<parameter_description> location to return the number of child properties found
+<parameter name="range">
+<parameter_description> a #GtkRange
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated %NULL-terminated array of #GParamSpec*.
-The array must be freed with g_free().
+<return> %TRUE if the range is inverted
</return>
</function>
-<function name="gtk_text_view_set_cursor_visible">
+<function name="gtk_range_get_lower_stepper_sensitivity">
<description>
-Toggles whether the insertion point is displayed. A buffer with no editable
-text probably shouldn't have a visible cursor, so you may want to turn
-the cursor off.
+Gets the sensitivity policy for the stepper that points to the
+'lower' end of the GtkRange's adjustment.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
-</parameter_description>
-</parameter>
-<parameter name="setting">
-<parameter_description> whether to show the insertion cursor
+<parameter name="range">
+<parameter_description> a #GtkRange
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The lower stepper's sensitivity policy.
+
+</return>
</function>
-<function name="gtk_entry_text_index_to_layout_index">
+<function name="gtk_range_get_min_slider_size">
<description>
-Converts from a position in the entry's #PangoLayout (returned by
-gtk_entry_get_layout()) to a position in the entry contents
-(returned by gtk_entry_get_text()).
+This function is useful mainly for #GtkRange subclasses.
+See gtk_range_set_min_slider_size().
+
+Since: 2.20
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
-</parameter_description>
-</parameter>
-<parameter name="text_index">
-<parameter_description> byte index into the entry contents
+<parameter name="range">
+<parameter_description> a #GtkRange
</parameter_description>
</parameter>
</parameters>
-<return> byte index into the entry layout text
+<return> The minimum size of the range's slider.
+
</return>
</function>
-<function name="gtk_tree_view_append_column">
+<function name="gtk_range_get_range_rect">
<description>
-Appends @column to the list of columns. If @tree_view has "fixed_height"
-mode enabled, then @column must have its "sizing" property set to be
-GTK_TREE_VIEW_COLUMN_FIXED.
+This function returns the area that contains the range's trough
+and its steppers, in widget->window coordinates.
+This function is useful mainly for #GtkRange subclasses.
+
+Since: 2.20
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView.
+<parameter name="range">
+<parameter_description> a #GtkRange
</parameter_description>
</parameter>
-<parameter name="column">
-<parameter_description> The #GtkTreeViewColumn to add.
+<parameter name="range_rect">
+<parameter_description> return location for the range rectangle
</parameter_description>
</parameter>
</parameters>
-<return> The number of columns in @tree_view after appending.
-</return>
+<return></return>
</function>
-<function name="gtk_image_get_animation">
+<function name="gtk_range_get_restrict_to_fill_level">
<description>
-Gets the #GdkPixbufAnimation being displayed by the #GtkImage.
-The storage type of the image must be %GTK_IMAGE_EMPTY or
-%GTK_IMAGE_ANIMATION (see gtk_image_get_storage_type()).
-The caller of this function does not own a reference to the
-returned animation.
+Gets whether the range is restricted to the fill level.
+Since: 2.12
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GtkImage
+<parameter name="range">
+<parameter_description> A #GtkRange
</parameter_description>
</parameter>
</parameters>
-<return> the displayed animation, or %NULL if
-the image is empty
+<return> %TRUE if @range is restricted to the fill level.
+
</return>
</function>
-<function name="gtk_combo_box_get_title">
+<function name="gtk_range_get_show_fill_level">
<description>
-Gets the current title of the menu in tearoff mode. See
-gtk_combo_box_set_add_tearoffs().
+Gets whether the range displays the fill level graphically.
-Since: 2.10
+Since: 2.12
</description>
<parameters>
-<parameter name="combo_box">
-<parameter_description> a #GtkComboBox
+<parameter name="range">
+<parameter_description> A #GtkRange
</parameter_description>
</parameter>
</parameters>
-<return> the menu's title in tearoff mode. This is an internal copy of the
-string which must not be freed.
+<return> %TRUE if @range shows the fill level.
</return>
</function>
-<function name="gtk_editable_insert_text">
+<function name="gtk_range_get_slider_range">
<description>
-Inserts @new_text_length bytes of @new_text into the contents of the
-widget, at position @position.
+This function returns sliders range along the long dimension,
+in widget->window coordinates.
-Note that the position is in characters, not in bytes.
-The function updates @position to point after the newly inserted text.
+This function is useful mainly for #GtkRange subclasses.
+
+Since: 2.20
</description>
<parameters>
-<parameter name="editable">
-<parameter_description> a #GtkEditable
-</parameter_description>
-</parameter>
-<parameter name="new_text">
-<parameter_description> the text to append
+<parameter name="range">
+<parameter_description> a #GtkRange
</parameter_description>
</parameter>
-<parameter name="new_text_length">
-<parameter_description> the length of the text in bytes, or -1
+<parameter name="slider_start">
+<parameter_description> return location for the slider's start, or %NULL
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> location of the position text will be inserted at
+<parameter name="slider_end">
+<parameter_description> return location for the slider's end, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_action_group_list_actions">
+<function name="gtk_range_get_slider_size_fixed">
<description>
-Lists the actions in the action group.
+This function is useful mainly for #GtkRange subclasses.
-Since: 2.4
+See gtk_range_set_slider_size_fixed().
+
+Since: 2.20
</description>
<parameters>
-<parameter name="action_group">
-<parameter_description> the action group
+<parameter name="range">
+<parameter_description> a #GtkRange
</parameter_description>
</parameter>
</parameters>
-<return> an allocated list of the action objects in the action group
+<return> whether the range's slider has a fixed size.
</return>
</function>
-<function name="gtk_about_dialog_get_program_name">
+<function name="gtk_range_get_update_policy">
<description>
-Returns the program name displayed in the about dialog.
+Gets the update policy of @range. See gtk_range_set_update_policy().
-Since: 2.12
+Deprecated: 2.24: There is no replacement. If you require delayed
+updates, you need to code it yourself.
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter name="range">
+<parameter_description> a #GtkRange
</parameter_description>
</parameter>
</parameters>
-<return> The program name. The string is owned by the about
-dialog and must not be modified.
+<return> the current update policy
</return>
</function>
-<function name="gtk_ui_manager_get_accel_group">
+<function name="gtk_range_get_upper_stepper_sensitivity">
<description>
-Returns the #GtkAccelGroup associated with @self.
+Gets the sensitivity policy for the stepper that points to the
+'upper' end of the GtkRange's adjustment.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #GtkUIManager object
+<parameter name="range">
+<parameter_description> a #GtkRange
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkAccelGroup.
+<return> The upper stepper's sensitivity policy.
</return>
</function>
-<function name="gtk_tool_item_set_use_drag_window">
+<function name="gtk_range_get_value">
<description>
-Sets whether @tool_item has a drag window. When %TRUE the
-toolitem can be used as a drag source through gtk_drag_source_set().
-When @tool_item has a drag window it will intercept all events,
-even those that would otherwise be sent to a child of @tool_item.
+Gets the current value of the range.
-Since: 2.4
</description>
<parameters>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem
-</parameter_description>
-</parameter>
-<parameter name="use_drag_window">
-<parameter_description> Whether @tool_item has a drag window.
+<parameter name="range">
+<parameter_description> a #GtkRange
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> current value of the range.
+</return>
</function>
-<function name="gtk_requisition_free">
+<function name="gtk_range_set_adjustment">
<description>
-Frees a #GtkRequisition.
+Sets the adjustment to be used as the "model" object for this range
+widget. The adjustment indicates the current range value, the
+minimum and maximum range values, the step/page increments used
+for keybindings and scrolling, and the page size. The page size
+is normally 0 for #GtkScale and nonzero for #GtkScrollbar, and
+indicates the size of the visible area of the widget being scrolled.
+The page size affects the size of the scrollbar slider.
</description>
<parameters>
-<parameter name="requisition">
-<parameter_description> a #GtkRequisition
+<parameter name="range">
+<parameter_description> a #GtkRange
+</parameter_description>
+</parameter>
+<parameter name="adjustment">
+<parameter_description> a #GtkAdjustment
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_set_default_icon">
+<function name="gtk_range_set_fill_level">
<description>
-Sets an icon to be used as fallback for windows that haven't
-had gtk_window_set_icon() called on them from a pixbuf.
+Set the new position of the fill level indicator.
-Since: 2.4
+The "fill level" is probably best described by its most prominent
+use case, which is an indicator for the amount of pre-buffering in
+a streaming media player. In that use case, the value of the range
+would indicate the current play position, and the fill level would
+be the position up to which the file/stream has been downloaded.
+
+This amount of prebuffering can be displayed on the range's trough
+and is themeable separately from the trough. To enable fill level
+display, use gtk_range_set_show_fill_level(). The range defaults
+to not showing the fill level.
+
+Additionally, it's possible to restrict the range's slider position
+to values which are smaller than the fill level. This is controller
+by gtk_range_set_restrict_to_fill_level() and is by default
+enabled.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="icon">
-<parameter_description> the icon
+<parameter name="range">
+<parameter_description> a #GtkRange
+</parameter_description>
+</parameter>
+<parameter name="fill_level">
+<parameter_description> the new position of the fill level indicator
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_printer_get_default_page_size">
+<function name="gtk_range_set_flippable">
<description>
-Returns default page size of @printer.
+If a range is flippable, it will switch its direction if it is
+horizontal and its direction is %GTK_TEXT_DIR_RTL.
-Since: 2.14
+See gtk_widget_get_direction().
+
+Since: 2.18
</description>
<parameters>
-<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter name="range">
+<parameter_description> a #GtkRange
+</parameter_description>
+</parameter>
+<parameter name="flippable">
+<parameter_description> %TRUE to make the range flippable
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated #GtkPageSetup with default page size of the printer.
-
-</return>
+<return></return>
</function>
-<function name="gtk_action_group_add_action_with_accel">
+<function name="gtk_range_set_increments">
<description>
-Adds an action object to the action group and sets up the accelerator.
-
-If @accelerator is %NULL, attempts to use the accelerator associated
-with the stock_id of the action.
-
-Accel paths are set to
-<literal><Actions>/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.
-
-Since: 2.4
+Sets the step and page sizes for the range.
+The step size is used when the user clicks the #GtkScrollbar
+arrows or moves #GtkScale via arrow keys. The page size
+is used for example when moving via Page Up or Page Down keys.
</description>
<parameters>
-<parameter name="action_group">
-<parameter_description> the action group
+<parameter name="range">
+<parameter_description> a #GtkRange
</parameter_description>
</parameter>
-<parameter name="action">
-<parameter_description> the action to add
+<parameter name="step">
+<parameter_description> step size
</parameter_description>
</parameter>
-<parameter name="accelerator">
-<parameter_description> the accelerator for the action, in
-the format understood by gtk_accelerator_parse(), or "" for no accelerator, or
-%NULL to use the stock accelerator
+<parameter name="page">
+<parameter_description> page size
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_message_dialog_get_message_area">
+<function name="gtk_range_set_inverted">
<description>
-Since: 2.22
+Ranges normally move from lower to higher values as the
+slider moves from top to bottom or left to right. Inverted
+ranges have higher values at the top or on the right rather than
+on the bottom or left.
</description>
<parameters>
-<parameter name="message_dialog">
-<parameter_description> a #GtkMessageDialog
+<parameter name="range">
+<parameter_description> a #GtkRange
+</parameter_description>
+</parameter>
+<parameter name="setting">
+<parameter_description> %TRUE to invert the range
</parameter_description>
</parameter>
</parameters>
-<return> A #GtkVBox corresponding to the "message area" in the
- message_dialog This is the box where the dialog's primary and secondary
-labels are packed. You can add your own extra content to that box and it
-will appear below those labels, on the right side of the dialog's image (or
-on the left for right-to-left languages). See gtk_dialog_get_content_area()
-for the corresponding function in the parent #GtkDialog.
-
-</return>
+<return></return>
</function>
-<function name="gtk_progress_bar_set_ellipsize">
+<function name="gtk_range_set_lower_stepper_sensitivity">
<description>
-Sets the mode used to ellipsize (add an ellipsis: "...") the text
-if there is not enough space to render the entire string.
+Sets the sensitivity policy for the stepper that points to the
+'lower' end of the GtkRange's adjustment.
-Since: 2.6
+Since: 2.10
</description>
<parameters>
-<parameter name="pbar">
-<parameter_description> a #GtkProgressBar
+<parameter name="range">
+<parameter_description> a #GtkRange
</parameter_description>
</parameter>
-<parameter name="mode">
-<parameter_description> a #PangoEllipsizeMode
+<parameter name="sensitivity">
+<parameter_description> the lower stepper's sensitivity policy.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_font_selection_get_preview_entry">
+<function name="gtk_range_set_min_slider_size">
<description>
-This returns the #GtkEntry used to display the font as a preview.
+Sets the minimum size of the range's slider.
-Since: 2.14
+This function is useful mainly for #GtkRange subclasses.
+
+Since: 2.20
</description>
<parameters>
-<parameter name="fontsel">
-<parameter_description> a #GtkFontSelection
+<parameter name="range">
+<parameter_description> a #GtkRange
+</parameter_description>
+</parameter>
+<parameter name="min_size">
+<parameter_description> The slider's minimum size
</parameter_description>
</parameter>
</parameters>
-<return> A #GtkWidget that is part of @fontsel
-
-</return>
+<return></return>
</function>
-<function name="gtk_print_context_create_pango_layout">
+<function name="gtk_range_set_range">
<description>
-Creates a new #PangoLayout that is suitable for use
-with the #GtkPrintContext.
-
-Since: 2.10
+Sets the allowable values in the #GtkRange, and clamps the range
+value to be between @min and @max. (If the range has a non-zero
+page size, it is clamped between @min and @max - page-size.)
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GtkPrintContext
+<parameter name="range">
+<parameter_description> a #GtkRange
+</parameter_description>
+</parameter>
+<parameter name="min">
+<parameter_description> minimum range value
+</parameter_description>
+</parameter>
+<parameter name="max">
+<parameter_description> maximum range value
</parameter_description>
</parameter>
</parameters>
-<return> a new Pango layout for @context
-
-</return>
+<return></return>
</function>
-<function name="gtk_bindings_activate">
+<function name="gtk_range_set_restrict_to_fill_level">
<description>
-Find a key binding matching @keyval and @modifiers and activate the
-binding on @object.
+Sets whether the slider is restricted to the fill level. See
+gtk_range_set_fill_level() for a general description of the fill
+level concept.
+Since: 2.12
</description>
<parameters>
-<parameter name="object">
-<parameter_description> object to activate when binding found
-</parameter_description>
-</parameter>
-<parameter name="keyval">
-<parameter_description> key value of the binding
+<parameter name="range">
+<parameter_description> A #GtkRange
</parameter_description>
</parameter>
-<parameter name="modifiers">
-<parameter_description> key modifier of the binding
+<parameter name="restrict_to_fill_level">
+<parameter_description> Whether the fill level restricts slider movement.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if a binding was found and activated
-</return>
+<return></return>
</function>
-<function name="gtk_spin_button_spin">
+<function name="gtk_range_set_show_fill_level">
<description>
-Increment or decrement a spin button's value in a specified direction
-by a specified amount.
+Sets whether a graphical fill level is show on the trough. See
+gtk_range_set_fill_level() for a general description of the fill
+level concept.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
-</parameter_description>
-</parameter>
-<parameter name="direction">
-<parameter_description> a #GtkSpinType indicating the direction to spin.
+<parameter name="range">
+<parameter_description> A #GtkRange
</parameter_description>
</parameter>
-<parameter name="increment">
-<parameter_description> step increment to apply in the specified direction.
+<parameter name="show_fill_level">
+<parameter_description> Whether a fill level indicator graphics is shown.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_toolbar_get_item_index">
+<function name="gtk_range_set_slider_size_fixed">
<description>
-Returns the position of @item on the toolbar, starting from 0.
-It is an error if @item is not a child of the toolbar.
+Sets whether the range's slider has a fixed size, or a size that
+depends on it's adjustment's page size.
-Since: 2.4
+This function is useful mainly for #GtkRange subclasses.
+
+Since: 2.20
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar
+<parameter name="range">
+<parameter_description> a #GtkRange
</parameter_description>
</parameter>
-<parameter name="item">
-<parameter_description> a #GtkToolItem that is a child of @toolbar
+<parameter name="size_fixed">
+<parameter_description> %TRUE to make the slider size constant
</parameter_description>
</parameter>
</parameters>
-<return> the position of item on the toolbar.
-
-</return>
+<return></return>
</function>
-<function name="gtk_init_check">
+<function name="gtk_range_set_update_policy">
<description>
-This function does the same work as gtk_init() with only
-a single change: It does not terminate the program if the GUI can't be
-initialized. Instead it returns %FALSE on failure.
-
-This way the application can fall back to some other means of communication
-with the user - for example a curses or command line interface.
+Sets the update policy for the range. #GTK_UPDATE_CONTINUOUS means that
+anytime the range slider is moved, the range value will change and the
+value_changed signal will be emitted. #GTK_UPDATE_DELAYED means that
+the value will be updated after a brief timeout where no slider motion
+occurs, so updates are spaced by a short time rather than
+continuous. #GTK_UPDATE_DISCONTINUOUS means that the value will only
+be updated when the user releases the button and ends the slider
+drag operation.
+Deprecated: 2.24: There is no replacement. If you require delayed
+updates, you need to code it yourself.
</description>
<parameters>
-<parameter name="argc">
-<parameter_description> Address of the <parameter>argc</parameter> parameter of your
-main() function. Changed if any arguments were handled.
+<parameter name="range">
+<parameter_description> a #GtkRange
</parameter_description>
</parameter>
-<parameter name="argv">
-<parameter_description> Address of the <parameter>argv</parameter> parameter of main().
-Any parameters understood by gtk_init() are stripped before return.
+<parameter name="policy">
+<parameter_description> update policy
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the GUI has been successfully initialized,
-%FALSE otherwise.
-</return>
+<return></return>
</function>
-<function name="gtk_entry_set_icon_tooltip_markup">
+<function name="gtk_range_set_upper_stepper_sensitivity">
<description>
-Sets @tooltip as the contents of the tooltip for the icon at
-the specified position. @tooltip is assumed to be marked up with
-the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
+Sets the sensitivity policy for the stepper that points to the
+'upper' end of the GtkRange's adjustment.
-Use %NULL for @tooltip to remove an existing tooltip.
+Since: 2.10
-See also gtk_widget_set_tooltip_markup() and
-gtk_enty_set_icon_tooltip_text().
+</description>
+<parameters>
+<parameter name="range">
+<parameter_description> a #GtkRange
+</parameter_description>
+</parameter>
+<parameter name="sensitivity">
+<parameter_description> the upper stepper's sensitivity policy.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-Since: 2.16
+<function name="gtk_range_set_value">
+<description>
+Sets the current value of the range; if the value is outside the
+minimum or maximum range values, it will be clamped to fit inside
+them. The range emits the #GtkRange::value-changed signal if the
+value changes.
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="range">
+<parameter_description> a #GtkRange
</parameter_description>
</parameter>
-<parameter name="icon_pos">
-<parameter_description> the icon position
+<parameter name="value">
+<parameter_description> new value of the range
</parameter_description>
</parameter>
-<parameter name="tooltip">
-<parameter_description> the contents of the tooltip for the icon, or %NULL
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_rc_add_default_file">
+<description>
+Adds a file to the list of files to be parsed at the
+end of gtk_init().
+
+</description>
+<parameters>
+<parameter name="filename">
+<parameter_description> the pathname to the file. If @filename is not absolute, it
+is searched in the current directory.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tooltip_set_tip_area">
+<function name="gtk_rc_find_module_in_path">
<description>
-Sets the area of the widget, where the contents of this tooltip apply,
-to be @rect (in widget coordinates). This is especially useful for
-properly setting tooltips on #GtkTreeView rows and cells, #GtkIconViews,
-etc.
-
-For setting tooltips on #GtkTreeView, please refer to the convenience
-functions for this: gtk_tree_view_set_tooltip_row() and
-gtk_tree_view_set_tooltip_cell().
+Searches for a theme engine in the GTK+ search path. This function
+is not useful for applications and should not be used.
-Since: 2.12
</description>
<parameters>
-<parameter name="tooltip">
-<parameter_description> a #GtkTooltip
-</parameter_description>
-</parameter>
-<parameter name="rect">
-<parameter_description> a #GdkRectangle
+<parameter name="module_file">
+<parameter_description> name of a theme engine
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The filename, if found (must be freed with g_free()),
+otherwise %NULL.
+</return>
</function>
-<function name="gtk_assistant_get_page_side_image">
+<function name="gtk_rc_find_pixmap_in_path">
<description>
-Gets the header image for @page.
+Looks up a file in pixmap path for the specified #GtkSettings.
+If the file is not found, it outputs a warning message using
+g_warning() and returns %NULL.
-Since: 2.10
</description>
<parameters>
-<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter name="settings">
+<parameter_description> a #GtkSettings
</parameter_description>
</parameter>
-<parameter name="page">
-<parameter_description> a page of @assistant
+<parameter name="scanner">
+<parameter_description> Scanner used to get line number information for the
+warning message, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="pixmap_file">
+<parameter_description> name of the pixmap file to locate.
</parameter_description>
</parameter>
</parameters>
-<return> the side image for @page, or %NULL
-if there's no side image for the page.
+<return> the filename.
+</return>
+</function>
+<function name="gtk_rc_get_default_files">
+<description>
+Retrieves the current list of RC files that will be parsed
+at the end of gtk_init().
+
+
+</description>
+<parameters>
+</parameters>
+<return> A %NULL-terminated array of filenames.
+This memory is owned by GTK+ and must not be freed by the application.
+If you want to store this information, you should make a copy.
</return>
</function>
-<function name="gtk_drag_source_set_target_list">
+<function name="gtk_rc_get_im_module_file">
<description>
-Changes the target types that this widget offers for drag-and-drop.
-The widget must first be made into a drag source with
-gtk_drag_source_set().
+Obtains the path to the IM modules file. See the documentation
+of the <link linkend="im-module-file"><envar>GTK_IM_MODULE_FILE</envar></link>
+environment variable for more details.
+
+</description>
+<parameters>
+</parameters>
+<return> a newly-allocated string containing the name of the file
+listing the IM modules available for loading
+</return>
+</function>
+
+<function name="gtk_rc_get_im_module_path">
+<description>
+Obtains the path in which to look for IM modules. See the documentation
+of the <link linkend="im-module-path"><envar>GTK_PATH</envar></link>
+environment variable for more details about looking up modules. This
+function is useful solely for utilities supplied with GTK+ and should
+not be used by applications under normal circumstances.
+
+</description>
+<parameters>
+</parameters>
+<return> a newly-allocated string containing the path in which to
+look for IM modules.
+</return>
+</function>
+
+<function name="gtk_rc_get_module_dir">
+<description>
+Returns a directory in which GTK+ looks for theme engines.
+For full information about the search for theme engines,
+see the docs for <envar>GTK_PATH</envar> in
+<xref linkend="gtk-running"/>.
+
+
+</description>
+<parameters>
+</parameters>
+<return> the directory. (Must be freed with g_free())
+</return>
+</function>
+
+<function name="gtk_rc_get_style">
+<description>
+Finds all matching RC styles for a given widget,
+composites them together, and then creates a
+#GtkStyle representing the composite appearance.
+(GTK+ actually keeps a cache of previously
+created styles, so a new style may not be
+created.)
-Since: 2.4
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget that's a drag source
-</parameter_description>
-</parameter>
-<parameter name="target_list">
-<parameter_description> list of draggable targets, or %NULL for none
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the resulting style. No refcount is added
+to the returned style, so if you want to save this
+style around, you should add a reference yourself.
+</return>
</function>
-<function name="gtk_tree_view_get_background_area">
+<function name="gtk_rc_get_style_by_paths">
<description>
-Fills the bounding rectangle in bin_window coordinates for the cell at the
-row specified by @path and the column specified by @column. If @path is
-%NULL, or points to a node not found in the tree, the @y and @height fields of
-the rectangle will be filled with 0. If @column is %NULL, the @x and @width
-fields will be filled with 0. The returned rectangle is equivalent to the
- background_area passed to gtk_cell_renderer_render(). These background
-areas tile to cover the entire bin window. Contrast with the @cell_area,
-returned by gtk_tree_view_get_cell_area(), which returns only the cell
-itself, excluding surrounding borders and the tree expander area.
+Creates up a #GtkStyle from styles defined in a RC file by providing
+the raw components used in matching. This function may be useful
+when creating pseudo-widgets that should be themed like widgets but
+don't actually have corresponding GTK+ widgets. An example of this
+would be items inside a GNOME canvas widget.
+
+The action of gtk_rc_get_style() is similar to:
+|[
+gtk_widget_path (widget, NULL, &path, NULL);
+gtk_widget_class_path (widget, NULL, &class_path, NULL);
+gtk_rc_get_style_by_paths (gtk_widget_get_settings (widget),
+path, class_path,
+G_OBJECT_TYPE (widget));
+]|
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
+<parameter name="settings">
+<parameter_description> a #GtkSettings object
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> a #GtkTreePath for the row, or %NULL to get only horizontal coordinates
+<parameter name="widget_path">
+<parameter_description> the widget path to use when looking up the
+style, or %NULL if no matching against the widget path should be done
</parameter_description>
</parameter>
-<parameter name="column">
-<parameter_description> a #GtkTreeViewColumn for the column, or %NULL to get only vertical coordiantes
+<parameter name="class_path">
+<parameter_description> the class path to use when looking up the style,
+or %NULL if no matching against the class path should be done.
</parameter_description>
</parameter>
-<parameter name="rect">
-<parameter_description> rectangle to fill with cell background rect
+<parameter name="type">
+<parameter_description> a type that will be used along with parent types of this type
+when matching against class styles, or #G_TYPE_NONE
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A style created by matching with the
+supplied paths, or %NULL if nothing matching was specified and the
+default style should be used. The returned value is owned by GTK+
+as part of an internal cache, so you must call g_object_ref() on
+the returned value if you want to keep a reference to it.
+</return>
</function>
-<function name="gtk_paint_hline">
+<function name="gtk_rc_parse_color">
<description>
-Draws a horizontal line from (@x1, @y) to (@x2, @y) in @window
-using the given style and state.
+Parses a color in the <link linkend="color=format">format</link> expected
+in a RC file.
+
+Note that theme engines should use gtk_rc_parse_color_full() in
+order to support symbolic colors.
+
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="scanner">
+<parameter_description> a #GScanner
</parameter_description>
</parameter>
-<parameter name="state_type">
-<parameter_description> a state
+<parameter name="color">
+<parameter_description> a pointer to a #GdkColor structure in which to store the result
</parameter_description>
</parameter>
-<parameter name="area">
-<parameter_description> rectangle to which the output is clipped, or %NULL if the
-output should not be clipped
+</parameters>
+<return> %G_TOKEN_NONE if parsing succeeded, otherwise the token
+that was expected but not found
+</return>
+</function>
+
+<function name="gtk_rc_parse_color_full">
+<description>
+Parses a color in the <link linkend="color=format">format</link> expected
+in a RC file. If @style is not %NULL, it will be consulted to resolve
+references to symbolic colors.
+
+Since: 2.12
+
+</description>
+<parameters>
+<parameter name="scanner">
+<parameter_description> a #GScanner
</parameter_description>
</parameter>
-<parameter name="widget">
-<parameter_description> the widget
+<parameter name="style">
+<parameter_description> a #GtkRcStyle, or %NULL
</parameter_description>
</parameter>
-<parameter name="detail">
-<parameter_description> a style detail
+<parameter name="color">
+<parameter_description> a pointer to a #GdkColor structure in which to store the result
</parameter_description>
</parameter>
-<parameter name="x1">
-<parameter_description> the starting x coordinate
+</parameters>
+<return> %G_TOKEN_NONE if parsing succeeded, otherwise the token
+that was expected but not found
+
+</return>
+</function>
+
+<function name="gtk_rc_property_parse_border">
+<description>
+A #GtkRcPropertyParser for use with gtk_settings_install_property_parser()
+or gtk_widget_class_install_style_property_parser() which parses
+borders in the form
+<literal>"{ left, right, top, bottom }"</literal> for integers
+%left, %right, %top and %bottom.
+
+
+</description>
+<parameters>
+<parameter name="pspec">
+<parameter_description> a #GParamSpec
</parameter_description>
</parameter>
-<parameter name="x2">
-<parameter_description> the ending x coordinate
+<parameter name="gstring">
+<parameter_description> the #GString to be parsed
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> the y coordinate
+<parameter name="property_value">
+<parameter_description> a #GValue which must hold boxed values.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @gstring could be parsed and @property_value
+has been set to the resulting #GtkBorder.
+</return>
</function>
-<function name="gtk_print_context_get_cairo_context">
+<function name="gtk_rc_property_parse_color">
<description>
-Obtains the cairo context that is associated with the
-#GtkPrintContext.
+A #GtkRcPropertyParser for use with gtk_settings_install_property_parser()
+or gtk_widget_class_install_style_property_parser() which parses a
+color given either by its name or in the form
+<literal>{ red, green, blue }</literal> where %red, %green and
+%blue are integers between 0 and 65535 or floating-point numbers
+between 0 and 1.
-Since: 2.10
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GtkPrintContext
+<parameter name="pspec">
+<parameter_description> a #GParamSpec
+</parameter_description>
+</parameter>
+<parameter name="gstring">
+<parameter_description> the #GString to be parsed
+</parameter_description>
+</parameter>
+<parameter name="property_value">
+<parameter_description> a #GValue which must hold #GdkColor values.
</parameter_description>
</parameter>
</parameters>
-<return> the cairo context of @context
-
+<return> %TRUE if @gstring could be parsed and @property_value
+has been set to the resulting #GdkColor.
</return>
</function>
-<function name="gtk_container_get_border_width">
+<function name="gtk_rc_property_parse_enum">
<description>
-Retrieves the border width of the container. See
-gtk_container_set_border_width().
+A #GtkRcPropertyParser for use with gtk_settings_install_property_parser()
+or gtk_widget_class_install_style_property_parser() which parses a single
+enumeration value.
+
+The enumeration value can be specified by its name, its nickname or
+its numeric value. For consistency with flags parsing, the value
+may be surrounded by parentheses.
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
+<parameter name="pspec">
+<parameter_description> a #GParamSpec
+</parameter_description>
+</parameter>
+<parameter name="gstring">
+<parameter_description> the #GString to be parsed
+</parameter_description>
+</parameter>
+<parameter name="property_value">
+<parameter_description> a #GValue which must hold enum values.
</parameter_description>
</parameter>
</parameters>
-<return> the current border width
+<return> %TRUE if @gstring could be parsed and @property_value
+has been set to the resulting #GEnumValue.
</return>
</function>
-<function name="gtk_widget_get_double_buffered">
+<function name="gtk_rc_property_parse_flags">
<description>
-Determines whether the widget is double buffered.
+A #GtkRcPropertyParser for use with gtk_settings_install_property_parser()
+or gtk_widget_class_install_style_property_parser() which parses flags.
-See gtk_widget_set_double_buffered()
+Flags can be specified by their name, their nickname or
+numerically. Multiple flags can be specified in the form
+<literal>"( flag1 | flag2 | ... )"</literal>.
-Since: 2.18
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="pspec">
+<parameter_description> a #GParamSpec
+</parameter_description>
+</parameter>
+<parameter name="gstring">
+<parameter_description> the #GString to be parsed
+</parameter_description>
+</parameter>
+<parameter name="property_value">
+<parameter_description> a #GValue which must hold flags values.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the widget is double buffered
-
+<return> %TRUE if @gstring could be parsed and @property_value
+has been set to the resulting flags value.
</return>
</function>
-<function name="gtk_tree_view_expand_all">
+<function name="gtk_rc_property_parse_requisition">
<description>
-Recursively expands all nodes in the @tree_view.
+A #GtkRcPropertyParser for use with gtk_settings_install_property_parser()
+or gtk_widget_class_install_style_property_parser() which parses a
+requisition in the form
+<literal>"{ width, height }"</literal> for integers %width and %height.
+
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView.
+<parameter name="pspec">
+<parameter_description> a #GParamSpec
+</parameter_description>
+</parameter>
+<parameter name="gstring">
+<parameter_description> the #GString to be parsed
+</parameter_description>
+</parameter>
+<parameter name="property_value">
+<parameter_description> a #GValue which must hold boxed values.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @gstring could be parsed and @property_value
+has been set to the resulting #GtkRequisition.
+</return>
</function>
-<function name="gtk_text_view_get_cursor_visible">
+<function name="gtk_rc_reparse_all">
<description>
-Find out whether the cursor is being displayed.
+If the modification time on any previously read file for the
+default #GtkSettings has changed, discard all style information
+and then reread all previously read RC files.
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
-</parameter_description>
-</parameter>
</parameters>
-<return> whether the insertion mark is visible
+<return> %TRUE if the files were reread.
</return>
</function>
-<function name="gtk_print_settings_get_print_pages">
+<function name="gtk_rc_reparse_all_for_settings">
<description>
-Gets the value of %GTK_PRINT_SETTINGS_PRINT_PAGES.
+If the modification time on any previously read file
+for the given #GtkSettings has changed, discard all style information
+and then reread all previously read RC files.
-Since: 2.10
</description>
<parameters>
<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter_description> a #GtkSettings
+</parameter_description>
+</parameter>
+<parameter name="force_load">
+<parameter_description> load whether or not anything changed
</parameter_description>
</parameter>
</parameters>
-<return> which pages to print
-
+<return> %TRUE if the files were reread.
</return>
</function>
-<function name="gtk_file_chooser_set_filter">
+<function name="gtk_rc_reset_styles">
<description>
-Sets the current filter; only the files that pass the
-filter will be displayed. If the user-selectable list of filters
-is non-empty, then the filter should be one of the filters
-in that list. Setting the current filter when the list of
-filters is empty is useful if you want to restrict the displayed
-set of files without letting the user change it.
+This function recomputes the styles for all widgets that use a
+particular #GtkSettings object. (There is one #GtkSettings object
+per #GdkScreen, see gtk_settings_get_for_screen()); It is useful
+when some global parameter has changed that affects the appearance
+of all widgets, because when a widget gets a new style, it will
+both redraw and recompute any cached information about its
+appearance. As an example, it is used when the default font size
+set by the operating system changes. Note that this function
+doesn't affect widgets that have a style set explicitely on them
+with gtk_widget_set_style().
Since: 2.4
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
-</parameter_description>
-</parameter>
-<parameter name="filter">
-<parameter_description> a #GtkFileFilter
+<parameter name="settings">
+<parameter_description> a #GtkSettings
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_entry_set_activates_default">
+<function name="gtk_rc_set_default_files">
<description>
-If @setting is %TRUE, pressing Enter in the @entry will activate the default
-widget for the window containing the entry. This usually means that
-the dialog box containing the entry will be closed, since the default
-widget is usually one of the dialog buttons.
-
-(For experts: if @setting is %TRUE, the entry calls
-gtk_window_activate_default() on the window containing the entry, in
-the default handler for the #GtkWidget::activate signal.)
+Sets the list of files that GTK+ will read at the
+end of gtk_init().
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
-</parameter_description>
-</parameter>
-<parameter name="setting">
-<parameter_description> %TRUE to activate window's default widget on Enter keypress
+<parameter name="filenames">
+<parameter_description> A %NULL-terminated list of filenames.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_image_get_stock">
+<function name="gtk_rc_style_copy">
<description>
-Gets the stock icon name and size being displayed by the #GtkImage.
-The storage type of the image must be %GTK_IMAGE_EMPTY or
-%GTK_IMAGE_STOCK (see gtk_image_get_storage_type()).
-The returned string is owned by the #GtkImage and should not
-be freed.
+Makes a copy of the specified #GtkRcStyle. This function
+will correctly copy an RC style that is a member of a class
+derived from #GtkRcStyle.
+
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GtkImage
-</parameter_description>
-</parameter>
-<parameter name="stock_id">
-<parameter_description> place to store a
-stock icon name, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="size">
-<parameter_description> place to store a stock icon
-size, or %NULL
+<parameter name="orig">
+<parameter_description> the style to copy
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the resulting #GtkRcStyle
+</return>
</function>
-<function name="gtk_printer_request_details">
+<function name="gtk_recent_action_get_show_numbers">
<description>
-Requests the printer details. When the details are available,
-the #GtkPrinter::details-acquired signal will be emitted on @printer.
+Returns the value set by gtk_recent_chooser_menu_set_show_numbers().
Since: 2.12
</description>
<parameters>
-<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter name="action">
+<parameter_description> a #GtkRecentAction
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if numbers should be shown.
+
+</return>
</function>
-<function name="gtk_text_iter_backward_search">
+<function name="gtk_recent_action_new">
<description>
-Same as gtk_text_iter_forward_search(), but moves backward.
+Creates a new #GtkRecentAction object. To add the action to
+a #GtkActionGroup and set the accelerator for the action,
+call gtk_action_group_add_action_with_accel().
+Since: 2.12
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter where the search begins
+<parameter name="name">
+<parameter_description> a unique name for the action
</parameter_description>
</parameter>
-<parameter name="str">
-<parameter_description> search string
+<parameter name="label">
+<parameter_description> the label displayed in menu items and on buttons, or %NULL
</parameter_description>
</parameter>
-<parameter name="flags">
-<parameter_description> bitmask of flags affecting the search
+<parameter name="tooltip">
+<parameter_description> a tooltip for the action, or %NULL
</parameter_description>
</parameter>
-<parameter name="match_start">
-<parameter_description> return location for start of match, or %NULL
+<parameter name="stock_id">
+<parameter_description> the stock icon to display in widgets representing the
+action, or %NULL
</parameter_description>
</parameter>
-<parameter name="match_end">
-<parameter_description> return location for end of match, or %NULL
+</parameters>
+<return> the newly created #GtkRecentAction.
+
+</return>
+</function>
+
+<function name="gtk_recent_action_new_for_manager">
+<description>
+Creates a new #GtkRecentAction object. To add the action to
+a #GtkActionGroup and set the accelerator for the action,
+call gtk_action_group_add_action_with_accel().
+
+Since: 2.12
+
+</description>
+<parameters>
+<parameter name="name">
+<parameter_description> a unique name for the action
</parameter_description>
</parameter>
-<parameter name="limit">
-<parameter_description> location of last possible @match_start, or %NULL for start of buffer
+<parameter name="label">
+<parameter_description> the label displayed in menu items and on buttons, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="tooltip">
+<parameter_description> a tooltip for the action, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="stock_id">
+<parameter_description> the stock icon to display in widgets representing the
+action, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="manager">
+<parameter_description> a #GtkRecentManager, or %NULL for using the default
+#GtkRecentManager
</parameter_description>
</parameter>
</parameters>
-<return> whether a match was found
+<return> the newly created #GtkRecentAction
+
</return>
</function>
-<function name="gtk_window_set_type_hint">
+<function name="gtk_recent_action_set_show_numbers">
<description>
-By setting the type hint for the window, you allow the window
-manager to decorate and handle the window in a way which is
-suitable to the function of the window in your application.
-
-This function should be called before the window becomes visible.
-
-gtk_dialog_new_with_buttons() and other convenience functions in GTK+
-will sometimes call gtk_window_set_type_hint() on your behalf.
+Sets whether a number should be added to the items shown by the
+widgets representing @action. The numbers are shown to provide
+a unique character for a mnemonic to be used inside the menu item's
+label. Only the first ten items get a number to avoid clashes.
+Since: 2.12
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="action">
+<parameter_description> a #GtkRecentAction
</parameter_description>
</parameter>
-<parameter name="hint">
-<parameter_description> the window type
+<parameter name="show_numbers">
+<parameter_description> %TRUE if the shown items should be numbered
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_im_multicontext_set_context_id">
+<function name="gtk_recent_chooser_add_filter">
<description>
-Sets the context id for @context.
+Adds @filter to the list of #GtkRecentFilter objects held by @chooser.
-This causes the currently active slave of @context to be
-replaced by the slave corresponding to the new context id.
+If no previous filter objects were defined, this function will call
+gtk_recent_chooser_set_filter().
-Since: 2.16
+Since: 2.10
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GtkIMMulticontext
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
</parameter_description>
</parameter>
-<parameter name="context_id">
-<parameter_description> the id to use
+<parameter name="filter">
+<parameter_description> a #GtkRecentFilter
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_font_button_new_with_font">
+<function name="gtk_recent_chooser_dialog_new">
<description>
-Creates a new font picker widget.
+Creates a new #GtkRecentChooserDialog. This function is analogous to
+gtk_dialog_new_with_buttons().
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="fontname">
-<parameter_description> Name of font to display in font selection dialog
+<parameter name="title">
+<parameter_description> Title of the dialog, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="parent">
+<parameter_description> Transient parent of the dialog, or %NULL,
+</parameter_description>
+</parameter>
+<parameter name="first_button_text">
+<parameter_description> stock ID or text to go in the first button, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> response ID for the first button, then additional (button, id)
+pairs, ending with %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a new font picker widget.
+<return> a new #GtkRecentChooserDialog
</return>
</function>
-<function name="gtk_print_unix_dialog_set_has_selection">
+<function name="gtk_recent_chooser_dialog_new_for_manager">
<description>
-Sets whether a selection exists.
+Creates a new #GtkRecentChooserDialog with a specified recent manager.
-Since: 2.18
+This is useful if you have implemented your own recent manager, or if you
+have a customized instance of a #GtkRecentManager object.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter name="title">
+<parameter_description> Title of the dialog, or %NULL
</parameter_description>
</parameter>
-<parameter name="has_selection">
-<parameter_description> %TRUE indicates that a selection exists
+<parameter name="parent">
+<parameter_description> Transient parent of the dialog, or %NULL,
+</parameter_description>
+</parameter>
+<parameter name="manager">
+<parameter_description> a #GtkRecentManager
+</parameter_description>
+</parameter>
+<parameter name="first_button_text">
+<parameter_description> stock ID or text to go in the first button, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> response ID for the first button, then additional (button, id)
+pairs, ending with %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GtkRecentChooserDialog
+
+</return>
</function>
-<function name="gtk_text_child_anchor_get_widgets">
+<function name="gtk_recent_chooser_get_current_item">
<description>
-Gets a list of all widgets anchored at this child anchor.
-The returned list should be freed with g_list_free().
-
+Gets the #GtkRecentInfo currently selected by @chooser.
+Since: 2.10
</description>
<parameters>
-<parameter name="anchor">
-<parameter_description> a #GtkTextChildAnchor
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
</parameter_description>
</parameter>
</parameters>
-<return> list of widgets anchored at @anchor
+<return> a #GtkRecentInfo. Use gtk_recent_info_unref() when
+when you have finished using it.
+
</return>
</function>
-<function name="gtk_label_set_angle">
+<function name="gtk_recent_chooser_get_current_uri">
<description>
-Sets the angle of rotation for the label. An angle of 90 reads from
-from bottom to top, an angle of 270, from top to bottom. The angle
-setting for the label is ignored if the label is selectable,
-wrapped, or ellipsized.
+Gets the URI currently selected by @chooser.
-Since: 2.6
+Since: 2.10
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
-</parameter_description>
-</parameter>
-<parameter name="angle">
-<parameter_description> the angle that the baseline of the label makes with
-the horizontal, in degrees, measured counterclockwise
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a newly allocated string holding a URI.
+
+</return>
</function>
-<function name="gtk_printer_accepts_ps">
+<function name="gtk_recent_chooser_get_filter">
<description>
-Returns whether the printer accepts input in
-PostScript format.
+Gets the #GtkRecentFilter object currently used by @chooser to affect
+the display of the recently used resources.
Since: 2.10
</description>
<parameters>
-<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @printer accepts PostScript
+<return> a #GtkRecentFilter object.
</return>
</function>
-<function name="gtk_print_job_get_surface">
+<function name="gtk_recent_chooser_get_items">
<description>
-Gets a cairo surface onto which the pages of
-the print job should be rendered.
+Gets the list of recently used resources in form of #GtkRecentInfo objects.
+
+The return value of this function is affected by the "sort-type" and
+"limit" properties of @chooser.
Since: 2.10
</description>
<parameters>
-<parameter name="job">
-<parameter_description> a #GtkPrintJob
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for errors, or %NULL
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
</parameter_description>
</parameter>
</parameters>
-<return> the cairo surface of @job
+<return> A newly allocated
+list of #GtkRecentInfo objects. You should
+use gtk_recent_info_unref() on every item of the list, and then free
+the list itself using g_list_free().
</return>
</function>
-<function name="gtk_text_iter_set_visible_line_offset">
+<function name="gtk_recent_chooser_get_limit">
<description>
-Like gtk_text_iter_set_line_offset(), but the offset is in visible
-characters, i.e. text with a tag making it invisible is not
-counted in the offset.
+Gets the number of items returned by gtk_recent_chooser_get_items()
+and gtk_recent_chooser_get_uris().
+
+Since: 2.10
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
</parameter_description>
</parameter>
-<parameter name="char_on_line">
-<parameter_description> a character offset
+</parameters>
+<return> A positive integer, or -1 meaning that all items are
+returned.
+
+</return>
+</function>
+
+<function name="gtk_recent_chooser_get_local_only">
+<description>
+Gets whether only local resources should be shown in the recently used
+resources selector. See gtk_recent_chooser_set_local_only()
+
+Since: 2.10
+
+</description>
+<parameters>
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if only local resources should be shown.
+
+</return>
</function>
-<function name="gtk_handle_box_get_shadow_type">
+<function name="gtk_recent_chooser_get_select_multiple">
<description>
-Gets the type of shadow drawn around the handle box. See
-gtk_handle_box_set_shadow_type().
+Gets whether @chooser can select multiple items.
+Since: 2.10
</description>
<parameters>
-<parameter name="handle_box">
-<parameter_description> a #GtkHandleBox
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
</parameter_description>
</parameter>
</parameters>
-<return> the type of shadow currently drawn around the handle box.
+<return> %TRUE if @chooser can select more than one item.
+
</return>
</function>
-<function name="gtk_tooltip_set_custom">
+<function name="gtk_recent_chooser_get_show_icons">
<description>
-Replaces the widget packed into the tooltip with
- custom_widget @custom_widget does not get destroyed when the tooltip goes
-away.
-By default a box with a #GtkImage and #GtkLabel is embedded in
-the tooltip, which can be configured using gtk_tooltip_set_markup()
-and gtk_tooltip_set_icon().
-
+Retrieves whether @chooser should show an icon near the resource.
-Since: 2.12
+Since: 2.10
</description>
<parameters>
-<parameter name="tooltip">
-<parameter_description> a #GtkTooltip
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
</parameter_description>
</parameter>
-<parameter name="custom_widget">
-<parameter_description> a #GtkWidget, or %NULL to unset the old custom widget.
+</parameters>
+<return> %TRUE if the icons should be displayed, %FALSE otherwise.
+
+</return>
+</function>
+
+<function name="gtk_recent_chooser_get_show_not_found">
+<description>
+Retrieves whether @chooser should show the recently used resources that
+were not found.
+
+Since: 2.10
+
+</description>
+<parameters>
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the resources not found should be displayed, and
+%FALSE otheriwse.
+
+</return>
</function>
-<function name="gtk_recent_filter_get_needed">
+<function name="gtk_recent_chooser_get_show_numbers">
<description>
-Gets the fields that need to be filled in for the structure
-passed to gtk_recent_filter_filter()
+Returns whether @chooser should display recently used resources
+prepended by a unique number.
-This function will not typically be used by applications; it
-is intended principally for use in the implementation of
-#GtkRecentChooser.
+Deprecated: 2.12: use gtk_recent_chooser_menu_get_show_numbers() instead.
Since: 2.10
</description>
<parameters>
-<parameter name="filter">
-<parameter_description> a #GtkRecentFilter
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
</parameter_description>
</parameter>
</parameters>
-<return> bitfield of flags indicating needed fields when
-calling gtk_recent_filter_filter()
+<return> %TRUE if the recent chooser should show display numbers,
+%FALSE otherwise.
</return>
</function>
-<function name="gtk_accel_label_new">
+<function name="gtk_recent_chooser_get_show_private">
<description>
-Creates a new #GtkAccelLabel.
+Returns whether @chooser should display recently used resources
+registered as private.
+Since: 2.10
</description>
<parameters>
-<parameter name="string">
-<parameter_description> the label string. Must be non-%NULL.
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkAccelLabel.
+<return> %TRUE if the recent chooser should show private items,
+%FALSE otherwise.
+
</return>
</function>
-<function name="gtk_target_list_unref">
+<function name="gtk_recent_chooser_get_show_tips">
<description>
-Decreases the reference count of a #GtkTargetList by one.
-If the resulting reference count is zero, frees the list.
+Gets whether @chooser should display tooltips containing the full path
+of a recently user resource.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GtkTargetList
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the recent chooser should show tooltips,
+%FALSE otherwise.
+
+</return>
</function>
-<function name="gtk_selection_data_get_selection">
+<function name="gtk_recent_chooser_get_sort_type">
<description>
-Retrieves the selection #GdkAtom of the selection data.
+Gets the value set by gtk_recent_chooser_set_sort_type().
-Since: 2.16
+Since: 2.10
</description>
<parameters>
-<parameter name="selection_data">
-<parameter_description> a pointer to a #GtkSelectionData structure.
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
</parameter_description>
</parameter>
</parameters>
-<return> the selection #GdkAtom of the selection data.
+<return> the sorting order of the @chooser.
</return>
</function>
-<function name="gtk_text_tag_table_foreach">
+<function name="gtk_recent_chooser_get_uris">
<description>
-Calls @func on each tag in @table, with user data @data.
-Note that the table may not be modified while iterating
-over it (you can't add/remove tags).
+Gets the URI of the recently used resources.
+
+The return value of this function is affected by the "sort-type" and "limit"
+properties of @chooser.
+
+Since the returned array is %NULL terminated, @length may be %NULL.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="table">
-<parameter_description> a #GtkTextTagTable
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> a function to call on each tag
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> user data
+<parameter name="length">
+<parameter_description> return location for a the length of the URI list, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A newly allocated, %NULL-terminated array
+of strings. Use g_strfreev() to free it.
+
+</return>
</function>
-<function name="gtk_print_job_new">
+<function name="gtk_recent_chooser_list_filters">
<description>
-Creates a new #GtkPrintJob.
+Gets the #GtkRecentFilter objects held by @chooser.
Since: 2.10
</description>
<parameters>
-<parameter name="title">
-<parameter_description> the job title
-</parameter_description>
-</parameter>
-<parameter name="printer">
-<parameter_description> a #GtkPrinter
-</parameter_description>
-</parameter>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
-</parameter_description>
-</parameter>
-<parameter name="page_setup">
-<parameter_description> a #GtkPageSetup
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPrintJob
+<return> A singly linked list
+of #GtkRecentFilter objects. You
+should just free the returned list using g_slist_free().
</return>
</function>
-<function name="gtk_print_job_get_title">
+<function name="gtk_recent_chooser_menu_get_show_numbers">
<description>
-Gets the job title.
+Returns the value set by gtk_recent_chooser_menu_set_show_numbers().
Since: 2.10
</description>
<parameters>
-<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter name="menu">
+<parameter_description> a #GtkRecentChooserMenu
</parameter_description>
</parameter>
</parameters>
-<return> the title of @job
+<return> %TRUE if numbers should be shown.
</return>
</function>
-<function name="gtk_tree_store_is_ancestor">
+<function name="gtk_recent_chooser_menu_new">
<description>
-Returns %TRUE if @iter is an ancestor of @descendant. That is, @iter is the
-parent (or grandparent or great-grandparent) of @descendant.
+Creates a new #GtkRecentChooserMenu widget.
+
+This kind of widget shows the list of recently used resources as
+a menu, each item as a menu item. Each item inside the menu might
+have an icon, representing its MIME type, and a number, for mnemonic
+access.
+
+This widget implements the #GtkRecentChooser interface.
+
+This widget creates its own #GtkRecentManager object. See the
+gtk_recent_chooser_menu_new_for_manager() function to know how to create
+a #GtkRecentChooserMenu widget bound to another #GtkRecentManager object.
+Since: 2.10
</description>
<parameters>
-<parameter name="tree_store">
-<parameter_description> A #GtkTreeStore
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> A valid #GtkTreeIter
-</parameter_description>
-</parameter>
-<parameter name="descendant">
-<parameter_description> A valid #GtkTreeIter
-</parameter_description>
-</parameter>
</parameters>
-<return> %TRUE, if @iter is an ancestor of @descendant
+<return> a new #GtkRecentChooserMenu
+
</return>
</function>
-<function name="gtk_print_settings_set_use_color">
+<function name="gtk_recent_chooser_menu_new_for_manager">
<description>
-Sets the value of %GTK_PRINT_SETTINGS_USE_COLOR.
+Creates a new #GtkRecentChooserMenu widget using @manager as
+the underlying recently used resources manager.
+
+This is useful if you have implemented your own recent manager,
+or if you have a customized instance of a #GtkRecentManager
+object or if you wish to share a common #GtkRecentManager object
+among multiple #GtkRecentChooser widgets.
Since: 2.10
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
-</parameter_description>
-</parameter>
-<parameter name="use_color">
-<parameter_description> whether to use color
+<parameter name="manager">
+<parameter_description> a #GtkRecentManager
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GtkRecentChooserMenu, bound to @manager.
+
+</return>
</function>
-<function name="gtk_paint_polygon">
+<function name="gtk_recent_chooser_menu_set_show_numbers">
<description>
-Draws a polygon on @window with the given parameters.
+Sets whether a number should be added to the items of @menu. The
+numbers are shown to provide a unique character for a mnemonic to
+be used inside ten menu item's label. Only the first the items
+get a number to avoid clashes.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
-</parameter_description>
-</parameter>
-<parameter name="shadow_type">
-<parameter_description> type of shadow to draw
-</parameter_description>
-</parameter>
-<parameter name="area">
-<parameter_description> clip rectangle, or %NULL if the
-output should not be clipped
-</parameter_description>
-</parameter>
-<parameter name="widget">
-<parameter_description> the widget
-</parameter_description>
-</parameter>
-<parameter name="detail">
-<parameter_description> a style detail
-</parameter_description>
-</parameter>
-<parameter name="points">
-<parameter_description> an array of #GdkPoint<!-- -->s
-</parameter_description>
-</parameter>
-<parameter name="n_points">
-<parameter_description> length of @points
+<parameter name="menu">
+<parameter_description> a #GtkRecentChooserMenu
</parameter_description>
</parameter>
-<parameter name="fill">
-<parameter_description> %TRUE if the polygon should be filled
+<parameter name="show_numbers">
+<parameter_description> whether to show numbers
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_set_double_buffered">
+<function name="gtk_recent_chooser_remove_filter">
<description>
-Widgets are double buffered by default; you can use this function
-to turn off the buffering. "Double buffered" simply means that
-gdk_window_begin_paint_region() and gdk_window_end_paint() are called
-automatically around expose events sent to the
-widget. gdk_window_begin_paint() diverts all drawing to a widget's
-window to an offscreen buffer, and gdk_window_end_paint() draws the
-buffer to the screen. The result is that users see the window
-update in one smooth step, and don't see individual graphics
-primitives being rendered.
-
-In very simple terms, double buffered widgets don't flicker,
-so you would only use this function to turn off double buffering
-if you had special needs and really knew what you were doing.
+Removes @filter from the list of #GtkRecentFilter objects held by @chooser.
-Note: if you turn off double-buffering, you have to handle
-expose events, since even the clearing to the background color or
-pixmap will not happen automatically (as it is done in
-gdk_window_begin_paint()).
+Since: 2.10
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
</parameter_description>
</parameter>
-<parameter name="double_buffered">
-<parameter_description> %TRUE to double-buffer a widget
+<parameter name="filter">
+<parameter_description> a #GtkRecentFilter
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_tag_set_priority">
+<function name="gtk_recent_chooser_select_all">
<description>
-Sets the priority of a #GtkTextTag. Valid priorities are
-start at 0 and go to one less than gtk_text_tag_table_get_size().
-Each tag in a table has a unique priority; setting the priority
-of one tag shifts the priorities of all the other tags in the
-table to maintain a unique priority for each tag. Higher priority
-tags "win" if two tags both set the same text attribute. When adding
-a tag to a tag table, it will be assigned the highest priority in
-the table by default; so normally the precedence of a set of tags
-is the order in which they were added to the table, or created with
-gtk_text_buffer_create_tag(), which adds the tag to the buffer's table
-automatically.
+Selects all the items inside @chooser, if the @chooser supports
+multiple selection.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="tag">
-<parameter_description> a #GtkTextTag
-</parameter_description>
-</parameter>
-<parameter name="priority">
-<parameter_description> the new priority
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_job_get_settings">
+<function name="gtk_recent_chooser_select_uri">
<description>
-Gets the #GtkPrintSettings of the print job.
+Selects @uri inside @chooser.
Since: 2.10
</description>
<parameters>
-<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
+</parameter_description>
+</parameter>
+<parameter name="uri">
+<parameter_description> a URI
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the settings of @job
+<return> %TRUE if @uri was found.
</return>
</function>
-<function name="gtk_range_set_show_fill_level">
+<function name="gtk_recent_chooser_set_current_uri">
<description>
-Sets whether a graphical fill level is show on the trough. See
-gtk_range_set_fill_level() for a general description of the fill
-level concept.
+Sets @uri as the current URI for @chooser.
-Since: 2.12
+Since: 2.10
</description>
<parameters>
-<parameter name="range">
-<parameter_description> A #GtkRange
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
</parameter_description>
</parameter>
-<parameter name="show_fill_level">
-<parameter_description> Whether a fill level indicator graphics is shown.
+<parameter name="uri">
+<parameter_description> a URI
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the URI was found.
+
+</return>
</function>
-<function name="gtk_widget_reparent">
+<function name="gtk_recent_chooser_set_filter">
<description>
-Moves a widget from one #GtkContainer to another, handling reference
-count issues to avoid destroying the widget.
+Sets @filter as the current #GtkRecentFilter object used by @chooser
+to affect the displayed recently used resources.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
</parameter_description>
</parameter>
-<parameter name="new_parent">
-<parameter_description> a #GtkContainer to move the widget into
+<parameter name="filter">
+<parameter_description> a #GtkRecentFilter
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_operation_get_print_settings">
+<function name="gtk_recent_chooser_set_limit">
<description>
-Returns the current print settings.
-
-Note that the return value is %NULL until either
-gtk_print_operation_set_print_settings() or
-gtk_print_operation_run() have been called.
+Sets the number of items that should be returned by
+gtk_recent_chooser_get_items() and gtk_recent_chooser_get_uris().
Since: 2.10
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
+</parameter_description>
+</parameter>
+<parameter name="limit">
+<parameter_description> a positive integer, or -1 for all items
</parameter_description>
</parameter>
</parameters>
-<return> the current print settings of @op.
-
-</return>
+<return></return>
</function>
-<function name="gtk_toolbar_unset_icon_size">
+<function name="gtk_recent_chooser_set_local_only">
<description>
-Unsets toolbar icon size set with gtk_toolbar_set_icon_size(), so that
-user preferences will be used to determine the icon size.
+Sets whether only local resources, that is resources using the file:// URI
+scheme, should be shown in the recently used resources selector. If
+ local_only is %TRUE (the default) then the shown resources are guaranteed
+to be accessible through the operating system native file system.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
+</parameter_description>
+</parameter>
+<parameter name="local_only">
+<parameter_description> %TRUE if only local files can be shown
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_im_context_delete_surrounding">
+<function name="gtk_recent_chooser_set_select_multiple">
<description>
-Asks the widget that the input context is attached to to delete
-characters around the cursor position by emitting the
-GtkIMContext::delete_surrounding signal. Note that @offset and @n_chars
-are in characters not in bytes which differs from the usage other
-places in #GtkIMContext.
-
-In order to use this function, you should first call
-gtk_im_context_get_surrounding() to get the current context, and
-call this function immediately afterwards to make sure that you
-know what you are deleting. You should also account for the fact
-that even if the signal was handled, the input context might not
-have deleted all the characters that were requested to be deleted.
-
-This function is used by an input method that wants to make
-subsitutions in the existing text in response to new input. It is
-not useful for applications.
+Sets whether @chooser can select multiple items.
+Since: 2.10
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GtkIMContext
-</parameter_description>
-</parameter>
-<parameter name="offset">
-<parameter_description> offset from cursor position in chars;
-a negative value means start before the cursor.
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
</parameter_description>
</parameter>
-<parameter name="n_chars">
-<parameter_description> number of characters to delete.
+<parameter name="select_multiple">
+<parameter_description> %TRUE if @chooser can select more than one item
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the signal was handled.
-</return>
+<return></return>
</function>
-<function name="gtk_entry_completion_get_inline_selection">
+<function name="gtk_recent_chooser_set_show_icons">
<description>
-Returns %TRUE if inline-selection mode is turned on.
+Sets whether @chooser should show an icon near the resource when
+displaying it.
-Since: 2.12
+Since: 2.10
</description>
<parameters>
-<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
+</parameter_description>
+</parameter>
+<parameter name="show_icons">
+<parameter_description> whether to show an icon near the resource
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if inline-selection mode is on
-
-</return>
+<return></return>
</function>
-<function name="gtk_widget_create_pango_layout">
+<function name="gtk_recent_chooser_set_show_not_found">
<description>
-Creates a new #PangoLayout with the appropriate font map,
-font description, and base direction for drawing text for
-this widget.
-
-If you keep a #PangoLayout created in this way around, in order to
-notify the layout of changes to the base direction or font of this
-widget, you must call pango_layout_context_changed() in response to
-the #GtkWidget::style-set and #GtkWidget::direction-changed signals
-for the widget.
+Sets whether @chooser should display the recently used resources that
+it didn't find. This only applies to local resources.
+Since: 2.10
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> text to set on the layout (can be %NULL)
+<parameter name="show_not_found">
+<parameter_description> whether to show the local items we didn't find
</parameter_description>
</parameter>
</parameters>
-<return> the new #PangoLayout
-</return>
+<return></return>
</function>
-<function name="gtk_tree_sortable_set_default_sort_func">
+<function name="gtk_recent_chooser_set_show_numbers">
<description>
-Sets the default comparison function used when sorting to be @sort_func.
-If the current sort column id of @sortable is
-%GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, then the model will sort using
-this function.
+Whether to show recently used resources prepended by a unique number.
-If @sort_func is %NULL, then there will be no default comparison function.
-This means that once the model has been sorted, it can't go back to the
-default state. In this case, when the current sort column id of @sortable
-is %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, the model will be unsorted.
+Deprecated: 2.12: Use gtk_recent_chooser_menu_set_show_numbers() instead.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="sortable">
-<parameter_description> A #GtkTreeSortable
-</parameter_description>
-</parameter>
-<parameter name="sort_func">
-<parameter_description> The comparison function
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> User data to pass to @sort_func, or %NULL
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
</parameter_description>
</parameter>
-<parameter name="destroy">
-<parameter_description> Destroy notifier of @user_data, or %NULL
+<parameter name="show_numbers">
+<parameter_description> %TRUE to show numbers, %FALSE otherwise
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_calendar_get_display_options">
+<function name="gtk_recent_chooser_set_show_private">
<description>
-Returns the current display options of @calendar.
+Whether to show recently used resources marked registered as private.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="calendar">
-<parameter_description> a #GtkCalendar
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
+</parameter_description>
+</parameter>
+<parameter name="show_private">
+<parameter_description> %TRUE to show private items, %FALSE otherwise
</parameter_description>
</parameter>
</parameters>
-<return> the display options.
-
-</return>
+<return></return>
</function>
-<function name="gtk_info_bar_add_action_widget">
+<function name="gtk_recent_chooser_set_show_tips">
<description>
-Add an activatable widget to the action area of a #GtkInfoBar,
-connecting a signal handler that will emit the #GtkInfoBar::response
-signal on the message area when the widget is activated. The widget
-is appended to the end of the message areas action area.
+Sets whether to show a tooltips containing the full path of each
+recently used resource in a #GtkRecentChooser widget.
-Since: 2.18
+Since: 2.10
</description>
<parameters>
-<parameter name="info_bar">
-<parameter_description> a #GtkInfoBar
-</parameter_description>
-</parameter>
-<parameter name="child">
-<parameter_description> an activatable widget
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
</parameter_description>
</parameter>
-<parameter name="response_id">
-<parameter_description> response ID for @child
+<parameter name="show_tips">
+<parameter_description> %TRUE if tooltips should be shown
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_entry_get_text_window">
+<function name="gtk_recent_chooser_set_sort_func">
<description>
-Returns the #GdkWindow which contains the text. This function is
-useful when drawing something to the entry in an expose-event
-callback because it enables the callback to distinguish between
-the text window and entry's icon windows.
+Sets the comparison function used when sorting to be @sort_func. If
+the @chooser has the sort type set to #GTK_RECENT_SORT_CUSTOM then
+the chooser will sort using this function.
-See also gtk_entry_get_icon_window().
+To the comparison function will be passed two #GtkRecentInfo structs and
+ sort_data; @sort_func should return a positive integer if the first
+item comes before the second, zero if the two items are equal and
+a negative integer if the first item comes after the second.
-Since: 2.20
+Since: 2.10
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
+</parameter_description>
+</parameter>
+<parameter name="sort_func">
+<parameter_description> the comparison function
+</parameter_description>
+</parameter>
+<parameter name="sort_data">
+<parameter_description> user data to pass to @sort_func, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="data_destroy">
+<parameter_description> destroy notifier for @sort_data, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the entry's text window.
-
-</return>
+<return></return>
</function>
-<function name="gtk_tree_view_row_activated">
+<function name="gtk_recent_chooser_set_sort_type">
<description>
-Activates the cell determined by @path and @column.
+Changes the sorting order of the recently used resources list displayed by
+ chooser
+
+Since: 2.10
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> The #GtkTreePath to be activated.
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
</parameter_description>
</parameter>
-<parameter name="column">
-<parameter_description> The #GtkTreeViewColumn to be activated.
+<parameter name="sort_type">
+<parameter_description> sort order that the chooser should use
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_entry_completion_set_model">
+<function name="gtk_recent_chooser_unselect_all">
<description>
-Sets the model for a #GtkEntryCompletion. If @completion already has
-a model set, it will remove it before setting the new model.
-If model is %NULL, then it will unset the model.
+Unselects all the items inside @chooser.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="completion">
-<parameter_description> A #GtkEntryCompletion.
-</parameter_description>
-</parameter>
-<parameter name="model">
-<parameter_description> The #GtkTreeModel.
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_notebook_append_page_menu">
+<function name="gtk_recent_chooser_unselect_uri">
<description>
-Appends a page to @notebook, specifying the widget to use as the
-label in the popup menu.
+Unselects @uri inside @chooser.
+Since: 2.10
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
-</parameter_description>
-</parameter>
-<parameter name="child">
-<parameter_description> the #GtkWidget to use as the contents of the page.
-</parameter_description>
-</parameter>
-<parameter name="tab_label">
-<parameter_description> the #GtkWidget to be used as the label for the page,
-or %NULL to use the default label, 'page N'.
+<parameter name="chooser">
+<parameter_description> a #GtkRecentChooser
</parameter_description>
</parameter>
-<parameter name="menu_label">
-<parameter_description> the widget to use as a label for the page-switch
-menu, if that is enabled. If %NULL, and @tab_label
-is a #GtkLabel or %NULL, then the menu label will be
-a newly created label with the same text as @tab_label;
-If @tab_label is not a #GtkLabel, @menu_label must be
-specified if the page-switch menu is to be used.
+<parameter name="uri">
+<parameter_description> a URI
</parameter_description>
</parameter>
</parameters>
-<return> the index (starting from 0) of the appended
-page in the notebook, or -1 if function fails
-</return>
+<return></return>
</function>
-<function name="gtk_radio_menu_item_new_with_mnemonic_from_widget">
+<function name="gtk_recent_chooser_widget_new">
<description>
-Creates a new GtkRadioMenuItem containing a label. The label will be
-created using gtk_label_new_with_mnemonic(), so underscores in label
-indicate the mnemonic for the menu item.
-
-The new #GtkRadioMenuItem is added to the same group as @group.
+Creates a new #GtkRecentChooserWidget object. This is an embeddable widget
+used to access the recently used resources list.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="group">
-<parameter_description> An existing #GtkRadioMenuItem
-</parameter_description>
-</parameter>
-<parameter name="label">
-<parameter_description> the text of the button, with an underscore in front of the
-mnemonic character
-</parameter_description>
-</parameter>
</parameters>
-<return> The new #GtkRadioMenuItem
+<return> a new #GtkRecentChooserWidget
</return>
</function>
-<function name="gtk_status_icon_get_visible">
+<function name="gtk_recent_chooser_widget_new_for_manager">
<description>
-Returns whether the status icon is visible or not.
-Note that being visible does not guarantee that
-the user can actually see the icon, see also
-gtk_status_icon_is_embedded().
+Creates a new #GtkRecentChooserWidget with a specified recent manager.
+
+This is useful if you have implemented your own recent manager, or if you
+have a customized instance of a #GtkRecentManager object.
Since: 2.10
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
+<parameter name="manager">
+<parameter_description> a #GtkRecentManager
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the status icon is visible
+<return> a new #GtkRecentChooserWidget
</return>
</function>
-<function name="gtk_toolbar_set_style">
+<function name="gtk_recent_filter_add_age">
<description>
-Alters the view of @toolbar to display either icons only, text only, or both.
+Adds a rule that allows resources based on their age - that is, the number
+of days elapsed since they were last modified.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar.
+<parameter name="filter">
+<parameter_description> a #GtkRecentFilter
</parameter_description>
</parameter>
-<parameter name="style">
-<parameter_description> the new style for @toolbar.
+<parameter name="days">
+<parameter_description> number of days
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_entry_set_completion">
+<function name="gtk_recent_filter_add_application">
<description>
-Sets @completion to be the auxiliary completion object to use with @entry.
-All further configuration of the completion mechanism is done on
- completion using the #GtkEntryCompletion API. Completion is disabled if
- completion is set to %NULL.
+Adds a rule that allows resources based on the name of the application
+that has registered them.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> A #GtkEntry
+<parameter name="filter">
+<parameter_description> a #GtkRecentFilter
</parameter_description>
</parameter>
-<parameter name="completion">
-<parameter_description> The #GtkEntryCompletion or %NULL
+<parameter name="application">
+<parameter_description> an application name
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_menu_popup">
+<function name="gtk_recent_filter_add_custom">
<description>
-Displays a menu and makes it available for selection. Applications can use
-this function to display context-sensitive menus, and will typically supply
-%NULL for the @parent_menu_shell, @parent_menu_item, @func and @data
-parameters. The default menu positioning function will position the menu
-at the current mouse cursor position.
-
-The @button parameter should be the mouse button pressed to initiate
-the menu popup. If the menu popup was initiated by something other than
-a mouse button press, such as a mouse button release or a keypress,
- button should be 0.
+Adds a rule to a filter that allows resources based on a custom callback
+function. The bitfield @needed which is passed in provides information
+about what sorts of information that the filter function needs;
+this allows GTK+ to avoid retrieving expensive information when
+it isn't needed by the filter.
-The @activate_time parameter is used to conflict-resolve initiation of
-concurrent requests for mouse/keyboard grab requests. To function
-properly, this needs to be the time stamp of the user event (such as
-a mouse click or key press) that caused the initiation of the popup.
-Only if no such event is available, gtk_get_current_event_time() can
-be used instead.
+Since: 2.10
</description>
<parameters>
-<parameter name="menu">
-<parameter_description> a #GtkMenu.
-</parameter_description>
-</parameter>
-<parameter name="parent_menu_shell">
-<parameter_description> the menu shell containing the triggering menu item, or %NULL
+<parameter name="filter">
+<parameter_description> a #GtkRecentFilter
</parameter_description>
</parameter>
-<parameter name="parent_menu_item">
-<parameter_description> the menu item whose activation triggered the popup, or %NULL
+<parameter name="needed">
+<parameter_description> bitfield of flags indicating the information that the custom
+filter function needs.
</parameter_description>
</parameter>
<parameter name="func">
-<parameter_description> a user supplied function used to position the menu, or %NULL
+<parameter_description> callback function; if the function returns %TRUE, then
+the file will be displayed.
</parameter_description>
</parameter>
<parameter name="data">
-<parameter_description> user supplied data to be passed to @func.
-</parameter_description>
-</parameter>
-<parameter name="button">
-<parameter_description> the mouse button which was pressed to initiate the event.
+<parameter_description> data to pass to @func
</parameter_description>
</parameter>
-<parameter name="activate_time">
-<parameter_description> the time at which the activation event occurred.
+<parameter name="data_destroy">
+<parameter_description> function to call to free @data when it is no longer needed.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_editable_set_editable">
+<function name="gtk_recent_filter_add_group">
<description>
-Determines if the user can edit the text in the editable
-widget or not.
+Adds a rule that allows resources based on the name of the group
+to which they belong
+
+Since: 2.10
</description>
<parameters>
-<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter name="filter">
+<parameter_description> a #GtkRecentFilter
</parameter_description>
</parameter>
-<parameter name="is_editable">
-<parameter_description> %TRUE if the user is allowed to edit the text
-in the widget
+<parameter name="group">
+<parameter_description> a group name
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_group_remove_window">
+<function name="gtk_recent_filter_add_mime_type">
<description>
-Removes a window from a #GtkWindowGroup.
+Adds a rule that allows resources based on their registered MIME type.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="window_group">
-<parameter_description> a #GtkWindowGroup
+<parameter name="filter">
+<parameter_description> a #GtkRecentFilter
</parameter_description>
</parameter>
-<parameter name="window">
-<parameter_description> the #GtkWindow to remove
+<parameter name="mime_type">
+<parameter_description> a MIME type
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_range_set_update_policy">
+<function name="gtk_recent_filter_add_pattern">
<description>
-Sets the update policy for the range. #GTK_UPDATE_CONTINUOUS means that
-anytime the range slider is moved, the range value will change and the
-value_changed signal will be emitted. #GTK_UPDATE_DELAYED means that
-the value will be updated after a brief timeout where no slider motion
-occurs, so updates are spaced by a short time rather than
-continuous. #GTK_UPDATE_DISCONTINUOUS means that the value will only
-be updated when the user releases the button and ends the slider
-drag operation.
+Adds a rule that allows resources based on a pattern matching their
+display name.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter name="filter">
+<parameter_description> a #GtkRecentFilter
</parameter_description>
</parameter>
-<parameter name="policy">
-<parameter_description> update policy
+<parameter name="pattern">
+<parameter_description> a file pattern
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_recent_info_get_age">
+<function name="gtk_recent_filter_add_pixbuf_formats">
<description>
-Gets the number of days elapsed since the last update of the resource
-pointed by @info.
+Adds a rule allowing image files in the formats supported
+by GdkPixbuf.
Since: 2.10
</description>
<parameters>
-<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter name="filter">
+<parameter_description> a #GtkRecentFilter
</parameter_description>
</parameter>
</parameters>
-<return> a positive integer containing the number of days elapsed
-since the time this resource was last modified.
-
-</return>
+<return></return>
</function>
-<function name="gtk_entry_select_region">
+<function name="gtk_recent_filter_filter">
<description>
-Selects a region of text. The characters that are selected are
-those characters at positions from @start_pos up to, but not
-including @end_pos. If @end_pos is negative, then the the characters
-selected will be those characters from @start_pos to the end of
-the text.
+Tests whether a file should be displayed according to @filter.
+The #GtkRecentFilterInfo structure @filter_info should include
+the fields returned from gtk_recent_filter_get_needed().
-Deprecated: 2.0: Use gtk_editable_select_region() instead.
+This function will not typically be used by applications; it
+is intended principally for use in the implementation of
+#GtkRecentChooser.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
-</parameter_description>
-</parameter>
-<parameter name="start">
-<parameter_description> the starting position
+<parameter name="filter">
+<parameter_description> a #GtkRecentFilter
</parameter_description>
</parameter>
-<parameter name="end">
-<parameter_description> the end position
+<parameter name="filter_info">
+<parameter_description> a #GtkRecentFilterInfo structure containing information
+about a recently used resource
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the file should be displayed
+
+</return>
</function>
-<function name="gtk_entry_completion_get_inline_completion">
+<function name="gtk_recent_filter_get_name">
<description>
-Returns whether the common prefix of the possible completions should
-be automatically inserted in the entry.
+Gets the human-readable name for the filter.
+See gtk_recent_filter_set_name().
-Since: 2.6
+Since: 2.10
</description>
<parameters>
-<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter name="filter">
+<parameter_description> a #GtkRecentFilter
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if inline completion is turned on
+<return> the name of the filter, or %NULL. The returned string
+is owned by the filter object and should not be freed.
</return>
</function>
-<function name="gtk_adjustment_get_lower">
+<function name="gtk_recent_filter_get_needed">
<description>
-Retrieves the minimum value of the adjustment.
+Gets the fields that need to be filled in for the structure
+passed to gtk_recent_filter_filter()
-Since: 2.14
+This function will not typically be used by applications; it
+is intended principally for use in the implementation of
+#GtkRecentChooser.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
+<parameter name="filter">
+<parameter_description> a #GtkRecentFilter
</parameter_description>
</parameter>
</parameters>
-<return> The current minimum value of the adjustment.
+<return> bitfield of flags indicating needed fields when
+calling gtk_recent_filter_filter()
</return>
</function>
-<function name="gtk_notebook_get_tab_label_text">
+<function name="gtk_recent_filter_new">
<description>
-Retrieves the text of the tab label for the page containing
- child
+Creates a new #GtkRecentFilter with no rules added to it.
+Such filter does not accept any recently used resources, so is not
+particularly useful until you add rules with
+gtk_recent_filter_add_pattern(), gtk_recent_filter_add_mime_type(),
+gtk_recent_filter_add_application(), gtk_recent_filter_add_age().
+To create a filter that accepts any recently used resource, use:
+|[
+GtkRecentFilter *filter = gtk_recent_filter_new ();
+gtk_recent_filter_add_pattern (filter, "*");
+]|
+Since: 2.10
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
-</parameter_description>
-</parameter>
-<parameter name="child">
-<parameter_description> a widget contained in a page of @notebook
-</parameter_description>
-</parameter>
</parameters>
-<return> the text of the tab label, or %NULL if the
-tab label widget is not a #GtkLabel. The
-string is owned by the widget and must not
-be freed.
+<return> a new #GtkRecentFilter
+
</return>
</function>
-<function name="gtk_menu_bar_set_child_pack_direction">
+<function name="gtk_recent_filter_set_name">
<description>
-Sets how widgets should be packed inside the children of a menubar.
+Sets the human-readable name of the filter; this is the string
+that will be displayed in the recently used resources selector
+user interface if there is a selectable list of filters.
-Since: 2.8
+Since: 2.10
</description>
<parameters>
-<parameter name="menubar">
-<parameter_description> a #GtkMenuBar
+<parameter name="filter">
+<parameter_description> a #GtkRecentFilter
</parameter_description>
</parameter>
-<parameter name="child_pack_dir">
-<parameter_description> a new #GtkPackDirection
+<parameter name="name">
+<parameter_description> then human readable name of @filter
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_view_convert_widget_to_bin_window_coords">
+<function name="gtk_recent_info_exists">
<description>
-Converts widget coordinates to coordinates for the bin_window,
-as expected by e.g. gtk_icon_view_get_path_at_pos().
+Checks whether the resource pointed by @info still exists. At
+the moment this check is done only on resources pointing to local files.
-Since: 2.12
+Since: 2.10
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
-</parameter_description>
-</parameter>
-<parameter name="wx">
-<parameter_description> X coordinate relative to the widget
-</parameter_description>
-</parameter>
-<parameter name="wy">
-<parameter_description> Y coordinate relative to the widget
-</parameter_description>
-</parameter>
-<parameter name="bx">
-<parameter_description> return location for bin_window X coordinate
-</parameter_description>
-</parameter>
-<parameter name="by">
-<parameter_description> return location for bin_window Y coordinate
+<parameter name="info">
+<parameter_description> a #GtkRecentInfo
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the resource exists
+
+</return>
</function>
-<function name="gtk_paint_option">
+<function name="gtk_recent_info_get_added">
<description>
-Draws a radio button indicator in the given rectangle on @window with
-the given parameters.
+Gets the timestamp (seconds from system's Epoch) when the resource
+was added to the recently used resources list.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
+<parameter name="info">
+<parameter_description> a #GtkRecentInfo
</parameter_description>
</parameter>
-<parameter name="shadow_type">
-<parameter_description> the type of shadow to draw
+</parameters>
+<return> the number of seconds elapsed from system's Epoch when
+the resource was added to the list, or -1 on failure.
+
+</return>
+</function>
+
+<function name="gtk_recent_info_get_age">
+<description>
+Gets the number of days elapsed since the last update of the resource
+pointed by @info.
+
+Since: 2.10
+
+</description>
+<parameters>
+<parameter name="info">
+<parameter_description> a #GtkRecentInfo
</parameter_description>
</parameter>
-<parameter name="area">
-<parameter_description> clip rectangle, or %NULL if the
-output should not be clipped
+</parameters>
+<return> a positive integer containing the number of days elapsed
+since the time this resource was last modified.
+
+</return>
+</function>
+
+<function name="gtk_recent_info_get_application_info">
+<description>
+Gets the data regarding the application that has registered the resource
+pointed by @info.
+
+If the command line contains any escape characters defined inside the
+storage specification, they will be expanded.
+
+Since: 2.10
+
+</description>
+<parameters>
+<parameter name="info">
+<parameter_description> a #GtkRecentInfo
</parameter_description>
</parameter>
-<parameter name="widget">
-<parameter_description> the widget
+<parameter name="app_name">
+<parameter_description> the name of the application that has registered this item
</parameter_description>
</parameter>
-<parameter name="detail">
-<parameter_description> a style detail
+<parameter name="app_exec">
+<parameter_description> return location for the string containing the command line
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> x origin of the rectangle to draw the option in
+<parameter name="count">
+<parameter_description> return location for the number of times this item was registered
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> y origin of the rectangle to draw the option in
+<parameter name="time_">
+<parameter_description> return location for the timestamp this item was last registered
+for this application
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> the width of the rectangle to draw the option in
+</parameters>
+<return> %TRUE if an application with @app_name has registered this
+resource inside the recently used list, or %FALSE otherwise. The
+ app_exec string is owned by the #GtkRecentInfo and should not be
+modified or freed
+
+</return>
+</function>
+
+<function name="gtk_recent_info_get_applications">
+<description>
+Retrieves the list of applications that have registered this resource.
+
+Since: 2.10
+
+</description>
+<parameters>
+<parameter name="info">
+<parameter_description> a #GtkRecentInfo
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> the height of the rectangle to draw the option in
+<parameter name="length">
+<parameter_description> return location for the length of the returned list
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return>
+a newly allocated %NULL-terminated array of strings.
+Use g_strfreev() to free it.
+
+</return>
</function>
-<function name="gtk_window_activate_focus">
+<function name="gtk_recent_info_get_description">
<description>
-Activates the current focused widget within the window.
+Gets the (short) description of the resource.
+Since: 2.10
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="info">
+<parameter_description> a #GtkRecentInfo
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if a widget got activated.
+<return> the description of the resource. The returned string
+is owned by the recent manager, and should not be freed.
+
</return>
</function>
-<function name="gtk_entry_completion_delete_action">
+<function name="gtk_recent_info_get_display_name">
<description>
-Deletes the action at @index_ from @completion's action list.
+Gets the name of the resource. If none has been defined, the basename
+of the resource is obtained.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="completion">
-<parameter_description> A #GtkEntryCompletion.
-</parameter_description>
-</parameter>
-<parameter name="index_">
-<parameter_description> The index of the item to Delete.
+<parameter name="info">
+<parameter_description> a #GtkRecentInfo
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the display name of the resource. The returned string
+is owned by the recent manager, and should not be freed.
+
+</return>
</function>
-<function name="gtk_calendar_set_detail_func">
+<function name="gtk_recent_info_get_groups">
<description>
-Installs a function which provides Pango markup with detail information
-for each day. Examples for such details are holidays or appointments. That
-information is shown below each day when #GtkCalendar:show-details is set.
-A tooltip containing with full detail information is provided, if the entire
-text should not fit into the details area, or if #GtkCalendar:show-details
-is not set.
-
-The size of the details area can be restricted by setting the
-#GtkCalendar:detail-width-chars and #GtkCalendar:detail-height-rows
-properties.
+Returns all groups registered for the recently used item @info. The
+array of returned group names will be %NULL terminated, so length might
+optionally be %NULL.
-Since: 2.14
+Since: 2.10
</description>
<parameters>
-<parameter name="calendar">
-<parameter_description> a #GtkCalendar.
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> a function providing details for each day.
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> data to pass to @func invokations.
+<parameter name="info">
+<parameter_description> a #GtkRecentInfo
</parameter_description>
</parameter>
-<parameter name="destroy">
-<parameter_description> a function for releasing @data.
+<parameter name="length">
+<parameter_description> return location for the number of groups returned
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return>
+a newly allocated %NULL terminated array of strings.
+Use g_strfreev() to free it.
+
+</return>
</function>
-<function name="gtk_text_view_window_to_buffer_coords">
+<function name="gtk_recent_info_get_icon">
<description>
-Converts coordinates on the window identified by @win to buffer
-coordinates, storing the result in (@buffer_x,@buffer_y).
+Retrieves the icon of size @size associated to the resource MIME type.
-Note that you can't convert coordinates for a nonexisting window (see
-gtk_text_view_set_border_window_size()).
+Since: 2.10
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
-</parameter_description>
-</parameter>
-<parameter name="win">
-<parameter_description> a #GtkTextWindowType except #GTK_TEXT_WINDOW_PRIVATE
-</parameter_description>
-</parameter>
-<parameter name="window_x">
-<parameter_description> window x coordinate
-</parameter_description>
-</parameter>
-<parameter name="window_y">
-<parameter_description> window y coordinate
-</parameter_description>
-</parameter>
-<parameter name="buffer_x">
-<parameter_description> buffer x coordinate return location or %NULL
+<parameter name="info">
+<parameter_description> a #GtkRecentInfo
</parameter_description>
</parameter>
-<parameter name="buffer_y">
-<parameter_description> buffer y coordinate return location or %NULL
+<parameter name="size">
+<parameter_description> the size of the icon in pixels
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #GdkPixbuf containing the icon,
+or %NULL. Use g_object_unref() when finished using the icon.
+
+</return>
</function>
-<function name="gtk_text_iter_get_offset">
+<function name="gtk_recent_info_get_mime_type">
<description>
-Returns the character offset of an iterator.
-Each character in a #GtkTextBuffer has an offset,
-starting with 0 for the first character in the buffer.
-Use gtk_text_buffer_get_iter_at_offset () to convert an
-offset back into an iterator.
+Gets the MIME type of the resource.
+Since: 2.10
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
+<parameter name="info">
+<parameter_description> a #GtkRecentInfo
</parameter_description>
</parameter>
</parameters>
-<return> a character offset
+<return> the MIME type of the resource. The returned string
+is owned by the recent manager, and should not be freed.
+
</return>
</function>
-<function name="gtk_tree_store_iter_is_valid">
+<function name="gtk_recent_info_get_modified">
<description>
-WARNING: This function is slow. Only use it for debugging and/or testing
-purposes.
-
-Checks if the given iter is a valid iter for this #GtkTreeStore.
+Gets the timestamp (seconds from system's Epoch) when the resource
+was last modified.
-Since: 2.2
+Since: 2.10
</description>
<parameters>
-<parameter name="tree_store">
-<parameter_description> A #GtkTreeStore.
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> A #GtkTreeIter.
+<parameter name="info">
+<parameter_description> a #GtkRecentInfo
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the iter is valid, %FALSE if the iter is invalid.
+<return> the number of seconds elapsed from system's Epoch when
+the resource was last modified, or -1 on failure.
</return>
</function>
-<function name="gtk_color_button_set_color">
+<function name="gtk_recent_info_get_private_hint">
<description>
-Sets the current color to be @color.
+Gets the value of the "private" flag. Resources in the recently used
+list that have this flag set to %TRUE should only be displayed by the
+applications that have registered them.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="color_button">
-<parameter_description> a #GtkColorButton.
-</parameter_description>
-</parameter>
-<parameter name="color">
-<parameter_description> A #GdkColor to set the current color with.
+<parameter name="info">
+<parameter_description> a #GtkRecentInfo
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the private flag was found, %FALSE otherwise.
+
+</return>
</function>
-<function name="gtk_print_settings_get_finishings">
+<function name="gtk_recent_info_get_short_name">
<description>
-Gets the value of %GTK_PRINT_SETTINGS_FINISHINGS.
+Computes a valid UTF-8 string that can be used as the name of the item in a
+menu or list. For example, calling this function on an item that refers to
+"file:///foo/bar.txt" will yield "bar.txt".
Since: 2.10
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="info">
+<parameter_description> an #GtkRecentInfo
</parameter_description>
</parameter>
</parameters>
-<return> the finishings
+<return> A newly-allocated string in UTF-8 encoding; free it with
+g_free().
</return>
</function>
-<function name="gtk_text_iter_backward_line">
+<function name="gtk_recent_info_get_uri">
<description>
-Moves @iter to the start of the previous line. Returns %TRUE if
- iter could be moved; i.e. if @iter was at character offset 0, this
-function returns %FALSE. Therefore if @iter was already on line 0,
-but not at the start of the line, @iter is snapped to the start of
-the line and the function returns %TRUE. (Note that this implies that
-in a loop calling this function, the line number may not change on
-every iteration, if your first iteration is on line 0.)
+Gets the URI of the resource.
+Since: 2.10
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
+<parameter name="info">
+<parameter_description> a #GtkRecentInfo
</parameter_description>
</parameter>
</parameters>
-<return> whether @iter moved
+<return> the URI of the resource. The returned string is
+owned by the recent manager, and should not be freed.
+
</return>
</function>
-<function name="gtk_scale_button_set_value">
+<function name="gtk_recent_info_get_uri_display">
<description>
-Sets the current value of the scale; if the value is outside
-the minimum or maximum range values, it will be clamped to fit
-inside them. The scale button emits the #GtkScaleButton::value-changed
-signal if the value changes.
+Gets a displayable version of the resource's URI. If the resource
+is local, it returns a local path; if the resource is not local,
+it returns the UTF-8 encoded content of gtk_recent_info_get_uri().
-Since: 2.12
+Since: 2.10
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkScaleButton
-</parameter_description>
-</parameter>
-<parameter name="value">
-<parameter_description> new value of the scale button
+<parameter name="info">
+<parameter_description> a #GtkRecentInfo
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a newly allocated UTF-8 string containing the
+resource's URI or %NULL. Use g_free() when done using it.
+
+</return>
</function>
-<function name="gtk_font_selection_get_family">
+<function name="gtk_recent_info_get_visited">
<description>
-Gets the #PangoFontFamily representing the selected font family.
+Gets the timestamp (seconds from system's Epoch) when the resource
+was last visited.
-Since: 2.14
+Since: 2.10
</description>
<parameters>
-<parameter name="fontsel">
-<parameter_description> a #GtkFontSelection
+<parameter name="info">
+<parameter_description> a #GtkRecentInfo
</parameter_description>
</parameter>
</parameters>
-<return> A #PangoFontFamily representing the selected font
-family. Font families are a collection of font faces. The
-returned object is owned by @fontsel and must not be modified
-or freed.
+<return> the number of seconds elapsed from system's Epoch when
+the resource was last visited, or -1 on failure.
</return>
</function>
-<function name="gtk_scale_clear_marks">
+<function name="gtk_recent_info_has_application">
<description>
-Removes any marks that have been added with gtk_scale_add_mark().
+Checks whether an application registered this resource using @app_name.
-Since: 2.16
+Since: 2.10
</description>
<parameters>
-<parameter name="scale">
-<parameter_description> a #GtkScale
+<parameter name="info">
+<parameter_description> a #GtkRecentInfo
+</parameter_description>
+</parameter>
+<parameter name="app_name">
+<parameter_description> a string containing an application name
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if an application with name @app_name was found,
+%FALSE otherwise.
+
+</return>
</function>
-<function name="gtk_print_unix_dialog_get_embed_page_setup">
+<function name="gtk_recent_info_has_group">
<description>
-Gets the value of #GtkPrintUnixDialog::embed-page-setup property.
+Checks whether @group_name appears inside the groups registered for the
+recently used item @info.
-Since: 2.18
+Since: 2.10
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter name="info">
+<parameter_description> a #GtkRecentInfo
+</parameter_description>
+</parameter>
+<parameter name="group_name">
+<parameter_description> name of a group
</parameter_description>
</parameter>
</parameters>
-<return> whether there is a selection
+<return> %TRUE if the group was found.
</return>
</function>
-<function name="gtk_entry_set_visibility">
+<function name="gtk_recent_info_is_local">
<description>
-Sets whether the contents of the entry are visible or not.
-When visibility is set to %FALSE, characters are displayed
-as the invisible char, and will also appear that way when
-the text in the entry widget is copied elsewhere.
+Checks whether the resource is local or not by looking at the
+scheme of its URI.
-By default, GTK+ picks the best invisible character available
-in the current font, but it can be changed with
-gtk_entry_set_invisible_char().
+Since: 2.10
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
-</parameter_description>
-</parameter>
-<parameter name="visible">
-<parameter_description> %TRUE if the contents of the entry are displayed
-as plaintext
+<parameter name="info">
+<parameter_description> a #GtkRecentInfo
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the resource is local.
+
+</return>
</function>
-<function name="gtk_action_get_is_important">
+<function name="gtk_recent_info_last_application">
<description>
-Checks whether @action is important or not
+Gets the name of the last application that have registered the
+recently used resource represented by @info.
-Since: 2.16
+Since: 2.10
</description>
<parameters>
-<parameter name="action">
-<parameter_description> a #GtkAction
+<parameter name="info">
+<parameter_description> a #GtkRecentInfo
</parameter_description>
</parameter>
</parameters>
-<return> whether @action is important
+<return> an application name. Use g_free() to free it.
</return>
</function>
-<function name="gtk_radio_menu_item_new_with_label_from_widget">
+<function name="gtk_recent_info_match">
<description>
-Creates a new GtkRadioMenuItem whose child is a simple GtkLabel.
-The new #GtkRadioMenuItem is added to the same group as @group.
+Checks whether two #GtkRecentInfo structures point to the same
+resource.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="group">
-<parameter_description> an existing #GtkRadioMenuItem
+<parameter name="info_a">
+<parameter_description> a #GtkRecentInfo
</parameter_description>
</parameter>
-<parameter name="label">
-<parameter_description> the text for the label
+<parameter name="info_b">
+<parameter_description> a #GtkRecentInfo
</parameter_description>
</parameter>
</parameters>
-<return> The new #GtkRadioMenuItem
+<return> %TRUE if both #GtkRecentInfo structures point to se same
+resource, %FALSE otherwise.
</return>
</function>
-<function name="gtk_icon_info_get_base_size">
+<function name="gtk_recent_info_ref">
<description>
-Gets the base size for the icon. The base size
-is a size for the icon that was specified by
-the icon theme creator. This may be different
-than the actual size of image; an example of
-this is small emblem icons that can be attached
-to a larger icon. These icons will be given
-the same base size as the larger icons to which
-they are attached.
+Increases the reference count of @recent_info by one.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="icon_info">
-<parameter_description> a #GtkIconInfo
+<parameter name="info">
+<parameter_description> a #GtkRecentInfo
</parameter_description>
</parameter>
</parameters>
-<return> the base size, or 0, if no base
-size is known for the icon.
+<return> the recent info object with its reference count increased
+by one.
</return>
</function>
-<function name="gtk_viewport_set_hadjustment">
+<function name="gtk_recent_info_unref">
<description>
-Sets the horizontal adjustment of the viewport.
+Decreases the reference count of @info by one. If the reference
+count reaches zero, @info is deallocated, and the memory freed.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="viewport">
-<parameter_description> a #GtkViewport.
-</parameter_description>
-</parameter>
-<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment.
+<parameter name="info">
+<parameter_description> a #GtkRecentInfo
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_color_selection_set_change_palette_hook">
+<function name="gtk_recent_manager_add_full">
<description>
-Installs a global function to be called whenever the user tries to
-modify the palette in a color selection. This function should save
-the new palette contents, and update the GtkSettings property
-"gtk-color-palette" so all GtkColorSelection widgets will be modified.
+Adds a new resource, pointed by @uri, into the recently used
+resources list, using the metadata specified inside the #GtkRecentData
+structure passed in @recent_data.
-Deprecated: 2.4: This function does not work in multihead environments.
-Use gtk_color_selection_set_change_palette_with_screen_hook() instead.
+The passed URI will be used to identify this resource inside the
+list.
+In order to register the new recently used resource, metadata about
+the resource must be passed as well as the URI; the metadata is
+stored in a #GtkRecentData structure, which must contain the MIME
+type of the resource pointed by the URI; the name of the application
+that is registering the item, and a command line to be used when
+launching the item.
+
+Optionally, a #GtkRecentData structure might contain a UTF-8 string
+to be used when viewing the item instead of the last component of the
+URI; a short description of the item; whether the item should be
+considered private - that is, should be displayed only by the
+applications that have registered it.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="func">
-<parameter_description> a function to call when the custom palette needs saving.
+<parameter name="manager">
+<parameter_description> a #GtkRecentManager
+</parameter_description>
+</parameter>
+<parameter name="uri">
+<parameter_description> a valid URI
+</parameter_description>
+</parameter>
+<parameter name="recent_data">
+<parameter_description> metadata of the resource
</parameter_description>
</parameter>
</parameters>
-<return> the previous change palette hook (that was replaced).
+<return> %TRUE if the new item was successfully added to the
+recently used resources list, %FALSE otherwise.
</return>
</function>
-<function name="gtk_widget_set_tooltip_markup">
+<function name="gtk_recent_manager_add_item">
<description>
-Sets @markup as the contents of the tooltip, which is marked up with
-the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
+Adds a new resource, pointed by @uri, into the recently used
+resources list.
-This function will take care of setting GtkWidget:has-tooltip to %TRUE
-and of the default handler for the GtkWidget::query-tooltip signal.
+This function automatically retrieves some of the needed
+metadata and setting other metadata to common default values; it
+then feeds the data to gtk_recent_manager_add_full().
-See also the GtkWidget:tooltip-markup property and
-gtk_tooltip_set_markup().
+See gtk_recent_manager_add_full() if you want to explicitly
+define the metadata for the resource pointed by @uri.
-Since: 2.12
+Since: 2.10
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="manager">
+<parameter_description> a #GtkRecentManager
</parameter_description>
</parameter>
-<parameter name="markup">
-<parameter_description> the contents of the tooltip for @widget, or %NULL
+<parameter name="uri">
+<parameter_description> a valid URI
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the new item was successfully added
+to the recently used resources list
+
+</return>
</function>
-<function name="gtk_clipboard_wait_for_targets">
+<function name="gtk_recent_manager_get_default">
<description>
-Returns a list of targets that are present on the clipboard, or %NULL
-if there aren't any targets available. The returned list must be
-freed with g_free().
-This function waits for the data to be received using the main
-loop, so events, timeouts, etc, may be dispatched during the wait.
+Gets a unique instance of #GtkRecentManager, that you can share
+in your application without caring about memory management. The
+returned instance will be freed when you application terminates.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="clipboard">
-<parameter_description> a #GtkClipboard
-</parameter_description>
-</parameter>
-<parameter name="targets">
-<parameter_description> location to store an array of targets. The result
-stored here must be freed with g_free().
-</parameter_description>
-</parameter>
-<parameter name="n_targets">
-<parameter_description> location to store number of items in @targets.
-</parameter_description>
-</parameter>
</parameters>
-<return> %TRUE if any targets are present on the clipboard,
-otherwise %FALSE.
+<return> A unique #GtkRecentManager. Do not ref or unref it.
</return>
</function>
-<function name="gtk_text_buffer_get_iter_at_child_anchor">
+<function name="gtk_recent_manager_get_for_screen">
<description>
-Obtains the location of @anchor within @buffer.
+Gets the recent manager object associated with @screen; if this
+function has not previously been called for the given screen,
+a new recent manager object will be created and associated with
+the screen. Recent manager objects are fairly expensive to create,
+so using this function is usually a better choice than calling
+gtk_recent_manager_new() and setting the screen yourself; by using
+this function a single recent manager object will be shared between
+users.
+
+Deprecated: 2.12: This function has been deprecated and should
+not be used in newly written code. Calling this function is
+equivalent to calling gtk_recent_manager_get_default().
+
+Since: 2.10
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> an iterator to be initialized
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
-<parameter name="anchor">
-<parameter_description> a child anchor that appears in @buffer
+</parameters>
+<return> A unique #GtkRecentManager associated with the given
+screen. This recent manager is associated to the with the screen
+and can be used as long as the screen is open. Do not ref or
+unref it.
+
+</return>
+</function>
+
+<function name="gtk_recent_manager_get_items">
+<description>
+Gets the list of recently used resources.
+
+Since: 2.10
+
+</description>
+<parameters>
+<parameter name="manager">
+<parameter_description> a #GtkRecentManager
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a list of
+newly allocated #GtkRecentInfo objects. Use
+gtk_recent_info_unref() on each item inside the list, and then
+free the list itself using g_list_free().
+
+</return>
</function>
-<function name="gtk_print_settings_foreach">
+<function name="gtk_recent_manager_get_limit">
<description>
-Calls @func for each key-value pair of @settings.
+Gets the maximum number of items that the gtk_recent_manager_get_items()
+function should return.
Since: 2.10
+Deprecated: 2.22: The length of the list should be managed by the
+view (implementing #GtkRecentChooser), and not by the model (the
+#GtkRecentManager). See #GtkRecentChooser:limit.
+
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="manager">
+<parameter_description> a #GtkRecentManager
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> (scope call) the function to call
+</parameters>
+<return> the number of items to return, or -1 for every item.
+
+</return>
+</function>
+
+<function name="gtk_recent_manager_has_item">
+<description>
+Checks whether there is a recently used resource registered
+with @uri inside the recent manager.
+
+Since: 2.10
+
+</description>
+<parameters>
+<parameter name="manager">
+<parameter_description> a #GtkRecentManager
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data for @func
+<parameter name="uri">
+<parameter_description> a URI
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the resource was found, %FALSE otherwise.
+
+</return>
</function>
-<function name="gtk_print_operation_set_has_selection">
+<function name="gtk_recent_manager_lookup_item">
<description>
-Sets whether there is a selection to print.
-
-Application has to set number of pages to which the selection
-will draw by gtk_print_operation_set_n_pages() in a callback of
-#GtkPrintOperation::begin-print.
+Searches for a URI inside the recently used resources list, and
+returns a structure containing informations about the resource
+like its MIME type, or its display name.
-Since: 2.18
+Since: 2.10
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter name="manager">
+<parameter_description> a #GtkRecentManager
</parameter_description>
</parameter>
-<parameter name="has_selection">
-<parameter_description> %TRUE indicates that a selection exists
+<parameter name="uri">
+<parameter_description> a URI
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a return location for a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #GtkRecentInfo structure containing information
+about the resource pointed by @uri, or %NULL if the URI was
+not registered in the recently used resources list. Free with
+gtk_recent_info_unref().
+
+</return>
</function>
-<function name="gtk_action_get_label">
+<function name="gtk_recent_manager_move_item">
<description>
-Gets the label text of @action.
+Changes the location of a recently used resource from @uri to @new_uri.
-Since: 2.16
+Please note that this function will not affect the resource pointed
+by the URIs, but only the URI used in the recently used resources list.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="action">
-<parameter_description> a #GtkAction
+<parameter name="manager">
+<parameter_description> a #GtkRecentManager
+</parameter_description>
+</parameter>
+<parameter name="uri">
+<parameter_description> the URI of a recently used resource
+</parameter_description>
+</parameter>
+<parameter name="new_uri">
+<parameter_description> the new URI of the recently used resource, or %NULL to
+remove the item pointed by @uri in the list
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a return location for a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the label text
+<return> %TRUE on success.
</return>
</function>
-<function name="gtk_ui_manager_new">
+<function name="gtk_recent_manager_new">
<description>
-Creates a new ui manager object.
+Creates a new recent manager object. Recent manager objects are used to
+handle the list of recently used resources. A #GtkRecentManager object
+monitors the recently used resources list, and emits the "changed" signal
+each time something inside the list changes.
-Since: 2.4
+#GtkRecentManager objects are expensive: be sure to create them only when
+needed. You should use gtk_recent_manager_get_default() instead.
+
+Since: 2.10
</description>
<parameters>
</parameters>
-<return> a new ui manager object.
+<return> A newly created #GtkRecentManager object.
</return>
</function>
-<function name="gtk_text_iter_get_toggled_tags">
+<function name="gtk_recent_manager_purge_items">
<description>
-Returns a list of #GtkTextTag that are toggled on or off at this
-point. (If @toggled_on is %TRUE, the list contains tags that are
-toggled on.) If a tag is toggled on at @iter, then some non-empty
-range of characters following @iter has that tag applied to it. If
-a tag is toggled off, then some non-empty range following @iter
-does <emphasis>not</emphasis> have the tag applied to it.
+Purges every item from the recently used resources list.
+Since: 2.10
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
+<parameter name="manager">
+<parameter_description> a #GtkRecentManager
</parameter_description>
</parameter>
-<parameter name="toggled_on">
-<parameter_description> %TRUE to get toggled-on tags
+<parameter name="error">
+<parameter_description> a return location for a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> tags toggled at this point
+<return> the number of items that have been removed from the
+recently used resources list.
+
</return>
</function>
-<function name="gtk_radio_tool_button_new">
+<function name="gtk_recent_manager_remove_item">
<description>
-Creates a new #GtkRadioToolButton, adding it to @group.
+Removes a resource pointed by @uri from the recently used resources
+list handled by a recent manager.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="group">
-<parameter_description> An existing radio button group, or %NULL if you are creating a new group
+<parameter name="manager">
+<parameter_description> a #GtkRecentManager
+</parameter_description>
+</parameter>
+<parameter name="uri">
+<parameter_description> the URI of the item you wish to remove
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> The new #GtkRadioToolButton
+<return> %TRUE if the item pointed by @uri has been successfully
+removed by the recently used resources list, and %FALSE otherwise.
</return>
</function>
-<function name="gtk_vbutton_box_set_spacing_default">
+<function name="gtk_recent_manager_set_limit">
<description>
-Changes the default spacing that is placed between widgets in an
-vertical button box.
+Sets the maximum number of item that the gtk_recent_manager_get_items()
+function should return. If @limit is set to -1, then return all the
+items.
-Deprecated: 2.0: Use gtk_box_set_spacing() instead.
+Since: 2.10
+
+Deprecated: 2.22: The length of the list should be managed by the
+view (implementing #GtkRecentChooser), and not by the model (the
+#GtkRecentManager). See #GtkRecentChooser:limit.
</description>
<parameters>
-<parameter name="spacing">
-<parameter_description> an integer value.
+<parameter name="manager">
+<parameter_description> a #GtkRecentManager
+</parameter_description>
+</parameter>
+<parameter name="limit">
+<parameter_description> the maximum number of items to return, or -1.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tool_item_group_set_label_widget">
+<function name="gtk_recent_manager_set_screen">
<description>
-Sets the label of the tool item group.
-The label widget is displayed in the header of the group, in place
-of the usual label.
+Sets the screen for a recent manager; the screen is used to
+track the user's currently configured recently used documents
+storage.
-Since: 2.20
+Since: 2.10
+
+Deprecated: 2.12: This function has been deprecated and should
+not be used in newly written code. Calling this function has
+no effect.
</description>
<parameters>
-<parameter name="group">
-<parameter_description> a #GtkToolItemGroup
+<parameter name="manager">
+<parameter_description> a #GtkRecentManager
</parameter_description>
</parameter>
-<parameter name="label_widget">
-<parameter_description> the widget to be displayed in place of the usual label
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_editable_get_position">
+<function name="gtk_requisition_copy">
<description>
-Retrieves the current position of the cursor relative to the start
-of the content of the editable.
-
-Note that this position is in characters, not in bytes.
+Copies a #GtkRequisition.
</description>
<parameters>
-<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter name="requisition">
+<parameter_description> a #GtkRequisition
</parameter_description>
</parameter>
</parameters>
-<return> the cursor position
+<return> a copy of @requisition
</return>
</function>
-<function name="gtk_style_set_font">
+<function name="gtk_requisition_free">
<description>
-Sets the #GdkFont to use for a given style. This is
-meant only as a replacement for direct access to style->font
-and should not be used in new code. New code should
-use style->font_desc instead.
+Frees a #GtkRequisition.
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle.
-</parameter_description>
-</parameter>
-<parameter name="font">
-<parameter_description> a #GdkFont, or %NULL to use the #GdkFont corresponding
-to style->font_desc.
+<parameter name="requisition">
+<parameter_description> a #GtkRequisition
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_iter_forward_find_char">
+<function name="gtk_rgb_to_hsv">
<description>
-Advances @iter, calling @pred on each character. If
- pred returns %TRUE, returns %TRUE and stops scanning.
-If @pred never returns %TRUE, @iter is set to @limit if
- limit is non-%NULL, otherwise to the end iterator.
+Converts a color from RGB space to HSV.
+Input values must be in the [0.0, 1.0] range;
+output values will be in the same range.
+Since: 2.14
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="r">
+<parameter_description> Red
</parameter_description>
</parameter>
-<parameter name="pred">
-<parameter_description> a function to be called on each character
+<parameter name="g">
+<parameter_description> Green
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data for @pred
+<parameter name="b">
+<parameter_description> Blue
</parameter_description>
</parameter>
-<parameter name="limit">
-<parameter_description> search limit, or %NULL for none
+<parameter name="h">
+<parameter_description> Return value for the hue component
+</parameter_description>
+</parameter>
+<parameter name="s">
+<parameter_description> Return value for the saturation component
+</parameter_description>
+</parameter>
+<parameter name="v">
+<parameter_description> Return value for the value component
</parameter_description>
</parameter>
</parameters>
-<return> whether a match was found
-</return>
+<return></return>
</function>
-<function name="gtk_about_dialog_get_copyright">
+<function name="gtk_ruler_get_metric">
<description>
-Returns the copyright string.
+Gets the units used for a #GtkRuler. See gtk_ruler_set_metric().
-Since: 2.6
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter name="ruler">
+<parameter_description> a #GtkRuler
</parameter_description>
</parameter>
</parameters>
-<return> The copyright string. The string is owned by the about
-dialog and must not be modified.
+<return> the units currently used for @ruler
+ Deprecated: 2.24: #GtkRuler has been removed from GTK 3 for being
+unmaintained and too specialized. There is no replacement.
</return>
</function>
-<function name="gtk_stock_set_translate_func">
+<function name="gtk_ruler_get_range">
<description>
-Sets a function to be used for translating the @label of
-a stock item.
-
-If no function is registered for a translation domain,
-g_dgettext() is used.
-
-The function is used for all stock items whose
- translation_domain matches @domain. Note that it is possible
-to use strings different from the actual gettext translation domain
-of your application for this, as long as your #GtkTranslateFunc uses
-the correct domain when calling dgettext(). This can be useful, e.g.
-when dealing with message contexts:
-
-|[
-GtkStockItem items[] = {
-{ MY_ITEM1, NC_("odd items", "Item 1"), 0, 0, "odd-item-domain" },
-{ MY_ITEM2, NC_("even items", "Item 2"), 0, 0, "even-item-domain" },
-};
-
-gchar *
-my_translate_func (const gchar *msgid,
-gpointer data)
-{
-gchar *msgctxt = data;
-
-return (gchar*)g_dpgettext2 (GETTEXT_PACKAGE, msgctxt, msgid);
-}
-
-/ * ... * /
-
-gtk_stock_add (items, G_N_ELEMENTS (items));
-gtk_stock_set_translate_func ("odd-item-domain", my_translate_func, "odd items");
-gtk_stock_set_translate_func ("even-item-domain", my_translate_func, "even items");
-]|
+Retrieves values indicating the range and current position of a #GtkRuler.
+See gtk_ruler_set_range().
-Since: 2.8
+ Deprecated: 2.24: #GtkRuler has been removed from GTK 3 for being
+unmaintained and too specialized. There is no replacement.
</description>
<parameters>
-<parameter name="domain">
-<parameter_description> the translation domain for which @func shall be used
+<parameter name="ruler">
+<parameter_description> a #GtkRuler
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> a #GtkTranslateFunc
+<parameter name="lower">
+<parameter_description> location to store lower limit of the ruler, or %NULL
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to pass to @func
+<parameter name="upper">
+<parameter_description> location to store upper limit of the ruler, or %NULL
</parameter_description>
</parameter>
-<parameter name="notify">
-<parameter_description> a #GDestroyNotify that is called when @data is
-no longer needed
+<parameter name="position">
+<parameter_description> location to store the current position of the mark on the ruler, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="max_size">
+<parameter_description> location to store the maximum size of the ruler used when calculating
+the space to leave for the text, or %NULL.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_combo_box_get_row_separator_func">
+<function name="gtk_ruler_set_range">
<description>
-Returns the current row separator function.
+This sets the range of the ruler.
-Since: 2.6
+ Deprecated: 2.24: #GtkRuler has been removed from GTK 3 for being
+unmaintained and too specialized. There is no replacement.
</description>
<parameters>
-<parameter name="combo_box">
-<parameter_description> a #GtkComboBox
+<parameter name="ruler">
+<parameter_description> the gtkruler
+</parameter_description>
+</parameter>
+<parameter name="lower">
+<parameter_description> the lower limit of the ruler
+</parameter_description>
+</parameter>
+<parameter name="upper">
+<parameter_description> the upper limit of the ruler
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> the mark on the ruler
+</parameter_description>
+</parameter>
+<parameter name="max_size">
+<parameter_description> the maximum size of the ruler used when calculating the space to
+leave for the text
</parameter_description>
</parameter>
</parameters>
-<return> the current row separator function.
-
-</return>
+<return></return>
</function>
-<function name="gtk_file_filter_filter">
+<function name="gtk_scale_add_mark">
<description>
-Tests whether a file should be displayed according to @filter.
-The #GtkFileFilterInfo structure @filter_info should include
-the fields returned from gtk_file_filter_get_needed().
+Adds a mark at @value.
-This function will not typically be used by applications; it
-is intended principally for use in the implementation of
-#GtkFileChooser.
+A mark is indicated visually by drawing a tick mark next to the scale,
+and GTK+ makes it easy for the user to position the scale exactly at the
+marks value.
-Since: 2.4
+If @markup is not %NULL, text is shown next to the tick mark.
+
+To remove marks from a scale, use gtk_scale_clear_marks().
+
+Since: 2.16
</description>
<parameters>
-<parameter name="filter">
-<parameter_description> a #GtkFileFilter
+<parameter name="scale">
+<parameter_description> a #GtkScale
</parameter_description>
</parameter>
-<parameter name="filter_info">
-<parameter_description> a #GtkFileFilterInfo structure containing information
-about a file.
+<parameter name="value">
+<parameter_description> the value at which the mark is placed, must be between
+the lower and upper limits of the scales' adjustment
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> where to draw the mark. For a horizontal scale, #GTK_POS_TOP
+is drawn above the scale, anything else below. For a vertical scale,
+#GTK_POS_LEFT is drawn to the left of the scale, anything else to the
+right.
+</parameter_description>
+</parameter>
+<parameter name="markup">
+<parameter_description> Text to be shown at the mark, using <link linkend="PangoMarkupFormat">Pango markup</link>, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the file should be displayed
-
-</return>
+<return></return>
</function>
-<function name="gtk_cell_renderer_spin_new">
+<function name="gtk_scale_button_get_adjustment">
<description>
-Creates a new #GtkCellRendererSpin.
+Gets the #GtkAdjustment associated with the #GtkScaleButton's scale.
+See gtk_range_get_adjustment() for details.
-Since: 2.10
+Since: 2.12
</description>
<parameters>
+<parameter name="button">
+<parameter_description> a #GtkScaleButton
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GtkCellRendererSpin
+<return> the adjustment associated with the scale
</return>
</function>
-<function name="gtk_container_get_children">
+<function name="gtk_scale_button_get_minus_button">
<description>
-Returns the container's non-internal children. See
-gtk_container_forall() for details on what constitutes an "internal" child.
+Retrieves the minus button of the #GtkScaleButton.
+Since: 2.14
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
+<parameter name="button">
+<parameter_description> a #GtkScaleButton
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated list of the container's non-internal children.
+<return> the minus button of the #GtkScaleButton
+
</return>
</function>
-<function name="gtk_calendar_select_day">
+<function name="gtk_scale_button_get_orientation">
<description>
-Selects a day from the current month.
+Gets the orientation of the #GtkScaleButton's popup window.
+
+Since: 2.14
+
+Deprecated: 2.16: Use gtk_orientable_get_orientation() instead.
</description>
<parameters>
-<parameter name="calendar">
-<parameter_description> a #GtkCalendar.
-</parameter_description>
-</parameter>
-<parameter name="day">
-<parameter_description> the day number between 1 and 31, or 0 to unselect
-the currently selected day.
+<parameter name="button">
+<parameter_description> a #GtkScaleButton
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GtkScaleButton's orientation.
+
+</return>
</function>
-<function name="gtk_accel_group_disconnect_key">
+<function name="gtk_scale_button_get_plus_button">
<description>
-Removes an accelerator previously installed through
-gtk_accel_group_connect().
+Retrieves the plus button of the #GtkScaleButton.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="accel_group">
-<parameter_description> the accelerator group to install an accelerator in
-</parameter_description>
-</parameter>
-<parameter name="accel_key">
-<parameter_description> key value of the accelerator
-</parameter_description>
-</parameter>
-<parameter name="accel_mods">
-<parameter_description> modifier combination of the accelerator
+<parameter name="button">
+<parameter_description> a #GtkScaleButton
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if there was an accelerator which could be
-removed, %FALSE otherwise
+<return> the plus button of the #GtkScaleButton
+
</return>
</function>
-<function name="gtk_window_stick">
+<function name="gtk_scale_button_get_popup">
<description>
-Asks to stick @window, which means that it will appear on all user
-desktops. Note that you shouldn't assume the window is definitely
-stuck afterward, because other entities (e.g. the user or <link
-linkend="gtk-X11-arch">window manager</link>) could unstick it
-again, and some window managers do not support sticking
-windows. But normally the window will end up stuck. Just don't
-write code that crashes if not.
-
-It's permitted to call this function before showing a window.
-
-You can track stickiness via the "window-state-event" signal
-on #GtkWidget.
+Retrieves the popup of the #GtkScaleButton.
+Since: 2.14
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="button">
+<parameter_description> a #GtkScaleButton
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the popup of the #GtkScaleButton
+
+</return>
</function>
-<function name="gtk_clipboard_set_with_data">
+<function name="gtk_scale_button_get_value">
<description>
-Virtually sets the contents of the specified clipboard by providing
-a list of supported formats for the clipboard data and a function
-to call to get the actual data when it is requested.
+Gets the current value of the scale button.
+Since: 2.12
</description>
<parameters>
-<parameter name="clipboard">
-<parameter_description> a #GtkClipboard
+<parameter name="button">
+<parameter_description> a #GtkScaleButton
</parameter_description>
</parameter>
-<parameter name="targets">
-<parameter_description> array containing information about the available forms for the
-clipboard data
+</parameters>
+<return> current value of the scale button
+
+</return>
+</function>
+
+<function name="gtk_scale_button_new">
+<description>
+Creates a #GtkScaleButton, with a range between @min and @max, with
+a stepping of @step.
+
+Since: 2.12
+
+</description>
+<parameters>
+<parameter name="size">
+<parameter_description> a stock icon size
</parameter_description>
</parameter>
-<parameter name="n_targets">
-<parameter_description> number of elements in @targets
+<parameter name="min">
+<parameter_description> the minimum value of the scale (usually 0)
</parameter_description>
</parameter>
-<parameter name="get_func">
-<parameter_description> function to call to get the actual clipboard data
+<parameter name="max">
+<parameter_description> the maximum value of the scale (usually 100)
</parameter_description>
</parameter>
-<parameter name="clear_func">
-<parameter_description> when the clipboard contents are set again, this function will
-be called, and @get_func will not be subsequently called.
+<parameter name="step">
+<parameter_description> the stepping of value when a scroll-wheel event,
+or up/down arrow event occurs (usually 2)
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to @get_func and @clear_func.
+<parameter name="icons">
+<parameter_description> a %NULL-terminated array of icon names, or %NULL if
+you want to set the list later with gtk_scale_button_set_icons()
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if setting the clipboard data succeeded. If setting
-the clipboard data failed the provided callback functions
-will be ignored.
+<return> a new #GtkScaleButton
+
</return>
</function>
-<function name="gtk_notebook_set_tab_label_packing">
+<function name="gtk_scale_button_set_adjustment">
<description>
-Sets the packing parameters for the tab label of the page
-containing @child. See gtk_box_pack_start() for the exact meaning
-of the parameters.
+Sets the #GtkAdjustment to be used as a model
+for the #GtkScaleButton's scale.
+See gtk_range_set_adjustment() for details.
-Deprecated: 2.20: Modify the #GtkNotebook:tab-expand and
-#GtkNotebook:tab-fill child properties instead.
-Modifying the packing of the tab label is a deprecated feature and
-shouldn't be done anymore.
+Since: 2.12
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
-</parameter_description>
-</parameter>
-<parameter name="child">
-<parameter_description> the child widget
+<parameter name="button">
+<parameter_description> a #GtkScaleButton
</parameter_description>
</parameter>
-<parameter name="expand">
-<parameter_description> whether to expand the tab label or not
+<parameter name="adjustment">
+<parameter_description> a #GtkAdjustment
</parameter_description>
</parameter>
-<parameter name="fill">
-<parameter_description> whether the tab label should fill the allocated area or not
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_scale_button_set_icons">
+<description>
+Sets the icons to be used by the scale button.
+For details, see the #GtkScaleButton:icons property.
+
+Since: 2.12
+
+</description>
+<parameters>
+<parameter name="button">
+<parameter_description> a #GtkScaleButton
</parameter_description>
</parameter>
-<parameter name="pack_type">
-<parameter_description> the position of the tab label
+<parameter name="icons">
+<parameter_description> a %NULL-terminated array of icon names
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_drag_source_set_icon">
+<function name="gtk_scale_button_set_orientation">
<description>
-Sets the icon that will be used for drags from a particular widget
-from a pixmap/mask. GTK+ retains references for the arguments, and
-will release them when they are no longer needed.
-Use gtk_drag_source_set_icon_pixbuf() instead.
+Sets the orientation of the #GtkScaleButton's popup window.
+
+Since: 2.14
+
+Deprecated: 2.16: Use gtk_orientable_set_orientation() instead.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="button">
+<parameter_description> a #GtkScaleButton
</parameter_description>
</parameter>
-<parameter name="colormap">
-<parameter_description> the colormap of the icon
+<parameter name="orientation">
+<parameter_description> the new orientation
</parameter_description>
</parameter>
-<parameter name="pixmap">
-<parameter_description> the image data for the icon
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_scale_button_set_value">
+<description>
+Sets the current value of the scale; if the value is outside
+the minimum or maximum range values, it will be clamped to fit
+inside them. The scale button emits the #GtkScaleButton::value-changed
+signal if the value changes.
+
+Since: 2.12
+
+</description>
+<parameters>
+<parameter name="button">
+<parameter_description> a #GtkScaleButton
</parameter_description>
</parameter>
-<parameter name="mask">
-<parameter_description> the transparency mask for an image.
+<parameter name="value">
+<parameter_description> new value of the scale button
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_view_get_overwrite">
+<function name="gtk_scale_clear_marks">
<description>
-Returns whether the #GtkTextView is in overwrite mode or not.
+Removes any marks that have been added with gtk_scale_add_mark().
-Since: 2.4
+Since: 2.16
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="scale">
+<parameter_description> a #GtkScale
</parameter_description>
</parameter>
</parameters>
-<return> whether @text_view is in overwrite mode or not.
+<return></return>
+</function>
+<function name="gtk_scale_get_digits">
+<description>
+Gets the number of decimal places that are displayed in the value.
+
+
+</description>
+<parameters>
+<parameter name="scale">
+<parameter_description> a #GtkScale
+</parameter_description>
+</parameter>
+</parameters>
+<return> the number of decimal places that are displayed
</return>
</function>
-<function name="gtk_tree_selection_get_mode">
+<function name="gtk_scale_get_draw_value">
<description>
-Gets the selection mode for @selection. See
-gtk_tree_selection_set_mode().
+Returns whether the current value is displayed as a string
+next to the slider.
</description>
<parameters>
-<parameter name="selection">
-<parameter_description> a #GtkTreeSelection
+<parameter name="scale">
+<parameter_description> a #GtkScale
</parameter_description>
</parameter>
</parameters>
-<return> the current selection mode
+<return> whether the current value is displayed as a string
</return>
</function>
-<function name="gtk_text_attributes_ref">
+<function name="gtk_scale_get_layout">
<description>
-Increments the reference count on @values.
+Gets the #PangoLayout used to display the scale. The returned
+object is owned by the scale so does not need to be freed by
+the caller.
+Since: 2.4
</description>
<parameters>
-<parameter name="values">
-<parameter_description> a #GtkTextAttributes
+<parameter name="scale">
+<parameter_description> A #GtkScale
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkTextAttributes that were passed in
+<return> the #PangoLayout for this scale,
+or %NULL if the #GtkScale:draw-value property is %FALSE.
+
</return>
</function>
-<function name="gtk_cell_editable_start_editing">
+<function name="gtk_scale_get_layout_offsets">
<description>
-Begins editing on a @cell_editable. @event is the #GdkEvent that began
-the editing process. It may be %NULL, in the instance that editing was
-initiated through programatic means.
+Obtains the coordinates where the scale will draw the
+#PangoLayout representing the text in the scale. Remember
+when using the #PangoLayout function you need to convert to
+and from pixels using PANGO_PIXELS() or #PANGO_SCALE.
+
+If the #GtkScale:draw-value property is %FALSE, the return
+values are undefined.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="cell_editable">
-<parameter_description> A #GtkCellEditable
+<parameter name="scale">
+<parameter_description> a #GtkScale
</parameter_description>
</parameter>
-<parameter name="event">
-<parameter_description> A #GdkEvent, or %NULL
+<parameter name="x">
+<parameter_description> location to store X offset of layout, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> location to store Y offset of layout, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_range_set_value">
+<function name="gtk_scale_get_value_pos">
<description>
-Sets the current value of the range; if the value is outside the
-minimum or maximum range values, it will be clamped to fit inside
-them. The range emits the #GtkRange::value-changed signal if the
-value changes.
+Gets the position in which the current value is displayed.
+
</description>
<parameters>
-<parameter name="range">
-<parameter_description> a #GtkRange
-</parameter_description>
-</parameter>
-<parameter name="value">
-<parameter_description> new value of the range
+<parameter name="scale">
+<parameter_description> a #GtkScale
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the position in which the current value is displayed
+</return>
</function>
-<function name="gtk_selection_data_get_uris">
+<function name="gtk_scale_new">
<description>
-Gets the contents of the selection data as array of URIs.
+Creates a new #GtkScale.
-Since: 2.6
+Since: 2.16
</description>
<parameters>
-<parameter name="selection_data">
-<parameter_description> a #GtkSelectionData
+<parameter name="orientation">
+<parameter_description> the scale's orientation.
+</parameter_description>
+</parameter>
+<parameter name="adjustment">
+<parameter_description> the #GtkAdjustment which sets the range of the scale, or
+%NULL to create a new adjustment.
</parameter_description>
</parameter>
</parameters>
-<return> if
-the selection data contains a list of
-URIs, a newly allocated %NULL-terminated string array
-containing the URIs, otherwise %NULL. If the result is
-non-%NULL it must be freed with g_strfreev().
+<return> a new #GtkScale
</return>
</function>
-<function name="gtk_widget_input_shape_combine_mask">
+<function name="gtk_scale_new_with_range">
<description>
-Sets an input shape for this widget's GDK window. This allows for
-windows which react to mouse click in a nonrectangular region, see
-gdk_window_input_shape_combine_mask() for more information.
+Creates a new scale widget with the given orientation that lets the
+user input a number between @min and @max (including @min and @max)
+with the increment @step. @step must be nonzero; it's the distance
+the slider moves when using the arrow keys to adjust the scale
+value.
-Since: 2.10
+Note that the way in which the precision is derived works best if @step
+is a power of ten. If the resulting precision is not suitable for your
+needs, use gtk_scale_set_digits() to correct it.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="orientation">
+<parameter_description> the scale's orientation.
</parameter_description>
</parameter>
-<parameter name="shape_mask">
-<parameter_description> shape to be added, or %NULL to remove an existing shape
+<parameter name="min">
+<parameter_description> minimum value
</parameter_description>
</parameter>
-<parameter name="offset_x">
-<parameter_description> X position of shape mask with respect to @window
+<parameter name="max">
+<parameter_description> maximum value
</parameter_description>
</parameter>
-<parameter name="offset_y">
-<parameter_description> Y position of shape mask with respect to @window
+<parameter name="step">
+<parameter_description> step increment (tick size) used with keyboard shortcuts
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GtkScale
+
+</return>
</function>
-<function name="gtk_widget_get_extension_events">
+<function name="gtk_scale_set_digits">
<description>
-Retrieves the extension events the widget will receive; see
-gdk_input_set_extension_events().
-
+Sets the number of decimal places that are displayed in the value.
+Also causes the value of the adjustment to be rounded off to this
+number of digits, so the retrieved value matches the value the user saw.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="scale">
+<parameter_description> a #GtkScale
+</parameter_description>
+</parameter>
+<parameter name="digits">
+<parameter_description> the number of decimal places to display,
+e.g. use 1 to display 1.0, 2 to display 1.00, etc
</parameter_description>
</parameter>
</parameters>
-<return> extension events for @widget
-</return>
+<return></return>
</function>
-<function name="gtk_range_set_upper_stepper_sensitivity">
+<function name="gtk_scale_set_draw_value">
<description>
-Sets the sensitivity policy for the stepper that points to the
-'upper' end of the GtkRange's adjustment.
-
-Since: 2.10
+Specifies whether the current value is displayed as a string next
+to the slider.
</description>
<parameters>
-<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter name="scale">
+<parameter_description> a #GtkScale
</parameter_description>
</parameter>
-<parameter name="sensitivity">
-<parameter_description> the upper stepper's sensitivity policy.
+<parameter name="draw_value">
+<parameter_description> %TRUE to draw the value
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_printer_is_default">
+<function name="gtk_scale_set_value_pos">
<description>
-Returns whether the printer is the default printer.
-
-Since: 2.10
+Sets the position in which the current value is displayed.
</description>
<parameters>
-<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter name="scale">
+<parameter_description> a #GtkScale
+</parameter_description>
+</parameter>
+<parameter name="pos">
+<parameter_description> the position in which the current value is displayed
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @printer is the default
-
-</return>
+<return></return>
</function>
-<function name="gtk_targets_include_rich_text">
+<function name="gtk_scrollbar_new">
<description>
-Determines if any of the targets in @targets can be used to
-provide rich text.
+Creates a new scrollbar with the given orientation.
-Since: 2.10
+Since: 2.16
</description>
<parameters>
-<parameter name="targets">
-<parameter_description> an array of #GdkAtom<!-- -->s
-</parameter_description>
-</parameter>
-<parameter name="n_targets">
-<parameter_description> the length of @targets
+<parameter name="orientation">
+<parameter_description> the scrollbar's orientation.
</parameter_description>
</parameter>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="adjustment">
+<parameter_description> the #GtkAdjustment to use, or %NULL to create a new adjustment.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @targets include a suitable target for rich text,
-otherwise %FALSE.
+<return> the new #GtkScrollbar.
</return>
</function>
-<function name="gtk_widget_get_app_paintable">
+<function name="gtk_scrolled_window_add_with_viewport">
<description>
-Determines whether the application intends to draw on the widget in
-an #GtkWidget::expose-event handler.
+Used to add children without native scrolling capabilities. This
+is simply a convenience function; it is equivalent to adding the
+unscrollable child to a viewport, then adding the viewport to the
+scrolled window. If a child has native scrolling, use
+gtk_container_add() instead of this function.
-See gtk_widget_set_app_paintable()
+The viewport scrolls the child by moving its #GdkWindow, and takes
+the size of the child to be the size of its toplevel #GdkWindow.
+This will be very wrong for most widgets that support native scrolling;
+for example, if you add a widget such as #GtkTreeView with a viewport,
+the whole widget will scroll, including the column headings. Thus,
+widgets with native scrolling support should not be used with the
+#GtkViewport proxy.
-Since: 2.18
+A widget supports scrolling natively if the
+set_scroll_adjustments_signal field in #GtkWidgetClass is non-zero,
+i.e. has been filled in with a valid signal identifier.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="scrolled_window">
+<parameter_description> a #GtkScrolledWindow
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> the widget you want to scroll
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the widget is app paintable
-
-</return>
+<return></return>
</function>
-<function name="gtk_widget_set_can_default">
+<function name="gtk_scrolled_window_get_hadjustment">
<description>
-Specifies whether @widget can be a default widget. See
-gtk_widget_grab_default() for details about the meaning of
-"default".
+Returns the horizontal scrollbar's adjustment, used to connect the
+horizontal scrollbar to the child widget's horizontal scroll
+functionality.
-Since: 2.18
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="can_default">
-<parameter_description> whether or not @widget can be a default widget.
+<parameter name="scrolled_window">
+<parameter_description> a #GtkScrolledWindow
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the horizontal #GtkAdjustment
+</return>
</function>
-<function name="gtk_page_setup_set_top_margin">
+<function name="gtk_scrolled_window_get_hscrollbar">
<description>
-Sets the top margin of the #GtkPageSetup.
+Returns the horizontal scrollbar of @scrolled_window.
-Since: 2.10
+Since: 2.8
</description>
<parameters>
-<parameter name="setup">
-<parameter_description> a #GtkPageSetup
-</parameter_description>
-</parameter>
-<parameter name="margin">
-<parameter_description> the new top margin in units of @unit
-</parameter_description>
-</parameter>
-<parameter name="unit">
-<parameter_description> the units for @margin
+<parameter name="scrolled_window">
+<parameter_description> a #GtkScrolledWindow
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the horizontal scrollbar of the scrolled window,
+or %NULL if it does not have one.
+
+</return>
</function>
-<function name="gtk_cell_renderer_get_visible">
+<function name="gtk_scrolled_window_get_placement">
<description>
-Returns the cell renderer's visibility.
+Gets the placement of the contents with respect to the scrollbars
+for the scrolled window. See gtk_scrolled_window_set_placement().
-Since: 2.18
</description>
<parameters>
-<parameter name="cell">
-<parameter_description> A #GtkCellRenderer
+<parameter name="scrolled_window">
+<parameter_description> a #GtkScrolledWindow
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the cell renderer is visible
+<return> the current placement value.
+See also gtk_scrolled_window_set_placement() and
+gtk_scrolled_window_unset_placement().
</return>
</function>
-<function name="gtk_tree_view_scroll_to_point">
+<function name="gtk_scrolled_window_get_policy">
<description>
-Scrolls the tree view such that the top-left corner of the visible
-area is @tree_x, @tree_y, where @tree_x and @tree_y are specified
-in tree coordinates. The @tree_view must be realized before
-this function is called. If it isn't, you probably want to be
-using gtk_tree_view_scroll_to_cell().
-
-If either @tree_x or @tree_y are -1, then that direction isn't scrolled.
+Retrieves the current policy values for the horizontal and vertical
+scrollbars. See gtk_scrolled_window_set_policy().
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
+<parameter name="scrolled_window">
+<parameter_description> a #GtkScrolledWindow
</parameter_description>
</parameter>
-<parameter name="tree_x">
-<parameter_description> X coordinate of new top-left pixel of visible area, or -1
+<parameter name="hscrollbar_policy">
+<parameter_description> location to store the policy for the horizontal
+scrollbar, or %NULL.
</parameter_description>
</parameter>
-<parameter name="tree_y">
-<parameter_description> Y coordinate of new top-left pixel of visible area, or -1
+<parameter name="vscrollbar_policy">
+<parameter_description> location to store the policy for the vertical
+scrollbar, or %NULL.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_get_hover_expand">
+<function name="gtk_scrolled_window_get_shadow_type">
<description>
-Returns whether hover expansion mode is turned on for @tree_view.
+Gets the shadow type of the scrolled window. See
+gtk_scrolled_window_set_shadow_type().
-Since: 2.6
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
+<parameter name="scrolled_window">
+<parameter_description> a #GtkScrolledWindow
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @tree_view is in hover expansion mode
-
+<return> the current shadow type
</return>
</function>
-<function name="gtk_tree_view_column_get_spacing">
+<function name="gtk_scrolled_window_get_vadjustment">
<description>
-Returns the spacing of @tree_column.
+Returns the vertical scrollbar's adjustment, used to connect the
+vertical scrollbar to the child widget's vertical scroll functionality.
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn.
+<parameter name="scrolled_window">
+<parameter_description> a #GtkScrolledWindow
</parameter_description>
</parameter>
</parameters>
-<return> the spacing of @tree_column.
+<return> the vertical #GtkAdjustment
</return>
</function>
-<function name="gtk_entry_completion_get_model">
+<function name="gtk_scrolled_window_get_vscrollbar">
<description>
-Returns the model the #GtkEntryCompletion is using as data source.
-Returns %NULL if the model is unset.
+Returns the vertical scrollbar of @scrolled_window.
-Since: 2.4
+Since: 2.8
</description>
<parameters>
-<parameter name="completion">
-<parameter_description> A #GtkEntryCompletion.
+<parameter name="scrolled_window">
+<parameter_description> a #GtkScrolledWindow
</parameter_description>
</parameter>
</parameters>
-<return> A #GtkTreeModel, or %NULL if none is currently being used.
+<return> the vertical scrollbar of the scrolled window,
+or %NULL if it does not have one.
</return>
</function>
-<function name="gtk_text_iter_get_char">
+<function name="gtk_scrolled_window_new">
<description>
-Returns the Unicode character at this iterator. (Equivalent to
-operator* on a C++ iterator.) If the element at this iterator is a
-non-character element, such as an image embedded in the buffer, the
-Unicode "unknown" character 0xFFFC is returned. If invoked on
-the end iterator, zero is returned; zero is not a valid Unicode character.
-So you can write a loop which ends when gtk_text_iter_get_char ()
-returns 0.
+Creates a new scrolled window.
+
+The two arguments are the scrolled window's adjustments; these will be
+shared with the scrollbars and the child widget to keep the bars in sync
+with the child. Usually you want to pass %NULL for the adjustments, which
+will cause the scrolled window to create them for you.
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
+<parameter name="hadjustment">
+<parameter_description> horizontal adjustment
+</parameter_description>
+</parameter>
+<parameter name="vadjustment">
+<parameter_description> vertical adjustment
</parameter_description>
</parameter>
</parameters>
-<return> a Unicode character, or 0 if @iter is not dereferenceable
+<return> a new scrolled window
</return>
</function>
-<function name="gtk_window_get_role">
+<function name="gtk_scrolled_window_set_hadjustment">
<description>
-Returns the role of the window. See gtk_window_set_role() for
-further explanation.
+Sets the #GtkAdjustment for the horizontal scrollbar.
+</description>
+<parameters>
+<parameter name="scrolled_window">
+<parameter_description> a #GtkScrolledWindow
+</parameter_description>
+</parameter>
+<parameter name="hadjustment">
+<parameter_description> horizontal scroll adjustment
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_scrolled_window_set_placement">
+<description>
+Sets the placement of the contents with respect to the scrollbars
+for the scrolled window.
+
+The default is %GTK_CORNER_TOP_LEFT, meaning the child is
+in the top left, with the scrollbars underneath and to the right.
+Other values in #GtkCornerType are %GTK_CORNER_TOP_RIGHT,
+%GTK_CORNER_BOTTOM_LEFT, and %GTK_CORNER_BOTTOM_RIGHT.
+
+See also gtk_scrolled_window_get_placement() and
+gtk_scrolled_window_unset_placement().
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="scrolled_window">
+<parameter_description> a #GtkScrolledWindow
+</parameter_description>
+</parameter>
+<parameter name="window_placement">
+<parameter_description> position of the child window
</parameter_description>
</parameter>
</parameters>
-<return> the role of the window if set, or %NULL. The
-returned is owned by the widget and must not be modified
-or freed.
-</return>
+<return></return>
</function>
-<function name="gtk_entry_completion_insert_action_markup">
+<function name="gtk_scrolled_window_set_policy">
<description>
-Inserts an action in @completion's action item list at position @index_
-with markup @markup.
+Sets the scrollbar policy for the horizontal and vertical scrollbars.
-Since: 2.4
+The policy determines when the scrollbar should appear; it is a value
+from the #GtkPolicyType enumeration. If %GTK_POLICY_ALWAYS, the
+scrollbar is always present; if %GTK_POLICY_NEVER, the scrollbar is
+never present; if %GTK_POLICY_AUTOMATIC, the scrollbar is present only
+if needed (that is, if the slider part of the bar would be smaller
+than the trough - the display is larger than the page size).
</description>
<parameters>
-<parameter name="completion">
-<parameter_description> A #GtkEntryCompletion.
+<parameter name="scrolled_window">
+<parameter_description> a #GtkScrolledWindow
</parameter_description>
</parameter>
-<parameter name="index_">
-<parameter_description> The index of the item to insert.
+<parameter name="hscrollbar_policy">
+<parameter_description> policy for horizontal bar
</parameter_description>
</parameter>
-<parameter name="markup">
-<parameter_description> Markup of the item to insert.
+<parameter name="vscrollbar_policy">
+<parameter_description> policy for vertical bar
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_entry_buffer_set_max_length">
+<function name="gtk_scrolled_window_set_shadow_type">
<description>
-Sets the maximum allowed length of the contents of the buffer. If
-the current contents are longer than the given length, then they
-will be truncated to fit.
+Changes the type of shadow drawn around the contents of
+ scrolled_window
-Since: 2.18
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkEntryBuffer
+<parameter name="scrolled_window">
+<parameter_description> a #GtkScrolledWindow
</parameter_description>
</parameter>
-<parameter name="max_length">
-<parameter_description> the maximum length of the entry buffer, or 0 for no maximum.
-(other than the maximum length of entries.) The value passed in will
-be clamped to the range 0-65536.
+<parameter name="type">
+<parameter_description> kind of shadow to draw around scrolled window contents
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_key_hash_free">
+<function name="gtk_scrolled_window_set_vadjustment">
<description>
-Destroys a key hash created with gtk_key_hash_new()
+Sets the #GtkAdjustment for the vertical scrollbar.
</description>
<parameters>
-<parameter name="key_hash">
-<parameter_description> a #GtkKeyHash
+<parameter name="scrolled_window">
+<parameter_description> a #GtkScrolledWindow
+</parameter_description>
+</parameter>
+<parameter name="vadjustment">
+<parameter_description> vertical scroll adjustment
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_file_chooser_widget_new">
+<function name="gtk_scrolled_window_unset_placement">
<description>
-Creates a new #GtkFileChooserWidget. This is a file chooser widget that can
-be embedded in custom windows, and it is the same widget that is used by
-#GtkFileChooserDialog.
+Unsets the placement of the contents with respect to the scrollbars
+for the scrolled window. If no window placement is set for a scrolled
+window, it obeys the "gtk-scrolled-window-placement" XSETTING.
-Since: 2.4
+See also gtk_scrolled_window_set_placement() and
+gtk_scrolled_window_get_placement().
+
+Since: 2.10
</description>
<parameters>
-<parameter name="action">
-<parameter_description> Open or save mode for the widget
+<parameter name="scrolled_window">
+<parameter_description> a #GtkScrolledWindow
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkFileChooserWidget
-
-</return>
+<return></return>
</function>
-<function name="gtk_range_get_inverted">
+<function name="gtk_selection_add_target">
<description>
-Gets the value set by gtk_range_set_inverted().
-
+Appends a specified target to the list of supported targets for a
+given widget and selection.
</description>
<parameters>
-<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter name="widget">
+<parameter_description> a #GtkTarget
+</parameter_description>
+</parameter>
+<parameter name="selection">
+<parameter_description> the selection
+</parameter_description>
+</parameter>
+<parameter name="target">
+<parameter_description> target to add.
+</parameter_description>
+</parameter>
+<parameter name="info">
+<parameter_description> A unsigned integer which will be passed back to the application.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the range is inverted
-</return>
+<return></return>
</function>
-<function name="gtk_notebook_set_window_creation_hook">
+<function name="gtk_selection_add_targets">
<description>
-Installs a global function used to create a window
-when a detached tab is dropped in an empty area.
-
-Since: 2.10
+Prepends a table of targets to the list of supported targets
+for a given widget and selection.
</description>
<parameters>
-<parameter name="func">
-<parameter_description> the #GtkNotebookWindowCreationFunc, or %NULL
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> user data for @func
+<parameter name="selection">
+<parameter_description> the selection
</parameter_description>
</parameter>
-<parameter name="destroy">
-<parameter_description> Destroy notifier for @data, or %NULL
+<parameter name="targets">
+<parameter_description> a table of targets to add
+</parameter_description>
+</parameter>
+<parameter name="ntargets">
+<parameter_description> number of entries in @targets
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_frame_get_label">
+<function name="gtk_selection_clear">
<description>
-If the frame's label widget is a #GtkLabel, returns the
-text in the label widget. (The frame will have a #GtkLabel
-for the label widget if a non-%NULL argument was passed
-to gtk_frame_new().)
+The default handler for the #GtkWidget::selection-clear-event
+signal.
+Since: 2.2
+
+Deprecated: 2.4: Instead of calling this function, chain up from
+your selection-clear-event handler. Calling this function
+from any other context is illegal.
</description>
<parameters>
-<parameter name="frame">
-<parameter_description> a #GtkFrame
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="event">
+<parameter_description> the event
</parameter_description>
</parameter>
</parameters>
-<return> the text in the label, or %NULL if there
-was no label widget or the lable widget was not
-a #GtkLabel. This string is owned by GTK+ and
-must not be modified or freed.
+<return> %TRUE if the event was handled, otherwise false
+
</return>
</function>
-<function name="gtk_size_group_set_mode">
+<function name="gtk_selection_clear_targets">
<description>
-Sets the #GtkSizeGroupMode of the size group. The mode of the size
-group determines whether the widgets in the size group should
-all have the same horizontal requisition (%GTK_SIZE_GROUP_MODE_HORIZONTAL)
-all have the same vertical requisition (%GTK_SIZE_GROUP_MODE_VERTICAL),
-or should all have the same requisition in both directions
-(%GTK_SIZE_GROUP_MODE_BOTH).
+Remove all targets registered for the given selection for the
+widget.
</description>
<parameters>
-<parameter name="size_group">
-<parameter_description> a #GtkSizeGroup
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="mode">
-<parameter_description> the mode to set for the size group.
+<parameter name="selection">
+<parameter_description> an atom representing a selection
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_begin_user_action">
+<function name="gtk_selection_convert">
<description>
-Called to indicate that the buffer operations between here and a
-call to gtk_text_buffer_end_user_action() are part of a single
-user-visible operation. The operations between
-gtk_text_buffer_begin_user_action() and
-gtk_text_buffer_end_user_action() can then be grouped when creating
-an undo stack. #GtkTextBuffer maintains a count of calls to
-gtk_text_buffer_begin_user_action() that have not been closed with
-a call to gtk_text_buffer_end_user_action(), and emits the
-"begin-user-action" and "end-user-action" signals only for the
-outermost pair of calls. This allows you to build user actions
-from other user actions.
+Requests the contents of a selection. When received,
+a "selection-received" signal will be generated.
-The "interactive" buffer mutation functions, such as
-gtk_text_buffer_insert_interactive(), automatically call begin/end
-user action around the buffer operations they perform, so there's
-no need to add extra calls if you user action consists solely of a
-single call to one of those functions.
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="widget">
+<parameter_description> The widget which acts as requestor
+</parameter_description>
+</parameter>
+<parameter name="selection">
+<parameter_description> Which selection to get
+</parameter_description>
+</parameter>
+<parameter name="target">
+<parameter_description> Form of information desired (e.g., STRING)
+</parameter_description>
+</parameter>
+<parameter name="time_">
+<parameter_description> Time of request (usually of triggering event)
+ In emergency, you could use #GDK_CURRENT_TIME
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if requested succeeded. %FALSE if we could not process
+request. (e.g., there was already a request in process for
+this widget).
+</return>
</function>
-<function name="gtk_tool_item_group_set_ellipsize">
+<function name="gtk_selection_data_copy">
<description>
-Sets the ellipsization mode which should be used by labels in @group.
+Makes a copy of a #GtkSelectionData structure and its data.
-Since: 2.20
</description>
<parameters>
-<parameter name="group">
-<parameter_description> a #GtkToolItemGroup
+<parameter name="data">
+<parameter_description> a pointer to a #GtkSelectionData structure.
</parameter_description>
</parameter>
-<parameter name="ellipsize">
-<parameter_description> the #PangoEllipsizeMode labels in @group should use
+</parameters>
+<return> a pointer to a copy of @data.
+</return>
+</function>
+
+<function name="gtk_selection_data_free">
+<description>
+Frees a #GtkSelectionData structure returned from
+gtk_selection_data_copy().
+
+</description>
+<parameters>
+<parameter name="data">
+<parameter_description> a pointer to a #GtkSelectionData structure.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_new">
+<function name="gtk_selection_data_get_data">
<description>
-Creates a new #GtkTreeView widget.
+Retrieves the raw data of the selection.
+Since: 2.14
</description>
<parameters>
+<parameter name="selection_data">
+<parameter_description> a pointer to a #GtkSelectionData structure.
+</parameter_description>
+</parameter>
</parameters>
-<return> A newly created #GtkTreeView widget.
+<return> the raw data of the selection.
+
</return>
</function>
-<function name="gtk_file_chooser_set_current_folder">
+<function name="gtk_selection_data_get_data_type">
<description>
-Sets the current folder for @chooser from a local filename.
-The user will be shown the full contents of the current folder,
-plus user interface elements for navigating to other folders.
+Retrieves the data type of the selection.
-Since: 2.4
+Since: 2.14
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
-</parameter_description>
-</parameter>
-<parameter name="filename">
-<parameter_description> the full path of the new current folder
+<parameter name="selection_data">
+<parameter_description> a pointer to a #GtkSelectionData structure.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the folder could be changed successfully, %FALSE
-otherwise.
+<return> the data type of the selection.
</return>
</function>
-<function name="gtk_combo_box_get_row_span_column">
+<function name="gtk_selection_data_get_display">
<description>
-Returns the column with row span information for @combo_box.
+Retrieves the display of the selection.
-Since: 2.6
+Since: 2.14
</description>
<parameters>
-<parameter name="combo_box">
-<parameter_description> A #GtkComboBox
+<parameter name="selection_data">
+<parameter_description> a pointer to a #GtkSelectionData structure.
</parameter_description>
</parameter>
</parameters>
-<return> the row span column.
+<return> the display of the selection.
</return>
</function>
-<function name="gtk_notebook_set_current_page">
+<function name="gtk_selection_data_get_format">
<description>
-Switches to the page number @page_num.
+Retrieves the format of the selection.
-Note that due to historical reasons, GtkNotebook refuses
-to switch to a page unless the child widget is visible.
-Therefore, it is recommended to show child widgets before
-adding them to a notebook.
+Since: 2.14
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
-</parameter_description>
-</parameter>
-<parameter name="page_num">
-<parameter_description> index of the page to switch to, starting from 0.
-If negative, the last page will be used. If greater
-than the number of pages in the notebook, nothing
-will be done.
+<parameter name="selection_data">
+<parameter_description> a pointer to a #GtkSelectionData structure.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the format of the selection.
+
+</return>
</function>
-<function name="gtk_ui_manager_ensure_update">
+<function name="gtk_selection_data_get_length">
<description>
-Makes sure that all pending updates to the UI have been completed.
-
-This may occasionally be necessary, since #GtkUIManager updates the
-UI in an idle function. A typical example where this function is
-useful is to enforce that the menubar and toolbar have been added to
-the main window before showing it:
-|[
-gtk_container_add (GTK_CONTAINER (window), vbox);
-g_signal_connect (merge, "add-widget",
-G_CALLBACK (add_widget), vbox);
-gtk_ui_manager_add_ui_from_file (merge, "my-menus");
-gtk_ui_manager_add_ui_from_file (merge, "my-toolbars");
-gtk_ui_manager_ensure_update (merge);
-gtk_widget_show (window);
-]|
+Retrieves the length of the raw data of the selection.
-Since: 2.4
+Since: 2.14
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #GtkUIManager
+<parameter name="selection_data">
+<parameter_description> a pointer to a #GtkSelectionData structure.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the length of the data of the selection.
+
+</return>
</function>
-<function name="gtk_label_get_single_line_mode">
+<function name="gtk_selection_data_get_pixbuf">
<description>
-Returns whether the label is in single line mode.
+Gets the contents of the selection data as a #GdkPixbuf.
Since: 2.6
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="selection_data">
+<parameter_description> a #GtkSelectionData
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE when the label is in single line mode.
+<return> if the selection data contained a recognized
+image type and it could be converted to a #GdkPixbuf, a
+newly allocated pixbuf is returned, otherwise %NULL.
+If the result is non-%NULL it must be freed with g_object_unref().
</return>
</function>
-<function name="gtk_entry_completion_insert_action_text">
+<function name="gtk_selection_data_get_selection">
<description>
-Inserts an action in @completion's action item list at position @index_
-with text @text. If you want the action item to have markup, use
-gtk_entry_completion_insert_action_markup().
+Retrieves the selection #GdkAtom of the selection data.
-Since: 2.4
+Since: 2.16
</description>
<parameters>
-<parameter name="completion">
-<parameter_description> A #GtkEntryCompletion.
-</parameter_description>
-</parameter>
-<parameter name="index_">
-<parameter_description> The index of the item to insert.
-</parameter_description>
-</parameter>
-<parameter name="text">
-<parameter_description> Text of the item to insert.
+<parameter name="selection_data">
+<parameter_description> a pointer to a #GtkSelectionData structure.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the selection #GdkAtom of the selection data.
+
+</return>
</function>
-<function name="gtk_window_has_toplevel_focus">
+<function name="gtk_selection_data_get_target">
<description>
-Returns whether the input focus is within this GtkWindow.
-For real toplevel windows, this is identical to gtk_window_is_active(),
-but for embedded windows, like #GtkPlug, the results will differ.
+Retrieves the target of the selection.
-Since: 2.4
+Since: 2.14
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="selection_data">
+<parameter_description> a pointer to a #GtkSelectionData structure.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the input focus is within this GtkWindow
+<return> the target of the selection.
</return>
</function>
-<function name="gtk_tree_store_swap">
+<function name="gtk_selection_data_get_targets">
<description>
-Swaps @a and @b in the same level of @tree_store. Note that this function
-only works with unsorted stores.
+Gets the contents of @selection_data as an array of targets.
+This can be used to interpret the results of getting
+the standard TARGETS target that is always supplied for
+any selection.
-Since: 2.2
</description>
<parameters>
-<parameter name="tree_store">
-<parameter_description> A #GtkTreeStore.
+<parameter name="selection_data">
+<parameter_description> a #GtkSelectionData object
</parameter_description>
</parameter>
-<parameter name="a">
-<parameter_description> A #GtkTreeIter.
+<parameter name="targets">
+<parameter_description> location to store an array of targets. The result
+stored here must be freed with g_free().
</parameter_description>
</parameter>
-<parameter name="b">
-<parameter_description> Another #GtkTreeIter.
+<parameter name="n_atoms">
+<parameter_description> location to store number of items in @targets.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @selection_data contains a valid
+array of targets, otherwise %FALSE.
+</return>
</function>
-<function name="gtk_print_operation_draw_page_finish">
+<function name="gtk_selection_data_get_text">
<description>
-Signalize that drawing of particular page is complete.
-
-It is called after completion of page drawing (e.g. drawing in another
-thread).
-If gtk_print_operation_set_defer_drawing() was called before, then this function
-has to be called by application. In another case it is called by the library
-itself.
+Gets the contents of the selection data as a UTF-8 string.
-Since: 2.16
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter name="selection_data">
+<parameter_description> a #GtkSelectionData
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> if the selection data contained a recognized
+text type and it could be converted to UTF-8, a newly allocated
+string containing the converted text, otherwise %NULL.
+If the result is non-%NULL it must be freed with g_free().
+</return>
</function>
-<function name="gtk_window_get_title">
+<function name="gtk_selection_data_get_uris">
<description>
-Retrieves the title of the window. See gtk_window_set_title().
+Gets the contents of the selection data as array of URIs.
+Since: 2.6
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="selection_data">
+<parameter_description> a #GtkSelectionData
</parameter_description>
</parameter>
</parameters>
-<return> the title of the window, or %NULL if none has
-been set explicitely. The returned string is owned by the widget
-and must not be modified or freed.
+<return> if
+the selection data contains a list of
+URIs, a newly allocated %NULL-terminated string array
+containing the URIs, otherwise %NULL. If the result is
+non-%NULL it must be freed with g_strfreev().
+
</return>
</function>
-<function name="gtk_print_settings_set_reverse">
+<function name="gtk_selection_data_set">
<description>
-Sets the value of %GTK_PRINT_SETTINGS_REVERSE.
-
-Since: 2.10
+Stores new data into a #GtkSelectionData object. Should
+<emphasis>only</emphasis> be called from a selection handler callback.
+Zero-terminates the stored data.
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="selection_data">
+<parameter_description> a pointer to a #GtkSelectionData structure.
</parameter_description>
</parameter>
-<parameter name="reverse">
-<parameter_description> whether to reverse the output
+<parameter name="type">
+<parameter_description> the type of selection data
+</parameter_description>
+</parameter>
+<parameter name="format">
+<parameter_description> format (number of bits in a unit)
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> pointer to the data (will be copied)
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> length of the data
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_get_snapshot">
+<function name="gtk_selection_data_set_pixbuf">
<description>
-Create a #GdkPixmap of the contents of the widget and its children.
-
-Works even if the widget is obscured. The depth and visual of the
-resulting pixmap is dependent on the widget being snapshot and likely
-differs from those of a target widget displaying the pixmap.
-The function gdk_pixbuf_get_from_drawable() can be used to convert
-the pixmap to a visual independant representation.
-
-The snapshot area used by this function is the @widget's allocation plus
-any extra space occupied by additional windows belonging to this widget
-(such as the arrows of a spin button).
-Thus, the resulting snapshot pixmap is possibly larger than the allocation.
-
-If @clip_rect is non-%NULL, the resulting pixmap is shrunken to
-match the specified clip_rect. The (x,y) coordinates of @clip_rect are
-interpreted widget relative. If width or height of @clip_rect are 0 or
-negative, the width or height of the resulting pixmap will be shrunken
-by the respective amount.
-For instance a @clip_rect <literal>{ +5, +5, -10, -10 }</literal> will
-chop off 5 pixels at each side of the snapshot pixmap.
-If non-%NULL, @clip_rect will contain the exact widget-relative snapshot
-coordinates upon return. A @clip_rect of <literal>{ -1, -1, 0, 0 }</literal>
-can be used to preserve the auto-grown snapshot area and use @clip_rect
-as a pure output parameter.
-
-The returned pixmap can be %NULL, if the resulting @clip_area was empty.
+Sets the contents of the selection from a #GdkPixbuf
+The pixbuf is converted to the form determined by
+ selection_data->target.
-Since: 2.14
+Since: 2.6
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="selection_data">
+<parameter_description> a #GtkSelectionData
</parameter_description>
</parameter>
-<parameter name="clip_rect">
-<parameter_description> a #GdkRectangle or %NULL
+<parameter name="pixbuf">
+<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
</parameters>
-<return> #GdkPixmap snapshot of the widget
+<return> %TRUE if the selection was successfully set,
+otherwise %FALSE.
</return>
</function>
-<function name="gtk_clipboard_set_image">
+<function name="gtk_selection_data_set_text">
<description>
-Sets the contents of the clipboard to the given #GdkPixbuf.
-GTK+ will take responsibility for responding for requests
-for the image, and for converting the image into the
-requested format.
+Sets the contents of the selection from a UTF-8 encoded string.
+The string is converted to the form determined by
+ selection_data->target.
-Since: 2.6
</description>
<parameters>
-<parameter name="clipboard">
-<parameter_description> a #GtkClipboard object
+<parameter name="selection_data">
+<parameter_description> a #GtkSelectionData
</parameter_description>
</parameter>
-<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf
+<parameter name="str">
+<parameter_description> a UTF-8 string
+</parameter_description>
+</parameter>
+<parameter name="len">
+<parameter_description> the length of @str, or -1 if @str is nul-terminated.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the selection was successfully set,
+otherwise %FALSE.
+</return>
</function>
-<function name="gtk_file_chooser_get_show_hidden">
+<function name="gtk_selection_data_set_uris">
<description>
-Gets whether hidden files and folders are displayed in the file selector.
-See gtk_file_chooser_set_show_hidden().
+Sets the contents of the selection from a list of URIs.
+The string is converted to the form determined by
+ selection_data->target.
Since: 2.6
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="selection_data">
+<parameter_description> a #GtkSelectionData
+</parameter_description>
+</parameter>
+<parameter name="uris">
+<parameter_description> a %NULL-terminated array of strings holding URIs
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if hidden files and folders are displayed.
+<return> %TRUE if the selection was successfully set,
+otherwise %FALSE.
</return>
</function>
-<function name="gtk_icon_view_get_columns">
+<function name="gtk_selection_data_targets_include_image">
<description>
-Returns the value of the ::columns property.
+Given a #GtkSelectionData object holding a list of targets,
+determines if any of the targets in @targets can be used to
+provide a #GdkPixbuf.
Since: 2.6
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
+<parameter name="selection_data">
+<parameter_description> a #GtkSelectionData object
+</parameter_description>
+</parameter>
+<parameter name="writable">
+<parameter_description> whether to accept only targets for which GTK+ knows
+how to convert a pixbuf into the format
</parameter_description>
</parameter>
</parameters>
-<return> the number of columns, or -1
+<return> %TRUE if @selection_data holds a list of targets,
+and a suitable target for images is included, otherwise %FALSE.
</return>
</function>
-<function name="gtk_widget_push_colormap">
+<function name="gtk_selection_data_targets_include_rich_text">
<description>
-Pushes @cmap onto a global stack of colormaps; the topmost
-colormap on the stack will be used to create all widgets.
-Remove @cmap with gtk_widget_pop_colormap(). There's little
-reason to use this function.
+Given a #GtkSelectionData object holding a list of targets,
+determines if any of the targets in @targets can be used to
+provide rich text.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="cmap">
-<parameter_description> a #GdkColormap
+<parameter name="selection_data">
+<parameter_description> a #GtkSelectionData object
+</parameter_description>
+</parameter>
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @selection_data holds a list of targets,
+and a suitable target for rich text is included,
+otherwise %FALSE.
+
+</return>
</function>
-<function name="gtk_widget_intersect">
+<function name="gtk_selection_data_targets_include_text">
<description>
-Computes the intersection of a @widget's area and @area, storing
-the intersection in @intersection, and returns %TRUE if there was
-an intersection. @intersection may be %NULL if you're only
-interested in whether there was an intersection.
+Given a #GtkSelectionData object holding a list of targets,
+determines if any of the targets in @targets can be used to
+provide text.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="area">
-<parameter_description> a rectangle
-</parameter_description>
-</parameter>
-<parameter name="intersection">
-<parameter_description> rectangle to store intersection of @widget and @area
+<parameter name="selection_data">
+<parameter_description> a #GtkSelectionData object
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if there was an intersection
+<return> %TRUE if @selection_data holds a list of targets,
+and a suitable target for text is included, otherwise %FALSE.
</return>
</function>
-<function name="gtk_image_new_from_animation">
+<function name="gtk_selection_data_targets_include_uri">
<description>
-Creates a #GtkImage displaying the given animation.
-The #GtkImage does not assume a reference to the
-animation; you still need to unref it if you own references.
-#GtkImage will add its own reference rather than adopting yours.
-
-Note that the animation frames are shown using a timeout with
-#G_PRIORITY_DEFAULT. When using animations to indicate busyness,
-keep in mind that the animation will only be shown if the main loop
-is not busy with something that has a higher priority.
+Given a #GtkSelectionData object holding a list of targets,
+determines if any of the targets in @targets can be used to
+provide a list or URIs.
+Since: 2.10
</description>
<parameters>
-<parameter name="animation">
-<parameter_description> an animation
+<parameter name="selection_data">
+<parameter_description> a #GtkSelectionData object
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkImage widget
+<return> %TRUE if @selection_data holds a list of targets,
+and a suitable target for URI lists is included, otherwise %FALSE.
+
</return>
</function>
-<function name="gtk_style_render_icon">
+<function name="gtk_selection_owner_set">
<description>
-Renders the icon specified by @source at the given @size
-according to the given parameters and returns the result in a
-pixbuf.
+Claims ownership of a given selection for a particular widget,
+or, if @widget is %NULL, release ownership of the selection.
+
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
+<parameter name="widget">
+<parameter_description> a #GtkWidget, or %NULL.
</parameter_description>
</parameter>
-<parameter name="source">
-<parameter_description> the #GtkIconSource specifying the icon to render
+<parameter name="selection">
+<parameter_description> an interned atom representing the selection to claim
</parameter_description>
</parameter>
-<parameter name="direction">
-<parameter_description> a text direction
+<parameter name="time_">
+<parameter_description> timestamp with which to claim the selection
</parameter_description>
</parameter>
-<parameter name="state">
-<parameter_description> a state
+</parameters>
+<return> %TRUE if the operation succeeded
+</return>
+</function>
+
+<function name="gtk_selection_owner_set_for_display">
+<description>
+Claim ownership of a given selection for a particular widget, or,
+if @widget is %NULL, release ownership of the selection.
+
+Since: 2.2
+
+</description>
+<parameters>
+<parameter name="display">
+<parameter_description> the #Gdkdisplay where the selection is set
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> (type int) the size to render the icon at. A size of
-(GtkIconSize)-1 means render at the size of the source and
-don't scale.
+<parameter name="widget">
+<parameter_description> new selection owner (a #GdkWidget), or %NULL.
</parameter_description>
</parameter>
-<parameter name="widget">
-<parameter_description> the widget
+<parameter name="selection">
+<parameter_description> an interned atom representing the selection to claim.
</parameter_description>
</parameter>
-<parameter name="detail">
-<parameter_description> a style detail
+<parameter name="time_">
+<parameter_description> timestamp with which to claim the selection
</parameter_description>
</parameter>
</parameters>
-<return> a newly-created #GdkPixbuf containing the rendered icon
+<return> TRUE if the operation succeeded
+
</return>
</function>
-<function name="gtk_entry_set_icon_from_icon_name">
+<function name="gtk_selection_remove_all">
<description>
-Sets the icon shown in the entry at the specified position
-from the current icon theme.
+Removes all handlers and unsets ownership of all
+selections for a widget. Called when widget is being
+destroyed. This function will not generally be
+called by applications.
-If the icon name isn't known, a "broken image" icon will be displayed
-instead.
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-If @icon_name is %NULL, no icon will be shown in the specified position.
+<function name="gtk_separator_new">
+<description>
+Creates a new #GtkSeparator with the given orientation.
Since: 2.16
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> A #GtkEntry
-</parameter_description>
-</parameter>
-<parameter name="icon_pos">
-<parameter_description> The position at which to set the icon
-</parameter_description>
-</parameter>
-<parameter name="icon_name">
-<parameter_description> An icon name, or %NULL
+<parameter name="orientation">
+<parameter_description> the separator's orientation.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GtkSeparator.
+
+</return>
</function>
-<function name="gtk_box_get_homogeneous">
+<function name="gtk_separator_tool_item_get_draw">
<description>
-Returns whether the box is homogeneous (all children are the
-same size). See gtk_box_set_homogeneous().
+Returns whether @item is drawn as a line, or just blank.
+See gtk_separator_tool_item_set_draw().
+Since: 2.4
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #GtkBox
+<parameter name="item">
+<parameter_description> a #GtkSeparatorToolItem
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the box is homogeneous.
+<return> %TRUE if @item is drawn as a line, or just blank.
+
</return>
</function>
-<function name="gtk_vbutton_box_get_layout_default">
+<function name="gtk_separator_tool_item_new">
<description>
-Retrieves the current layout used to arrange buttons in button box widgets.
+Create a new #GtkSeparatorToolItem
-Deprecated: 2.0: Use gtk_button_box_get_layout() instead.
+Since: 2.4
</description>
<parameters>
</parameters>
-<return> the current #GtkButtonBoxStyle.
+<return> the new #GtkSeparatorToolItem
</return>
</function>
-<function name="gtk_target_list_add">
+<function name="gtk_separator_tool_item_set_draw">
<description>
-Appends another target to a #GtkTargetList.
+Whether @item is drawn as a vertical line, or just blank.
+Setting this to %FALSE along with gtk_tool_item_set_expand() is useful
+to create an item that forces following items to the end of the toolbar.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GtkTargetList
-</parameter_description>
-</parameter>
-<parameter name="target">
-<parameter_description> the interned atom representing the target
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> the flags for this target
+<parameter name="item">
+<parameter_description> a #GtkSeparatorToolItem
</parameter_description>
</parameter>
-<parameter name="info">
-<parameter_description> an ID that will be passed back to the application
+<parameter name="draw">
+<parameter_description> whether @item is drawn as a vertical line
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_border_new">
+<function name="gtk_set_locale">
<description>
-Allocates a new #GtkBorder structure and initializes its elements to zero.
+Initializes internationalization support for GTK+. gtk_init()
+automatically does this, so there is typically no point
+in calling this function.
-Since: 2.14
+If you are calling this function because you changed the locale
+after GTK+ is was initialized, then calling this function
+may help a bit. (Note, however, that changing the locale
+after GTK+ is initialized may produce inconsistent results and
+is not really supported.)
+
+In detail - sets the current locale according to the
+program environment. This is the same as calling the C library function
+<literal>setlocale (LC_ALL, "")</literal> but also takes care of the
+locale specific setup of the windowing system used by GDK.
+
+Deprecated: 2.24: Use setlocale() directly
</description>
<parameters>
</parameters>
-<return> a new empty #GtkBorder. The newly allocated #GtkBorder should be
-freed with gtk_border_free()
+<return> a string corresponding to the locale set, typically in the
+form lang_COUNTRY, where lang is an ISO-639 language code, and
+COUNTRY is an ISO-3166 country code. On Unix, this form matches the
+result of the setlocale(); it is also used on other machines, such as
+Windows, where the C library returns a different result. The string is
+owned by GTK+ and should not be modified or freed.
</return>
</function>
-<function name="gtk_socket_get_id">
+<function name="gtk_settings_get_default">
<description>
-Gets the window ID of a #GtkSocket widget, which can then
-be used to create a client embedded inside the socket, for
-instance with gtk_plug_new().
-
-The #GtkSocket must have already be added into a toplevel window
-before you can make this call.
+Gets the #GtkSettings object for the default GDK screen, creating
+it if necessary. See gtk_settings_get_for_screen().
</description>
<parameters>
-<parameter name="socket_">
-<parameter_description> a #GtkSocket.
-</parameter_description>
-</parameter>
</parameters>
-<return> the window ID for the socket
+<return> a #GtkSettings object. If there is no default
+screen, then returns %NULL.
</return>
</function>
-<function name="gtk_entry_progress_pulse">
+<function name="gtk_settings_get_for_screen">
<description>
-Indicates that some progress is made, but you don't know how much.
-Causes the entry's progress indicator to enter "activity mode,"
-where a block bounces back and forth. Each call to
-gtk_entry_progress_pulse() causes the block to move by a little bit
-(the amount of movement per pulse is determined by
-gtk_entry_set_progress_pulse_step()).
+Gets the #GtkSettings object for @screen, creating it if necessary.
-Since: 2.16
+Since: 2.2
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="screen">
+<parameter_description> a #GdkScreen.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #GtkSettings object.
+
+</return>
</function>
-<function name="gtk_file_selection_set_filename">
+<function name="gtk_show_about_dialog">
<description>
-Sets a default path for the file requestor. If @filename includes a
-directory path, then the requestor will open with that path as its
-current working directory.
-
-This has the consequence that in order to open the requestor with a
-working directory and an empty filename, @filename must have a trailing
-directory separator.
+This is a convenience function for showing an application's about box.
+The constructed dialog is associated with the parent window and
+reused for future invocations of this function.
-The encoding of @filename is preferred GLib file name encoding, which
-may not be UTF-8. See g_filename_from_utf8().
+Since: 2.6
</description>
<parameters>
-<parameter name="filesel">
-<parameter_description> a #GtkFileSelection.
+<parameter name="parent">
+<parameter_description> transient parent, or %NULL for none
</parameter_description>
</parameter>
-<parameter name="filename">
-<parameter_description> a string to set as the default file name.
+<parameter name="first_property_name">
+<parameter_description> the name of the first property
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> value of first property, followed by more properties, %NULL-terminated
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_buildable_construct_child">
+<function name="gtk_show_uri">
<description>
-Constructs a child of @buildable with the name @name.
+This is a convenience function for launching the default application
+to show the uri. The uri must be of a form understood by GIO (i.e. you
+need to install gvfs to get support for uri schemes such as http://
+or ftp://, as only local files are handled by GIO itself).
+Typical examples are
+<simplelist>
+<member><filename>file:///home/gnome/pict.jpg</filename></member>
+<member><filename>http://www.gnome.org</filename></member>
+<member><filename>mailto:me gnome org</filename></member>
+</simplelist>
+Ideally the timestamp is taken from the event triggering
+the gtk_show_uri() call. If timestamp is not known you can take
+%GDK_CURRENT_TIME.
-#GtkBuilder calls this function if a "constructor" has been
-specified in the UI definition.
+This function can be used as a replacement for gnome_vfs_url_show()
+and gnome_url_show().
-Since: 2.12
+Since: 2.14
</description>
<parameters>
-<parameter name="buildable">
-<parameter_description> A #GtkBuildable
+<parameter name="screen">
+<parameter_description> screen to show the uri on or %NULL for the default screen
</parameter_description>
</parameter>
-<parameter name="builder">
-<parameter_description> #GtkBuilder used to construct this object
+<parameter name="uri">
+<parameter_description> the uri to show
</parameter_description>
</parameter>
-<parameter name="name">
-<parameter_description> name of child to construct
+<parameter name="timestamp">
+<parameter_description> a timestamp to prevent focus stealing.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> a #GError that is returned in case of errors
</parameter_description>
</parameter>
</parameters>
-<return> the constructed child
+<return> %TRUE on success, %FALSE on error.
</return>
</function>
-<function name="gtk_viewport_get_vadjustment">
+<function name="gtk_size_group_add_widget">
<description>
-Returns the vertical adjustment of the viewport.
+Adds a widget to a #GtkSizeGroup. In the future, the requisition
+of the widget will be determined as the maximum of its requisition
+and the requisition of the other widgets in the size group.
+Whether this applies horizontally, vertically, or in both directions
+depends on the mode of the size group. See gtk_size_group_set_mode().
+When the widget is destroyed or no longer referenced elsewhere, it will
+be removed from the size group.
</description>
<parameters>
-<parameter name="viewport">
-<parameter_description> a #GtkViewport.
+<parameter name="size_group">
+<parameter_description> a #GtkSizeGroup
+</parameter_description>
+</parameter>
+<parameter name="widget">
+<parameter_description> the #GtkWidget to add
</parameter_description>
</parameter>
</parameters>
-<return> the vertical adjustment of @viewport.
-</return>
+<return></return>
</function>
-<function name="gtk_recent_chooser_set_show_icons">
+<function name="gtk_size_group_get_ignore_hidden">
<description>
-Sets whether @chooser should show an icon near the resource when
-displaying it.
+Returns if invisible widgets are ignored when calculating the size.
-Since: 2.10
+Since: 2.8
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
-</parameter_description>
-</parameter>
-<parameter name="show_icons">
-<parameter_description> whether to show an icon near the resource
+<parameter name="size_group">
+<parameter_description> a #GtkSizeGroup
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if invisible widgets are ignored.
+
+</return>
</function>
-<function name="gtk_tree_selection_select_range">
+<function name="gtk_size_group_get_mode">
<description>
-Selects a range of nodes, determined by @start_path and @end_path inclusive.
- selection must be set to #GTK_SELECTION_MULTIPLE mode.
+Gets the current mode of the size group. See gtk_size_group_set_mode().
+
</description>
<parameters>
-<parameter name="selection">
-<parameter_description> A #GtkTreeSelection.
-</parameter_description>
-</parameter>
-<parameter name="start_path">
-<parameter_description> The initial node of the range.
-</parameter_description>
-</parameter>
-<parameter name="end_path">
-<parameter_description> The final node of the range.
+<parameter name="size_group">
+<parameter_description> a #GtkSizeGroup
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the current mode of the size group.
+</return>
</function>
-<function name="gtk_icon_theme_get_icon_sizes">
+<function name="gtk_size_group_get_widgets">
<description>
-Returns an array of integers describing the sizes at which
-the icon is available without scaling. A size of -1 means
-that the icon is available in a scalable format. The array
-is zero-terminated.
+Returns the list of widgets associated with @size_group.
-Since: 2.6
+Since: 2.10
</description>
<parameters>
-<parameter name="icon_theme">
-<parameter_description> a #GtkIconTheme
-</parameter_description>
-</parameter>
-<parameter name="icon_name">
-<parameter_description> the name of an icon
+<parameter name="size_group">
+<parameter_description> a #GtkSizeGrup
</parameter_description>
</parameter>
</parameters>
-<return> An newly allocated array describing the sizes at
-which the icon is available. The array should be freed with g_free()
-when it is no longer needed.
+<return> a #GSList of
+widgets. The list is owned by GTK+ and should not be modified.
</return>
</function>
-<function name="gtk_text_iter_backward_sentence_starts">
+<function name="gtk_size_group_new">
<description>
-Calls gtk_text_iter_backward_sentence_start() up to @count times,
-or until it returns %FALSE. If @count is negative, moves forward
-instead of backward.
-
+Create a new #GtkSizeGroup.
+
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
-</parameter_description>
-</parameter>
-<parameter name="count">
-<parameter_description> number of sentences to move
+<parameter name="mode">
+<parameter_description> the mode for the new size group.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter moved and is not the end iterator
+<return> a newly created #GtkSizeGroup
</return>
</function>
-<function name="gtk_text_view_get_vadjustment">
+<function name="gtk_size_group_remove_widget">
<description>
-Gets the vertical-scrolling #GtkAdjustment.
-
-Since: 2.22
+Removes a widget from a #GtkSizeGroup.
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="size_group">
+<parameter_description> a #GtkSizeGrup
+</parameter_description>
+</parameter>
+<parameter name="widget">
+<parameter_description> the #GtkWidget to remove
</parameter_description>
</parameter>
</parameters>
-<return> pointer to the vertical #GtkAdjustment
-
-</return>
+<return></return>
</function>
-<function name="gtk_recent_chooser_select_all">
+<function name="gtk_size_group_set_ignore_hidden">
<description>
-Selects all the items inside @chooser, if the @chooser supports
-multiple selection.
+Sets whether unmapped widgets should be ignored when
+calculating the size.
-Since: 2.10
+Since: 2.8
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
+<parameter name="size_group">
+<parameter_description> a #GtkSizeGroup
+</parameter_description>
+</parameter>
+<parameter name="ignore_hidden">
+<parameter_description> whether unmapped widgets should be ignored
+when calculating the size
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_set_opacity">
+<function name="gtk_size_group_set_mode">
<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 has any effect only on X screens with a compositing manager
-running. See gtk_widget_is_composited(). On Windows it should work
-always.
-
-Note that setting a window's opacity after the window has been
-shown causes it to flicker once on Windows.
-
-Since: 2.12
+Sets the #GtkSizeGroupMode of the size group. The mode of the size
+group determines whether the widgets in the size group should
+all have the same horizontal requisition (%GTK_SIZE_GROUP_MODE_HORIZONTAL)
+all have the same vertical requisition (%GTK_SIZE_GROUP_MODE_VERTICAL),
+or should all have the same requisition in both directions
+(%GTK_SIZE_GROUP_MODE_BOTH).
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="size_group">
+<parameter_description> a #GtkSizeGroup
</parameter_description>
</parameter>
-<parameter name="opacity">
-<parameter_description> desired opacity, between 0 and 1
+<parameter name="mode">
+<parameter_description> the mode to set for the size group.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_settings_set_default_source">
+<function name="gtk_socket_add_id">
<description>
-Sets the value of %GTK_PRINT_SETTINGS_DEFAULT_SOURCE.
+Adds an XEMBED client, such as a #GtkPlug, to the #GtkSocket. The
+client may be in the same process or in a different process.
-Since: 2.10
+To embed a #GtkPlug in a #GtkSocket, you can either create the
+#GtkPlug with <literal>gtk_plug_new (0)</literal>, call
+gtk_plug_get_id() to get the window ID of the plug, and then pass that to the
+gtk_socket_add_id(), or you can call gtk_socket_get_id() to get the
+window ID for the socket, and call gtk_plug_new() passing in that
+ID.
+
+The #GtkSocket must have already be added into a toplevel window
+before you can make this call.
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="socket_">
+<parameter_description> a #GtkSocket
</parameter_description>
</parameter>
-<parameter name="default_source">
-<parameter_description> the default source
+<parameter name="window_id">
+<parameter_description> the window ID of a client participating in the XEMBED protocol.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_model_get_value">
+<function name="gtk_socket_get_id">
<description>
-Initializes and sets @value to that at @column.
-When done with @value, g_value_unset() needs to be called
-to free any allocated memory.
+Gets the window ID of a #GtkSocket widget, which can then
+be used to create a client embedded inside the socket, for
+instance with gtk_plug_new().
+
+The #GtkSocket must have already be added into a toplevel window
+before you can make this call.
+
</description>
<parameters>
-<parameter name="tree_model">
-<parameter_description> A #GtkTreeModel.
+<parameter name="socket_">
+<parameter_description> a #GtkSocket.
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> The #GtkTreeIter.
+</parameters>
+<return> the window ID for the socket
+</return>
+</function>
+
+<function name="gtk_socket_get_plug_window">
+<description>
+Retrieves the window of the plug. Use this to check if the plug has
+been created inside of the socket.
+
+Since: 2.14
+
+</description>
+<parameters>
+<parameter name="socket_">
+<parameter_description> a #GtkSocket.
</parameter_description>
</parameter>
-<parameter name="column">
-<parameter_description> The column to lookup the value at.
+</parameters>
+<return> the window of the plug if available, or %NULL
+
+</return>
+</function>
+
+<function name="gtk_socket_new">
+<description>
+Create a new empty #GtkSocket.
+
+
+</description>
+<parameters>
+</parameters>
+<return> the new #GtkSocket.
+</return>
+</function>
+
+<function name="gtk_socket_steal">
+<description>
+Reparents a pre-existing toplevel window into a #GtkSocket. This is
+meant to embed clients that do not know about embedding into a
+#GtkSocket, however doing so is inherently unreliable, and using
+this function is not recommended.
+
+The #GtkSocket must have already be added into a toplevel window
+before you can make this call.
+
+</description>
+<parameters>
+<parameter name="socket_">
+<parameter_description> a #GtkSocket
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> An empty #GValue to set.
+<parameter name="wid">
+<parameter_description> the window ID of an existing toplevel window.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_delete">
+<function name="gtk_spin_button_configure">
<description>
-Deletes text between @start and @end. The order of @start and @end
-is not actually relevant; gtk_text_buffer_delete() will reorder
-them. This function actually emits the "delete-range" signal, and
-the default handler of that signal deletes the text. Because the
-buffer is modified, all outstanding iterators become invalid after
-calling this function; however, the @start and @end will be
-re-initialized to point to the location where text was deleted.
+Changes the properties of an existing spin button. The adjustment, climb rate,
+and number of decimal places are all changed accordingly, after this function call.
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="spin_button">
+<parameter_description> a #GtkSpinButton
</parameter_description>
</parameter>
-<parameter name="start">
-<parameter_description> a position in @buffer
+<parameter name="adjustment">
+<parameter_description> a #GtkAdjustment.
</parameter_description>
</parameter>
-<parameter name="end">
-<parameter_description> another position in @buffer
+<parameter name="climb_rate">
+<parameter_description> the new climb rate.
+</parameter_description>
+</parameter>
+<parameter name="digits">
+<parameter_description> the number of decimal places to display in the spin button.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_get_window_type">
+<function name="gtk_spin_button_get_adjustment">
<description>
-Gets the type of the window. See #GtkWindowType.
+Get the adjustment associated with a #GtkSpinButton
-Since: 2.20
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="spin_button">
+<parameter_description> a #GtkSpinButton
</parameter_description>
</parameter>
</parameters>
-<return> the type of the window
-
+<return> the #GtkAdjustment of @spin_button
</return>
</function>
-<function name="gtk_tool_item_retrieve_proxy_menu_item">
+<function name="gtk_spin_button_get_digits">
<description>
-Returns the #GtkMenuItem that was last set by
-gtk_tool_item_set_proxy_menu_item(), ie. the #GtkMenuItem
-that is going to appear in the overflow menu.
+Fetches the precision of @spin_button. See gtk_spin_button_set_digits().
-Since: 2.4
</description>
<parameters>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem
+<parameter name="spin_button">
+<parameter_description> a #GtkSpinButton
</parameter_description>
</parameter>
</parameters>
-<return> The #GtkMenuItem that is going to appear in the
-overflow menu for @tool_item.
-
+<return> the current precision
</return>
</function>
-<function name="gtk_image_set_from_file">
+<function name="gtk_spin_button_get_increments">
<description>
-See gtk_image_new_from_file() for details.
+Gets the current step and page the increments used by @spin_button. See
+gtk_spin_button_set_increments().
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GtkImage
+<parameter name="spin_button">
+<parameter_description> a #GtkSpinButton
</parameter_description>
</parameter>
-<parameter name="filename">
-<parameter_description> a filename or %NULL
+<parameter name="step">
+<parameter_description> location to store step increment, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="page">
+<parameter_description> location to store page increment, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_selection_add_targets">
+<function name="gtk_spin_button_get_numeric">
<description>
-Prepends a table of targets to the list of supported targets
-for a given widget and selection.
+Returns whether non-numeric text can be typed into the spin button.
+See gtk_spin_button_set_numeric().
+
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="spin_button">
+<parameter_description> a #GtkSpinButton
</parameter_description>
</parameter>
-<parameter name="selection">
-<parameter_description> the selection
+</parameters>
+<return> %TRUE if only numeric text can be entered
+</return>
+</function>
+
+<function name="gtk_spin_button_get_range">
+<description>
+Gets the range allowed for @spin_button. See
+gtk_spin_button_set_range().
+
+</description>
+<parameters>
+<parameter name="spin_button">
+<parameter_description> a #GtkSpinButton
</parameter_description>
</parameter>
-<parameter name="targets">
-<parameter_description> a table of targets to add
+<parameter name="min">
+<parameter_description> location to store minimum allowed value, or %NULL
</parameter_description>
</parameter>
-<parameter name="ntargets">
-<parameter_description> number of entries in @targets
+<parameter name="max">
+<parameter_description> location to store maximum allowed value, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_settings_get_printer_lpi">
+<function name="gtk_spin_button_get_snap_to_ticks">
<description>
-Gets the value of %GTK_PRINT_SETTINGS_PRINTER_LPI.
+Returns whether the values are corrected to the nearest step. See
+gtk_spin_button_set_snap_to_ticks().
-Since: 2.16
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="spin_button">
+<parameter_description> a #GtkSpinButton
</parameter_description>
</parameter>
</parameters>
-<return> the resolution in lpi (lines per inch)
-
+<return> %TRUE if values are snapped to the nearest step.
</return>
</function>
-<function name="gtk_get_current_event">
+<function name="gtk_spin_button_get_update_policy">
<description>
-Obtains a copy of the event currently being processed by GTK+. For
-example, if you get a "clicked" signal from #GtkButton, the current
-event will be the #GdkEventButton that triggered the "clicked"
-signal. The returned event must be freed with gdk_event_free().
-If there is no current event, the function returns %NULL.
+Gets the update behavior of a spin button. See
+gtk_spin_button_set_update_policy().
</description>
<parameters>
+<parameter name="spin_button">
+<parameter_description> a #GtkSpinButton
+</parameter_description>
+</parameter>
</parameters>
-<return> a copy of the current event, or %NULL if no current event.
+<return> the current update policy
</return>
</function>
-<function name="gtk_target_table_new_from_list">
+<function name="gtk_spin_button_get_value">
<description>
-This function creates an #GtkTargetEntry array that contains the
-same targets as the passed %list. The returned table is newly
-allocated and should be freed using gtk_target_table_free() when no
-longer needed.
+Get the value in the @spin_button.
-Since: 2.10
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GtkTargetList
-</parameter_description>
-</parameter>
-<parameter name="n_targets">
-<parameter_description> return location for the number ot targets in the table
+<parameter name="spin_button">
+<parameter_description> a #GtkSpinButton
</parameter_description>
</parameter>
</parameters>
-<return> the new table.
-
+<return> the value of @spin_button
</return>
</function>
-<function name="gtk_notebook_popup_disable">
+<function name="gtk_spin_button_get_value_as_int">
<description>
-Disables the popup menu.
+Get the value @spin_button represented as an integer.
+
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="spin_button">
+<parameter_description> a #GtkSpinButton
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the value of @spin_button
+</return>
</function>
-<function name="gtk_icon_set_new_from_pixbuf">
+<function name="gtk_spin_button_get_wrap">
<description>
-Creates a new #GtkIconSet with @pixbuf as the default/fallback
-source image. If you don't add any additional #GtkIconSource to the
-icon set, all variants of the icon will be created from @pixbuf,
-using scaling, pixelation, etc. as required to adjust the icon size
-or make the icon look insensitive/prelighted.
+Returns whether the spin button's value wraps around to the
+opposite limit when the upper or lower limit of the range is
+exceeded. See gtk_spin_button_set_wrap().
</description>
<parameters>
-<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf
+<parameter name="spin_button">
+<parameter_description> a #GtkSpinButton
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkIconSet
+<return> %TRUE if the spin button wraps around
</return>
</function>
-<function name="gtk_item_factory_get_item">
+<function name="gtk_spin_button_new_with_range">
<description>
-Obtains the menu item which corresponds to @path.
+This is a convenience constructor that allows creation of a numeric
+#GtkSpinButton without manually creating an adjustment. The value is
+initially set to the minimum value and a page increment of 10 * @step
+is the default. The precision of the spin button is equivalent to the
+precision of @step.
-If the widget corresponding to @path is a menu item which opens a
-submenu, then the item is returned. If you are interested in the submenu,
-use gtk_item_factory_get_widget() instead.
+Note that the way in which the precision is derived works best if @step
+is a power of ten. If the resulting precision is not suitable for your
+needs, use gtk_spin_button_set_digits() to correct it.
-Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="ifactory">
-<parameter_description> a #GtkItemFactory
+<parameter name="min">
+<parameter_description> Minimum allowable value
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> the path to the menu item
+<parameter name="max">
+<parameter_description> Maximum allowable value
+</parameter_description>
+</parameter>
+<parameter name="step">
+<parameter_description> Increment added or subtracted by spinning the widget
</parameter_description>
</parameter>
</parameters>
-<return> the menu item for the given path, or %NULL if @path doesn't
-lead to a menu item
+<return> The new spin button as a #GtkWidget.
</return>
</function>
-<function name="gtk_text_iter_set_offset">
+<function name="gtk_spin_button_set_adjustment">
<description>
-Sets @iter to point to @char_offset. @char_offset counts from the start
-of the entire text buffer, starting with 0.
+Replaces the #GtkAdjustment associated with @spin_button.
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="spin_button">
+<parameter_description> a #GtkSpinButton
</parameter_description>
</parameter>
-<parameter name="char_offset">
-<parameter_description> a character number
+<parameter name="adjustment">
+<parameter_description> a #GtkAdjustment to replace the existing adjustment
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_set_search_position_func">
+<function name="gtk_spin_button_set_digits">
<description>
-Sets the function to use when positioning the search dialog.
-
-Since: 2.10
+Set the precision to be displayed by @spin_button. Up to 20 digit precision
+is allowed.
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView
+<parameter name="spin_button">
+<parameter_description> a #GtkSpinButton
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> the function to use to position the search dialog, or %NULL
-to use the default search position function
+<parameter name="digits">
+<parameter_description> the number of digits after the decimal point to be displayed for the spin button's value
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> user data to pass to @func, or %NULL
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_spin_button_set_increments">
+<description>
+Sets the step and page increments for spin_button. This affects how
+quickly the value changes when the spin button's arrows are activated.
+
+</description>
+<parameters>
+<parameter name="spin_button">
+<parameter_description> a #GtkSpinButton
</parameter_description>
</parameter>
-<parameter name="destroy">
-<parameter_description> Destroy notifier for @data, or %NULL
+<parameter name="step">
+<parameter_description> increment applied for a button 1 press.
+</parameter_description>
+</parameter>
+<parameter name="page">
+<parameter_description> increment applied for a button 2 press.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_convert_tree_to_widget_coords">
+<function name="gtk_spin_button_set_numeric">
<description>
-Converts tree coordinates (coordinates in full scrollable area of the tree)
-to widget coordinates.
-
-Since: 2.12
+Sets the flag that determines if non-numeric text can be typed into
+the spin button.
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
+<parameter name="spin_button">
+<parameter_description> a #GtkSpinButton
</parameter_description>
</parameter>
-<parameter name="tx">
-<parameter_description> X coordinate relative to the tree
+<parameter name="numeric">
+<parameter_description> flag indicating if only numeric entry is allowed.
</parameter_description>
</parameter>
-<parameter name="ty">
-<parameter_description> Y coordinate relative to the tree
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_spin_button_set_range">
+<description>
+Sets the minimum and maximum allowable values for @spin_button
+
+</description>
+<parameters>
+<parameter name="spin_button">
+<parameter_description> a #GtkSpinButton
</parameter_description>
</parameter>
-<parameter name="wx">
-<parameter_description> return location for widget X coordinate
+<parameter name="min">
+<parameter_description> minimum allowable value
</parameter_description>
</parameter>
-<parameter name="wy">
-<parameter_description> return location for widget Y coordinate
+<parameter name="max">
+<parameter_description> maximum allowable value
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_cell_renderer_stop_editing">
+<function name="gtk_spin_button_set_snap_to_ticks">
<description>
-Informs the cell renderer that the editing is stopped.
-If @canceled is %TRUE, the cell renderer will emit the
-#GtkCellRenderer::editing-canceled signal.
-
-This function should be called by cell renderer implementations
-in response to the #GtkCellEditable::editing-done signal of
-#GtkCellEditable.
-
-Since: 2.6
+Sets the policy as to whether values are corrected to the nearest step
+increment when a spin button is activated after providing an invalid value.
</description>
<parameters>
-<parameter name="cell">
-<parameter_description> A #GtkCellRenderer
+<parameter name="spin_button">
+<parameter_description> a #GtkSpinButton
</parameter_description>
</parameter>
-<parameter name="canceled">
-<parameter_description> %TRUE if the editing has been canceled
+<parameter name="snap_to_ticks">
+<parameter_description> a flag indicating if invalid values should be corrected.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_entry_get_icon_window">
+<function name="gtk_spin_button_set_update_policy">
<description>
-Returns the #GdkWindow which contains the entry's icon at
- icon_pos This function is useful when drawing something to the
-entry in an expose-event callback because it enables the callback
-to distinguish between the text window and entry's icon windows.
+Sets the update behavior of a spin button. This determines whether the
+spin button is always updated or only when a valid value is set.
-See also gtk_entry_get_text_window().
+</description>
+<parameters>
+<parameter name="spin_button">
+<parameter_description> a #GtkSpinButton
+</parameter_description>
+</parameter>
+<parameter name="policy">
+<parameter_description> a #GtkSpinButtonUpdatePolicy value
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-Since: 2.20
+<function name="gtk_spin_button_set_value">
+<description>
+Set the value of @spin_button.
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> A #GtkEntry
+<parameter name="spin_button">
+<parameter_description> a #GtkSpinButton
</parameter_description>
</parameter>
-<parameter name="icon_pos">
-<parameter_description> Icon position
+<parameter name="value">
+<parameter_description> the new value
</parameter_description>
</parameter>
</parameters>
-<return> the entry's icon window at @icon_pos.
-
-</return>
+<return></return>
</function>
-<function name="gtk_text_view_add_child_in_window">
+<function name="gtk_spin_button_set_wrap">
<description>
-Adds a child at fixed coordinates in one of the text widget's
-windows. The window must have nonzero size (see
-gtk_text_view_set_border_window_size()). Note that the child
-coordinates are given relative to the #GdkWindow in question, and
-that these coordinates have no sane relationship to scrolling. When
-placing a child in #GTK_TEXT_WINDOW_WIDGET, scrolling is
-irrelevant, the child floats above all scrollable areas. But when
-placing a child in one of the scrollable windows (border windows or
-text window), you'll need to compute the child's correct position
-in buffer coordinates any time scrolling occurs or buffer changes
-occur, and then call gtk_text_view_move_child() to update the
-child's position. Unfortunately there's no good way to detect that
-scrolling has occurred, using the current API; a possible hack
-would be to update all child positions when the scroll adjustments
-change or the text buffer changes. See bug 64518 on
-bugzilla.gnome.org for status of fixing this issue.
+Sets the flag that determines if a spin button value wraps around to the
+opposite limit when the upper or lower limit of the range is exceeded.
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="spin_button">
+<parameter_description> a #GtkSpinButton
</parameter_description>
</parameter>
-<parameter name="child">
-<parameter_description> a #GtkWidget
+<parameter name="wrap">
+<parameter_description> a flag indicating if wrapping behavior is performed.
</parameter_description>
</parameter>
-<parameter name="which_window">
-<parameter_description> which window the child should appear in
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_spin_button_spin">
+<description>
+Increment or decrement a spin button's value in a specified direction
+by a specified amount.
+
+</description>
+<parameters>
+<parameter name="spin_button">
+<parameter_description> a #GtkSpinButton
</parameter_description>
</parameter>
-<parameter name="xpos">
-<parameter_description> X position of child in window coordinates
+<parameter name="direction">
+<parameter_description> a #GtkSpinType indicating the direction to spin.
</parameter_description>
</parameter>
-<parameter name="ypos">
-<parameter_description> Y position of child in window coordinates
+<parameter name="increment">
+<parameter_description> step increment to apply in the specified direction.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_recent_info_is_local">
+<function name="gtk_spin_button_update">
<description>
-Checks whether the resource is local or not by looking at the
-scheme of its URI.
-
-Since: 2.10
+Manually force an update of the spin button.
</description>
<parameters>
-<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter name="spin_button">
+<parameter_description> a #GtkSpinButton
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the resource is local.
+<return></return>
+</function>
+
+<function name="gtk_spinner_new">
+<description>
+Returns a new spinner widget. Not yet started.
+
+Since: 2.20
+
+</description>
+<parameters>
+</parameters>
+<return> a new #GtkSpinner
</return>
</function>
-<function name="gtk_layout_get_size">
+<function name="gtk_spinner_start">
<description>
-Gets the size that has been set on the layout, and that determines
-the total extents of the layout's scrollbar area. See
-gtk_layout_set_size ().
+Starts the animation of the spinner.
+
+Since: 2.20
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #GtkLayout
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> location to store the width set on @layout, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> location to store the height set on @layout, or %NULL
+<parameter name="spinner">
+<parameter_description> a #GtkSpinner
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tool_item_get_homogeneous">
+<function name="gtk_spinner_stop">
<description>
-Returns whether @tool_item is the same size as other homogeneous
-items. See gtk_tool_item_set_homogeneous().
+Stops the animation of the spinner.
-Since: 2.4
+Since: 2.20
</description>
<parameters>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem
+<parameter name="spinner">
+<parameter_description> a #GtkSpinner
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the item is the same size as other homogeneous
-items.
-
-</return>
+<return></return>
</function>
-<function name="gtk_widget_list_mnemonic_labels">
+<function name="gtk_status_icon_get_blinking">
<description>
-Returns a newly allocated list of the widgets, normally labels, for
-which this widget is a the target of a mnemonic (see for example,
-gtk_label_set_mnemonic_widget()).
+Returns whether the icon is blinking, see
+gtk_status_icon_set_blinking().
-The widgets in the list are not individually referenced. If you
-want to iterate through the list and perform actions involving
-callbacks that might destroy the widgets, you
-<emphasis>must</emphasis> call <literal>g_list_foreach (result,
-(GFunc)g_object_ref, NULL)</literal> first, and then unref all the
-widgets afterwards.
+Since: 2.10
-Since: 2.4
+Deprecated: 2.22: This function will be removed in GTK+ 3
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
</parameter_description>
</parameter>
</parameters>
-<return> the list of
-mnemonic labels; free this list
-with g_list_free() when you are done with it.
+<return> %TRUE if the icon is blinking
</return>
</function>
-<function name="gtk_image_menu_item_new_from_stock">
+<function name="gtk_status_icon_get_geometry">
<description>
-Creates a new #GtkImageMenuItem containing the image and text from a
-stock item. Some stock ids have preprocessor macros like #GTK_STOCK_OK
-and #GTK_STOCK_APPLY.
+Obtains information about the location of the status icon
+on screen. This information can be used to e.g. position
+popups like notification bubbles.
-If you want this menu item to have changeable accelerators, then pass in
-%NULL for accel_group. Next call gtk_menu_item_set_accel_path() with an
-appropriate path for the menu item, use gtk_stock_lookup() to look up the
-standard accelerator for the stock item, and if one is found, call
-gtk_accel_map_add_entry() to register it.
+See gtk_status_icon_position_menu() for a more convenient
+alternative for positioning menus.
+
+Note that some platforms do not allow GTK+ to provide
+this information, and even on platforms that do allow it,
+the information is not reliable unless the status icon
+is embedded in a notification area, see
+gtk_status_icon_is_embedded().
+
+Since: 2.10
</description>
<parameters>
-<parameter name="stock_id">
-<parameter_description> the name of the stock item.
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
</parameter_description>
</parameter>
-<parameter name="accel_group">
-<parameter_description> the #GtkAccelGroup to add the menu items
-accelerator to, or %NULL.
+<parameter name="screen">
+<parameter_description> return location for the screen, or %NULL if the
+information is not needed
+</parameter_description>
+</parameter>
+<parameter name="area">
+<parameter_description> return location for the area occupied by the status
+icon, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="orientation">
+<parameter_description> return location for the orientation of the panel
+in which the status icon is embedded, or %NULL. A panel
+at the top or bottom of the screen is horizontal, a panel
+at the left or right is vertical.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkImageMenuItem.
+<return> %TRUE if the location information has
+been filled in
+
</return>
</function>
-<function name="gtk_text_iter_forward_text_chars">
+<function name="gtk_status_icon_get_gicon">
<description>
-Moves backward by @count text characters (pixbufs, widgets,
-etc. do not count as characters for this). Equivalent to moving
-through the results of gtk_text_iter_get_text (), rather than
-gtk_text_iter_get_slice ().
+Retrieves the #GIcon being displayed by the #GtkStatusIcon.
+The storage type of the status icon must be %GTK_IMAGE_EMPTY or
+%GTK_IMAGE_GICON (see gtk_status_icon_get_storage_type()).
+The caller of this function does not own a reference to the
+returned #GIcon.
+If this function fails, @icon is left unchanged;
+
+Since: 2.14
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
-</parameter_description>
-</parameter>
-<parameter name="count">
-<parameter_description> number of chars to move
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
</parameter_description>
</parameter>
</parameters>
-<return> whether @iter moved and is dereferenceable
+<return> the displayed icon, or %NULL if the image is empty
+
</return>
</function>
-<function name="gtk_icon_factory_new">
+<function name="gtk_status_icon_get_has_tooltip">
<description>
-Creates a new #GtkIconFactory. An icon factory manages a collection
-of #GtkIconSet<!-- -->s; a #GtkIconSet manages a set of variants of a
-particular icon (i.e. a #GtkIconSet contains variants for different
-sizes and widget states). Icons in an icon factory are named by a
-stock ID, which is a simple string identifying the icon. Each
-#GtkStyle has a list of #GtkIconFactory<!-- -->s derived from the current
-theme; those icon factories are consulted first when searching for
-an icon. If the theme doesn't set a particular icon, GTK+ looks for
-the icon in a list of default icon factories, maintained by
-gtk_icon_factory_add_default() and
-gtk_icon_factory_remove_default(). Applications with icons should
-add a default icon factory with their icons, which will allow
-themes to override the icons for the application.
+Returns the current value of the has-tooltip property.
+See #GtkStatusIcon:has-tooltip for more information.
+Since: 2.16
</description>
<parameters>
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GtkIconFactory
+<return> current value of has-tooltip on @status_icon.
+
</return>
</function>
-<function name="gtk_widget_queue_shallow_draw">
+<function name="gtk_status_icon_get_icon_name">
<description>
-Like gtk_widget_queue_draw(), but only windows owned
-by @widget are invalidated.
+Gets the name of the icon being displayed by the #GtkStatusIcon.
+The storage type of the status icon must be %GTK_IMAGE_EMPTY or
+%GTK_IMAGE_ICON_NAME (see gtk_status_icon_get_storage_type()).
+The returned string is owned by the #GtkStatusIcon and should not
+be freed or modified.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> name of the displayed icon, or %NULL if the image is empty.
+
+</return>
</function>
-<function name="gtk_status_icon_set_tooltip">
+<function name="gtk_status_icon_get_pixbuf">
<description>
-Sets the tooltip of the status icon.
+Gets the #GdkPixbuf being displayed by the #GtkStatusIcon.
+The storage type of the status icon must be %GTK_IMAGE_EMPTY or
+%GTK_IMAGE_PIXBUF (see gtk_status_icon_get_storage_type()).
+The caller of this function does not own a reference to the
+returned pixbuf.
Since: 2.10
-Deprecated: 2.16: Use gtk_status_icon_set_tooltip_text() instead.
-
</description>
<parameters>
<parameter name="status_icon">
<parameter_description> a #GtkStatusIcon
</parameter_description>
</parameter>
-<parameter name="tooltip_text">
-<parameter_description> the tooltip text, or %NULL
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> the displayed pixbuf,
+or %NULL if the image is empty.
+
+</return>
</function>
-<function name="gtk_recent_filter_add_age">
+<function name="gtk_status_icon_get_screen">
<description>
-Adds a rule that allows resources based on their age - that is, the number
-of days elapsed since they were last modified.
+Returns the #GdkScreen associated with @status_icon.
-Since: 2.10
+Since: 2.12
</description>
<parameters>
-<parameter name="filter">
-<parameter_description> a #GtkRecentFilter
-</parameter_description>
-</parameter>
-<parameter name="days">
-<parameter_description> number of days
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #GdkScreen.
+
+</return>
</function>
-<function name="gtk_combo_box_new">
+<function name="gtk_status_icon_get_size">
<description>
-Creates a new empty #GtkComboBox.
+Gets the size in pixels that is available for the image.
+Stock icons and named icons adapt their size automatically
+if the size of the notification area changes. For other
+storage types, the size-changed signal can be used to
+react to size changes.
-Since: 2.4
+Note that the returned size is only meaningful while the
+status icon is embedded (see gtk_status_icon_is_embedded()).
+
+Since: 2.10
</description>
<parameters>
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
+</parameter_description>
+</parameter>
</parameters>
-<return> A new #GtkComboBox.
+<return> the size that is available for the image
</return>
</function>
-<function name="gtk_range_get_min_slider_size">
+<function name="gtk_status_icon_get_stock">
<description>
-This function is useful mainly for #GtkRange subclasses.
-
-See gtk_range_set_min_slider_size().
+Gets the id of the stock icon being displayed by the #GtkStatusIcon.
+The storage type of the status icon must be %GTK_IMAGE_EMPTY or
+%GTK_IMAGE_STOCK (see gtk_status_icon_get_storage_type()).
+The returned string is owned by the #GtkStatusIcon and should not
+be freed or modified.
-Since: 2.20
+Since: 2.10
</description>
<parameters>
-<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
</parameter_description>
</parameter>
</parameters>
-<return> The minimum size of the range's slider.
+<return> stock id of the displayed stock icon,
+or %NULL if the image is empty.
</return>
</function>
-<function name="gtk_accel_map_load">
+<function name="gtk_status_icon_get_storage_type">
<description>
-Parses a file previously saved with gtk_accel_map_save() for
-accelerator specifications, and propagates them accordingly.
+Gets the type of representation being used by the #GtkStatusIcon
+to store image data. If the #GtkStatusIcon has no image data,
+the return value will be %GTK_IMAGE_EMPTY.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="file_name">
-<parameter_description> a file containing accelerator specifications,
-in the GLib file name encoding
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the image representation being used
+
+</return>
</function>
-<function name="gtk_print_settings_new">
+<function name="gtk_status_icon_get_title">
<description>
-Creates a new #GtkPrintSettings object.
+Gets the title of this tray icon. See gtk_status_icon_set_title().
-Since: 2.10
+Since: 2.18
</description>
<parameters>
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GtkPrintSettings object
+<return> the title of the status icon
</return>
</function>
-<function name="gtk_text_iter_get_line_index">
+<function name="gtk_status_icon_get_tooltip_markup">
<description>
-Returns the byte index of the iterator, counting
-from the start of a newline-terminated line.
-Remember that #GtkTextBuffer encodes text in
-UTF-8, and that characters can require a variable
-number of bytes to represent.
+Gets the contents of the tooltip for @status_icon.
+Since: 2.16
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
</parameter_description>
</parameter>
</parameters>
-<return> distance from start of line, in bytes
+<return> the tooltip text, or %NULL. You should free the
+returned string with g_free() when done.
+
</return>
</function>
-<function name="gtk_tree_model_iter_n_children">
+<function name="gtk_status_icon_get_tooltip_text">
<description>
-Returns the number of children that @iter has. As a special case, if @iter
-is %NULL, then the number of toplevel nodes is returned.
+Gets the contents of the tooltip for @status_icon.
+Since: 2.16
</description>
<parameters>
-<parameter name="tree_model">
-<parameter_description> A #GtkTreeModel.
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> The #GtkTreeIter, or %NULL.
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
</parameter_description>
</parameter>
</parameters>
-<return> The number of children of @iter.
+<return> the tooltip text, or %NULL. You should free the
+returned string with g_free() when done.
+
</return>
</function>
-<function name="gtk_recent_chooser_get_current_item">
+<function name="gtk_status_icon_get_visible">
<description>
-Gets the #GtkRecentInfo currently selected by @chooser.
+Returns whether the status icon is visible or not.
+Note that being visible does not guarantee that
+the user can actually see the icon, see also
+gtk_status_icon_is_embedded().
Since: 2.10
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkRecentInfo. Use gtk_recent_info_unref() when
-when you have finished using it.
+<return> %TRUE if the status icon is visible
</return>
</function>
-<function name="gtk_ruler_set_range">
+<function name="gtk_status_icon_get_x11_window_id">
<description>
-This sets the range of the ruler.
+This function is only useful on the X11/freedesktop.org platform.
+It returns a window ID for the widget in the underlying
+status icon implementation. This is useful for the Galago
+notification service, which can send a window ID in the protocol
+in order for the server to position notification windows
+pointing to a status icon reliably.
+
+This function is not intended for other use cases which are
+more likely to be met by one of the non-X11 specific methods, such
+as gtk_status_icon_position_menu().
+
+Since: 2.14
</description>
<parameters>
-<parameter name="ruler">
-<parameter_description> the gtkruler
-</parameter_description>
-</parameter>
-<parameter name="lower">
-<parameter_description> the lower limit of the ruler
-</parameter_description>
-</parameter>
-<parameter name="upper">
-<parameter_description> the upper limit of the ruler
-</parameter_description>
-</parameter>
-<parameter name="position">
-<parameter_description> the mark on the ruler
-</parameter_description>
-</parameter>
-<parameter name="max_size">
-<parameter_description> the maximum size of the ruler used when calculating the space to
-leave for the text
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> An 32 bit unsigned integer identifier for the
+underlying X11 Window
+
+</return>
</function>
-<function name="gtk_image_set_from_image">
+<function name="gtk_status_icon_is_embedded">
<description>
-See gtk_image_new_from_image() for details.
+Returns whether the status icon is embedded in a notification
+area.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GtkImage
-</parameter_description>
-</parameter>
-<parameter name="gdk_image">
-<parameter_description> a #GdkImage or %NULL
-</parameter_description>
-</parameter>
-<parameter name="mask">
-<parameter_description> a #GdkBitmap or %NULL
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the status icon is embedded in
+a notification area.
+
+</return>
</function>
-<function name="gtk_page_setup_get_top_margin">
+<function name="gtk_status_icon_new">
<description>
-Gets the top margin in units of @unit.
+Creates an empty status icon object.
Since: 2.10
</description>
<parameters>
-<parameter name="setup">
-<parameter_description> a #GtkPageSetup
-</parameter_description>
-</parameter>
-<parameter name="unit">
-<parameter_description> the unit for the return value
-</parameter_description>
-</parameter>
</parameters>
-<return> the top margin
+<return> a new #GtkStatusIcon
</return>
</function>
-<function name="gtk_selection_data_copy">
+<function name="gtk_status_icon_new_from_file">
<description>
-Makes a copy of a #GtkSelectionData structure and its data.
+Creates a status icon displaying the file @filename.
+The image will be scaled down to fit in the available
+space in the notification area, if necessary.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="data">
-<parameter_description> a pointer to a #GtkSelectionData structure.
+<parameter name="filename">
+<parameter_description> a filename
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to a copy of @data.
+<return> a new #GtkStatusIcon
+
</return>
</function>
-<function name="gtk_accel_map_save_fd">
+<function name="gtk_status_icon_new_from_gicon">
<description>
-Filedescriptor variant of gtk_accel_map_save().
+Creates a status icon displaying a #GIcon. If the icon is a
+themed icon, it will be updated when the theme changes.
-Note that the file descriptor will not be closed by this function.
+Since: 2.14
</description>
<parameters>
-<parameter name="fd">
-<parameter_description> a valid writable file descriptor
+<parameter name="icon">
+<parameter_description> a #GIcon
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GtkStatusIcon
+
+</return>
</function>
-<function name="gtk_adjustment_get_page_increment">
+<function name="gtk_status_icon_new_from_icon_name">
<description>
-Retrieves the page increment of the adjustment.
+Creates a status icon displaying an icon from the current icon theme.
+If the current icon theme is changed, the icon will be updated
+appropriately.
-Since: 2.14
+Since: 2.10
</description>
<parameters>
-<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
+<parameter name="icon_name">
+<parameter_description> an icon name
</parameter_description>
</parameter>
</parameters>
-<return> The current page increment of the adjustment.
+<return> a new #GtkStatusIcon
</return>
</function>
-<function name="gtk_color_selection_palette_from_string">
+<function name="gtk_status_icon_new_from_pixbuf">
<description>
-Parses a color palette string; the string is a colon-separated
-list of color names readable by gdk_color_parse().
+Creates a status icon displaying @pixbuf.
+The image will be scaled down to fit in the available
+space in the notification area, if necessary.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="str">
-<parameter_description> a string encoding a color palette.
-</parameter_description>
-</parameter>
-<parameter name="colors">
-<parameter_description> return location for allocated array of #GdkColor.
-</parameter_description>
-</parameter>
-<parameter name="n_colors">
-<parameter_description> return location for length of array.
+<parameter name="pixbuf">
+<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if a palette was successfully parsed.
+<return> a new #GtkStatusIcon
+
</return>
</function>
-<function name="gtk_about_dialog_get_name">
+<function name="gtk_status_icon_new_from_stock">
<description>
-Returns the program name displayed in the about dialog.
-
-Since: 2.6
+Creates a status icon displaying a stock icon. Sample stock icon
+names are #GTK_STOCK_OPEN, #GTK_STOCK_QUIT. You can register your
+own stock icon names, see gtk_icon_factory_add_default() and
+gtk_icon_factory_add().
-Deprecated: 2.12: Use gtk_about_dialog_get_program_name() instead.
+Since: 2.10
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter name="stock_id">
+<parameter_description> a stock icon id
</parameter_description>
</parameter>
</parameters>
-<return> The program name. The string is owned by the about
-dialog and must not be modified.
+<return> a new #GtkStatusIcon
</return>
</function>
-<function name="gtk_scrolled_window_get_policy">
+<function name="gtk_status_icon_position_menu">
<description>
-Retrieves the current policy values for the horizontal and vertical
-scrollbars. See gtk_scrolled_window_set_policy().
+Menu positioning function to use with gtk_menu_popup()
+to position @menu aligned to the status icon @user_data.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter name="menu">
+<parameter_description> the #GtkMenu
</parameter_description>
</parameter>
-<parameter name="hscrollbar_policy">
-<parameter_description> location to store the policy for the horizontal
-scrollbar, or %NULL.
+<parameter name="x">
+<parameter_description> return location for the x position
</parameter_description>
</parameter>
-<parameter name="vscrollbar_policy">
-<parameter_description> location to store the policy for the vertical
-scrollbar, or %NULL.
+<parameter name="y">
+<parameter_description> return location for the y position
+</parameter_description>
+</parameter>
+<parameter name="push_in">
+<parameter_description> whether the first menu item should be offset (pushed in) to be
+aligned with the menu popup position (only useful for GtkOptionMenu).
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> the status icon to position the menu on
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_entry_get_invisible_char">
+<function name="gtk_status_icon_set_blinking">
<description>
-Retrieves the character displayed in place of the real characters
-for entries with visibility set to false. See gtk_entry_set_invisible_char().
+Makes the status icon start or stop blinking.
+Note that blinking user interface elements may be problematic
+for some users, and thus may be turned off, in which case
+this setting has no effect.
+Since: 2.10
+
+Deprecated: 2.22: This function will be removed in GTK+ 3
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
+</parameter_description>
+</parameter>
+<parameter name="blinking">
+<parameter_description> %TRUE to turn blinking on, %FALSE to turn it off
</parameter_description>
</parameter>
</parameters>
-<return> the current invisible char, or 0, if the entry does not
-show invisible text at all.
-</return>
+<return></return>
</function>
-<function name="gtk_tree_view_set_hover_selection">
+<function name="gtk_status_icon_set_from_file">
<description>
-Enables of disables the hover selection mode of @tree_view.
-Hover selection makes the selected row follow the pointer.
-Currently, this works only for the selection modes
-%GTK_SELECTION_SINGLE and %GTK_SELECTION_BROWSE.
+Makes @status_icon display the file @filename.
+See gtk_status_icon_new_from_file() for details.
-Since: 2.6
+Since: 2.10
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
</parameter_description>
</parameter>
-<parameter name="hover">
-<parameter_description> %TRUE to enable hover selection mode
+<parameter name="filename">
+<parameter_description> a filename
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_spin_button_set_value">
+<function name="gtk_status_icon_set_from_gicon">
<description>
-Set the value of @spin_button.
+Makes @status_icon display the #GIcon.
+See gtk_status_icon_new_from_gicon() for details.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> the new value
+<parameter name="icon">
+<parameter_description> a GIcon
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_builder_add_from_string">
+<function name="gtk_status_icon_set_from_icon_name">
<description>
-Parses a string containing a <link linkend="BUILDER-UI">GtkBuilder
-UI definition</link> and merges it with the current contents of @builder.
-
-Upon errors 0 will be returned and @error will be assigned a
-#GError from the #GTK_BUILDER_ERROR or #G_MARKUP_ERROR domain.
+Makes @status_icon display the icon named @icon_name from the
+current icon theme.
+See gtk_status_icon_new_from_icon_name() for details.
-Since: 2.12
+Since: 2.10
</description>
<parameters>
-<parameter name="builder">
-<parameter_description> a #GtkBuilder
-</parameter_description>
-</parameter>
-<parameter name="buffer">
-<parameter_description> the string to parse
-</parameter_description>
-</parameter>
-<parameter name="length">
-<parameter_description> the length of @buffer (may be -1 if @buffer is nul-terminated)
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for an error, or %NULL
+<parameter name="icon_name">
+<parameter_description> an icon name
</parameter_description>
</parameter>
</parameters>
-<return> A positive value on success, 0 if an error occurred
-
-</return>
+<return></return>
</function>
-<function name="gtk_list_store_append">
+<function name="gtk_status_icon_set_from_pixbuf">
<description>
-Appends a new row to @list_store. @iter will be changed to point to this new
-row. The row will be empty after this function is called. To fill in
-values, you need to call gtk_list_store_set() or gtk_list_store_set_value().
+Makes @status_icon display @pixbuf.
+See gtk_status_icon_new_from_pixbuf() for details.
+Since: 2.10
</description>
<parameters>
-<parameter name="list_store">
-<parameter_description> A #GtkListStore
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> An unset #GtkTreeIter to set to the appended row
+<parameter name="pixbuf">
+<parameter_description> a #GdkPixbuf or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_source_free">
+<function name="gtk_status_icon_set_from_stock">
<description>
-Frees a dynamically-allocated icon source, along with its
-filename, size, and pixbuf fields if those are not %NULL.
+Makes @status_icon display the stock icon with the id @stock_id.
+See gtk_status_icon_new_from_stock() for details.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GtkIconSource
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
+</parameter_description>
+</parameter>
+<parameter name="stock_id">
+<parameter_description> a stock icon id
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tool_item_get_visible_vertical">
+<function name="gtk_status_icon_set_has_tooltip">
<description>
-Returns whether @tool_item is visible when the toolbar is docked vertically.
-See gtk_tool_item_set_visible_vertical().
+Sets the has-tooltip property on @status_icon to @has_tooltip.
+See #GtkStatusIcon:has-tooltip for more information.
-Since: 2.4
+Since: 2.16
</description>
<parameters>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
+</parameter_description>
+</parameter>
+<parameter name="has_tooltip">
+<parameter_description> whether or not @status_icon has a tooltip
</parameter_description>
</parameter>
</parameters>
-<return> Whether @tool_item is visible when the toolbar is docked vertically
-
-</return>
+<return></return>
</function>
-<function name="gtk_recent_info_get_uri_display">
+<function name="gtk_status_icon_set_name">
<description>
-Gets a displayable version of the resource's URI. If the resource
-is local, it returns a local path; if the resource is not local,
-it returns the UTF-8 encoded content of gtk_recent_info_get_uri().
+Sets the name of this tray icon.
+This should be a string identifying this icon. It is may be
+used for sorting the icons in the tray and will not be shown to
+the user.
-Since: 2.10
+Since: 2.20
</description>
<parameters>
-<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> the name
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated UTF-8 string containing the
-resource's URI or %NULL. Use g_free() when done using it.
-
-</return>
+<return></return>
</function>
-<function name="gtk_accel_group_unlock">
+<function name="gtk_status_icon_set_screen">
<description>
-Undoes the last call to gtk_accel_group_lock() on this @accel_group.
+Sets the #GdkScreen where @status_icon is displayed; if
+the icon is already mapped, it will be unmapped, and
+then remapped on the new screen.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="accel_group">
-<parameter_description> a #GtkAccelGroup
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
+</parameter_description>
+</parameter>
+<parameter name="screen">
+<parameter_description> a #GdkScreen
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_notebook_set_tab_border">
+<function name="gtk_status_icon_set_title">
<description>
-Sets the width the border around the tab labels
-in a notebook. This is equivalent to calling
-gtk_notebook_set_tab_hborder (@notebook, @border_width) followed
-by gtk_notebook_set_tab_vborder (@notebook, @border_width).
+Sets the title of this tray icon.
+This should be a short, human-readable, localized string
+describing the tray icon. It may be used by tools like screen
+readers to render the tray icon.
+
+Since: 2.18
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
</parameter_description>
</parameter>
-<parameter name="border_width">
-<parameter_description> width of the border around the tab labels.
+<parameter name="title">
+<parameter_description> the title
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_settings_set_dither">
+<function name="gtk_status_icon_set_tooltip">
<description>
-Sets the value of %GTK_PRINT_SETTINGS_DITHER.
+Sets the tooltip of the status icon.
Since: 2.10
+Deprecated: 2.16: Use gtk_status_icon_set_tooltip_text() instead.
+
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
</parameter_description>
</parameter>
-<parameter name="dither">
-<parameter_description> the dithering that is used
+<parameter name="tooltip_text">
+<parameter_description> the tooltip text, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_propagate_event">
+<function name="gtk_status_icon_set_tooltip_markup">
<description>
-Sends an event to a widget, propagating the event to parent widgets
-if the event remains unhandled. Events received by GTK+ from GDK
-normally begin in gtk_main_do_event(). Depending on the type of
-event, existence of modal dialogs, grabs, etc., the event may be
-propagated; if so, this function is used. gtk_propagate_event()
-calls gtk_widget_event() on each widget it decides to send the
-event to. So gtk_widget_event() is the lowest-level function; it
-simply emits the "event" and possibly an event-specific signal on a
-widget. gtk_propagate_event() is a bit higher-level, and
-gtk_main_do_event() is the highest level.
+Sets @markup as the contents of the tooltip, which is marked up with
+the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
-All that said, you most likely don't want to use any of these
-functions; synthesizing events is rarely needed. Consider asking on
-the mailing list for better ways to achieve your goals. For
-example, use gdk_window_invalidate_rect() or
-gtk_widget_queue_draw() instead of making up expose events.
+This function will take care of setting #GtkStatusIcon:has-tooltip to %TRUE
+and of the default handler for the #GtkStatusIcon::query-tooltip signal.
+See also the #GtkStatusIcon:tooltip-markup property and
+gtk_tooltip_set_markup().
+
+Since: 2.16
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
</parameter_description>
</parameter>
-<parameter name="event">
-<parameter_description> an event
+<parameter name="markup">
+<parameter_description> the contents of the tooltip for @status_icon, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_buildable_get_internal_child">
+<function name="gtk_status_icon_set_tooltip_text">
<description>
-Get the internal child called @childname of the @buildable object.
+Sets @text as the contents of the tooltip.
-Since: 2.12
+This function will take care of setting #GtkStatusIcon:has-tooltip to
+%TRUE and of the default handler for the #GtkStatusIcon::query-tooltip
+signal.
+
+See also the #GtkStatusIcon:tooltip-text property and
+gtk_tooltip_set_text().
+
+Since: 2.16
</description>
<parameters>
-<parameter name="buildable">
-<parameter_description> a #GtkBuildable
-</parameter_description>
-</parameter>
-<parameter name="builder">
-<parameter_description> a #GtkBuilder
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
</parameter_description>
</parameter>
-<parameter name="childname">
-<parameter_description> name of child
+<parameter name="text">
+<parameter_description> the contents of the tooltip for @status_icon
</parameter_description>
</parameter>
</parameters>
-<return> the internal child of the buildable object
-
-</return>
+<return></return>
</function>
-<function name="gtk_tool_palette_set_exclusive">
+<function name="gtk_status_icon_set_visible">
<description>
-Sets whether the group should be exclusive or not.
-If an exclusive group is expanded all other groups are collapsed.
+Shows or hides a status icon.
-Since: 2.20
+Since: 2.10
</description>
<parameters>
-<parameter name="palette">
-<parameter_description> a #GtkToolPalette
-</parameter_description>
-</parameter>
-<parameter name="group">
-<parameter_description> a #GtkToolItemGroup which is a child of palette
+<parameter name="status_icon">
+<parameter_description> a #GtkStatusIcon
</parameter_description>
</parameter>
-<parameter name="exclusive">
-<parameter_description> whether the group should be exclusive or not
+<parameter name="visible">
+<parameter_description> %TRUE to show the status icon, %FALSE to hide it
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_apply_tag_by_name">
+<function name="gtk_statusbar_get_context_id">
<description>
-Calls gtk_text_tag_table_lookup() on the buffer's tag table to
-get a #GtkTextTag, then calls gtk_text_buffer_apply_tag().
+Returns a new context identifier, given a description
+of the actual context. Note that the description is
+<emphasis>not</emphasis> shown in the UI.
+
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="name">
-<parameter_description> name of a named #GtkTextTag
+<parameter name="statusbar">
+<parameter_description> a #GtkStatusbar
</parameter_description>
</parameter>
-<parameter name="start">
-<parameter_description> one bound of range to be tagged
+<parameter name="context_description">
+<parameter_description> textual description of what context
+the new message is being used in
</parameter_description>
</parameter>
-<parameter name="end">
-<parameter_description> other bound of range to be tagged
+</parameters>
+<return> an integer id
+</return>
+</function>
+
+<function name="gtk_statusbar_get_has_resize_grip">
+<description>
+Returns whether the statusbar has a resize grip.
+
+
+</description>
+<parameters>
+<parameter name="statusbar">
+<parameter_description> a #GtkStatusBar
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the statusbar has a resize grip.
+</return>
</function>
-<function name="gtk_status_icon_new_from_gicon">
+<function name="gtk_statusbar_get_message_area">
<description>
-Creates a status icon displaying a #GIcon. If the icon is a
-themed icon, it will be updated when the theme changes.
+Retrieves the box containing the label widget.
-Since: 2.14
+Since: 2.20
</description>
<parameters>
-<parameter name="icon">
-<parameter_description> a #GIcon
+<parameter name="statusbar">
+<parameter_description> a #GtkStatusBar
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkStatusIcon
+<return> a #GtkBox
</return>
</function>
-<function name="gtk_entry_set_max_length">
+<function name="gtk_statusbar_new">
<description>
-Sets the maximum allowed length of the contents of the widget. If
-the current contents are longer than the given length, then they
-will be truncated to fit.
+Creates a new #GtkStatusbar ready for messages.
-This is equivalent to:
-<informalexample><programlisting>
-gtk_entry_buffer_set_max_length (gtk_entry_get_buffer (entry), max);
-</programlisting></informalexample>
+</description>
+<parameters>
+</parameters>
+<return> the new #GtkStatusbar
+</return>
+</function>
+
+<function name="gtk_statusbar_pop">
+<description>
+Removes the first message in the #GtkStatusBar's stack
+with the given context id.
+
+Note that this may not change the displayed message, if
+the message at the top of the stack has a different
+context id.
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="statusbar">
+<parameter_description> a #GtkStatusBar
</parameter_description>
</parameter>
-<parameter name="max">
-<parameter_description> the maximum length of the entry, or 0 for no maximum.
-(other than the maximum length of entries.) The value passed in will
-be clamped to the range 0-65536.
+<parameter name="context_id">
+<parameter_description> a context identifier
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_recent_manager_get_limit">
+<function name="gtk_statusbar_push">
<description>
-Gets the maximum number of items that the gtk_recent_manager_get_items()
-function should return.
+Pushes a new message onto a statusbar's stack.
-Since: 2.10
-
-Deprecated: 2.22: The length of the list should be managed by the
-view (implementing #GtkRecentChooser), and not by the model (the
-#GtkRecentManager). See #GtkRecentChooser:limit.
</description>
<parameters>
-<parameter name="manager">
-<parameter_description> a #GtkRecentManager
+<parameter name="statusbar">
+<parameter_description> a #GtkStatusbar
+</parameter_description>
+</parameter>
+<parameter name="context_id">
+<parameter_description> the message's context id, as returned by
+gtk_statusbar_get_context_id()
+</parameter_description>
+</parameter>
+<parameter name="text">
+<parameter_description> the message to add to the statusbar
</parameter_description>
</parameter>
</parameters>
-<return> the number of items to return, or -1 for every item.
-
+<return> a message id that can be used with
+gtk_statusbar_remove().
</return>
</function>
-<function name="gtk_hsv_get_metrics">
+<function name="gtk_statusbar_remove">
<description>
-Queries the size and ring width of an HSV color selector.
-
-Since: 2.14
+Forces the removal of a message from a statusbar's stack.
+The exact @context_id and @message_id must be specified.
</description>
<parameters>
-<parameter name="hsv">
-<parameter_description> An HSV color selector
+<parameter name="statusbar">
+<parameter_description> a #GtkStatusBar
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> Return value for the diameter of the hue ring
+<parameter name="context_id">
+<parameter_description> a context identifier
</parameter_description>
</parameter>
-<parameter name="ring_width">
-<parameter_description> Return value for the width of the hue ring
+<parameter name="message_id">
+<parameter_description> a message identifier, as returned by gtk_statusbar_push()
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_unset_rows_drag_dest">
+<function name="gtk_statusbar_remove_all">
<description>
-Undoes the effect of
-gtk_tree_view_enable_model_drag_dest(). Calling this method sets
-#GtkTreeView:reorderable to %FALSE.
+Forces the removal of all messages from a statusbar's
+stack with the exact @context_id.
+
+Since: 2.22
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
+<parameter name="statusbar">
+<parameter_description> a #GtkStatusBar
+</parameter_description>
+</parameter>
+<parameter name="context_id">
+<parameter_description> a context identifier
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_view_reset_im_context">
+<function name="gtk_statusbar_set_has_resize_grip">
<description>
-Reset the input method context of the text view if needed.
+Sets whether the statusbar has a resize grip.
+%TRUE by default.
-This can be necessary in the case where modifying the buffer
-would confuse on-going input method behavior.
+</description>
+<parameters>
+<parameter name="statusbar">
+<parameter_description> a #GtkStatusBar
+</parameter_description>
+</parameter>
+<parameter name="setting">
+<parameter_description> %TRUE to have a resize grip
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_stock_add">
+<description>
+Registers each of the stock items in @items. If an item already
+exists with the same stock ID as one of the @items, the old item
+gets replaced. The stock items are copied, so GTK+ does not hold
+any pointer into @items and @items can be freed. Use
+gtk_stock_add_static() if @items is persistent and GTK+ need not
+copy the array.
-Since: 2.22
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="items">
+<parameter_description> a #GtkStockItem or array of items
+</parameter_description>
+</parameter>
+<parameter name="n_items">
+<parameter_description> number of #GtkStockItem in @items
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_link_button_new_with_label">
+<function name="gtk_stock_add_static">
<description>
-Creates a new #GtkLinkButton containing a label.
+Same as gtk_stock_add(), but doesn't copy @items, so
+ items must persist until application exit.
-Since: 2.10
</description>
<parameters>
-<parameter name="uri">
-<parameter_description> a valid URI
+<parameter name="items">
+<parameter_description> a #GtkStockItem or array of #GtkStockItem
</parameter_description>
</parameter>
-<parameter name="label">
-<parameter_description> the text of the button
+<parameter name="n_items">
+<parameter_description> number of items
</parameter_description>
</parameter>
</parameters>
-<return> a new link button widget.
+<return></return>
+</function>
+
+<function name="gtk_stock_item_copy">
+<description>
+Copies a stock item, mostly useful for language bindings and not in applications.
+
+</description>
+<parameters>
+<parameter name="item">
+<parameter_description> a #GtkStockItem
+</parameter_description>
+</parameter>
+</parameters>
+<return> a new #GtkStockItem
</return>
</function>
-<function name="gtk_menu_tool_button_new_from_stock">
+<function name="gtk_stock_item_free">
<description>
-Creates a new #GtkMenuToolButton.
-The new #GtkMenuToolButton will contain an icon and label from
-the stock item indicated by @stock_id.
+Frees a stock item allocated on the heap, such as one returned by
+gtk_stock_item_copy(). Also frees the fields inside the stock item,
+if they are not %NULL.
-Since: 2.6
</description>
<parameters>
-<parameter name="stock_id">
-<parameter_description> the name of a stock item
+<parameter name="item">
+<parameter_description> a #GtkStockItem
</parameter_description>
</parameter>
</parameters>
-<return> the new #GtkMenuToolButton
+<return></return>
+</function>
+
+<function name="gtk_stock_list_ids">
+<description>
+Retrieves a list of all known stock IDs added to a #GtkIconFactory
+or registered with gtk_stock_add(). The list must be freed with g_slist_free(),
+and each string in the list must be freed with g_free().
+
+</description>
+<parameters>
+</parameters>
+<return> a list of known stock IDs
</return>
</function>
-<function name="gtk_file_chooser_get_do_overwrite_confirmation">
+<function name="gtk_stock_lookup">
<description>
-Queries whether a file chooser is set to confirm for overwriting when the user
-types a file name that already exists.
+Fills @item with the registered values for @stock_id, returning %TRUE
+if @stock_id was known.
+
-Since: 2.8
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="stock_id">
+<parameter_description> a stock item name
+</parameter_description>
+</parameter>
+<parameter name="item">
+<parameter_description> stock item to initialize with values
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the file chooser will present a confirmation dialog;
-%FALSE otherwise.
-
+<return> %TRUE if @item was initialized
</return>
</function>
-<function name="gtk_action_group_set_translate_func">
+<function name="gtk_stock_set_translate_func">
<description>
-Sets a function to be used for translating the @label and @tooltip of
-#GtkActionGroupEntry<!-- -->s added by gtk_action_group_add_actions().
+Sets a function to be used for translating the @label of
+a stock item.
-If you're using gettext(), it is enough to set the translation domain
-with gtk_action_group_set_translation_domain().
+If no function is registered for a translation domain,
+g_dgettext() is used.
-Since: 2.4
+The function is used for all stock items whose
+ translation_domain matches @domain. Note that it is possible
+to use strings different from the actual gettext translation domain
+of your application for this, as long as your #GtkTranslateFunc uses
+the correct domain when calling dgettext(). This can be useful, e.g.
+when dealing with message contexts:
+
+|[
+GtkStockItem items[] = {
+{ MY_ITEM1, NC_("odd items", "Item 1"), 0, 0, "odd-item-domain" },
+{ MY_ITEM2, NC_("even items", "Item 2"), 0, 0, "even-item-domain" },
+};
+
+gchar *
+my_translate_func (const gchar *msgid,
+gpointer data)
+{
+gchar *msgctxt = data;
+
+return (gchar*)g_dpgettext2 (GETTEXT_PACKAGE, msgctxt, msgid);
+}
+
+/ * ... * /
+
+gtk_stock_add (items, G_N_ELEMENTS (items));
+gtk_stock_set_translate_func ("odd-item-domain", my_translate_func, "odd items");
+gtk_stock_set_translate_func ("even-item-domain", my_translate_func, "even items");
+]|
+
+Since: 2.8
</description>
<parameters>
-<parameter name="action_group">
-<parameter_description> a #GtkActionGroup
+<parameter name="domain">
+<parameter_description> the translation domain for which @func shall be used
</parameter_description>
</parameter>
<parameter name="func">
-<parameter_description> a #GtkTranslateFunc
+<parameter_description> a #GtkTranslateFunc
</parameter_description>
</parameter>
<parameter name="data">
-<parameter_description> data to be passed to @func and @notify
+<parameter_description> data to pass to @func
</parameter_description>
</parameter>
<parameter name="notify">
-<parameter_description> a #GDestroyNotify function to be called when @action_group is
-destroyed and when the translation function is changed again
+<parameter_description> a #GDestroyNotify that is called when @data is
+no longer needed
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_alignment_set_padding">
+<function name="gtk_style_apply_default_background">
<description>
-Sets the padding on the different sides of the widget.
-The padding adds blank space to the sides of the widget. For instance,
-this can be used to indent the child widget towards the right by adding
-padding on the left.
-
-Since: 2.4
</description>
<parameters>
-<parameter name="alignment">
-<parameter_description> a #GtkAlignment
+<parameter name="style">
+<parameter_description>
</parameter_description>
</parameter>
-<parameter name="padding_top">
-<parameter_description> the padding at the top of the widget
+<parameter name="window">
+<parameter_description>
</parameter_description>
</parameter>
-<parameter name="padding_bottom">
-<parameter_description> the padding at the bottom of the widget
+<parameter name="set_bg">
+<parameter_description>
</parameter_description>
</parameter>
-<parameter name="padding_left">
-<parameter_description> the padding at the left of the widget
+<parameter name="state_type">
+<parameter_description>
</parameter_description>
</parameter>
-<parameter name="padding_right">
-<parameter_description> the padding at the right of the widget.
+<parameter name="area">
+<parameter_description>
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description>
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description>
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description>
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description>
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_store_set">
+<function name="gtk_style_attach">
<description>
-Sets the value of one or more cells in the row referenced by @iter.
-The variable argument list should contain integer column numbers,
-each column number followed by the value to be set.
-The list is terminated by a -1. For example, to set column 0 with type
-%G_TYPE_STRING to "Foo", you would write
-<literal>gtk_tree_store_set (store, iter, 0, "Foo", -1)</literal>.
+Attaches a style to a window; this process allocates the
+colors and creates the GC's for the style - it specializes
+it to a particular visual and colormap. The process may
+involve the creation of a new style if the style has already
+been attached to a window with a different style and colormap.
+
+Since this function may return a new object, you have to use it
+in the following way:
+<literal>style = gtk_style_attach (style, window)</literal>
-The value will be referenced by the store if it is a %G_TYPE_OBJECT, and it
-will be copied if it is a %G_TYPE_STRING or %G_TYPE_BOXED.
</description>
<parameters>
-<parameter name="tree_store">
-<parameter_description> A #GtkTreeStore
+<parameter name="style">
+<parameter_description> a #GtkStyle.
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> A valid #GtkTreeIter for the row being modified
+<parameter name="window">
+<parameter_description> a #GdkWindow.
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> pairs of column number and value, terminated with -1
+</parameters>
+<return> Either @style, or a newly-created #GtkStyle.
+If the style is newly created, the style parameter
+will be unref'ed, and the new style will have
+a reference count belonging to the caller.
+</return>
+</function>
+
+<function name="gtk_style_copy">
+<description>
+Creates a copy of the passed in #GtkStyle object.
+
+
+</description>
+<parameters>
+<parameter name="style">
+<parameter_description> a #GtkStyle
+</parameter_description>
+</parameter>
+</parameters>
+<return> a copy of @style
+</return>
+</function>
+
+<function name="gtk_style_detach">
+<description>
+Detaches a style from a window. If the style is not attached
+to any windows anymore, it is unrealized. See gtk_style_attach().
+
+
+</description>
+<parameters>
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_entry_completion_get_minimum_key_length">
+<function name="gtk_style_get">
<description>
-Returns the minimum key length as set for @completion.
+Gets the values of a multiple style properties for @widget_type
+from @style.
-Since: 2.4
+Since: 2.16
</description>
<parameters>
-<parameter name="completion">
-<parameter_description> A #GtkEntryCompletion.
+<parameter name="style">
+<parameter_description> a #GtkStyle
+</parameter_description>
+</parameter>
+<parameter name="widget_type">
+<parameter_description> the #GType of a descendant of #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="first_property_name">
+<parameter_description> the name of the first style property to get
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> pairs of property names and locations to
+return the property values, starting with the location for
+ first_property_name, terminated by %NULL.
</parameter_description>
</parameter>
</parameters>
-<return> The currently used minimum key length.
+<return></return>
+</function>
+<function name="gtk_style_get_font">
+<description>
+Gets the #GdkFont to use for the given style. This is
+meant only as a replacement for direct access to @style->font
+and should not be used in new code. New code should
+use @style->font_desc instead.
+
+
+</description>
+<parameters>
+<parameter name="style">
+<parameter_description> a #GtkStyle
+</parameter_description>
+</parameter>
+</parameters>
+<return> the #GdkFont for the style. This font is owned
+by the style; if you want to keep around a copy, you must
+call gdk_font_ref().
</return>
</function>
-<function name="gtk_binding_parse_binding">
+<function name="gtk_style_get_style_property">
<description>
-Parse a binding entry from a gtkrc file.
+Queries the value of a style property corresponding to a
+widget class is in the given style.
-Deprecated: 2.12: There should be no need to call this function outside GTK+.
+Since: 2.16
</description>
<parameters>
-<parameter name="scanner">
-<parameter_description> GtkRC scanner
+<parameter name="style">
+<parameter_description> a #GtkStyle
+</parameter_description>
+</parameter>
+<parameter name="widget_type">
+<parameter_description> the #GType of a descendant of #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="property_name">
+<parameter_description> the name of the style property to get
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> a #GValue where the value of the property being
+queried will be stored
</parameter_description>
</parameter>
</parameters>
-<return> expected token upon errors, %G_TOKEN_NONE on success.
-
-</return>
+<return></return>
</function>
-<function name="gtk_text_buffer_delete_mark_by_name">
+<function name="gtk_style_get_valist">
<description>
-Deletes the mark named @name; the mark must exist. See
-gtk_text_buffer_delete_mark() for details.
+Non-vararg variant of gtk_style_get().
+Used primarily by language bindings.
+
+Since: 2.16
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-<parameter name="name">
-<parameter_description> name of a mark in @buffer
+<parameter name="widget_type">
+<parameter_description> the #GType of a descendant of #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="first_property_name">
+<parameter_description> the name of the first style property to get
+</parameter_description>
+</parameter>
+<parameter name="var_args">
+<parameter_description> a <type>va_list</type> of pairs of property names and
+locations to return the property values, starting with the
+location for @first_property_name.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_file_filter_new">
+<function name="gtk_style_lookup_color">
<description>
-Creates a new #GtkFileFilter with no rules added to it.
-Such a filter doesn't accept any files, so is not
-particularly useful until you add rules with
-gtk_file_filter_add_mime_type(), gtk_file_filter_add_pattern(),
-or gtk_file_filter_add_custom(). To create a filter
-that accepts any file, use:
-|[
-GtkFileFilter *filter = gtk_file_filter_new ();
-gtk_file_filter_add_pattern (filter, "*");
-]|
+Looks up @color_name in the style's logical color mappings,
+filling in @color and returning %TRUE if found, otherwise
+returning %FALSE. Do not cache the found mapping, because
+it depends on the #GtkStyle and might change when a theme
+switch occurs.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
+<parameter name="style">
+<parameter_description> a #GtkStyle
+</parameter_description>
+</parameter>
+<parameter name="color_name">
+<parameter_description> the name of the logical color to look up
+</parameter_description>
+</parameter>
+<parameter name="color">
+<parameter_description> the #GdkColor to fill in
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GtkFileFilter
+<return> %TRUE if the mapping was found.
</return>
</function>
-<function name="gtk_widget_get_no_show_all">
+<function name="gtk_style_lookup_icon_set">
<description>
-Returns the current value of the GtkWidget:no-show-all property,
-which determines whether calls to gtk_widget_show_all() and
-gtk_widget_hide_all() will affect this widget.
+Looks up @stock_id in the icon factories associated with @style
+and the default icon factory, returning an icon set if found,
+otherwise %NULL.
-Since: 2.4
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="style">
+<parameter_description> a #GtkStyle
+</parameter_description>
+</parameter>
+<parameter name="stock_id">
+<parameter_description> an icon name
</parameter_description>
</parameter>
</parameters>
-<return> the current value of the "no-show-all" property.
+<return> icon set of @stock_id
+</return>
+</function>
+<function name="gtk_style_new">
+<description>
+Creates a new #GtkStyle.
+
+</description>
+<parameters>
+</parameters>
+<return> a new #GtkStyle.
</return>
</function>
-<function name="gtk_paint_resize_grip">
+<function name="gtk_style_ref">
<description>
-Draws a resize grip in the given rectangle on @window using the given
-parameters.
+Increase the reference count of @style.
+
+Deprecated: 2.0: use g_object_ref() instead.
+
+</description>
+<parameters>
+<parameter name="style">
+<parameter_description> a #GtkStyle.
+</parameter_description>
+</parameter>
+</parameters>
+<return> @style.
+</return>
+</function>
+
+<function name="gtk_style_render_icon">
+<description>
+Renders the icon specified by @source at the given @size
+according to the given parameters and returns the result in a
+pixbuf.
+
</description>
<parameters>
@@ -44506,17 +45427,22 @@ parameters.
<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="source">
+<parameter_description> the #GtkIconSource specifying the icon to render
</parameter_description>
</parameter>
-<parameter name="state_type">
+<parameter name="direction">
+<parameter_description> a text direction
+</parameter_description>
+</parameter>
+<parameter name="state">
<parameter_description> a state
</parameter_description>
</parameter>
-<parameter name="area">
-<parameter_description> clip rectangle, or %NULL if the
-output should not be clipped
+<parameter name="size">
+<parameter_description> (type int) the size to render the icon at. A size of
+(GtkIconSize)-1 means render at the size of the source and
+don't scale.
</parameter_description>
</parameter>
<parameter name="widget">
@@ -44527,1575 +45453,1740 @@ output should not be clipped
<parameter_description> a style detail
</parameter_description>
</parameter>
-<parameter name="edge">
-<parameter_description> the edge in which to draw the resize grip
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> the x origin of the rectangle in which to draw the resize grip
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> the y origin of the rectangle in which to draw the resize grip
+</parameters>
+<return> a newly-created #GdkPixbuf
+containing the rendered icon
+</return>
+</function>
+
+<function name="gtk_style_set_background">
+<description>
+Sets the background of @window to the background color or pixmap
+specified by @style for the given state.
+
+</description>
+<parameters>
+<parameter name="style">
+<parameter_description> a #GtkStyle
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> the width of the rectangle in which to draw the resize grip
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> the height of the rectangle in which to draw the resize grip
+<parameter name="state_type">
+<parameter_description> a state
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_attributes_unref">
+<function name="gtk_style_set_font">
<description>
-Decrements the reference count on @values, freeing the structure
-if the reference count reaches 0.
+Sets the #GdkFont to use for a given style. This is
+meant only as a replacement for direct access to style->font
+and should not be used in new code. New code should
+use style->font_desc instead.
</description>
<parameters>
-<parameter name="values">
-<parameter_description> a #GtkTextAttributes
+<parameter name="style">
+<parameter_description> a #GtkStyle.
+</parameter_description>
+</parameter>
+<parameter name="font">
+<parameter_description> a #GdkFont, or %NULL to use the #GdkFont corresponding
+to style->font_desc.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_about_dialog_get_artists">
+<function name="gtk_style_unref">
<description>
-Returns the string which are displayed in the artists tab
-of the secondary credits dialog.
+Decrease the reference count of @style.
-Since: 2.6
+Deprecated: 2.0: use g_object_unref() instead.
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter name="style">
+<parameter_description> a #GtkStyle.
</parameter_description>
</parameter>
</parameters>
-<return> A %NULL-terminated string array containing
-the artists. The array is owned by the about dialog
-and must not be modified.
-
-</return>
+<return></return>
</function>
-<function name="gtk_print_settings_get_paper_height">
+<function name="gtk_table_get_col_spacing">
<description>
-Gets the value of %GTK_PRINT_SETTINGS_PAPER_HEIGHT,
-converted to @unit.
+Gets the amount of space between column @col, and
+column @col + 1. See gtk_table_set_col_spacing().
-Since: 2.10
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="table">
+<parameter_description> a #GtkTable
</parameter_description>
</parameter>
-<parameter name="unit">
-<parameter_description> the unit for the return value
+<parameter name="column">
+<parameter_description> a column in the table, 0 indicates the first column
</parameter_description>
</parameter>
</parameters>
-<return> the paper height, in units of @unit
-
+<return> the column spacing
</return>
</function>
-<function name="gtk_menu_item_get_right_justified">
+<function name="gtk_table_get_default_col_spacing">
<description>
-Gets whether the menu item appears justified at the right
-side of the menu bar.
+Gets the default column spacing for the table. This is
+the spacing that will be used for newly added columns.
+(See gtk_table_set_col_spacings())
</description>
<parameters>
-<parameter name="menu_item">
-<parameter_description> a #GtkMenuItem
+<parameter name="table">
+<parameter_description> a #GtkTable
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the menu item will appear at the
-far right if added to a menu bar.
+<return> the default column spacing
</return>
</function>
-<function name="gtk_text_buffer_remove_tag">
+<function name="gtk_table_get_default_row_spacing">
<description>
-Emits the "remove-tag" signal. The default handler for the signal
-removes all occurrences of @tag from the given range. @start and
- end don't have to be in order.
+Gets the default row spacing for the table. This is
+the spacing that will be used for newly added rows.
+(See gtk_table_set_row_spacings())
+
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="tag">
-<parameter_description> a #GtkTextTag
-</parameter_description>
-</parameter>
-<parameter name="start">
-<parameter_description> one bound of range to be untagged
-</parameter_description>
-</parameter>
-<parameter name="end">
-<parameter_description> other bound of range to be untagged
+<parameter name="table">
+<parameter_description> a #GtkTable
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the default row spacing
+</return>
</function>
-<function name="gtk_rc_get_module_dir">
+<function name="gtk_table_get_homogeneous">
<description>
-Returns a directory in which GTK+ looks for theme engines.
-For full information about the search for theme engines,
-see the docs for <envar>GTK_PATH</envar> in
-<xref linkend="gtk-running"/>.
+Returns whether the table cells are all constrained to the same
+width and height. (See gtk_table_set_homogenous ())
</description>
<parameters>
+<parameter name="table">
+<parameter_description> a #GtkTable
+</parameter_description>
+</parameter>
</parameters>
-<return> the directory. (Must be freed with g_free())
+<return> %TRUE if the cells are all constrained to the same size
</return>
</function>
-<function name="gtk_print_settings_get_dither">
+<function name="gtk_table_get_row_spacing">
<description>
-Gets the value of %GTK_PRINT_SETTINGS_DITHER.
+Gets the amount of space between row @row, and
+row @row + 1. See gtk_table_set_row_spacing().
-Since: 2.10
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="table">
+<parameter_description> a #GtkTable
+</parameter_description>
+</parameter>
+<parameter name="row">
+<parameter_description> a row in the table, 0 indicates the first row
</parameter_description>
</parameter>
</parameters>
-<return> the dithering that is used
-
+<return> the row spacing
</return>
</function>
-<function name="gtk_tree_model_foreach">
+<function name="gtk_table_get_size">
<description>
-Calls func on each node in model in a depth-first fashion.
-If @func returns %TRUE, then the tree ceases to be walked, and
-gtk_tree_model_foreach() returns.
+Returns the number of rows and columns in the table.
+
+Since: 2.22
</description>
<parameters>
-<parameter name="model">
-<parameter_description> A #GtkTreeModel
+<parameter name="table">
+<parameter_description> a #GtkTable
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> A function to be called on each row
+<parameter name="rows">
+<parameter_description> return location for the number of
+rows, or %NULL
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> User data to passed to func.
+<parameter name="columns">
+<parameter_description> return location for the number
+of columns, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_path_is_descendant">
+<function name="gtk_target_list_add">
<description>
-Returns %TRUE if @path is a descendant of @ancestor.
-
+Appends another target to a #GtkTargetList.
</description>
<parameters>
-<parameter name="path">
-<parameter_description> a #GtkTreePath
+<parameter name="list">
+<parameter_description> a #GtkTargetList
</parameter_description>
</parameter>
-<parameter name="ancestor">
-<parameter_description> another #GtkTreePath
+<parameter name="target">
+<parameter_description> the interned atom representing the target
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> the flags for this target
+</parameter_description>
+</parameter>
+<parameter name="info">
+<parameter_description> an ID that will be passed back to the application
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @ancestor contains @path somewhere below it
-</return>
+<return></return>
</function>
-<function name="gtk_tool_item_group_set_item_position">
+<function name="gtk_target_list_add_image_targets">
<description>
-Sets the position of @item in the list of children of @group.
+Appends the image targets supported by #GtkSelection to
+the target list. All targets are added with the same @info.
-Since: 2.20
+Since: 2.6
</description>
<parameters>
-<parameter name="group">
-<parameter_description> a #GtkToolItemGroup
+<parameter name="list">
+<parameter_description> a #GtkTargetList
</parameter_description>
</parameter>
-<parameter name="item">
-<parameter_description> the #GtkToolItem to move to a new position, should
-be a child of @group.
+<parameter name="info">
+<parameter_description> an ID that will be passed back to the application
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> the new position of @item in @group, starting with 0.
-The position -1 means end of list.
+<parameter name="writable">
+<parameter_description> whether to add only targets for which GTK+ knows
+how to convert a pixbuf into the format
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_status_icon_get_tooltip_text">
+<function name="gtk_target_list_add_rich_text_targets">
<description>
-Gets the contents of the tooltip for @status_icon.
+Appends the rich text targets registered with
+gtk_text_buffer_register_serialize_format() or
+gtk_text_buffer_register_deserialize_format() to the target list. All
+targets are added with the same @info.
-Since: 2.16
+Since: 2.10
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
+<parameter name="list">
+<parameter_description> a #GtkTargetList
+</parameter_description>
+</parameter>
+<parameter name="info">
+<parameter_description> an ID that will be passed back to the application
+</parameter_description>
+</parameter>
+<parameter name="deserializable">
+<parameter_description> if %TRUE, then deserializable rich text formats
+will be added, serializable formats otherwise.
+</parameter_description>
+</parameter>
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer.
</parameter_description>
</parameter>
</parameters>
-<return> the tooltip text, or %NULL. You should free the
-returned string with g_free() when done.
-
-</return>
+<return></return>
</function>
-<function name="gtk_binding_entry_add_signall">
+<function name="gtk_target_list_add_table">
<description>
-Override or install a new key binding for @keyval with @modifiers on
- binding_set
+Prepends a table of #GtkTargetEntry to a target list.
</description>
<parameters>
-<parameter name="binding_set">
-<parameter_description> a #GtkBindingSet to add a signal to
+<parameter name="list">
+<parameter_description> a #GtkTargetList
</parameter_description>
</parameter>
-<parameter name="keyval">
-<parameter_description> key value
+<parameter name="targets">
+<parameter_description> the table of #GtkTargetEntry
</parameter_description>
</parameter>
-<parameter name="modifiers">
-<parameter_description> key modifier
+<parameter name="ntargets">
+<parameter_description> number of targets in the table
</parameter_description>
</parameter>
-<parameter name="signal_name">
-<parameter_description> signal name to be bound
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_target_list_add_text_targets">
+<description>
+Appends the text targets supported by #GtkSelection to
+the target list. All targets are added with the same @info.
+
+Since: 2.6
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GtkTargetList
</parameter_description>
</parameter>
-<parameter name="binding_args">
-<parameter_description> list of #GtkBindingArg signal arguments
+<parameter name="info">
+<parameter_description> an ID that will be passed back to the application
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_file_chooser_get_action">
+<function name="gtk_target_list_add_uri_targets">
<description>
-Gets the type of operation that the file chooser is performing; see
-gtk_file_chooser_set_action().
+Appends the URI targets supported by #GtkSelection to
+the target list. All targets are added with the same @info.
-Since: 2.4
+Since: 2.6
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="list">
+<parameter_description> a #GtkTargetList
+</parameter_description>
+</parameter>
+<parameter name="info">
+<parameter_description> an ID that will be passed back to the application
</parameter_description>
</parameter>
</parameters>
-<return> the action that the file selector is performing
-
-</return>
+<return></return>
</function>
-<function name="gtk_print_operation_set_track_print_status">
+<function name="gtk_target_list_find">
<description>
-If track_status is %TRUE, the print operation will try to continue report
-on the status of the print job in the printer queues and printer. This
-can allow your application to show things like "out of paper" issues,
-and when the print job actually reaches the printer.
-
-This function is often implemented using some form of polling, so it should
-not be enabled unless needed.
+Looks up a given target in a #GtkTargetList.
-Since: 2.10
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter name="list">
+<parameter_description> a #GtkTargetList
</parameter_description>
</parameter>
-<parameter name="track_status">
-<parameter_description> %TRUE to track status after printing
+<parameter name="target">
+<parameter_description> an interned atom representing the target to search for
+</parameter_description>
+</parameter>
+<parameter name="info">
+<parameter_description> a pointer to the location to store application info for target,
+or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the target was found, otherwise %FALSE
+</return>
</function>
-<function name="gtk_get_current_event_state">
+<function name="gtk_target_list_new">
<description>
-If there is a current event and it has a state field, place
-that state field in @state and return %TRUE, otherwise return
-%FALSE.
+Creates a new #GtkTargetList from an array of #GtkTargetEntry.
</description>
<parameters>
-<parameter name="state">
-<parameter_description> a location to store the state of the current event
+<parameter name="targets">
+<parameter_description> Pointer to an array of #GtkTargetEntry
+</parameter_description>
+</parameter>
+<parameter name="ntargets">
+<parameter_description> number of entries in @targets.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if there was a current event and it had a state field
+<return> the new #GtkTargetList.
</return>
</function>
-<function name="gtk_tree_view_column_get_visible">
+<function name="gtk_target_list_ref">
<description>
-Returns %TRUE if @tree_column is visible.
+Increases the reference count of a #GtkTargetList by one.
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn.
+<parameter name="list">
+<parameter_description> a #GtkTargetList
</parameter_description>
</parameter>
</parameters>
-<return> whether the column is visible or not. If it is visible, then
-the tree will show the column.
+<return> the passed in #GtkTargetList.
</return>
</function>
-<function name="gtk_tree_store_move_after">
+<function name="gtk_target_list_remove">
<description>
-Moves @iter in @tree_store to the position after @position. @iter and
- position should be in the same level. Note that this function only
-works with unsorted stores. If @position is %NULL, @iter will be moved
-to the start of the level.
-
-Since: 2.2
+Removes a target from a target list.
</description>
<parameters>
-<parameter name="tree_store">
-<parameter_description> A #GtkTreeStore.
+<parameter name="list">
+<parameter_description> a #GtkTargetList
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> A #GtkTreeIter.
+<parameter name="target">
+<parameter_description> the interned atom representing the target
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> A #GtkTreeIter.
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_target_list_unref">
+<description>
+Decreases the reference count of a #GtkTargetList by one.
+If the resulting reference count is zero, frees the list.
+
+</description>
+<parameters>
+<parameter name="list">
+<parameter_description> a #GtkTargetList
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_settings_set_bool">
+<function name="gtk_target_table_free">
<description>
-Sets @key to a boolean value.
+This function frees a target table as returned by
+gtk_target_table_new_from_list()
Since: 2.10
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
+<parameter name="targets">
+<parameter_description> a #GtkTargetEntry array
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> a boolean
+<parameter name="n_targets">
+<parameter_description> the number of entries in the array
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_recent_info_has_group">
+<function name="gtk_target_table_new_from_list">
<description>
-Checks whether @group_name appears inside the groups registered for the
-recently used item @info.
+This function creates an #GtkTargetEntry array that contains the
+same targets as the passed %list. The returned table is newly
+allocated and should be freed using gtk_target_table_free() when no
+longer needed.
Since: 2.10
</description>
<parameters>
-<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter name="list">
+<parameter_description> a #GtkTargetList
</parameter_description>
</parameter>
-<parameter name="group_name">
-<parameter_description> name of a group
+<parameter name="n_targets">
+<parameter_description> return location for the number ot targets in the table
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the group was found.
+<return> the new table.
</return>
</function>
-<function name="gtk_selection_remove_all">
+<function name="gtk_targets_include_image">
<description>
-Removes all handlers and unsets ownership of all
-selections for a widget. Called when widget is being
-destroyed. This function will not generally be
-called by applications.
+Determines if any of the targets in @targets can be used to
+provide a #GdkPixbuf.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="targets">
+<parameter_description> an array of #GdkAtom<!-- -->s
+</parameter_description>
+</parameter>
+<parameter name="n_targets">
+<parameter_description> the length of @targets
+</parameter_description>
+</parameter>
+<parameter name="writable">
+<parameter_description> whether to accept only targets for which GTK+ knows
+how to convert a pixbuf into the format
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @targets include a suitable target for images,
+otherwise %FALSE.
+
+</return>
</function>
-<function name="gtk_label_get_selection_bounds">
+<function name="gtk_targets_include_rich_text">
<description>
-Gets the selected range of characters in the label, returning %TRUE
-if there's a selection.
+Determines if any of the targets in @targets can be used to
+provide rich text.
+Since: 2.10
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="targets">
+<parameter_description> an array of #GdkAtom<!-- -->s
</parameter_description>
</parameter>
-<parameter name="start">
-<parameter_description> return location for start of selection, as a character offset
+<parameter name="n_targets">
+<parameter_description> the length of @targets
</parameter_description>
</parameter>
-<parameter name="end">
-<parameter_description> return location for end of selection, as a character offset
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if selection is non-empty
+<return> %TRUE if @targets include a suitable target for rich text,
+otherwise %FALSE.
+
</return>
</function>
-<function name="gtk_print_settings_get_media_type">
+<function name="gtk_targets_include_text">
<description>
-Gets the value of %GTK_PRINT_SETTINGS_MEDIA_TYPE.
-
-The set of media types is defined in PWG 5101.1-2002 PWG.
-<!-- FIXME link here -->
+Determines if any of the targets in @targets can be used to
+provide text.
Since: 2.10
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="targets">
+<parameter_description> an array of #GdkAtom<!-- -->s
+</parameter_description>
+</parameter>
+<parameter name="n_targets">
+<parameter_description> the length of @targets
</parameter_description>
</parameter>
</parameters>
-<return> the media type
+<return> %TRUE if @targets include a suitable target for text,
+otherwise %FALSE.
</return>
</function>
-<function name="gtk_dialog_get_has_separator">
+<function name="gtk_targets_include_uri">
<description>
-Accessor for whether the dialog has a separator.
+Determines if any of the targets in @targets can be used to
+provide an uri list.
-Deprecated: 2.22: This function will be removed in GTK+ 3
+Since: 2.10
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkDialog
+<parameter name="targets">
+<parameter_description> an array of #GdkAtom<!-- -->s
+</parameter_description>
+</parameter>
+<parameter name="n_targets">
+<parameter_description> the length of @targets
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the dialog has a separator
+<return> %TRUE if @targets include a suitable target for uri lists,
+otherwise %FALSE.
</return>
</function>
-<function name="gtk_tree_view_column_get_cell_renderers">
+<function name="gtk_test_create_simple_window">
<description>
-Returns a newly-allocated #GList of all the cell renderers in the column,
-in no particular order. The list must be freed with g_list_free().
+Create a simple window with window title @window_title and
+text contents @dialog_text.
+The window will quit any running gtk_main()-loop when destroyed, and it
+will automatically be destroyed upon test function teardown.
-Deprecated: 2.18: use gtk_cell_layout_get_cells() instead.
+Since: 2.14
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn
+<parameter name="window_title">
+<parameter_description> Title of the window to be displayed.
+</parameter_description>
+</parameter>
+<parameter name="dialog_text">
+<parameter_description> Text inside the window to be displayed.
</parameter_description>
</parameter>
</parameters>
-<return> A list of #GtkCellRenderers
+<return> a widget pointer to the newly created GtkWindow.
</return>
</function>
-<function name="gtk_selection_data_get_data_type">
+<function name="gtk_test_create_widget">
<description>
-Retrieves the data type of the selection.
+This function wraps g_object_new() for widget types.
+It'll automatically show all created non window widgets, also
+g_object_ref_sink() them (to keep them alive across a running test)
+and set them up for destruction during the next test teardown phase.
Since: 2.14
</description>
<parameters>
-<parameter name="selection_data">
-<parameter_description> a pointer to a #GtkSelectionData structure.
+<parameter name="widget_type">
+<parameter_description> a valid widget type.
+</parameter_description>
+</parameter>
+<parameter name="first_property_name">
+<parameter_description> Name of first property to set or %NULL
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> value to set the first property to, followed by more
+name-value pairs, terminated by %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the data type of the selection.
+<return> a newly created widget.
</return>
</function>
-<function name="gtk_tree_drag_dest_drag_data_received">
+<function name="gtk_test_display_button_window">
<description>
-Asks the #GtkTreeDragDest to insert a row before the path @dest,
-deriving the contents of the row from @selection_data. If @dest is
-outside the tree so that inserting before it is impossible, %FALSE
-will be returned. Also, %FALSE may be returned if the new row is
-not created for some model-specific reason. Should robustly handle
-a @dest no longer found in the model!
+Create a window with window title @window_title, text contents @dialog_text,
+and a number of buttons, according to the paired argument list given
+as @... parameters.
+Each button is created with a @label and a ::clicked signal handler that
+incremrents the integer stored in @nump.
+The window will be automatically shown with gtk_widget_show_now() after
+creation, so when this function returns it has already been mapped,
+resized and positioned on screen.
+The window will quit any running gtk_main()-loop when destroyed, and it
+will automatically be destroyed upon test function teardown.
+Since: 2.14
</description>
<parameters>
-<parameter name="drag_dest">
-<parameter_description> a #GtkTreeDragDest
+<parameter name="window_title">
+<parameter_description> Title of the window to be displayed.
</parameter_description>
</parameter>
-<parameter name="dest">
-<parameter_description> row to drop in front of
+<parameter name="dialog_text">
+<parameter_description> Text inside the window to be displayed.
</parameter_description>
</parameter>
-<parameter name="selection_data">
-<parameter_description> data to drop
+<parameter name="Varargs">
+<parameter_description> %NULL terminated list of (const char *label, int *nump) pairs.
</parameter_description>
</parameter>
</parameters>
-<return> whether a new row was created before position @dest
+<return> a widget pointer to the newly created GtkWindow.
+
</return>
</function>
-<function name="gtk_tool_item_get_text_orientation">
+<function name="gtk_test_find_label">
<description>
-Returns the text orientation used for @tool_item. Custom subclasses of
-#GtkToolItem should call this function to find out how text should
-be orientated.
+This function will search @widget and all its descendants for a GtkLabel
+widget with a text string matching @label_pattern.
+The @label_pattern may contain asterisks '*' and question marks '?' as
+placeholders, g_pattern_match() is used for the matching.
+Note that locales other than "C" tend to alter (translate" label strings,
+so this function is genrally only useful in test programs with
+predetermined locales, see gtk_test_init() for more details.
-Since: 2.20
+Since: 2.14
</description>
<parameters>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem
+<parameter name="widget">
+<parameter_description> Valid label or container widget.
+</parameter_description>
+</parameter>
+<parameter name="label_pattern">
+<parameter_description> Shell-glob pattern to match a label string.
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkOrientation indicating the text orientation
-used for @tool_item
+<return> a GtkLabel widget if any is found.
</return>
</function>
-<function name="gtk_spinner_start">
+<function name="gtk_test_find_sibling">
<description>
-Starts the animation of the spinner.
+This function will search siblings of @base_widget and siblings of its
+ancestors for all widgets matching @widget_type.
+Of the matching widgets, the one that is geometrically closest to
+ base_widget will be returned.
+The general purpose of this function is to find the most likely "action"
+widget, relative to another labeling widget. Such as finding a
+button or text entry widget, given it's corresponding label widget.
-Since: 2.20
+Since: 2.14
</description>
<parameters>
-<parameter name="spinner">
-<parameter_description> a #GtkSpinner
+<parameter name="base_widget">
+<parameter_description> Valid widget, part of a widget hierarchy
+</parameter_description>
+</parameter>
+<parameter name="widget_type">
+<parameter_description> Type of a aearched for sibling widget
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a widget of type @widget_type if any is found.
+
+</return>
</function>
-<function name="gtk_notebook_get_action_widget">
+<function name="gtk_test_find_widget">
<description>
-Gets one of the action widgets. See gtk_notebook_set_action_widget().
+This function will search the descendants of @widget for a widget
+of type @widget_type that has a label matching @label_pattern next
+to it. This is most useful for automated GUI testing, e.g. to find
+the "OK" button in a dialog and synthesize clicks on it.
+However see gtk_test_find_label(), gtk_test_find_sibling() and
+gtk_test_widget_click() for possible caveats involving the search of
+such widgets and synthesizing widget events.
-Since: 2.20
+Since: 2.14
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="widget">
+<parameter_description> Container widget, usually a GtkWindow.
</parameter_description>
</parameter>
-<parameter name="pack_type">
-<parameter_description> pack type of the action widget to receive
+<parameter name="label_pattern">
+<parameter_description> Shell-glob pattern to match a label string.
+</parameter_description>
+</parameter>
+<parameter name="widget_type">
+<parameter_description> Type of a aearched for label sibling widget.
</parameter_description>
</parameter>
</parameters>
-<return> The action widget with the given @pack_type or
-%NULL when this action widget has not been set
+<return> a valid widget if any is found or %NULL.
</return>
</function>
-<function name="gtk_icon_set_new">
+<function name="gtk_test_init">
<description>
-Creates a new #GtkIconSet. A #GtkIconSet represents a single icon
-in various sizes and widget states. It can provide a #GdkPixbuf
-for a given size and state on request, and automatically caches
-some of the rendered #GdkPixbuf objects.
-
-Normally you would use gtk_widget_render_icon() instead of
-using #GtkIconSet directly. The one case where you'd use
-#GtkIconSet is to create application-specific icon sets to place in
-a #GtkIconFactory.
-
+This function is used to initialize a GTK+ test program.
-</description>
-<parameters>
-</parameters>
-<return> a new #GtkIconSet
-</return>
-</function>
+It will in turn call g_test_init() and gtk_init() to properly
+initialize the testing framework and graphical toolkit. It'll
+also set the program's locale to "C" and prevent loading of rc
+files and Gtk+ modules. This is done to make tets program
+environments as deterministic as possible.
-<function name="gtk_ui_manager_get_toplevels">
-<description>
-Obtains a list of all toplevel widgets of the requested types.
+Like gtk_init() and g_test_init(), any known arguments will be
+processed and stripped from @argc and @argv.
-Since: 2.4
+Since: 2.14
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #GtkUIManager
+<parameter name="argcp">
+<parameter_description> Address of the <parameter>argc</parameter> parameter of the
+main() function. Changed if any arguments were handled.
</parameter_description>
</parameter>
-<parameter name="types">
-<parameter_description> specifies the types of toplevel widgets to include. Allowed
-types are #GTK_UI_MANAGER_MENUBAR, #GTK_UI_MANAGER_TOOLBAR and
-#GTK_UI_MANAGER_POPUP.
+<parameter name="argvp">
+<parameter_description> Address of the <parameter>argv</parameter> parameter of main().
+Any parameters understood by g_test_init() or gtk_init() are
+stripped before return.
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> currently unused
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated #GSList of
-all toplevel widgets of the requested types. Free the returned list with g_slist_free().
-
-</return>
+<return></return>
</function>
-<function name="gtk_icon_view_set_drag_dest_item">
+<function name="gtk_test_list_all_types">
<description>
-Sets the item that is highlighted for feedback.
+Return the type ids that have been registered after
+calling gtk_test_register_all_types().
-Since: 2.8
+Since: 2.14
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> The path of the item to highlight, or %NULL.
-</parameter_description>
-</parameter>
-<parameter name="pos">
-<parameter_description> Specifies where to drop, relative to the item
+<parameter name="n_types">
+<parameter_description> location to store number of types
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> 0-terminated array of type ids
+</return>
</function>
-<function name="gtk_buildable_set_buildable_property">
+<function name="gtk_test_register_all_types">
<description>
-Sets the property name @name to @value on the @buildable object.
+Force registration of all core Gtk+ and Gdk object types.
+This allowes to refer to any of those object types via
+g_type_from_name() after calling this function.
-Since: 2.12
+Since: 2.14
</description>
<parameters>
-<parameter name="buildable">
-<parameter_description> a #GtkBuildable
-</parameter_description>
-</parameter>
-<parameter name="builder">
-<parameter_description> a #GtkBuilder
-</parameter_description>
-</parameter>
-<parameter name="name">
-<parameter_description> name of property
-</parameter_description>
-</parameter>
-<parameter name="value">
-<parameter_description> value of property
-</parameter_description>
-</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_printer_get_description">
+<function name="gtk_test_slider_get_value">
<description>
-Gets the description of the printer.
+Retrive the literal adjustment value for GtkRange based
+widgets and spin buttons. Note that the value returned by
+this function is anything between the lower and upper bounds
+of the adjustment belonging to @widget, and is not a percentage
+as passed in to gtk_test_slider_set_perc().
-Since: 2.10
+Since: 2.14
</description>
<parameters>
-<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter name="widget">
+<parameter_description> valid widget pointer.
</parameter_description>
</parameter>
</parameters>
-<return> the description of @printer
+<return> adjustment->value for an adjustment belonging to @widget.
</return>
</function>
-<function name="gtk_tree_path_append_index">
+<function name="gtk_test_slider_set_perc">
<description>
-Appends a new index to a path. As a result, the depth of the path is
-increased.
+This function will adjust the slider position of all GtkRange
+based widgets, such as scrollbars or scales, it'll also adjust
+spin buttons. The adjustment value of these widgets is set to
+a value between the lower and upper limits, according to the
+ percentage argument.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="path">
-<parameter_description> A #GtkTreePath.
+<parameter name="widget">
+<parameter_description> valid widget pointer.
</parameter_description>
</parameter>
-<parameter name="index_">
-<parameter_description> The index.
+<parameter name="percentage">
+<parameter_description> value between 0 and 100.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_image_new_from_icon_set">
+<function name="gtk_test_spin_button_click">
<description>
-Creates a #GtkImage displaying an icon set. Sample stock sizes are
-#GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_SMALL_TOOLBAR. Instead of using
-this function, usually it's better to create a #GtkIconFactory, put
-your icon sets in the icon factory, add the icon factory to the
-list of default factories with gtk_icon_factory_add_default(), and
-then use gtk_image_new_from_stock(). This will allow themes to
-override the icon you ship with your application.
-
-The #GtkImage does not assume a reference to the
-icon set; you still need to unref it if you own references.
-#GtkImage will add its own reference rather than adopting yours.
+This function will generate a @button click in the upwards or downwards
+spin button arrow areas, usually leading to an increase or decrease of
+spin button's value.
+Since: 2.14
</description>
<parameters>
-<parameter name="icon_set">
-<parameter_description> a #GtkIconSet
+<parameter name="spinner">
+<parameter_description> valid GtkSpinButton widget.
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> a stock icon size
+<parameter name="button">
+<parameter_description> Number of the pointer button for the event, usually 1, 2 or 3.
+</parameter_description>
+</parameter>
+<parameter name="upwards">
+<parameter_description> %TRUE for upwards arrow click, %FALSE for downwards arrow click.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkImage
+<return> wether all actions neccessary for the button click simulation were carried out successfully.
+
</return>
</function>
-<function name="gtk_radio_tool_button_new_from_widget">
+<function name="gtk_test_text_get">
<description>
-Creates a new #GtkRadioToolButton adding it to the same group as @gruup
+Retrive the text string of @widget if it is a GtkLabel,
+GtkEditable (entry and text widgets) or GtkTextView.
-Since: 2.4
+Since: 2.14
</description>
<parameters>
-<parameter name="group">
-<parameter_description> An existing #GtkRadioToolButton
+<parameter name="widget">
+<parameter_description> valid widget pointer.
</parameter_description>
</parameter>
</parameters>
-<return> The new #GtkRadioToolButton
+<return> new 0-terminated C string, needs to be released with g_free().
</return>
</function>
-<function name="gtk_box_set_homogeneous">
+<function name="gtk_test_text_set">
<description>
-Sets the #GtkBox:homogeneous property of @box, controlling
-whether or not all children of @box are given equal space
-in the box.
+Set the text string of @widget to @string if it is a GtkLabel,
+GtkEditable (entry and text widgets) or GtkTextView.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #GtkBox
+<parameter name="widget">
+<parameter_description> valid widget pointer.
</parameter_description>
</parameter>
-<parameter name="homogeneous">
-<parameter_description> a boolean value, %TRUE to create equal allotments,
-%FALSE for variable allotments
+<parameter name="string">
+<parameter_description> a 0-terminated C string
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_entry_completion_set_inline_selection">
+<function name="gtk_test_widget_click">
<description>
-Sets whether it is possible to cycle through the possible completions
-inside the entry.
+This function will generate a @button click (button press and button
+release event) in the middle of the first GdkWindow found that belongs
+to @widget.
+For %GTK_NO_WINDOW widgets like GtkButton, this will often be an
+input-only event window. For other widgets, this is usually widget->window.
+Certain caveats should be considered when using this function, in
+particular because the mouse pointer is warped to the button click
+location, see gdk_test_simulate_button() for details.
-Since: 2.12
+Since: 2.14
</description>
<parameters>
-<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
-</parameter_description>
-</parameter>
-<parameter name="inline_selection">
-<parameter_description> %TRUE to do inline selection
+<parameter name="widget">
+<parameter_description> Widget to generate a button click on.
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_list_store_remove">
-<description>
-Removes the given row from the list store. After being removed,
- iter is set to be the next valid row, or invalidated if it pointed
-to the last row in @list_store.
-
-
-</description>
-<parameters>
-<parameter name="list_store">
-<parameter_description> A #GtkListStore
+<parameter name="button">
+<parameter_description> Number of the pointer button for the event, usually 1, 2 or 3.
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> A valid #GtkTreeIter
+<parameter name="modifiers">
+<parameter_description> Keyboard modifiers the event is setup with.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter is valid, %FALSE if not.
+<return> wether all actions neccessary for the button click simulation were carried out successfully.
+
</return>
</function>
-<function name="gtk_color_selection_set_color">
+<function name="gtk_test_widget_send_key">
<description>
-Sets the current color to be @color. The first time this is called, it will
-also set the original color to be @color too.
+This function will generate keyboard press and release events in
+the middle of the first GdkWindow found that belongs to @widget.
+For %GTK_NO_WINDOW widgets like GtkButton, this will often be an
+input-only event window. For other widgets, this is usually widget->window.
+Certain caveats should be considered when using this function, in
+particular because the mouse pointer is warped to the key press
+location, see gdk_test_simulate_key() for details.
-Deprecated: 2.0: Use gtk_color_selection_set_current_color() instead.
+Since: 2.14
</description>
<parameters>
-<parameter name="colorsel">
-<parameter_description> a #GtkColorSelection.
+<parameter name="widget">
+<parameter_description> Widget to generate a key press and release on.
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> an array of 4 doubles specifying the red, green, blue and opacity
-to set the current color to.
+<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>
</parameters>
-<return></return>
+<return> wether all actions neccessary for the key event simulation were carried out successfully.
+
+</return>
</function>
-<function name="gtk_status_icon_get_has_tooltip">
+<function name="gtk_text_attributes_copy">
<description>
-Returns the current value of the has-tooltip property.
-See #GtkStatusIcon:has-tooltip for more information.
+Copies @src and returns a new #GtkTextAttributes.
-Since: 2.16
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
+<parameter name="src">
+<parameter_description> a #GtkTextAttributes to be copied
</parameter_description>
</parameter>
</parameters>
-<return> current value of has-tooltip on @status_icon.
-
+<return> a copy of @src
</return>
</function>
-<function name="gtk_tree_view_column_set_fixed_width">
+<function name="gtk_text_attributes_copy_values">
<description>
-Sets the size of the column in pixels. This is meaningful only if the sizing
-type is #GTK_TREE_VIEW_COLUMN_FIXED. The size of the column is clamped to
-the min/max width for the column. Please note that the min/max width of the
-column doesn't actually affect the "fixed_width" property of the widget, just
-the actual size when displayed.
+Copies the values from @src to @dest so that @dest has the same values
+as @src. Frees existing values in @dest.
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn.
+<parameter name="src">
+<parameter_description> a #GtkTextAttributes
</parameter_description>
</parameter>
-<parameter name="fixed_width">
-<parameter_description> The size to set @tree_column to. Must be greater than 0.
+<parameter name="dest">
+<parameter_description> another #GtkTextAttributes
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_info_bar_response">
+<function name="gtk_text_attributes_new">
<description>
-Emits the 'response' signal with the given @response_id.
+Creates a #GtkTextAttributes, which describes
+a set of properties on some text.
-Since: 2.18
</description>
<parameters>
-<parameter name="info_bar">
-<parameter_description> a #GtkInfoBar
-</parameter_description>
-</parameter>
-<parameter name="response_id">
-<parameter_description> a response ID
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> a new #GtkTextAttributes
+</return>
</function>
-<function name="gtk_assistant_set_page_header_image">
+<function name="gtk_text_attributes_ref">
<description>
-Sets a header image for @page. This image is displayed in the header
-area of the assistant when @page is the current page.
+Increments the reference count on @values.
-Since: 2.10
</description>
<parameters>
-<parameter name="assistant">
-<parameter_description> a #GtkAssistant
-</parameter_description>
-</parameter>
-<parameter name="page">
-<parameter_description> a page of @assistant
+<parameter name="values">
+<parameter_description> a #GtkTextAttributes
</parameter_description>
</parameter>
-<parameter name="pixbuf">
-<parameter_description> the new header image @page
+</parameters>
+<return> the #GtkTextAttributes that were passed in
+</return>
+</function>
+
+<function name="gtk_text_attributes_unref">
+<description>
+Decrements the reference count on @values, freeing the structure
+if the reference count reaches 0.
+
+</description>
+<parameters>
+<parameter name="values">
+<parameter_description> a #GtkTextAttributes
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_hsv_set_metrics">
+<function name="gtk_text_buffer_add_mark">
<description>
-Sets the size and ring width of an HSV color selector.
+Adds the mark at position @where. The mark must not be added to
+another buffer, and if its name is not %NULL then there must not
+be another mark in the buffer with the same name.
-Since: 2.14
+Emits the "mark-set" signal as notification of the mark's initial
+placement.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="hsv">
-<parameter_description> An HSV color selector
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> Diameter for the hue ring
+<parameter name="mark">
+<parameter_description> the mark to add
</parameter_description>
</parameter>
-<parameter name="ring_width">
-<parameter_description> Width of the hue ring
+<parameter name="where">
+<parameter_description> location to place mark
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tool_item_set_expand">
+<function name="gtk_text_buffer_add_selection_clipboard">
<description>
-Sets whether @tool_item is allocated extra space when there
-is more room on the toolbar then needed for the items. The
-effect is that the item gets bigger when the toolbar gets bigger
-and smaller when the toolbar gets smaller.
-
-Since: 2.4
+Adds @clipboard to the list of clipboards in which the selection
+contents of @buffer are available. In most cases, @clipboard will be
+the #GtkClipboard of type %GDK_SELECTION_PRIMARY for a view of @buffer.
</description>
<parameters>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="expand">
-<parameter_description> Whether @tool_item is allocated extra space
+<parameter name="clipboard">
+<parameter_description> a #GtkClipboard
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_cell_renderer_get_fixed_size">
+<function name="gtk_text_buffer_apply_tag">
<description>
-Fills in @width and @height with the appropriate size of @cell.
+Emits the "apply-tag" signal on @buffer. The default
+handler for the signal applies @tag to the given range.
+ start and @end do not have to be in order.
</description>
<parameters>
-<parameter name="cell">
-<parameter_description> A #GtkCellRenderer
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> location to fill in with the fixed width of the cell, or %NULL
+<parameter name="tag">
+<parameter_description> a #GtkTextTag
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> location to fill in with the fixed height of the cell, or %NULL
+<parameter name="start">
+<parameter_description> one bound of range to be tagged
+</parameter_description>
+</parameter>
+<parameter name="end">
+<parameter_description> other bound of range to be tagged
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_drag_source_set_icon_pixbuf">
+<function name="gtk_text_buffer_apply_tag_by_name">
<description>
-Sets the icon that will be used for drags from a particular widget
-from a #GdkPixbuf. GTK+ retains a reference for @pixbuf and will
-release it when it is no longer needed.
+Calls gtk_text_tag_table_lookup() on the buffer's tag table to
+get a #GtkTextTag, then calls gtk_text_buffer_apply_tag().
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="pixbuf">
-<parameter_description> the #GdkPixbuf for the drag icon
+<parameter name="name">
+<parameter_description> name of a named #GtkTextTag
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_widget_set_default_colormap">
-<description>
-Sets the default colormap to use when creating widgets.
-gtk_widget_push_colormap() is a better function to use if
-you only want to affect a few widgets, rather than all widgets.
-
-</description>
-<parameters>
-<parameter name="colormap">
-<parameter_description> a #GdkColormap
+<parameter name="start">
+<parameter_description> one bound of range to be tagged
+</parameter_description>
+</parameter>
+<parameter name="end">
+<parameter_description> other bound of range to be tagged
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_size_request">
+<function name="gtk_text_buffer_backspace">
<description>
-This function is typically used when implementing a #GtkContainer
-subclass. Obtains the preferred size of a widget. The container
-uses this information to arrange its child widgets and decide what
-size allocations to give them with gtk_widget_size_allocate().
-
-You can also call this function from an application, with some
-caveats. Most notably, getting a size request requires the widget
-to be associated with a screen, because font information may be
-needed. Multihead-aware applications should keep this in mind.
+Performs the appropriate action as if the user hit the delete
+key with the cursor at the position specified by @iter. In the
+normal case a single character will be deleted, but when
+combining accents are involved, more than one character can
+be deleted, and when precomposed character and accent combinations
+are involved, less than one character will be deleted.
-Also remember that the size request is not necessarily the size
-a widget will actually be allocated.
+Because the buffer is modified, all outstanding iterators become
+invalid after calling this function; however, the @iter will be
+re-initialized to point to the location where text was deleted.
-See also gtk_widget_get_child_requisition().
+Since: 2.6
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="requisition">
-<parameter_description> a #GtkRequisition to be filled in
+<parameter name="iter">
+<parameter_description> a position in @buffer
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_tool_palette_get_group_position">
-<description>
-Gets the position of @group in @palette as index.
-See gtk_tool_palette_set_group_position().
-
-Since: 2.20
-
-</description>
-<parameters>
-<parameter name="palette">
-<parameter_description> a #GtkToolPalette
+<parameter name="interactive">
+<parameter_description> whether the deletion is caused by user interaction
</parameter_description>
</parameter>
-<parameter name="group">
-<parameter_description> a #GtkToolItemGroup
+<parameter name="default_editable">
+<parameter_description> whether the buffer is editable by default
</parameter_description>
</parameter>
</parameters>
-<return> the index of group or -1 if @group is not a child of @palette
+<return> %TRUE if the buffer was modified
</return>
</function>
-<function name="gtk_window_get_opacity">
+<function name="gtk_text_buffer_begin_user_action">
<description>
-Fetches the requested opacity for this window. See
-gtk_window_set_opacity().
+Called to indicate that the buffer operations between here and a
+call to gtk_text_buffer_end_user_action() are part of a single
+user-visible operation. The operations between
+gtk_text_buffer_begin_user_action() and
+gtk_text_buffer_end_user_action() can then be grouped when creating
+an undo stack. #GtkTextBuffer maintains a count of calls to
+gtk_text_buffer_begin_user_action() that have not been closed with
+a call to gtk_text_buffer_end_user_action(), and emits the
+"begin-user-action" and "end-user-action" signals only for the
+outermost pair of calls. This allows you to build user actions
+from other user actions.
-Since: 2.12
+The "interactive" buffer mutation functions, such as
+gtk_text_buffer_insert_interactive(), automatically call begin/end
+user action around the buffer operations they perform, so there's
+no need to add extra calls if you user action consists solely of a
+single call to one of those functions.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
</parameters>
-<return> the requested opacity for this window.
-
-</return>
+<return></return>
</function>
-<function name="gtk_tree_view_set_rubber_banding">
+<function name="gtk_text_buffer_copy_clipboard">
<description>
-Enables or disables rubber banding in @tree_view. If the selection mode
-is #GTK_SELECTION_MULTIPLE, rubber banding will allow the user to select
-multiple rows by dragging the mouse.
-
-Since: 2.10
+Copies the currently-selected text to a clipboard.
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="enable">
-<parameter_description> %TRUE to enable rubber banding
+<parameter name="clipboard">
+<parameter_description> the #GtkClipboard object to copy to
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_link_button_get_uri">
+<function name="gtk_text_buffer_create_child_anchor">
<description>
-Retrieves the URI set using gtk_link_button_set_uri().
+This is a convenience function which simply creates a child anchor
+with gtk_text_child_anchor_new() and inserts it into the buffer
+with gtk_text_buffer_insert_child_anchor(). The new anchor is
+owned by the buffer; no reference count is returned to
+the caller of gtk_text_buffer_create_child_anchor().
-Since: 2.10
</description>
<parameters>
-<parameter name="link_button">
-<parameter_description> a #GtkLinkButton
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> location in the buffer
</parameter_description>
</parameter>
</parameters>
-<return> a valid URI. The returned string is owned by the link button
-and should not be modified or freed.
-
+<return> the created child anchor
</return>
</function>
-<function name="gtk_widget_set_no_show_all">
+<function name="gtk_text_buffer_create_mark">
<description>
-Sets the #GtkWidget:no-show-all property, which determines whether
-calls to gtk_widget_show_all() and gtk_widget_hide_all() will affect
-this widget.
+Creates a mark at position @where. If @mark_name is %NULL, the mark
+is anonymous; otherwise, the mark can be retrieved by name using
+gtk_text_buffer_get_mark(). If a mark has left gravity, and text is
+inserted at the mark's current location, the mark will be moved to
+the left of the newly-inserted text. If the mark has right gravity
+(@left_gravity = %FALSE), the mark will end up on the right of
+newly-inserted text. The standard left-to-right cursor is a mark
+with right gravity (when you type, the cursor stays on the right
+side of the text you're typing).
-This is mostly for use in constructing widget hierarchies with externally
-controlled visibility, see #GtkUIManager.
+The caller of this function does <emphasis>not</emphasis> own a
+reference to the returned #GtkTextMark, so you can ignore the
+return value if you like. Marks are owned by the buffer and go
+away when the buffer does.
+
+Emits the "mark-set" signal as notification of the mark's initial
+placement.
-Since: 2.4
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="no_show_all">
-<parameter_description> the new value for the "no-show-all" property
+<parameter name="mark_name">
+<parameter_description> name for mark, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="where">
+<parameter_description> location to place mark
+</parameter_description>
+</parameter>
+<parameter name="left_gravity">
+<parameter_description> whether the mark has left gravity
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the new #GtkTextMark object
+</return>
</function>
-<function name="gtk_clipboard_request_rich_text">
+<function name="gtk_text_buffer_create_tag">
<description>
-Requests the contents of the clipboard as rich text. When the rich
-text is later received, @callback will be called.
+Creates a tag and adds it to the tag table for @buffer.
+Equivalent to calling gtk_text_tag_new() and then adding the
+tag to the buffer's tag table. The returned tag is owned by
+the buffer's tag table, so the ref count will be equal to one.
-The @text parameter to @callback will contain the resulting rich
-text if the request succeeded, or %NULL if it failed. The @length
-parameter will contain @text's length. This function can fail for
-various reasons, in particular if the clipboard was empty or if the
-contents of the clipboard could not be converted into rich text form.
+If @tag_name is %NULL, the tag is anonymous.
+
+If @tag_name is non-%NULL, a tag called @tag_name must not already
+exist in the tag table for this buffer.
+
+The @first_property_name argument and subsequent arguments are a list
+of properties to set on the tag, as with g_object_set().
-Since: 2.10
</description>
<parameters>
-<parameter name="clipboard">
-<parameter_description> a #GtkClipboard
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="tag_name">
+<parameter_description> name of the new tag, or %NULL
</parameter_description>
</parameter>
-<parameter name="callback">
-<parameter_description> a function to call when the text is received,
-or the retrieval fails. (It will always be called
-one way or the other.)
+<parameter name="first_property_name">
+<parameter_description> name of first property to set, or %NULL
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to @callback.
+<parameter name="Varargs">
+<parameter_description> %NULL-terminated list of property names and values
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new tag
+</return>
</function>
-<function name="gtk_selection_data_targets_include_uri">
+<function name="gtk_text_buffer_cut_clipboard">
<description>
-Given a #GtkSelectionData object holding a list of targets,
-determines if any of the targets in @targets can be used to
-provide a list or URIs.
-
-Since: 2.10
+Copies the currently-selected text to a clipboard, then deletes
+said text if it's editable.
</description>
<parameters>
-<parameter name="selection_data">
-<parameter_description> a #GtkSelectionData object
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
+</parameter_description>
+</parameter>
+<parameter name="clipboard">
+<parameter_description> the #GtkClipboard object to cut to
+</parameter_description>
+</parameter>
+<parameter name="default_editable">
+<parameter_description> default editability of the buffer
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @selection_data holds a list of targets,
-and a suitable target for URI lists is included, otherwise %FALSE.
-
-</return>
+<return></return>
</function>
-<function name="gtk_tree_selection_count_selected_rows">
+<function name="gtk_text_buffer_delete">
<description>
-Returns the number of rows that have been selected in @tree.
-
-Since: 2.2
+Deletes text between @start and @end. The order of @start and @end
+is not actually relevant; gtk_text_buffer_delete() will reorder
+them. This function actually emits the "delete-range" signal, and
+the default handler of that signal deletes the text. Because the
+buffer is modified, all outstanding iterators become invalid after
+calling this function; however, the @start and @end will be
+re-initialized to point to the location where text was deleted.
</description>
<parameters>
-<parameter name="selection">
-<parameter_description> A #GtkTreeSelection.
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
+</parameter_description>
+</parameter>
+<parameter name="start">
+<parameter_description> a position in @buffer
+</parameter_description>
+</parameter>
+<parameter name="end">
+<parameter_description> another position in @buffer
</parameter_description>
</parameter>
</parameters>
-<return> The number of rows selected.
-
-</return>
+<return></return>
</function>
-<function name="gtk_file_chooser_add_shortcut_folder_uri">
+<function name="gtk_text_buffer_delete_interactive">
<description>
-Adds a folder URI to be displayed with the shortcut folders in a file
-chooser. Note that shortcut folders do not get saved, as they are provided
-by the application. For example, you can use this to add a
-"file:///usr/share/mydrawprogram/Clipart" folder to the volume list.
+Deletes all <emphasis>editable</emphasis> text in the given range.
+Calls gtk_text_buffer_delete() for each editable sub-range of
+[ start,@end). @start and @end are revalidated to point to
+the location of the last deleted range, or left untouched if
+no text was deleted.
-Since: 2.4
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="uri">
-<parameter_description> URI of the folder to add
+<parameter name="start_iter">
+<parameter_description> start of range to delete
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> location to store error, or %NULL
+<parameter name="end_iter">
+<parameter_description> end of range
+</parameter_description>
+</parameter>
+<parameter name="default_editable">
+<parameter_description> whether the buffer is editable by default
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the folder could be added successfully, %FALSE
-otherwise. In the latter case, the @error will be set as appropriate.
-
+<return> whether some text was actually deleted
</return>
</function>
-<function name="gtk_button_set_label">
+<function name="gtk_text_buffer_delete_mark">
<description>
-Sets the text of the label of the button to @str. This text is
-also used to select the stock item if gtk_button_set_use_stock()
-is used.
-
-This will also clear any previously set labels.
+Deletes @mark, so that it's no longer located anywhere in the
+buffer. Removes the reference the buffer holds to the mark, so if
+you haven't called g_object_ref() on the mark, it will be freed. Even
+if the mark isn't freed, most operations on @mark become
+invalid, until it gets added to a buffer again with
+gtk_text_buffer_add_mark(). Use gtk_text_mark_get_deleted() to
+find out if a mark has been removed from its buffer.
+The "mark-deleted" signal will be emitted as notification after
+the mark is deleted.
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkButton
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="label">
-<parameter_description> a string
+<parameter name="mark">
+<parameter_description> a #GtkTextMark in @buffer
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_recent_manager_set_limit">
+<function name="gtk_text_buffer_delete_mark_by_name">
<description>
-Sets the maximum number of item that the gtk_recent_manager_get_items()
-function should return. If @limit is set to -1, then return all the
-items.
-
-Since: 2.10
-
-Deprecated: 2.22: The length of the list should be managed by the
-view (implementing #GtkRecentChooser), and not by the model (the
-#GtkRecentManager). See #GtkRecentChooser:limit.
+Deletes the mark named @name; the mark must exist. See
+gtk_text_buffer_delete_mark() for details.
</description>
<parameters>
-<parameter name="manager">
-<parameter_description> a #GtkRecentManager
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="limit">
-<parameter_description> the maximum number of items to return, or -1.
+<parameter name="name">
+<parameter_description> name of a mark in @buffer
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_notebook_get_current_page">
+<function name="gtk_text_buffer_delete_selection">
<description>
-Returns the page number of the current page.
+Deletes the range between the "insert" and "selection_bound" marks,
+that is, the currently-selected text. If @interactive is %TRUE,
+the editability of the selection will be considered (users can't delete
+uneditable text).
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
+</parameter_description>
+</parameter>
+<parameter name="interactive">
+<parameter_description> whether the deletion is caused by user interaction
+</parameter_description>
+</parameter>
+<parameter name="default_editable">
+<parameter_description> whether the buffer is editable by default
</parameter_description>
</parameter>
</parameters>
-<return> the index (starting from 0) of the current
-page in the notebook. If the notebook has no pages, then
--1 will be returned.
+<return> whether there was a non-empty selection to delete
</return>
</function>
-<function name="gtk_text_view_add_child_at_anchor">
+<function name="gtk_text_buffer_deserialize">
<description>
-Adds a child widget in the text buffer, at the given @anchor.
+This function deserializes rich text in format @format and inserts
+it at @iter.
+
+ format<!-- -->s to be used must be registered using
+gtk_text_buffer_register_deserialize_format() or
+gtk_text_buffer_register_deserialize_tagset() beforehand.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="register_buffer">
+<parameter_description> the #GtkTextBuffer @format is registered with
</parameter_description>
</parameter>
-<parameter name="child">
-<parameter_description> a #GtkWidget
+<parameter name="content_buffer">
+<parameter_description> the #GtkTextBuffer to deserialize into
</parameter_description>
</parameter>
-<parameter name="anchor">
-<parameter_description> a #GtkTextChildAnchor in the #GtkTextBuffer for @text_view
+<parameter name="format">
+<parameter_description> the rich text format to use for deserializing
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> insertion point for the deserialized text
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> data to deserialize
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> length of @data
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for a #GError
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE on success, %FALSE otherwise.
+
+</return>
</function>
-<function name="gtk_icon_set_unref">
+<function name="gtk_text_buffer_deserialize_get_can_create_tags">
<description>
-Decrements the reference count on @icon_set, and frees memory
-if the reference count reaches 0.
+This functions returns the value set with
+gtk_text_buffer_deserialize_set_can_create_tags()
+
+Since: 2.10
</description>
<parameters>
-<parameter name="icon_set">
-<parameter_description> a #GtkIconSet
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
+</parameter_description>
+</parameter>
+<parameter name="format">
+<parameter_description> a #GdkAtom representing a registered rich text format
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether deserializing this format may create tags
+
+</return>
</function>
-<function name="gtk_accel_group_connect_by_path">
+<function name="gtk_text_buffer_deserialize_set_can_create_tags">
<description>
-Installs an accelerator in this group, using an accelerator path to look
-up the appropriate key and modifiers (see gtk_accel_map_add_entry()).
-When @accel_group is being activated in response to a call to
-gtk_accel_groups_activate(), @closure will be invoked if the @accel_key and
- accel_mods from gtk_accel_groups_activate() match the key and modifiers
-for the path.
+Use this function to allow a rich text deserialization function to
+create new tags in the receiving buffer. Note that using this
+function is almost always a bad idea, because the rich text
+functions you register should know how to map the rich text format
+they handler to your text buffers set of tags.
-The signature used for the @closure is that of #GtkAccelGroupActivate.
+The ability of creating new (arbitrary!) tags in the receiving buffer
+is meant for special rich text formats like the internal one that
+is registered using gtk_text_buffer_register_deserialize_tagset(),
+because that format is essentially a dump of the internal structure
+of the source buffer, including its tag names.
-Note that @accel_path string will be stored in a #GQuark. Therefore, if you
-pass a static string, you can save some memory by interning it first with
-g_intern_static_string().
+You should allow creation of tags only if you know what you are
+doing, e.g. if you defined a tagset name for your application
+suite's text buffers and you know that it's fine to receive new
+tags from these buffers, because you know that your application can
+handle the newly created tags.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="accel_group">
-<parameter_description> the accelerator group to install an accelerator in
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="accel_path">
-<parameter_description> path used for determining key and modifiers.
+<parameter name="format">
+<parameter_description> a #GdkAtom representing a registered rich text format
</parameter_description>
</parameter>
-<parameter name="closure">
-<parameter_description> closure to be executed upon accelerator activation
+<parameter name="can_create_tags">
+<parameter_description> whether deserializing this format may create tags
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_recent_manager_has_item">
+<function name="gtk_text_buffer_end_user_action">
<description>
-Checks whether there is a recently used resource registered
-with @uri inside the recent manager.
-
-Since: 2.10
+Should be paired with a call to gtk_text_buffer_begin_user_action().
+See that function for a full explanation.
</description>
<parameters>
-<parameter name="manager">
-<parameter_description> a #GtkRecentManager
-</parameter_description>
-</parameter>
-<parameter name="uri">
-<parameter_description> a URI
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the resource was found, %FALSE otherwise.
-
-</return>
+<return></return>
</function>
-<function name="gtk_print_context_get_dpi_y">
+<function name="gtk_text_buffer_get_bounds">
<description>
-Obtains the vertical resolution of the #GtkPrintContext,
-in dots per inch.
-
-Since: 2.10
+Retrieves the first and last iterators in the buffer, i.e. the
+entire buffer lies within the range [ start,@end).
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GtkPrintContext
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
+</parameter_description>
+</parameter>
+<parameter name="start">
+<parameter_description> iterator to initialize with first position in the buffer
+</parameter_description>
+</parameter>
+<parameter name="end">
+<parameter_description> iterator to initialize with the end iterator
</parameter_description>
</parameter>
</parameters>
-<return> the vertical resolution of @context
-
-</return>
+<return></return>
</function>
-<function name="gtk_frame_get_shadow_type">
+<function name="gtk_text_buffer_get_char_count">
<description>
-Retrieves the shadow type of the frame. See
-gtk_frame_set_shadow_type().
+Gets the number of characters in the buffer; note that characters
+and bytes are not the same, you can't e.g. expect the contents of
+the buffer in string form to be this many bytes long. The character
+count is cached, so this function is very fast.
</description>
<parameters>
-<parameter name="frame">
-<parameter_description> a #GtkFrame
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
</parameters>
-<return> the current shadow type of the frame.
+<return> number of characters in the buffer
</return>
</function>
-<function name="gtk_tree_view_column_set_sort_column_id">
+<function name="gtk_text_buffer_get_copy_target_list">
<description>
-Sets the logical @sort_column_id that this column sorts on when this column
-is selected for sorting. Doing so makes the column header clickable.
+This function returns the list of targets this text buffer can
+provide for copying and as DND source. The targets in the list are
+added with %info values from the #GtkTextBufferTargetInfo enum,
+using gtk_target_list_add_rich_text_targets() and
+gtk_target_list_add_text_targets().
+
+Since: 2.10
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> a #GtkTreeViewColumn
-</parameter_description>
-</parameter>
-<parameter name="sort_column_id">
-<parameter_description> The @sort_column_id of the model to sort on.
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GtkTargetList
+
+</return>
</function>
-<function name="gtk_text_buffer_insert_range_interactive">
+<function name="gtk_text_buffer_get_deserialize_formats">
<description>
-Same as gtk_text_buffer_insert_range(), but does nothing if the
-insertion point isn't editable. The @default_editable parameter
-indicates whether the text is editable at @iter if no tags
-enclosing @iter affect editability. Typically the result of
-gtk_text_view_get_editable() is appropriate here.
+This function returns the rich text deserialize formats registered
+with @buffer using gtk_text_buffer_register_deserialize_format() or
+gtk_text_buffer_register_deserialize_tagset()
+Since: 2.10
</description>
<parameters>
@@ -46103,2085 +47194,2266 @@ gtk_text_view_get_editable() is appropriate here.
<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> a position in @buffer
-</parameter_description>
-</parameter>
-<parameter name="start">
-<parameter_description> a position in a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="end">
-<parameter_description> another position in the same buffer as @start
-</parameter_description>
-</parameter>
-<parameter name="default_editable">
-<parameter_description> default editability of the buffer
+<parameter name="n_formats">
+<parameter_description> return location for the number of formats
</parameter_description>
</parameter>
</parameters>
-<return> whether an insertion was possible at @iter
+<return> an array of #GdkAtom<!-- -->s representing the registered
+formats.
+
</return>
</function>
-<function name="gtk_icon_source_set_direction_wildcarded">
+<function name="gtk_text_buffer_get_end_iter">
<description>
-If the text direction is wildcarded, this source can be used
-as the base image for an icon in any #GtkTextDirection.
-If the text direction is not wildcarded, then the
-text direction the icon source applies to should be set
-with gtk_icon_source_set_direction(), and the icon source
-will only be used with that text direction.
-
-#GtkIconSet prefers non-wildcarded sources (exact matches) over
-wildcarded sources, and will use an exact match when possible.
+Initializes @iter with the "end iterator," one past the last valid
+character in the text buffer. If dereferenced with
+gtk_text_iter_get_char(), the end iterator has a character value of
+0. The entire buffer lies in the range from the first position in
+the buffer (call gtk_text_buffer_get_start_iter() to get
+character position 0) to the end iterator.
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GtkIconSource
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="setting">
-<parameter_description> %TRUE to wildcard the text direction
+<parameter name="iter">
+<parameter_description> iterator to initialize
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_assistant_get_page_title">
+<function name="gtk_text_buffer_get_has_selection">
<description>
-Gets the title for @page.
+Indicates whether the buffer has some text currently selected.
Since: 2.10
</description>
<parameters>
-<parameter name="assistant">
-<parameter_description> a #GtkAssistant
-</parameter_description>
-</parameter>
-<parameter name="page">
-<parameter_description> a page of @assistant
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
</parameters>
-<return> the title for @page.
+<return> %TRUE if the there is text selected
</return>
</function>
-<function name="gtk_link_button_get_visited">
+<function name="gtk_text_buffer_get_insert">
<description>
-Retrieves the 'visited' state of the URI where the #GtkLinkButton
-points. The button becomes visited when it is clicked. If the URI
-is changed on the button, the 'visited' state is unset again.
-
-The state may also be changed using gtk_link_button_set_visited().
+Returns the mark that represents the cursor (insertion point).
+Equivalent to calling gtk_text_buffer_get_mark() to get the mark
+named "insert", but very slightly more efficient, and involves less
+typing.
-Since: 2.14
</description>
<parameters>
-<parameter name="link_button">
-<parameter_description> a #GtkLinkButton
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the link has been visited, %FALSE otherwise
-
+<return> insertion point mark
</return>
</function>
-<function name="gtk_image_new_from_file">
+<function name="gtk_text_buffer_get_iter_at_child_anchor">
<description>
-Creates a new #GtkImage displaying the file @filename. If the file
-isn't found or can't be loaded, the resulting #GtkImage will
-display a "broken image" icon. This function never returns %NULL,
-it always returns a valid #GtkImage widget.
-
-If the file contains an animation, the image will contain an
-animation.
-
-If you need to detect failures to load the file, use
-gdk_pixbuf_new_from_file() to load the file yourself, then create
-the #GtkImage from the pixbuf. (Or for animations, use
-gdk_pixbuf_animation_new_from_file()).
-
-The storage type (gtk_image_get_storage_type()) of the returned
-image is not defined, it will be whatever is appropriate for
-displaying the file.
-
+Obtains the location of @anchor within @buffer.
</description>
<parameters>
-<parameter name="filename">
-<parameter_description> a filename
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> an iterator to be initialized
+</parameter_description>
+</parameter>
+<parameter name="anchor">
+<parameter_description> a child anchor that appears in @buffer
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkImage
-</return>
+<return></return>
</function>
-<function name="gtk_text_buffer_deserialize">
+<function name="gtk_text_buffer_get_iter_at_line">
<description>
-This function deserializes rich text in format @format and inserts
-it at @iter.
-
- format<!-- -->s to be used must be registered using
-gtk_text_buffer_register_deserialize_format() or
-gtk_text_buffer_register_deserialize_tagset() beforehand.
-
-Since: 2.10
+Initializes @iter to the start of the given line.
</description>
<parameters>
-<parameter name="register_buffer">
-<parameter_description> the #GtkTextBuffer @format is registered with
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="content_buffer">
-<parameter_description> the #GtkTextBuffer to deserialize into
+<parameter name="iter">
+<parameter_description> iterator to initialize
</parameter_description>
</parameter>
-<parameter name="format">
-<parameter_description> the rich text format to use for deserializing
+<parameter name="line_number">
+<parameter_description> line number counting from 0
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> insertion point for the deserialized text
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_text_buffer_get_iter_at_line_index">
+<description>
+Obtains an iterator pointing to @byte_index within the given line.
+ byte_index must be the start of a UTF-8 character, and must not be
+beyond the end of the line. Note <emphasis>bytes</emphasis>, not
+characters; UTF-8 may encode one character as multiple bytes.
+
+</description>
+<parameters>
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to deserialize
+<parameter name="iter">
+<parameter_description> iterator to initialize
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> length of @data
+<parameter name="line_number">
+<parameter_description> line number counting from 0
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError
+<parameter name="byte_index">
+<parameter_description> byte index from start of line
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success, %FALSE otherwise.
-
-</return>
+<return></return>
</function>
-<function name="gtk_widget_get_pointer">
+<function name="gtk_text_buffer_get_iter_at_line_offset">
<description>
-Obtains the location of the mouse pointer in widget coordinates.
-Widget coordinates are a bit odd; for historical reasons, they are
-defined as @widget->window coordinates for widgets that are not
-#GTK_NO_WINDOW widgets, and are relative to @widget->allocation.x,
- widget->allocation.y for widgets that are #GTK_NO_WINDOW widgets.
+Obtains an iterator pointing to @char_offset within the given
+line. The @char_offset must exist, offsets off the end of the line
+are not allowed. Note <emphasis>characters</emphasis>, not bytes;
+UTF-8 may encode one character as multiple bytes.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> return location for the X coordinate, or %NULL
+<parameter name="iter">
+<parameter_description> iterator to initialize
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> return location for the Y coordinate, or %NULL
+<parameter name="line_number">
+<parameter_description> line number counting from 0
+</parameter_description>
+</parameter>
+<parameter name="char_offset">
+<parameter_description> char offset from start of line
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_adjustment_set_step_increment">
+<function name="gtk_text_buffer_get_iter_at_mark">
<description>
-Sets the step increment of the adjustment.
-
-See gtk_adjustment_set_lower() about how to compress multiple
-emissions of the "changed" signal when setting multiple adjustment
-properties.
-
-Since: 2.14
+Initializes @iter with the current position of @mark.
</description>
<parameters>
-<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="step_increment">
-<parameter_description> the new step increment
+<parameter name="iter">
+<parameter_description> iterator to initialize
+</parameter_description>
+</parameter>
+<parameter name="mark">
+<parameter_description> a #GtkTextMark in @buffer
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_iter_backward_word_start">
+<function name="gtk_text_buffer_get_iter_at_offset">
<description>
-Moves backward to the previous word start. (If @iter is currently on a
-word start, moves backward to the next one after that.) Word breaks
-are determined by Pango and should be correct for nearly any
-language (if not, the correct fix would be to the Pango word break
-algorithms).
-
+Initializes @iter to a position @char_offset chars from the start
+of the entire buffer. If @char_offset is -1 or greater than the number
+of characters in the buffer, @iter is initialized to the end iterator,
+the iterator one past the last valid character in the buffer.
</description>
<parameters>
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
+</parameter_description>
+</parameter>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> iterator to initialize
+</parameter_description>
+</parameter>
+<parameter name="char_offset">
+<parameter_description> char offset from start of buffer, counting from 0, or -1
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter moved and is not the end iterator
-</return>
+<return></return>
</function>
-<function name="gtk_widget_unrealize">
+<function name="gtk_text_buffer_get_line_count">
<description>
-This function is only useful in widget implementations.
-Causes a widget to be unrealized (frees all GDK resources
-associated with the widget, such as @widget->window).
+Obtains the number of lines in the buffer. This value is cached, so
+the function is very fast.
+
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> number of lines in the buffer
+</return>
</function>
-<function name="gtk_about_dialog_get_version">
+<function name="gtk_text_buffer_get_mark">
<description>
-Returns the version string.
+Returns the mark named @name in buffer @buffer, or %NULL if no such
+mark exists in the buffer.
-Since: 2.6
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> a mark name
</parameter_description>
</parameter>
</parameters>
-<return> The version string. The string is owned by the about
-dialog and must not be modified.
-
+<return> a #GtkTextMark, or %NULL
</return>
</function>
-<function name="gtk_recent_manager_set_screen">
+<function name="gtk_text_buffer_get_modified">
<description>
-Sets the screen for a recent manager; the screen is used to
-track the user's currently configured recently used documents
-storage.
-
-Since: 2.10
+Indicates whether the buffer has been modified since the last call
+to gtk_text_buffer_set_modified() set the modification flag to
+%FALSE. Used for example to enable a "save" function in a text
+editor.
-Deprecated: 2.12: This function has been deprecated and should
-not be used in newly written code. Calling this function has
-no effect.
</description>
<parameters>
-<parameter name="manager">
-<parameter_description> a #GtkRecentManager
-</parameter_description>
-</parameter>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the buffer has been modified
+</return>
</function>
-<function name="gtk_text_iter_get_line">
+<function name="gtk_text_buffer_get_paste_target_list">
<description>
-Returns the line number containing the iterator. Lines in
-a #GtkTextBuffer are numbered beginning with 0 for the first
-line in the buffer.
+This function returns the list of targets this text buffer supports
+for pasting and as DND destination. The targets in the list are
+added with %info values from the #GtkTextBufferTargetInfo enum,
+using gtk_target_list_add_rich_text_targets() and
+gtk_target_list_add_text_targets().
+Since: 2.10
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
</parameters>
-<return> a line number
+<return> the #GtkTargetList
+
</return>
</function>
-<function name="gtk_menu_get_for_attach_widget">
+<function name="gtk_text_buffer_get_selection_bound">
<description>
-Returns a list of the menus which are attached to this widget.
-This list is owned by GTK+ and must not be modified.
+Returns the mark that represents the selection bound. Equivalent
+to calling gtk_text_buffer_get_mark() to get the mark named
+"selection_bound", but very slightly more efficient, and involves
+less typing.
+
+The currently-selected text in @buffer is the region between the
+"selection_bound" and "insert" marks. If "selection_bound" and
+"insert" are in the same place, then there is no current selection.
+gtk_text_buffer_get_selection_bounds() is another convenient function
+for handling the selection, if you just want to know whether there's a
+selection and what its bounds are.
-Since: 2.6
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
</parameters>
-<return> the list of menus attached to his widget.
-
+<return> selection bound mark
</return>
</function>
-<function name="gtk_widget_modify_bg">
+<function name="gtk_text_buffer_get_selection_bounds">
<description>
-Sets the background color for a widget in a particular state.
-All other style values are left untouched. See also
-gtk_widget_modify_style().
+Returns %TRUE if some text is selected; places the bounds
+of the selection in @start and @end (if the selection has length 0,
+then @start and @end are filled in with the same value).
+ start and @end will be in ascending order. If @start and @end are
+NULL, then they are not filled in, but the return value still indicates
+whether text is selected.
-Note that "no window" widgets (which have the %GTK_NO_WINDOW flag set)
-draw on their parent container's window and thus may not draw any
-background themselves. This is the case for e.g. #GtkLabel. To modify
-the background of such widgets, you have to set the background color
-on their parent; if you want to set the background of a rectangular
-area around a label, try placing the label in a #GtkEventBox widget
-and setting the background color on that.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="state">
-<parameter_description> the state for which to set the background color
+<parameter name="start">
+<parameter_description> iterator to initialize with selection start
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> the color to assign (does not need to be allocated),
-or %NULL to undo the effect of previous calls to
-of gtk_widget_modify_bg().
+<parameter name="end">
+<parameter_description> iterator to initialize with selection end
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether the selection has nonzero length
+</return>
</function>
-<function name="gtk_file_chooser_set_use_preview_label">
+<function name="gtk_text_buffer_get_serialize_formats">
<description>
-Sets whether the file chooser should display a stock label with the name of
-the file that is being previewed; the default is %TRUE. Applications that
-want to draw the whole preview area themselves should set this to %FALSE and
-display the name themselves in their preview widget.
-
-See also: gtk_file_chooser_set_preview_widget()
+This function returns the rich text serialize formats registered
+with @buffer using gtk_text_buffer_register_serialize_format() or
+gtk_text_buffer_register_serialize_tagset()
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="use_label">
-<parameter_description> whether to display a stock label with the name of the previewed file
+<parameter name="n_formats">
+<parameter_description> return location for the number of formats
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> an array of #GdkAtom<!-- -->s representing the registered
+formats.
+
+</return>
</function>
-<function name="gtk_layout_thaw">
+<function name="gtk_text_buffer_get_slice">
<description>
-This is a deprecated function, it doesn't do anything useful.
+Returns the text in the range [ start,@end). Excludes undisplayed
+text (text marked with tags that set the invisibility attribute) if
+ include_hidden_chars is %FALSE. The returned string includes a
+0xFFFC character whenever the buffer contains
+embedded images, so byte and character indexes into
+the returned string <emphasis>do</emphasis> correspond to byte
+and character indexes into the buffer. Contrast with
+gtk_text_buffer_get_text(). Note that 0xFFFC can occur in normal
+text as well, so it is not a reliable indicator that a pixbuf or
+widget is in the buffer.
+
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #GtkLayout
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
+</parameter_description>
+</parameter>
+<parameter name="start">
+<parameter_description> start of a range
+</parameter_description>
+</parameter>
+<parameter name="end">
+<parameter_description> end of a range
+</parameter_description>
+</parameter>
+<parameter name="include_hidden_chars">
+<parameter_description> whether to include invisible text
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> an allocated UTF-8 string
+</return>
</function>
-<function name="gtk_layout_put">
+<function name="gtk_text_buffer_get_start_iter">
<description>
-Adds @child_widget to @layout, at position (@x,@y).
- layout becomes the new parent container of @child_widget.
-
+Initialized @iter with the first position in the text buffer. This
+is the same as using gtk_text_buffer_get_iter_at_offset() to get
+the iter at character offset 0.
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #GtkLayout
-</parameter_description>
-</parameter>
-<parameter name="child_widget">
-<parameter_description> child widget
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> X position of child widget
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> Y position of child widget
+<parameter name="iter">
+<parameter_description> iterator to initialize
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tool_shell_get_ellipsize_mode">
+<function name="gtk_text_buffer_get_tag_table">
<description>
-Retrieves the current ellipsize mode for the tool shell. Tool items must not
-call this function directly, but rely on gtk_tool_item_get_ellipsize_mode()
-instead.
+Get the #GtkTextTagTable associated with this buffer.
-Since: 2.20
</description>
<parameters>
-<parameter name="shell">
-<parameter_description> a #GtkToolShell
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
</parameters>
-<return> the current ellipsize mode of @shell
-
+<return> the buffer's tag table
</return>
</function>
-<function name="gtk_notebook_set_homogeneous_tabs">
+<function name="gtk_text_buffer_get_text">
<description>
-Sets whether the tabs must have all the same size or not.
+Returns the text in the range [ start,@end). Excludes undisplayed
+text (text marked with tags that set the invisibility attribute) if
+ include_hidden_chars is %FALSE. Does not include characters
+representing embedded images, so byte and character indexes into
+the returned string do <emphasis>not</emphasis> correspond to byte
+and character indexes into the buffer. Contrast with
+gtk_text_buffer_get_slice().
+
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="homogeneous">
-<parameter_description> %TRUE if all tabs should be the same size.
+<parameter name="start">
+<parameter_description> start of a range
+</parameter_description>
+</parameter>
+<parameter name="end">
+<parameter_description> end of a range
+</parameter_description>
+</parameter>
+<parameter name="include_hidden_chars">
+<parameter_description> whether to include invisible text
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> an allocated UTF-8 string
+</return>
</function>
-<function name="gtk_parse_args">
+<function name="gtk_text_buffer_insert">
<description>
-Parses command line arguments, and initializes global
-attributes of GTK+, but does not actually open a connection
-to a display. (See gdk_display_open(), gdk_get_display_arg_name())
-
-Any arguments used by GTK+ or 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(), or gtk_init_check().
-
+Inserts @len bytes of @text at position @iter. If @len is -1,
+ text must be nul-terminated and will be inserted in its
+entirety. Emits the "insert-text" signal; insertion actually occurs
+in the default handler for the signal. @iter is invalidated when
+insertion occurs (because the buffer contents change), but the
+default signal handler revalidates it to point to the end of the
+inserted text.
</description>
<parameters>
-<parameter name="argc">
-<parameter_description> a pointer to the number of command line arguments.
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="argv">
-<parameter_description> a pointer to the array of command line arguments.
+<parameter name="iter">
+<parameter_description> a position in the buffer
+</parameter_description>
+</parameter>
+<parameter name="text">
+<parameter_description> text in UTF-8 format
+</parameter_description>
+</parameter>
+<parameter name="len">
+<parameter_description> length of text in bytes, or -1
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if initialization succeeded, otherwise %FALSE.
-</return>
+<return></return>
</function>
-<function name="gtk_color_selection_get_color">
+<function name="gtk_text_buffer_insert_at_cursor">
<description>
-Sets @color to be the current color in the GtkColorSelection widget.
-
-Deprecated: 2.0: Use gtk_color_selection_get_current_color() instead.
+Simply calls gtk_text_buffer_insert(), using the current
+cursor position as the insertion point.
</description>
<parameters>
-<parameter name="colorsel">
-<parameter_description> a #GtkColorSelection.
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> an array of 4 #gdouble to fill in with the current color.
+<parameter name="text">
+<parameter_description> text in UTF-8 format
+</parameter_description>
+</parameter>
+<parameter name="len">
+<parameter_description> length of text, in bytes
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_menu_set_title">
+<function name="gtk_text_buffer_insert_child_anchor">
<description>
-Sets the title string for the menu. The title is displayed when the menu
-is shown as a tearoff menu. If @title is %NULL, the menu will see if it is
-attached to a parent menu item, and if so it will try to use the same text as
-that menu item's label.
+Inserts a child widget anchor into the text buffer at @iter. The
+anchor will be counted as one character in character counts, and
+when obtaining the buffer contents as a string, will be represented
+by the Unicode "object replacement character" 0xFFFC. Note that the
+"slice" variants for obtaining portions of the buffer as a string
+include this character for child anchors, but the "text" variants do
+not. E.g. see gtk_text_buffer_get_slice() and
+gtk_text_buffer_get_text(). Consider
+gtk_text_buffer_create_child_anchor() as a more convenient
+alternative to this function. The buffer will add a reference to
+the anchor, so you can unref it after insertion.
</description>
<parameters>
-<parameter name="menu">
-<parameter_description> a #GtkMenu
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="title">
-<parameter_description> a string containing the title for the menu.
+<parameter name="iter">
+<parameter_description> location to insert the anchor
+</parameter_description>
+</parameter>
+<parameter name="anchor">
+<parameter_description> a #GtkTextChildAnchor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_toolbar_insert_stock">
+<function name="gtk_text_buffer_insert_interactive">
<description>
-Inserts a stock item at the specified position of the toolbar. If
- stock_id is not a known stock item ID, it's inserted verbatim,
-except that underscores used to mark mnemonics are removed.
+Like gtk_text_buffer_insert(), but the insertion will not occur if
+ iter is at a non-editable location in the buffer. Usually you
+want to prevent insertions at ineditable locations if the insertion
+results from a user action (is interactive).
- callback must be a pointer to a function taking a #GtkWidget and a gpointer as
-arguments. Use G_CALLBACK() to cast the function to #GCallback.
+ default_editable indicates the editability of text that doesn't
+have a tag affecting editability applied to it. Typically the
+result of gtk_text_view_get_editable() is appropriate here.
-Deprecated: 2.4: Use gtk_toolbar_insert() instead.
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> A #GtkToolbar
-</parameter_description>
-</parameter>
-<parameter name="stock_id">
-<parameter_description> The id of the stock item you want to insert
-</parameter_description>
-</parameter>
-<parameter name="tooltip_text">
-<parameter_description> The text in the tooltip of the toolbar button
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="tooltip_private_text">
-<parameter_description> The private text of the tooltip
+<parameter name="iter">
+<parameter_description> a position in @buffer
</parameter_description>
</parameter>
-<parameter name="callback">
-<parameter_description> The callback called when the toolbar button is clicked.
+<parameter name="text">
+<parameter_description> some UTF-8 text
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data passed to callback
+<parameter name="len">
+<parameter_description> length of text in bytes, or -1
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> The position the button shall be inserted at.
--1 means at the end.
+<parameter name="default_editable">
+<parameter_description> default editability of buffer
</parameter_description>
</parameter>
</parameters>
-<return> the inserted widget
-
+<return> whether text was actually inserted
</return>
</function>
-<function name="gtk_tree_model_sort_get_model">
+<function name="gtk_text_buffer_insert_interactive_at_cursor">
<description>
-Returns the model the #GtkTreeModelSort is sorting.
+Calls gtk_text_buffer_insert_interactive() at the cursor
+position.
+
+ default_editable indicates the editability of text that doesn't
+have a tag affecting editability applied to it. Typically the
+result of gtk_text_view_get_editable() is appropriate here.
</description>
<parameters>
-<parameter name="tree_model">
-<parameter_description> a #GtkTreeModelSort
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
+</parameter_description>
+</parameter>
+<parameter name="text">
+<parameter_description> text in UTF-8 format
+</parameter_description>
+</parameter>
+<parameter name="len">
+<parameter_description> length of text in bytes, or -1
+</parameter_description>
+</parameter>
+<parameter name="default_editable">
+<parameter_description> default editability of buffer
</parameter_description>
</parameter>
</parameters>
-<return> the "child model" being sorted
+<return> whether text was actually inserted
</return>
</function>
-<function name="gtk_text_view_set_right_margin">
+<function name="gtk_text_buffer_insert_pixbuf">
<description>
-Sets the default right margin for text in the text view.
-Tags in the buffer may override the default.
+Inserts an image into the text buffer at @iter. The image will be
+counted as one character in character counts, and when obtaining
+the buffer contents as a string, will be represented by the Unicode
+"object replacement character" 0xFFFC. Note that the "slice"
+variants for obtaining portions of the buffer as a string include
+this character for pixbufs, but the "text" variants do
+not. e.g. see gtk_text_buffer_get_slice() and
+gtk_text_buffer_get_text().
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="right_margin">
-<parameter_description> right margin in pixels
+<parameter name="iter">
+<parameter_description> location to insert the pixbuf
+</parameter_description>
+</parameter>
+<parameter name="pixbuf">
+<parameter_description> a #GdkPixbuf
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_source_get_size_wildcarded">
+<function name="gtk_text_buffer_insert_range">
<description>
-Gets the value set by gtk_icon_source_set_size_wildcarded().
+Copies text, tags, and pixbufs between @start and @end (the order
+of @start and @end doesn't matter) and inserts the copy at @iter.
+Used instead of simply getting/inserting text because it preserves
+images and tags. If @start and @end are in a different buffer from
+ buffer, the two buffers must share the same tag table.
+Implemented via emissions of the insert_text and apply_tag signals,
+so expect those.
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GtkIconSource
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> a position in @buffer
+</parameter_description>
+</parameter>
+<parameter name="start">
+<parameter_description> a position in a #GtkTextBuffer
+</parameter_description>
+</parameter>
+<parameter name="end">
+<parameter_description> another position in the same buffer as @start
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if this icon source is a base for any icon size variant
-</return>
+<return></return>
</function>
-<function name="gtk_tree_path_get_indices_with_depth">
+<function name="gtk_text_buffer_insert_range_interactive">
<description>
-Returns the current indices of @path.
-This is an array of integers, each representing a node in a tree.
-It also returns the number of elements in the array.
-The array should not be freed.
+Same as gtk_text_buffer_insert_range(), but does nothing if the
+insertion point isn't editable. The @default_editable parameter
+indicates whether the text is editable at @iter if no tags
+enclosing @iter affect editability. Typically the result of
+gtk_text_view_get_editable() is appropriate here.
-Since: 2.22
</description>
<parameters>
-<parameter name="path">
-<parameter_description> A #GtkTreePath.
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="depth">
-<parameter_description> Number of elements returned in the integer array
+<parameter name="iter">
+<parameter_description> a position in @buffer
+</parameter_description>
+</parameter>
+<parameter name="start">
+<parameter_description> a position in a #GtkTextBuffer
+</parameter_description>
+</parameter>
+<parameter name="end">
+<parameter_description> another position in the same buffer as @start
+</parameter_description>
+</parameter>
+<parameter name="default_editable">
+<parameter_description> default editability of the buffer
</parameter_description>
</parameter>
</parameters>
-<return> The current indices, or %NULL.
-
+<return> whether an insertion was possible at @iter
</return>
</function>
-<function name="gtk_paint_spinner">
+<function name="gtk_text_buffer_insert_with_tags">
<description>
-Draws a spinner on @window using the given parameters.
-
-Since: 2.20
+Inserts @text into @buffer at @iter, applying the list of tags to
+the newly-inserted text. The last tag specified must be NULL to
+terminate the list. Equivalent to calling gtk_text_buffer_insert(),
+then gtk_text_buffer_apply_tag() on the inserted text;
+gtk_text_buffer_insert_with_tags() is just a convenience function.
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="iter">
+<parameter_description> an iterator in @buffer
</parameter_description>
</parameter>
-<parameter name="state_type">
-<parameter_description> a state
+<parameter name="text">
+<parameter_description> UTF-8 text
</parameter_description>
</parameter>
-<parameter name="area">
-<parameter_description> clip rectangle, or %NULL if the
-output should not be clipped
+<parameter name="len">
+<parameter_description> length of @text, or -1
</parameter_description>
</parameter>
-<parameter name="widget">
-<parameter_description> the widget (may be %NULL)
+<parameter name="first_tag">
+<parameter_description> first tag to apply to @text
</parameter_description>
</parameter>
-<parameter name="detail">
-<parameter_description> a style detail (may be %NULL)
+<parameter name="Varargs">
+<parameter_description> NULL-terminated list of tags to apply
</parameter_description>
</parameter>
-<parameter name="step">
-<parameter_description> the nth step, a value between 0 and #GtkSpinner:num-steps
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_text_buffer_insert_with_tags_by_name">
+<description>
+Same as gtk_text_buffer_insert_with_tags(), but allows you
+to pass in tag names instead of tag objects.
+
+</description>
+<parameters>
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> the x origin of the rectangle in which to draw the spinner
+<parameter name="iter">
+<parameter_description> position in @buffer
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> the y origin of the rectangle in which to draw the spinner
+<parameter name="text">
+<parameter_description> UTF-8 text
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> the width of the rectangle in which to draw the spinner
+<parameter name="len">
+<parameter_description> length of @text, or -1
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> the height of the rectangle in which to draw the spinner
+<parameter name="first_tag_name">
+<parameter_description> name of a tag to apply to @text
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> more tag names
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_unix_dialog_set_settings">
+<function name="gtk_text_buffer_move_mark">
<description>
-Sets the #GtkPrintSettings for the #GtkPrintUnixDialog. Typically,
-this is used to restore saved print settings from a previous print
-operation before the print dialog is shown.
-
-Since: 2.10
+Moves @mark to the new location @where. Emits the "mark-set" signal
+as notification of the move.
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings, or %NULL
+<parameter name="mark">
+<parameter_description> a #GtkTextMark
+</parameter_description>
+</parameter>
+<parameter name="where">
+<parameter_description> new location for @mark in @buffer
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_notebook_get_tab_pos">
+<function name="gtk_text_buffer_move_mark_by_name">
<description>
-Gets the edge at which the tabs for switching pages in the
-notebook are drawn.
-
+Moves the mark named @name (which must exist) to location @where.
+See gtk_text_buffer_move_mark() for details.
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> name of a mark
+</parameter_description>
+</parameter>
+<parameter name="where">
+<parameter_description> new location for mark
</parameter_description>
</parameter>
</parameters>
-<return> the edge at which the tabs are drawn
-</return>
+<return></return>
</function>
-<function name="gtk_file_chooser_get_filenames">
+<function name="gtk_text_buffer_new">
<description>
-Lists all the selected files and subfolders in the current folder of
- chooser The returned names are full absolute paths. If files in the current
-folder cannot be represented as local filenames they will be ignored. (See
-gtk_file_chooser_get_uris())
+Creates a new text buffer.
-Since: 2.4
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="table">
+<parameter_description> a tag table, or %NULL to create a new one
</parameter_description>
</parameter>
</parameters>
-<return> a #GSList containing the filenames of all selected
-files and subfolders in the current folder. Free the returned list
-with g_slist_free(), and the filenames with g_free().
-
+<return> a new text buffer
</return>
</function>
-<function name="gtk_tree_view_get_cursor">
+<function name="gtk_text_buffer_paste_clipboard">
<description>
-Fills in @path and @focus_column with the current path and focus column. If
-the cursor isn't currently set, then * path will be %NULL. If no column
-currently has focus, then * focus_column will be %NULL.
-
-The returned #GtkTreePath must be freed with gtk_tree_path_free() when
-you are done with it.
+Pastes the contents of a clipboard at the insertion point, or
+at @override_location. (Note: pasting is asynchronous, that is,
+we'll ask for the paste data and return, and at some point later
+after the main loop runs, the paste data will be inserted.)
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> A pointer to be filled with the current cursor path, or %NULL
+<parameter name="clipboard">
+<parameter_description> the #GtkClipboard to paste from
</parameter_description>
</parameter>
-<parameter name="focus_column">
-<parameter_description> A pointer to be filled with the current focus column, or %NULL
+<parameter name="override_location">
+<parameter_description> location to insert pasted text, or %NULL for
+at the cursor
+</parameter_description>
+</parameter>
+<parameter name="default_editable">
+<parameter_description> whether the buffer is editable by default
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_calendar_freeze">
+<function name="gtk_text_buffer_place_cursor">
<description>
-Does nothing. Previously locked the display of the calendar until
-it was thawed with gtk_calendar_thaw().
-
-Deprecated: 2.8:
+This function moves the "insert" and "selection_bound" marks
+simultaneously. If you move them to the same place in two steps
+with gtk_text_buffer_move_mark(), you will temporarily select a
+region in between their old and new locations, which can be pretty
+inefficient since the temporarily-selected region will force stuff
+to be recalculated. This function moves them as a unit, which can
+be optimized.
</description>
<parameters>
-<parameter name="calendar">
-<parameter_description> a #GtkCalendar
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
+</parameter_description>
+</parameter>
+<parameter name="where">
+<parameter_description> where to put the cursor
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_model_get_iter_from_string">
+<function name="gtk_text_buffer_register_deserialize_format">
<description>
-Sets @iter to a valid iterator pointing to @path_string, if it
-exists. Otherwise, @iter is left invalid and %FALSE is returned.
+This function registers a rich text deserialization @function along with
+its @mime_type with the passed @buffer.
+Since: 2.10
</description>
<parameters>
-<parameter name="tree_model">
-<parameter_description> A #GtkTreeModel.
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> An uninitialized #GtkTreeIter.
+<parameter name="mime_type">
+<parameter_description> the format's mime-type
</parameter_description>
</parameter>
-<parameter name="path_string">
-<parameter_description> A string representation of a #GtkTreePath.
+<parameter name="function">
+<parameter_description> the deserialize function to register
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> @function's user_data
+</parameter_description>
+</parameter>
+<parameter name="user_data_destroy">
+<parameter_description> a function to call when @user_data is no longer needed
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE, if @iter was set.
+<return> the #GdkAtom that corresponds to the newly registered
+format's mime-type.
+
</return>
</function>
-<function name="gtk_event_box_get_visible_window">
+<function name="gtk_text_buffer_register_deserialize_tagset">
<description>
-Returns whether the event box has a visible window.
-See gtk_event_box_set_visible_window() for details.
+This function registers GTK+'s internal rich text serialization
+format with the passed @buffer. See
+gtk_text_buffer_register_serialize_tagset() for details.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="event_box">
-<parameter_description> a #GtkEventBox
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
+</parameter_description>
+</parameter>
+<parameter name="tagset_name">
+<parameter_description> an optional tagset name, on %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the event box window is visible
+<return> the #GdkAtom that corresponds to the newly registered
+format's mime-type.
</return>
</function>
-<function name="gtk_print_settings_set_number_up_layout">
+<function name="gtk_text_buffer_register_serialize_format">
<description>
-Sets the value of %GTK_PRINT_SETTINGS_NUMBER_UP_LAYOUT.
+This function registers a rich text serialization @function along with
+its @mime_type with the passed @buffer.
-Since: 2.14
+Since: 2.10
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="number_up_layout">
-<parameter_description> a #GtkNumberUpLayout value
+<parameter name="mime_type">
+<parameter_description> the format's mime-type
+</parameter_description>
+</parameter>
+<parameter name="function">
+<parameter_description> the serialize function to register
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> %function's user_data
+</parameter_description>
+</parameter>
+<parameter name="user_data_destroy">
+<parameter_description> a function to call when @user_data is no longer needed
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GdkAtom that corresponds to the newly registered
+format's mime-type.
+
+</return>
</function>
-<function name="gtk_range_set_increments">
+<function name="gtk_text_buffer_register_serialize_tagset">
<description>
-Sets the step and page sizes for the range.
-The step size is used when the user clicks the #GtkScrollbar
-arrows or moves #GtkScale via arrow keys. The page size
-is used for example when moving via Page Up or Page Down keys.
+This function registers GTK+'s internal rich text serialization
+format with the passed @buffer. The internal format does not comply
+to any standard rich text format and only works between #GtkTextBuffer
+instances. It is capable of serializing all of a text buffer's tags
+and embedded pixbufs.
+
+This function is just a wrapper around
+gtk_text_buffer_register_serialize_format(). The mime type used
+for registering is "application/x-gtk-text-buffer-rich-text", or
+"application/x-gtk-text-buffer-rich-text;format= tagset_name" if a
+ tagset_name was passed.
+
+The @tagset_name can be used to restrict the transfer of rich text
+to buffers with compatible sets of tags, in order to avoid unknown
+tags from being pasted. It is probably the common case to pass an
+identifier != %NULL here, since the %NULL tagset requires the
+receiving buffer to deal with with pasting of arbitrary tags.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="range">
-<parameter_description> a #GtkRange
-</parameter_description>
-</parameter>
-<parameter name="step">
-<parameter_description> step size
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="page">
-<parameter_description> page size
+<parameter name="tagset_name">
+<parameter_description> an optional tagset name, on %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GdkAtom that corresponds to the newly registered
+format's mime-type.
+
+</return>
</function>
-<function name="gtk_progress_bar_set_pulse_step">
+<function name="gtk_text_buffer_remove_all_tags">
<description>
-Sets the fraction of total progress bar length to move the
-bouncing block for each call to gtk_progress_bar_pulse().
+Removes all tags in the range between @start and @end. Be careful
+with this function; it could remove tags added in code unrelated to
+the code you're currently writing. That is, using this function is
+probably a bad idea if you have two or more unrelated code sections
+that add tags.
</description>
<parameters>
-<parameter name="pbar">
-<parameter_description> a #GtkProgressBar
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="fraction">
-<parameter_description> fraction between 0.0 and 1.0
+<parameter name="start">
+<parameter_description> one bound of range to be untagged
+</parameter_description>
+</parameter>
+<parameter name="end">
+<parameter_description> other bound of range to be untagged
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_is_drawable">
+<function name="gtk_text_buffer_remove_selection_clipboard">
<description>
-Determines whether @widget can be drawn to. A widget can be drawn
-to if it is mapped and visible.
-
-Since: 2.18
+Removes a #GtkClipboard added with
+gtk_text_buffer_add_selection_clipboard().
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
+</parameter_description>
+</parameter>
+<parameter name="clipboard">
+<parameter_description> a #GtkClipboard added to @buffer by
+gtk_text_buffer_add_selection_clipboard()
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @widget is drawable, %FALSE otherwise
-
-</return>
+<return></return>
</function>
-<function name="gtk_item_factory_from_widget">
+<function name="gtk_text_buffer_remove_tag">
<description>
-Obtains the item factory from which a widget was created.
-
-Deprecated: 2.4: Use #GtkUIManager instead.
+Emits the "remove-tag" signal. The default handler for the signal
+removes all occurrences of @tag from the given range. @start and
+ end don't have to be in order.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a widget
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
+</parameter_description>
+</parameter>
+<parameter name="tag">
+<parameter_description> a #GtkTextTag
+</parameter_description>
+</parameter>
+<parameter name="start">
+<parameter_description> one bound of range to be untagged
+</parameter_description>
+</parameter>
+<parameter name="end">
+<parameter_description> other bound of range to be untagged
</parameter_description>
</parameter>
</parameters>
-<return> the item factory from which @widget was created, or %NULL
-</return>
+<return></return>
</function>
-<function name="gtk_drag_set_icon_stock">
+<function name="gtk_text_buffer_remove_tag_by_name">
<description>
-Sets the icon for a given drag from a stock ID.
+Calls gtk_text_tag_table_lookup() on the buffer's tag table to
+get a #GtkTextTag, then calls gtk_text_buffer_remove_tag().
</description>
<parameters>
-<parameter name="context">
-<parameter_description> the context for a drag. (This must be called
-with a context for the source side of a drag)
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="stock_id">
-<parameter_description> the ID of the stock icon to use for the drag.
+<parameter name="name">
+<parameter_description> name of a #GtkTextTag
</parameter_description>
</parameter>
-<parameter name="hot_x">
-<parameter_description> the X offset within the icon of the hotspot.
+<parameter name="start">
+<parameter_description> one bound of range to be untagged
</parameter_description>
</parameter>
-<parameter name="hot_y">
-<parameter_description> the Y offset within the icon of the hotspot.
+<parameter name="end">
+<parameter_description> other bound of range to be untagged
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_entry_set_cursor_hadjustment">
+<function name="gtk_text_buffer_select_range">
<description>
-Hooks up an adjustment to the cursor position in an entry, so that when
-the cursor is moved, the adjustment is scrolled to show that position.
-See gtk_scrolled_window_get_hadjustment() for a typical way of obtaining
-the adjustment.
-
-The adjustment has to be in pixel units and in the same coordinate system
-as the entry.
+This function moves the "insert" and "selection_bound" marks
+simultaneously. If you move them in two steps
+with gtk_text_buffer_move_mark(), you will temporarily select a
+region in between their old and new locations, which can be pretty
+inefficient since the temporarily-selected region will force stuff
+to be recalculated. This function moves them as a unit, which can
+be optimized.
-Since: 2.12
+Since: 2.4
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="adjustment">
-<parameter_description> an adjustment which should be adjusted when the cursor
-is moved, or %NULL
+<parameter name="ins">
+<parameter_description> where to put the "insert" mark
+</parameter_description>
+</parameter>
+<parameter name="bound">
+<parameter_description> where to put the "selection_bound" mark
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_action_get_sensitive">
+<function name="gtk_text_buffer_serialize">
<description>
-Returns whether the action itself is sensitive. Note that this doesn't
-necessarily mean effective sensitivity. See gtk_action_is_sensitive()
-for that.
+This function serializes the portion of text between @start
+and @end in the rich text format represented by @format.
-Since: 2.4
+ format<!-- -->s to be used must be registered using
+gtk_text_buffer_register_serialize_format() or
+gtk_text_buffer_register_serialize_tagset() beforehand.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="action">
-<parameter_description> the action object
+<parameter name="register_buffer">
+<parameter_description> the #GtkTextBuffer @format is registered with
+</parameter_description>
+</parameter>
+<parameter name="content_buffer">
+<parameter_description> the #GtkTextBuffer to serialize
+</parameter_description>
+</parameter>
+<parameter name="format">
+<parameter_description> the rich text format to use for serializing
+</parameter_description>
+</parameter>
+<parameter name="start">
+<parameter_description> start of block of text to serialize
+</parameter_description>
+</parameter>
+<parameter name="end">
+<parameter_description> end of block of test to serialize
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> return location for the length of the serialized data
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the action itself is sensitive.
+<return> the serialized data, encoded as @format
</return>
</function>
-<function name="gtk_frame_set_label_widget">
+<function name="gtk_text_buffer_set_mark">
<description>
-Sets the label widget for the frame. This is the widget that
-will appear embedded in the top edge of the frame as a
-title.
+Move the mark to the given position, if not @should_exist,
+create the mark.
+
</description>
<parameters>
-<parameter name="frame">
-<parameter_description> a #GtkFrame
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="label_widget">
-<parameter_description> the new label widget
+<parameter name="mark_name">
+<parameter_description> name of the mark
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> location for the mark
+</parameter_description>
+</parameter>
+<parameter name="left_gravity">
+<parameter_description> if the mark is created by this function, gravity for
+the new mark
+</parameter_description>
+</parameter>
+<parameter name="should_exist">
+<parameter_description> if %TRUE, warn if the mark does not exist, and return
+immediately
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> mark
+</return>
</function>
-<function name="gtk_clipboard_wait_is_rich_text_available">
+<function name="gtk_text_buffer_set_modified">
<description>
-Test to see if there is rich text available to be pasted
-This is done by requesting the TARGETS atom and checking
-if it contains any of the supported rich text targets. This function
-waits for the data to be received using the main loop, so events,
-timeouts, etc, may be dispatched during the wait.
-
-This function is a little faster than calling
-gtk_clipboard_wait_for_rich_text() since it doesn't need to retrieve
-the actual text.
-
-Since: 2.10
+Used to keep track of whether the buffer has been modified since the
+last time it was saved. Whenever the buffer is saved to disk, call
+gtk_text_buffer_set_modified (@buffer, FALSE). When the buffer is modified,
+it will automatically toggled on the modified bit again. When the modified
+bit flips, the buffer emits a "modified-changed" signal.
</description>
<parameters>
-<parameter name="clipboard">
-<parameter_description> a #GtkClipboard
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="setting">
+<parameter_description> modification flag setting
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE is there is rich text available, %FALSE otherwise.
-
-</return>
+<return></return>
</function>
-<function name="gtk_icon_set_get_sizes">
+<function name="gtk_text_buffer_set_text">
<description>
-Obtains a list of icon sizes this icon set can render. The returned
-array must be freed with g_free().
+Deletes current contents of @buffer, and inserts @text instead. If
+ len is -1, @text must be nul-terminated. @text must be valid UTF-8.
</description>
<parameters>
-<parameter name="icon_set">
-<parameter_description> a #GtkIconSet
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="sizes">
-<parameter_description> return location
-for array of sizes
+<parameter name="text">
+<parameter_description> UTF-8 text to insert
</parameter_description>
</parameter>
-<parameter name="n_sizes">
-<parameter_description> location to store number of elements in returned array
+<parameter name="len">
+<parameter_description> length of @text in bytes
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_font_selection_get_face_list">
+<function name="gtk_text_buffer_unregister_deserialize_format">
<description>
-This returns the #GtkTreeView which lists all styles available for
-the selected font. For example, 'Regular', 'Bold', etc.
+This function unregisters a rich text format that was previously
+registered using gtk_text_buffer_register_deserialize_format() or
+gtk_text_buffer_register_deserialize_tagset().
-Since: 2.14
+Since: 2.10
</description>
<parameters>
-<parameter name="fontsel">
-<parameter_description> a #GtkFontSelection
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
+</parameter_description>
+</parameter>
+<parameter name="format">
+<parameter_description> a #GdkAtom representing a registered rich text format.
</parameter_description>
</parameter>
</parameters>
-<return> A #GtkWidget that is part of @fontsel
-
-</return>
+<return></return>
</function>
-<function name="gtk_table_get_size">
+<function name="gtk_text_buffer_unregister_serialize_format">
<description>
-Returns the number of rows and columns in the table.
+This function unregisters a rich text format that was previously
+registered using gtk_text_buffer_register_serialize_format() or
+gtk_text_buffer_register_serialize_tagset()
-Since: 2.22
+Since: 2.10
</description>
<parameters>
-<parameter name="table">
-<parameter_description> a #GtkTable
-</parameter_description>
-</parameter>
-<parameter name="rows">
-<parameter_description> return location for the number of
-rows, or %NULL
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
-<parameter name="columns">
-<parameter_description> return location for the number
-of columns, or %NULL
+<parameter name="format">
+<parameter_description> a #GdkAtom representing a registered rich text format.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_item_factory_get_item_by_action">
+<function name="gtk_text_child_anchor_get_deleted">
<description>
-Obtains the menu item which was constructed from the first
-#GtkItemFactoryEntry with the given @action.
+Determines whether a child anchor has been deleted from
+the buffer. Keep in mind that the child anchor will be
+unreferenced when removed from the buffer, so you need to
+hold your own reference (with g_object_ref()) if you plan
+to use this function — otherwise all deleted child anchors
+will also be finalized.
-Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="ifactory">
-<parameter_description> a #GtkItemFactory
-</parameter_description>
-</parameter>
-<parameter name="action">
-<parameter_description> an action as specified in the @callback_action field
-of #GtkItemFactoryEntry
+<parameter name="anchor">
+<parameter_description> a #GtkTextChildAnchor
</parameter_description>
</parameter>
</parameters>
-<return> the menu item which corresponds to the given action, or %NULL
-if no menu item was found
+<return> %TRUE if the child anchor has been deleted from its buffer
</return>
</function>
-<function name="gtk_image_menu_item_get_use_stock">
+<function name="gtk_text_child_anchor_get_widgets">
<description>
-Checks whether the label set in the menuitem is used as a
-stock id to select the stock item for the item.
+Gets a list of all widgets anchored at this child anchor.
+The returned list should be freed with g_list_free().
+
-Since: 2.16
</description>
<parameters>
-<parameter name="image_menu_item">
-<parameter_description> a #GtkImageMenuItem
+<parameter name="anchor">
+<parameter_description> a #GtkTextChildAnchor
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the label set in the menuitem is used as a
-stock id to select the stock item for the item
-
+<return> list of widgets anchored at @anchor
</return>
</function>
-<function name="gtk_printer_get_state_message">
+<function name="gtk_text_child_anchor_new">
<description>
-Returns the state message describing the current state
-of the printer.
+Creates a new #GtkTextChildAnchor. Usually you would then insert
+it into a #GtkTextBuffer with gtk_text_buffer_insert_child_anchor().
+To perform the creation and insertion in one step, use the
+convenience function gtk_text_buffer_create_child_anchor().
-Since: 2.10
</description>
<parameters>
-<parameter name="printer">
-<parameter_description> a #GtkPrinter
-</parameter_description>
-</parameter>
</parameters>
-<return> the state message of @printer
-
+<return> a new #GtkTextChildAnchor
</return>
</function>
-<function name="gtk_action_get_stock_id">
+<function name="gtk_text_iter_backward_char">
<description>
-Gets the stock id of @action.
+Moves backward by one character offset. Returns %TRUE if movement
+was possible; if @iter was the first in the buffer (character
+offset 0), gtk_text_iter_backward_char () returns %FALSE for convenience when
+writing loops.
-Since: 2.16
</description>
<parameters>
-<parameter name="action">
-<parameter_description> a #GtkAction
+<parameter name="iter">
+<parameter_description> an iterator
</parameter_description>
</parameter>
</parameters>
-<return> the stock id
-
+<return> whether movement was possible
</return>
</function>
-<function name="gtk_container_remove">
+<function name="gtk_text_iter_backward_chars">
<description>
-Removes @widget from @container. @widget must be inside @container.
-Note that @container will own a reference to @widget, and that this
-may be the last reference held; so removing a widget from its
-container can destroy that widget. If you want to use @widget
-again, you need to add a reference to it while it's not inside
-a container, using g_object_ref(). If you don't want to use @widget
-again it's usually more efficient to simply destroy it directly
-using gtk_widget_destroy() since this will remove it from the
-container and help break any circular reference count cycles.
+Moves @count characters backward, if possible (if @count would move
+past the start or end of the buffer, moves to the start or end of
+the buffer). The return value indicates whether the iterator moved
+onto a dereferenceable position; if the iterator didn't move, or
+moved onto the end iterator, then %FALSE is returned. If @count is 0,
+the function does nothing and returns %FALSE.
+
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
+<parameter name="iter">
+<parameter_description> an iterator
</parameter_description>
</parameter>
-<parameter name="widget">
-<parameter_description> a current child of @container
+<parameter name="count">
+<parameter_description> number of characters to move
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether @iter moved and is dereferenceable
+
+</return>
</function>
-<function name="gtk_print_context_get_pango_fontmap">
+<function name="gtk_text_iter_backward_cursor_position">
<description>
-Returns a #PangoFontMap that is suitable for use
-with the #GtkPrintContext.
+Like gtk_text_iter_forward_cursor_position(), but moves backward.
-Since: 2.10
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GtkPrintContext
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return> the font map of @context
-
+<return> %TRUE if we moved
</return>
</function>
-<function name="gtk_print_context_get_width">
+<function name="gtk_text_iter_backward_cursor_positions">
<description>
-Obtains the width of the #GtkPrintContext, in pixels.
+Moves up to @count cursor positions. See
+gtk_text_iter_forward_cursor_position() for details.
-Since: 2.10
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GtkPrintContext
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
+</parameter_description>
+</parameter>
+<parameter name="count">
+<parameter_description> number of positions to move
</parameter_description>
</parameter>
</parameters>
-<return> the width of @context
-
+<return> %TRUE if we moved and the new position is dereferenceable
</return>
</function>
-<function name="gtk_print_settings_get_default_source">
+<function name="gtk_text_iter_backward_find_char">
<description>
-Gets the value of %GTK_PRINT_SETTINGS_DEFAULT_SOURCE.
+Same as gtk_text_iter_forward_find_char(), but goes backward from @iter.
-Since: 2.10
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
+</parameter_description>
+</parameter>
+<parameter name="pred">
+<parameter_description> function to be called on each character
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data for @pred
+</parameter_description>
+</parameter>
+<parameter name="limit">
+<parameter_description> search limit, or %NULL for none
</parameter_description>
</parameter>
</parameters>
-<return> the default source
-
+<return> whether a match was found
</return>
</function>
-<function name="gtk_window_get_screen">
+<function name="gtk_text_iter_backward_line">
<description>
-Returns the #GdkScreen associated with @window.
+Moves @iter to the start of the previous line. Returns %TRUE if
+ iter could be moved; i.e. if @iter was at character offset 0, this
+function returns %FALSE. Therefore if @iter was already on line 0,
+but not at the start of the line, @iter is snapped to the start of
+the line and the function returns %TRUE. (Note that this implies that
+in a loop calling this function, the line number may not change on
+every iteration, if your first iteration is on line 0.)
-Since: 2.2
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow.
+<parameter name="iter">
+<parameter_description> an iterator
</parameter_description>
</parameter>
</parameters>
-<return> a #GdkScreen.
-
+<return> whether @iter moved
</return>
</function>
-<function name="gtk_tool_item_group_set_label">
+<function name="gtk_text_iter_backward_lines">
<description>
-Sets the label of the tool item group. The label is displayed in the header
-of the group.
+Moves @count lines backward, if possible (if @count would move
+past the start or end of the buffer, moves to the start or end of
+the buffer). The return value indicates whether the iterator moved
+onto a dereferenceable position; if the iterator didn't move, or
+moved onto the end iterator, then %FALSE is returned. If @count is 0,
+the function does nothing and returns %FALSE. If @count is negative,
+moves forward by 0 - @count lines.
-Since: 2.20
</description>
<parameters>
-<parameter name="group">
-<parameter_description> a #GtkToolItemGroup
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
-<parameter name="label">
-<parameter_description> the new human-readable label of of the group
+<parameter name="count">
+<parameter_description> number of lines to move backward
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether @iter moved and is dereferenceable
+</return>
</function>
-<function name="gtk_info_bar_add_button">
+<function name="gtk_text_iter_backward_search">
<description>
-Adds a button with the given text (or a stock button, if button_text
-is a stock ID) and sets things up so that clicking the button will emit
-the "response" signal with the given response_id. The button is appended
-to the end of the info bars's action area. The button widget is
-returned, but usually you don't need it.
+Same as gtk_text_iter_forward_search(), but moves backward.
-Since: 2.18
</description>
<parameters>
-<parameter name="info_bar">
-<parameter_description> a #GtkInfoBar
+<parameter name="iter">
+<parameter_description> a #GtkTextIter where the search begins
</parameter_description>
</parameter>
-<parameter name="button_text">
-<parameter_description> text of button, or stock ID
+<parameter name="str">
+<parameter_description> search string
</parameter_description>
</parameter>
-<parameter name="response_id">
-<parameter_description> response ID for the button
+<parameter name="flags">
+<parameter_description> bitmask of flags affecting the search
</parameter_description>
</parameter>
-</parameters>
-<return> the button widget that was added
-
-</return>
-</function>
-
-<function name="gtk_image_get_pixmap">
-<description>
-Gets the pixmap and mask being displayed by the #GtkImage.
-The storage type of the image must be %GTK_IMAGE_EMPTY or
-%GTK_IMAGE_PIXMAP (see gtk_image_get_storage_type()).
-The caller of this function does not own a reference to the
-returned pixmap and mask.
-
-</description>
-<parameters>
-<parameter name="image">
-<parameter_description> a #GtkImage
+<parameter name="match_start">
+<parameter_description> return location for start of match, or %NULL
</parameter_description>
</parameter>
-<parameter name="pixmap">
-<parameter_description> location to store the
-pixmap, or %NULL
+<parameter name="match_end">
+<parameter_description> return location for end of match, or %NULL
</parameter_description>
</parameter>
-<parameter name="mask">
-<parameter_description> location to store the
-mask, or %NULL
+<parameter name="limit">
+<parameter_description> location of last possible @match_start, or %NULL for start of buffer
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether a match was found
+</return>
</function>
-<function name="gtk_tool_palette_set_drag_source">
+<function name="gtk_text_iter_backward_sentence_start">
<description>
-Sets the tool palette as a drag source.
-Enables all groups and items in the tool palette as drag sources
-on button 1 and button 3 press with copy and move actions.
-See gtk_drag_source_set().
+Moves backward to the previous sentence start; if @iter is already at
+the start of a sentence, moves backward to the next one. Sentence
+boundaries are determined by Pango and should be correct for nearly
+any language (if not, the correct fix would be to the Pango text
+boundary algorithms).
-Since: 2.20
</description>
<parameters>
-<parameter name="palette">
-<parameter_description> a #GtkToolPalette
-</parameter_description>
-</parameter>
-<parameter name="targets">
-<parameter_description> the #GtkToolPaletteDragTarget<!-- -->s
-which the widget should support
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @iter moved and is not the end iterator
+</return>
</function>
-<function name="gtk_status_icon_get_storage_type">
+<function name="gtk_text_iter_backward_sentence_starts">
<description>
-Gets the type of representation being used by the #GtkStatusIcon
-to store image data. If the #GtkStatusIcon has no image data,
-the return value will be %GTK_IMAGE_EMPTY.
+Calls gtk_text_iter_backward_sentence_start() up to @count times,
+or until it returns %FALSE. If @count is negative, moves forward
+instead of backward.
-Since: 2.10
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
+</parameter_description>
+</parameter>
+<parameter name="count">
+<parameter_description> number of sentences to move
</parameter_description>
</parameter>
</parameters>
-<return> the image representation being used
-
+<return> %TRUE if @iter moved and is not the end iterator
</return>
</function>
-<function name="gtk_accel_map_unlock_path">
+<function name="gtk_text_iter_backward_to_tag_toggle">
<description>
-Undoes the last call to gtk_accel_map_lock_path() on this @accel_path.
-Refer to gtk_accel_map_lock_path() for information about accelerator path locking.
+Moves backward to the next toggle (on or off) of the
+#GtkTextTag @tag, or to the next toggle of any tag if
+ tag is %NULL. If no matching tag toggles are found,
+returns %FALSE, otherwise %TRUE. Does not return toggles
+located at @iter, only toggles before @iter. Sets @iter
+to the location of the toggle, or the start of the buffer
+if no toggle is found.
-Since: 2.4
</description>
<parameters>
-<parameter name="accel_path">
-<parameter_description> a valid accelerator path
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
+</parameter_description>
+</parameter>
+<parameter name="tag">
+<parameter_description> a #GtkTextTag, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether we found a tag toggle before @iter
+</return>
</function>
-<function name="gtk_tree_view_set_tooltip_column">
+<function name="gtk_text_iter_backward_visible_cursor_position">
<description>
-If you only plan to have simple (text-only) tooltips on full rows, you
-can use this function to have #GtkTreeView handle these automatically
-for you. @column should be set to the column in @tree_view's model
-containing the tooltip texts, or -1 to disable this feature.
-
-When enabled, #GtkWidget::has-tooltip will be set to %TRUE and
- tree_view will connect a #GtkWidget::query-tooltip signal handler.
-
-Note that the signal handler sets the text with gtk_tooltip_set_markup(),
-so &, <, etc have to be escaped in the text.
+Moves @iter forward to the previous visible cursor position. See
+gtk_text_iter_backward_cursor_position() for details.
-Since: 2.12
+Since: 2.4
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
-</parameter_description>
-</parameter>
-<parameter name="column">
-<parameter_description> an integer, which is a valid column number for @tree_view's model
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if we moved and the new position is dereferenceable
+
+</return>
</function>
-<function name="gtk_im_context_set_client_window">
+<function name="gtk_text_iter_backward_visible_cursor_positions">
<description>
-Set the client window for the input context; this is the
-#GdkWindow in which the input appears. This window is
-used in order to correctly position status windows, and may
-also be used for purposes internal to the input method.
+Moves up to @count visible cursor positions. See
+gtk_text_iter_backward_cursor_position() for details.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GtkIMContext
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
-<parameter name="window">
-<parameter_description> the client window. This may be %NULL to indicate
-that the previous client window no longer exists.
+<parameter name="count">
+<parameter_description> number of positions to move
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if we moved and the new position is dereferenceable
+
+</return>
</function>
-<function name="gtk_tool_item_set_visible_vertical">
+<function name="gtk_text_iter_backward_visible_line">
<description>
-Sets whether @tool_item is visible when the toolbar is docked
-vertically. Some tool items, such as text entries, are too wide to be
-useful on a vertically docked toolbar. If @visible_vertical is %FALSE
- tool_item will not appear on toolbars that are docked vertically.
+Moves @iter to the start of the previous visible line. Returns %TRUE if
+ iter could be moved; i.e. if @iter was at character offset 0, this
+function returns %FALSE. Therefore if @iter was already on line 0,
+but not at the start of the line, @iter is snapped to the start of
+the line and the function returns %TRUE. (Note that this implies that
+in a loop calling this function, the line number may not change on
+every iteration, if your first iteration is on line 0.)
-Since: 2.4
+Since: 2.8
</description>
<parameters>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem
-</parameter_description>
-</parameter>
-<parameter name="visible_vertical">
-<parameter_description> whether @tool_item is visible when the toolbar
-is in vertical mode
+<parameter name="iter">
+<parameter_description> an iterator
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether @iter moved
+
+</return>
</function>
-<function name="gtk_widget_set_parent">
+<function name="gtk_text_iter_backward_visible_lines">
<description>
-This function is useful only when implementing subclasses of
-#GtkContainer.
-Sets the container as the parent of @widget, and takes care of
-some details such as updating the state and style of the child
-to reflect its new location. The opposite function is
-gtk_widget_unparent().
+Moves @count visible lines backward, if possible (if @count would move
+past the start or end of the buffer, moves to the start or end of
+the buffer). The return value indicates whether the iterator moved
+onto a dereferenceable position; if the iterator didn't move, or
+moved onto the end iterator, then %FALSE is returned. If @count is 0,
+the function does nothing and returns %FALSE. If @count is negative,
+moves forward by 0 - @count lines.
+
+Since: 2.8
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
-<parameter name="parent">
-<parameter_description> parent container
+<parameter name="count">
+<parameter_description> number of lines to move backward
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether @iter moved and is dereferenceable
+
+</return>
</function>
-<function name="gtk_radio_button_new_with_mnemonic_from_widget">
+<function name="gtk_text_iter_backward_visible_word_start">
<description>
-Creates a new #GtkRadioButton containing a label. The label
-will be created using gtk_label_new_with_mnemonic(), so underscores
-in @label indicate the mnemonic for the button.
+Moves backward to the previous visible word start. (If @iter is currently
+on a word start, moves backward to the next one after that.) Word breaks
+are determined by Pango and should be correct for nearly any
+language (if not, the correct fix would be to the Pango word break
+algorithms).
+
+Since: 2.4
</description>
<parameters>
-<parameter name="radio_group_member">
-<parameter_description> widget to get radio group from or %NULL
-</parameter_description>
-</parameter>
-<parameter name="label">
-<parameter_description> the text of the button, with an underscore in front of the
-mnemonic character
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkRadioButton
+<return> %TRUE if @iter moved and is not the end iterator
+
</return>
</function>
-<function name="gtk_paint_slider">
+<function name="gtk_text_iter_backward_visible_word_starts">
<description>
-Draws a slider in the given rectangle on @window using the
-given style and orientation.
+Calls gtk_text_iter_backward_visible_word_start() up to @count times.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
-</parameter_description>
-</parameter>
-<parameter name="shadow_type">
-<parameter_description> a shadow
-</parameter_description>
-</parameter>
-<parameter name="area">
-<parameter_description> clip rectangle, or %NULL if the
-output should not be clipped
-</parameter_description>
-</parameter>
-<parameter name="widget">
-<parameter_description> the widget
-</parameter_description>
-</parameter>
-<parameter name="detail">
-<parameter_description> a style detail
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> the x origin of the rectangle in which to draw a slider
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> the y origin of the rectangle in which to draw a slider
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> the width of the rectangle in which to draw a slider
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> the height of the rectangle in which to draw a slider
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
-<parameter name="orientation">
-<parameter_description> the orientation to be used
+<parameter name="count">
+<parameter_description> number of times to move
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @iter moved and is not the end iterator
+
+</return>
</function>
-<function name="gtk_status_icon_set_from_gicon">
+<function name="gtk_text_iter_backward_word_start">
<description>
-Makes @status_icon display the #GIcon.
-See gtk_status_icon_new_from_gicon() for details.
+Moves backward to the previous word start. (If @iter is currently on a
+word start, moves backward to the next one after that.) Word breaks
+are determined by Pango and should be correct for nearly any
+language (if not, the correct fix would be to the Pango word break
+algorithms).
-Since: 2.14
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
-</parameter_description>
-</parameter>
-<parameter name="icon">
-<parameter_description> a GIcon
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @iter moved and is not the end iterator
+</return>
</function>
-<function name="gtk_table_get_homogeneous">
+<function name="gtk_text_iter_backward_word_starts">
<description>
-Returns whether the table cells are all constrained to the same
-width and height. (See gtk_table_set_homogenous ())
+Calls gtk_text_iter_backward_word_start() up to @count times.
</description>
<parameters>
-<parameter name="table">
-<parameter_description> a #GtkTable
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
+</parameter_description>
+</parameter>
+<parameter name="count">
+<parameter_description> number of times to move
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the cells are all constrained to the same size
+<return> %TRUE if @iter moved and is not the end iterator
</return>
</function>
-<function name="gtk_tree_model_row_deleted">
+<function name="gtk_text_iter_begins_tag">
<description>
-Emits the "row-deleted" signal on @tree_model. This should be called by
-models after a row has been removed. The location pointed to by @path
-should be the location that the row previously was at. It may not be a
-valid location anymore.
+Returns %TRUE if @tag is toggled on at exactly this point. If @tag
+is %NULL, returns %TRUE if any tag is toggled on at this point. Note
+that the gtk_text_iter_begins_tag () returns %TRUE if @iter is the
+<emphasis>start</emphasis> of the tagged range;
+gtk_text_iter_has_tag () tells you whether an iterator is
+<emphasis>within</emphasis> a tagged range.
+
</description>
<parameters>
-<parameter name="tree_model">
-<parameter_description> A #GtkTreeModel
+<parameter name="iter">
+<parameter_description> an iterator
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> A #GtkTreePath pointing to the previous location of the deleted row.
+<parameter name="tag">
+<parameter_description> a #GtkTextTag, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether @iter is the start of a range tagged with @tag
+</return>
</function>
-<function name="gtk_window_set_default_icon_name">
+<function name="gtk_text_iter_can_insert">
<description>
-Sets an icon to be used as fallback for windows that haven't
-had gtk_window_set_icon_list() called on them from a named
-themed icon, see gtk_window_set_icon_name().
+Considering the default editability of the buffer, and tags that
+affect editability, determines whether text inserted at @iter would
+be editable. If text inserted at @iter would be editable then the
+user should be allowed to insert text at @iter.
+gtk_text_buffer_insert_interactive() uses this function to decide
+whether insertions are allowed at a given position.
-Since: 2.6
</description>
<parameters>
-<parameter name="name">
-<parameter_description> the name of the themed icon
+<parameter name="iter">
+<parameter_description> an iterator
+</parameter_description>
+</parameter>
+<parameter name="default_editability">
+<parameter_description> %TRUE if text is editable by default
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether text inserted at @iter would be editable
+</return>
</function>
-<function name="gtk_icon_view_set_item_orientation">
+<function name="gtk_text_iter_compare">
<description>
-Sets the ::item-orientation property which determines whether
-the labels are drawn beside the icons instead of below.
+A qsort()-style function that returns negative if @lhs is less than
+ rhs, positive if @lhs is greater than @rhs, and 0 if they're equal.
+Ordering is in character offset order, i.e. the first character in the buffer
+is less than the second character in the buffer.
-Since: 2.22
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
+<parameter name="lhs">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
-<parameter name="orientation">
-<parameter_description> the relative position of texts and icons
+<parameter name="rhs">
+<parameter_description> another #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> -1 if @lhs is less than @rhs, 1 if @lhs is greater, 0 if they are equal
+</return>
</function>
-<function name="gtk_tool_item_group_get_ellipsize">
+<function name="gtk_text_iter_copy">
<description>
-Gets the ellipsization mode of @group.
+Creates a dynamically-allocated copy of an iterator. This function
+is not useful in applications, because iterators can be copied with a
+simple assignment (<literal>GtkTextIter i = j;</literal>). The
+function is used by language bindings.
-Since: 2.20
</description>
<parameters>
-<parameter name="group">
-<parameter_description> a #GtkToolItemGroup
+<parameter name="iter">
+<parameter_description> an iterator
</parameter_description>
</parameter>
</parameters>
-<return> the #PangoEllipsizeMode of @group
-
+<return> a copy of the @iter, free with gtk_text_iter_free ()
</return>
</function>
-<function name="gtk_about_dialog_set_logo_icon_name">
+<function name="gtk_text_iter_editable">
<description>
-Sets the pixbuf to be displayed as logo in the about dialog.
-If it is %NULL, the default window icon set with
-gtk_window_set_default_icon() will be used.
+Returns whether the character at @iter is within an editable region
+of text. Non-editable text is "locked" and can't be changed by the
+user via #GtkTextView. This function is simply a convenience
+wrapper around gtk_text_iter_get_attributes (). If no tags applied
+to this text affect editability, @default_setting will be returned.
+
+You don't want to use this function to decide whether text can be
+inserted at @iter, because for insertion you don't want to know
+whether the char at @iter is inside an editable range, you want to
+know whether a new character inserted at @iter would be inside an
+editable range. Use gtk_text_iter_can_insert() to handle this
+case.
-Since: 2.6
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter name="iter">
+<parameter_description> an iterator
</parameter_description>
</parameter>
-<parameter name="icon_name">
-<parameter_description> an icon name, or %NULL
+<parameter name="default_setting">
+<parameter_description> %TRUE if text is editable by default
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether @iter is inside an editable range
+</return>
</function>
-<function name="gtk_icon_view_get_selected_items">
+<function name="gtk_text_iter_ends_line">
<description>
-Creates a list of paths of all selected items. Additionally, if you are
-planning on modifying the model after calling this function, you may
-want to convert the returned list into a list of #GtkTreeRowReference<!-- -->s.
-To do this, you can use gtk_tree_row_reference_new().
-
-To free the return value, use:
-|[
-g_list_foreach (list, (GFunc)gtk_tree_path_free, NULL);
-g_list_free (list);
-]|
+Returns %TRUE if @iter points to the start of the paragraph
+delimiter characters for a line (delimiters will be either a
+newline, a carriage return, a carriage return followed by a
+newline, or a Unicode paragraph separator character). Note that an
+iterator pointing to the \n of a \r\n pair will not be counted as
+the end of a line, the line ends before the \r. The end iterator is
+considered to be at the end of a line, even though there are no
+paragraph delimiter chars there.
-Since: 2.6
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> A #GtkIconView.
+<parameter name="iter">
+<parameter_description> an iterator
</parameter_description>
</parameter>
</parameters>
-<return> A #GList containing a #GtkTreePath for each selected row.
-
+<return> whether @iter is at the end of a line
</return>
</function>
-<function name="gtk_printer_is_paused">
+<function name="gtk_text_iter_ends_sentence">
<description>
-Returns whether the printer is currently paused.
-A paused printer still accepts jobs, but it is not
-printing them.
+Determines whether @iter ends a sentence. Sentence boundaries are
+determined by Pango and should be correct for nearly any language
+(if not, the correct fix would be to the Pango text boundary
+algorithms).
-Since: 2.14
</description>
<parameters>
-<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @printer is paused
-
+<return> %TRUE if @iter is at the end of a sentence.
</return>
</function>
-<function name="gtk_icon_factory_lookup_default">
+<function name="gtk_text_iter_ends_tag">
<description>
-Looks for an icon in the list of default icon factories. For
-display to the user, you should use gtk_style_lookup_icon_set() on
-the #GtkStyle for the widget that will display the icon, instead of
-using this function directly, so that themes are taken into
-account.
+Returns %TRUE if @tag is toggled off at exactly this point. If @tag
+is %NULL, returns %TRUE if any tag is toggled off at this point. Note
+that the gtk_text_iter_ends_tag () returns %TRUE if @iter is the
+<emphasis>end</emphasis> of the tagged range;
+gtk_text_iter_has_tag () tells you whether an iterator is
+<emphasis>within</emphasis> a tagged range.
</description>
<parameters>
-<parameter name="stock_id">
-<parameter_description> an icon name
+<parameter name="iter">
+<parameter_description> an iterator
+</parameter_description>
+</parameter>
+<parameter name="tag">
+<parameter_description> a #GtkTextTag, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkIconSet, or %NULL
+<return> whether @iter is the end of a range tagged with @tag
+
</return>
</function>
-<function name="gtk_tree_view_row_expanded">
+<function name="gtk_text_iter_ends_word">
<description>
-Returns %TRUE if the node pointed to by @path is expanded in @tree_view.
+Determines whether @iter ends a natural-language word. Word breaks
+are determined by Pango and should be correct for nearly any
+language (if not, the correct fix would be to the Pango word break
+algorithms).
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView.
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> A #GtkTreePath to test expansion state.
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if #path is expanded.
+<return> %TRUE if @iter is at the end of a word
</return>
</function>
-<function name="gtk_tooltips_get_info_from_tip_window">
+<function name="gtk_text_iter_equal">
<description>
-Determines the tooltips and the widget they belong to from the window in
-which they are displayed.
-
-This function is mostly intended for use by accessibility technologies;
-applications should have little use for it.
+Tests whether two iterators are equal, using the fastest possible
+mechanism. This function is very fast; you can expect it to perform
+better than e.g. getting the character offset for each iterator and
+comparing the offsets yourself. Also, it's a bit faster than
+gtk_text_iter_compare().
-Since: 2.4
-
-Deprecated: 2.12:
</description>
<parameters>
-<parameter name="tip_window">
-<parameter_description> a #GtkWindow
-</parameter_description>
-</parameter>
-<parameter name="tooltips">
-<parameter_description> the return location for the tooltips which are displayed
-in @tip_window, or %NULL
+<parameter name="lhs">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
-<parameter name="current_widget">
-<parameter_description> the return location for the widget whose tooltips
-are displayed, or %NULL
+<parameter name="rhs">
+<parameter_description> another #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @tip_window is displaying tooltips, otherwise %FALSE.
-
+<return> %TRUE if the iterators point to the same place in the buffer
</return>
</function>
-<function name="gtk_notebook_get_tab_reorderable">
+<function name="gtk_text_iter_forward_char">
<description>
-Gets whether the tab can be reordered via drag and drop or not.
+Moves @iter forward by one character offset. Note that images
+embedded in the buffer occupy 1 character slot, so
+gtk_text_iter_forward_char () may actually move onto an image instead
+of a character, if you have images in your buffer. If @iter is the
+end iterator or one character before it, @iter will now point at
+the end iterator, and gtk_text_iter_forward_char () returns %FALSE for
+convenience when writing loops.
-Since: 2.10
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
-</parameter_description>
-</parameter>
-<parameter name="child">
-<parameter_description> a child #GtkWidget
+<parameter name="iter">
+<parameter_description> an iterator
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the tab is reorderable.
-
+<return> whether @iter moved and is dereferenceable
</return>
</function>
-<function name="gtk_tree_selection_set_select_function">
+<function name="gtk_text_iter_forward_chars">
<description>
-Sets the selection function. If set, this function is called before any node
-is selected or unselected, giving some control over which nodes are selected.
-The select function should return %TRUE if the state of the node may be toggled,
-and %FALSE if the state of the node should be left unchanged.
+Moves @count characters if possible (if @count would move past the
+start or end of the buffer, moves to the start or end of the
+buffer). The return value indicates whether the new position of
+ iter is different from its original position, and dereferenceable
+(the last iterator in the buffer is not dereferenceable). If @count
+is 0, the function does nothing and returns %FALSE.
+
</description>
<parameters>
-<parameter name="selection">
-<parameter_description> A #GtkTreeSelection.
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> The selection function.
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> The selection function's data.
+<parameter name="iter">
+<parameter_description> an iterator
</parameter_description>
</parameter>
-<parameter name="destroy">
-<parameter_description> The destroy function for user data. May be NULL.
+<parameter name="count">
+<parameter_description> number of characters to move, may be negative
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether @iter moved and is dereferenceable
+</return>
</function>
-<function name="gtk_icon_theme_append_search_path">
+<function name="gtk_text_iter_forward_cursor_position">
<description>
-Appends a directory to the search path.
-See gtk_icon_theme_set_search_path().
+Moves @iter forward by a single cursor position. Cursor positions
+are (unsurprisingly) positions where the cursor can appear. Perhaps
+surprisingly, there may not be a cursor position between all
+characters. The most common example for European languages would be
+a carriage return/newline sequence. For some Unicode characters,
+the equivalent of say the letter "a" with an accent mark will be
+represented as two characters, first the letter then a "combining
+mark" that causes the accent to be rendered; so the cursor can't go
+between those two characters. See also the #PangoLogAttr structure and
+pango_break() function.
-Since: 2.4
</description>
<parameters>
-<parameter name="icon_theme">
-<parameter_description> a #GtkIconTheme
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> directory name to append to the icon path
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if we moved and the new position is dereferenceable
+</return>
</function>
-<function name="gtk_text_view_forward_display_line_end">
+<function name="gtk_text_iter_forward_cursor_positions">
<description>
-Moves the given @iter forward to the next display line end.
-A display line is different from a paragraph. Paragraphs are
-separated by newlines or other paragraph separator characters.
-Display lines are created by line-wrapping a paragraph. If
-wrapping is turned off, display lines and paragraphs will be the
-same. Display lines are divided differently for each view, since
-they depend on the view's width; paragraphs are the same in all
-views, since they depend on the contents of the #GtkTextBuffer.
+Moves up to @count cursor positions. See
+gtk_text_iter_forward_cursor_position() for details.
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
-</parameter_description>
-</parameter>
<parameter name="iter">
<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
+<parameter name="count">
+<parameter_description> number of positions to move
+</parameter_description>
+</parameter>
</parameters>
-<return> %TRUE if @iter was moved and is not on the end iterator
+<return> %TRUE if we moved and the new position is dereferenceable
</return>
</function>
-<function name="gtk_range_get_range_rect">
+<function name="gtk_text_iter_forward_find_char">
<description>
-This function returns the area that contains the range's trough
-and its steppers, in widget->window coordinates.
-
-This function is useful mainly for #GtkRange subclasses.
+Advances @iter, calling @pred on each character. If
+ pred returns %TRUE, returns %TRUE and stops scanning.
+If @pred never returns %TRUE, @iter is set to @limit if
+ limit is non-%NULL, otherwise to the end iterator.
-Since: 2.20
</description>
<parameters>
-<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
-<parameter name="range_rect">
-<parameter_description> return location for the range rectangle
+<parameter name="pred">
+<parameter_description> a function to be called on each character
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data for @pred
+</parameter_description>
+</parameter>
+<parameter name="limit">
+<parameter_description> search limit, or %NULL for none
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether a match was found
+</return>
</function>
-<function name="gtk_cell_layout_get_cells">
+<function name="gtk_text_iter_forward_line">
<description>
-Returns the cell renderers which have been added to @cell_layout.
+Moves @iter to the start of the next line. If the iter is already on the
+last line of the buffer, moves the iter to the end of the current line.
+If after the operation, the iter is at the end of the buffer and not
+dereferencable, returns %FALSE. Otherwise, returns %TRUE.
-Since: 2.12
</description>
<parameters>
-<parameter name="cell_layout">
-<parameter_description> a #GtkCellLayout
+<parameter name="iter">
+<parameter_description> an iterator
</parameter_description>
</parameter>
</parameters>
-<return> a list of cell renderers. The list, but not the
-renderers has been newly allocated and should be freed with
-g_list_free() when no longer needed.
-
+<return> whether @iter can be dereferenced
</return>
</function>
-<function name="gtk_vbutton_box_new">
+<function name="gtk_text_iter_forward_lines">
<description>
-Creates a new vertical button box.
+Moves @count lines forward, if possible (if @count would move
+past the start or end of the buffer, moves to the start or end of
+the buffer). The return value indicates whether the iterator moved
+onto a dereferenceable position; if the iterator didn't move, or
+moved onto the end iterator, then %FALSE is returned. If @count is 0,
+the function does nothing and returns %FALSE. If @count is negative,
+moves backward by 0 - @count lines.
</description>
<parameters>
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
+</parameter_description>
+</parameter>
+<parameter name="count">
+<parameter_description> number of lines to move forward
+</parameter_description>
+</parameter>
</parameters>
-<return> a new button box #GtkWidget.
+<return> whether @iter moved and is dereferenceable
</return>
</function>
@@ -48234,3053 +49506,2778 @@ character in @str will match embedded pixbufs or child widgets.
</return>
</function>
-<function name="gtk_file_chooser_button_new">
+<function name="gtk_text_iter_forward_sentence_end">
<description>
-Creates a new file-selecting button widget.
+Moves forward to the next sentence end. (If @iter is at the end of
+a sentence, moves to the next end of sentence.) Sentence
+boundaries are determined by Pango and should be correct for nearly
+any language (if not, the correct fix would be to the Pango text
+boundary algorithms).
-Since: 2.6
</description>
<parameters>
-<parameter name="title">
-<parameter_description> the title of the browse dialog.
-</parameter_description>
-</parameter>
-<parameter name="action">
-<parameter_description> the open mode for the widget.
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return> a new button widget.
-
+<return> %TRUE if @iter moved and is not the end iterator
</return>
</function>
-<function name="gtk_clipboard_request_uris">
+<function name="gtk_text_iter_forward_sentence_ends">
<description>
-Requests the contents of the clipboard as URIs. When the URIs are
-later received @callback will be called.
-
-The @uris parameter to @callback will contain the resulting array of
-URIs if the request succeeded, or %NULL if it failed. This could happen
-for various reasons, in particular if the clipboard was empty or if the
-contents of the clipboard could not be converted into URI form.
+Calls gtk_text_iter_forward_sentence_end() @count times (or until
+gtk_text_iter_forward_sentence_end() returns %FALSE). If @count is
+negative, moves backward instead of forward.
-Since: 2.14
</description>
<parameters>
-<parameter name="clipboard">
-<parameter_description> a #GtkClipboard
-</parameter_description>
-</parameter>
-<parameter name="callback">
-<parameter_description> a function to call when the URIs are received,
-or the retrieval fails. (It will always be called
-one way or the other.)
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data to pass to @callback.
+<parameter name="count">
+<parameter_description> number of sentences to move
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @iter moved and is not the end iterator
+</return>
</function>
-<function name="gtk_entry_get_icon_stock">
+<function name="gtk_text_iter_forward_text_chars">
<description>
-Retrieves the stock id used for the icon, or %NULL if there is
-no icon or if the icon was set by some other method (e.g., by
-pixbuf, icon name or gicon).
+Moves backward by @count text characters (pixbufs, widgets,
+etc. do not count as characters for this). Equivalent to moving
+through the results of gtk_text_iter_get_text (), rather than
+gtk_text_iter_get_slice ().
-Since: 2.16
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> A #GtkEntry
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
-<parameter name="icon_pos">
-<parameter_description> Icon position
+<parameter name="count">
+<parameter_description> number of chars to move
</parameter_description>
</parameter>
</parameters>
-<return> A stock id, or %NULL if no icon is set or if the icon
-wasn't set from a stock id
-
+<return> whether @iter moved and is dereferenceable
</return>
</function>
-<function name="gtk_file_chooser_button_get_title">
+<function name="gtk_text_iter_forward_to_end">
<description>
-Retrieves the title of the browse dialog used by @button. The returned value
-should not be modified or freed.
-
-Since: 2.6
+Moves @iter forward to the "end iterator," which points one past the last
+valid character in the buffer. gtk_text_iter_get_char() called on the
+end iterator returns 0, which is convenient for writing loops.
</description>
<parameters>
-<parameter name="button">
-<parameter_description> the button widget to examine.
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the browse dialog's title.
-
-</return>
+<return></return>
</function>
-<function name="gtk_icon_info_get_display_name">
+<function name="gtk_text_iter_forward_to_line_end">
<description>
-Gets the display name for an icon. A display name is a
-string to be used in place of the icon name in a user
-visible context like a list of icons.
+Moves the iterator to point to the paragraph delimiter characters,
+which will be either a newline, a carriage return, a carriage
+return/newline in sequence, or the Unicode paragraph separator
+character. If the iterator is already at the paragraph delimiter
+characters, moves to the paragraph delimiter characters for the
+next line. If @iter is on the last line in the buffer, which does
+not end in paragraph delimiters, moves to the end iterator (end of
+the last line), and returns %FALSE.
-Since: 2.4
</description>
<parameters>
-<parameter name="icon_info">
-<parameter_description> a #GtkIconInfo
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return> the display name for the icon or %NULL, if
-the icon doesn't have a specified display name. This value
-is owned @icon_info and must not be modified or free.
-
+<return> %TRUE if we moved and the new location is not the end iterator
</return>
</function>
-<function name="gtk_print_settings_set_int">
+<function name="gtk_text_iter_forward_to_tag_toggle">
<description>
-Sets @key to an integer value.
+Moves forward to the next toggle (on or off) of the
+#GtkTextTag @tag, or to the next toggle of any tag if
+ tag is %NULL. If no matching tag toggles are found,
+returns %FALSE, otherwise %TRUE. Does not return toggles
+located at @iter, only toggles after @iter. Sets @iter to
+the location of the toggle, or to the end of the buffer
+if no toggle is found.
-Since: 2.10
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
-<parameter name="value">
-<parameter_description> an integer
+<parameter name="tag">
+<parameter_description> a #GtkTextTag, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether we found a tag toggle after @iter
+</return>
</function>
-<function name="gtk_widget_get_tooltip_markup">
+<function name="gtk_text_iter_forward_visible_cursor_position">
<description>
-Gets the contents of the tooltip for @widget.
+Moves @iter forward to the next visible cursor position. See
+gtk_text_iter_forward_cursor_position() for details.
-Since: 2.12
+Since: 2.4
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return> the tooltip text, or %NULL. You should free the
-returned string with g_free() when done.
+<return> %TRUE if we moved and the new position is dereferenceable
</return>
</function>
-<function name="gtk_window_remove_accel_group">
+<function name="gtk_text_iter_forward_visible_cursor_positions">
<description>
-Reverses the effects of gtk_window_add_accel_group().
+Moves up to @count visible cursor positions. See
+gtk_text_iter_forward_cursor_position() for details.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
-<parameter name="accel_group">
-<parameter_description> a #GtkAccelGroup
+<parameter name="count">
+<parameter_description> number of positions to move
</parameter_description>
</parameter>
</parameters>
-<return></return>
-</function>
-
-<function name="gtk_progress_bar_get_pulse_step">
-<description>
-Retrieves the pulse step set with gtk_progress_bar_set_pulse_step()
-
+<return> %TRUE if we moved and the new position is dereferenceable
-</description>
-<parameters>
-<parameter name="pbar">
-<parameter_description> a #GtkProgressBar
-</parameter_description>
-</parameter>
-</parameters>
-<return> a fraction from 0.0 to 1.0
</return>
</function>
-<function name="gtk_icon_view_get_item_orientation">
+<function name="gtk_text_iter_forward_visible_line">
<description>
-Returns the value of the ::item-orientation property which determines
-whether the labels are drawn beside the icons instead of below.
+Moves @iter to the start of the next visible line. Returns %TRUE if there
+was a next line to move to, and %FALSE if @iter was simply moved to
+the end of the buffer and is now not dereferenceable, or if @iter was
+already at the end of the buffer.
-Since: 2.22
+Since: 2.8
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
+<parameter name="iter">
+<parameter_description> an iterator
</parameter_description>
</parameter>
</parameters>
-<return> the relative position of texts and icons
+<return> whether @iter can be dereferenced
</return>
</function>
-<function name="gtk_selection_data_targets_include_image">
+<function name="gtk_text_iter_forward_visible_lines">
<description>
-Given a #GtkSelectionData object holding a list of targets,
-determines if any of the targets in @targets can be used to
-provide a #GdkPixbuf.
+Moves @count visible lines forward, if possible (if @count would move
+past the start or end of the buffer, moves to the start or end of
+the buffer). The return value indicates whether the iterator moved
+onto a dereferenceable position; if the iterator didn't move, or
+moved onto the end iterator, then %FALSE is returned. If @count is 0,
+the function does nothing and returns %FALSE. If @count is negative,
+moves backward by 0 - @count lines.
-Since: 2.6
+Since: 2.8
</description>
<parameters>
-<parameter name="selection_data">
-<parameter_description> a #GtkSelectionData object
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
-<parameter name="writable">
-<parameter_description> whether to accept only targets for which GTK+ knows
-how to convert a pixbuf into the format
+<parameter name="count">
+<parameter_description> number of lines to move forward
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @selection_data holds a list of targets,
-and a suitable target for images is included, otherwise %FALSE.
+<return> whether @iter moved and is dereferenceable
</return>
</function>
-<function name="gtk_action_set_is_important">
+<function name="gtk_text_iter_forward_visible_word_end">
<description>
-Sets whether the action is important, this attribute is used
-primarily by toolbar items to decide whether to show a label
-or not.
+Moves forward to the next visible word end. (If @iter is currently on a
+word end, moves forward to the next one after that.) Word breaks
+are determined by Pango and should be correct for nearly any
+language (if not, the correct fix would be to the Pango word break
+algorithms).
-Since: 2.16
+Since: 2.4
</description>
<parameters>
-<parameter name="action">
-<parameter_description> the action object
-</parameter_description>
-</parameter>
-<parameter name="is_important">
-<parameter_description> %TRUE to make the action important
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @iter moved and is not the end iterator
+
+</return>
</function>
-<function name="gtk_about_dialog_get_comments">
+<function name="gtk_text_iter_forward_visible_word_ends">
<description>
-Returns the comments string.
+Calls gtk_text_iter_forward_visible_word_end() up to @count times.
-Since: 2.6
+Since: 2.4
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
+</parameter_description>
+</parameter>
+<parameter name="count">
+<parameter_description> number of times to move
</parameter_description>
</parameter>
</parameters>
-<return> The comments. The string is owned by the about
-dialog and must not be modified.
+<return> %TRUE if @iter moved and is not the end iterator
</return>
</function>
-<function name="gtk_vseparator_new">
+<function name="gtk_text_iter_forward_word_end">
<description>
-Creates a new #GtkVSeparator.
+Moves forward to the next word end. (If @iter is currently on a
+word end, moves forward to the next one after that.) Word breaks
+are determined by Pango and should be correct for nearly any
+language (if not, the correct fix would be to the Pango word break
+algorithms).
</description>
<parameters>
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GtkVSeparator.
+<return> %TRUE if @iter moved and is not the end iterator
</return>
</function>
-<function name="gtk_widget_set_tooltip_text">
+<function name="gtk_text_iter_forward_word_ends">
<description>
-Sets @text as the contents of the tooltip. This function will take
-care of setting GtkWidget:has-tooltip to %TRUE and of the default
-handler for the GtkWidget::query-tooltip signal.
+Calls gtk_text_iter_forward_word_end() up to @count times.
-See also the GtkWidget:tooltip-text property and gtk_tooltip_set_text().
-
-Since: 2.12
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> the contents of the tooltip for @widget
+<parameter name="count">
+<parameter_description> number of times to move
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @iter moved and is not the end iterator
+</return>
</function>
-<function name="gtk_window_set_skip_pager_hint">
+<function name="gtk_text_iter_free">
<description>
-Windows may set a hint asking the desktop environment not to display
-the window in the pager. This function sets this hint.
-(A "pager" is any desktop navigation tool such as a workspace
-switcher that displays a thumbnail representation of the windows
-on the screen.)
-
-Since: 2.2
+Free an iterator allocated on the heap. This function
+is intended for use in language bindings, and is not
+especially useful for applications, because iterators can
+simply be allocated on the stack.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
-</parameter_description>
-</parameter>
-<parameter name="setting">
-<parameter_description> %TRUE to keep this window from appearing in the pager
+<parameter name="iter">
+<parameter_description> a dynamically-allocated iterator
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_test_register_all_types">
-<description>
-Force registration of all core Gtk+ and Gdk object types.
-This allowes to refer to any of those object types via
-g_type_from_name() after calling this function.
-
-Since: 2.14
-
-</description>
-<parameters>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_image_clear">
+<function name="gtk_text_iter_get_attributes">
<description>
-Resets the image to be empty.
-
-Since: 2.8
+Computes the effect of any tags applied to this spot in the
+text. The @values parameter should be initialized to the default
+settings you wish to use if no tags are in effect. You'd typically
+obtain the defaults from gtk_text_view_get_default_attributes().
-</description>
-<parameters>
-<parameter name="image">
-<parameter_description> a #GtkImage
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
-</function>
+gtk_text_iter_get_attributes () will modify @values, applying the
+effects of any tags present at @iter. If any tags affected @values,
+the function returns %TRUE.
-<function name="gtk_text_layout_move_iter_to_line_end">
-<description>
-Move to the beginning or end of a display line.
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #GtkTextLayout
+<parameter name="iter">
+<parameter_description> an iterator
</parameter_description>
</parameter>
-<parameter name="direction">
-<parameter_description> if negative, move to beginning of line, otherwise
- move to end of line.
+<parameter name="values">
+<parameter_description> a #GtkTextAttributes to be filled in
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @values was modified
+</return>
</function>
-<function name="gtk_buildable_add_child">
+<function name="gtk_text_iter_get_buffer">
<description>
-Adds a child to @buildable. @type is an optional string
-describing how the child should be added.
+Returns the #GtkTextBuffer this iterator is associated with.
-Since: 2.12
</description>
<parameters>
-<parameter name="buildable">
-<parameter_description> a #GtkBuildable
-</parameter_description>
-</parameter>
-<parameter name="builder">
-<parameter_description> a #GtkBuilder
-</parameter_description>
-</parameter>
-<parameter name="child">
-<parameter_description> child to add
-</parameter_description>
-</parameter>
-<parameter name="type">
-<parameter_description> kind of child or %NULL
+<parameter name="iter">
+<parameter_description> an iterator
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the buffer
+</return>
</function>
-<function name="gtk_dialog_add_action_widget">
+<function name="gtk_text_iter_get_bytes_in_line">
<description>
-Adds an activatable widget to the action area of a #GtkDialog,
-connecting a signal handler that will emit the #GtkDialog::response
-signal on the dialog when the widget is activated. The widget is
-appended to the end of the dialog's action area. If you want to add a
-non-activatable widget, simply pack it into the @action_area field
-of the #GtkDialog struct.
+Returns the number of bytes in the line containing @iter,
+including the paragraph delimiters.
+
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkDialog
-</parameter_description>
-</parameter>
-<parameter name="child">
-<parameter_description> an activatable widget
-</parameter_description>
-</parameter>
-<parameter name="response_id">
-<parameter_description> response ID for @child
+<parameter name="iter">
+<parameter_description> an iterator
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> number of bytes in the line
+</return>
</function>
-<function name="gtk_text_iter_backward_sentence_start">
+<function name="gtk_text_iter_get_char">
<description>
-Moves backward to the previous sentence start; if @iter is already at
-the start of a sentence, moves backward to the next one. Sentence
-boundaries are determined by Pango and should be correct for nearly
-any language (if not, the correct fix would be to the Pango text
-boundary algorithms).
+Returns the Unicode character at this iterator. (Equivalent to
+operator* on a C++ iterator.) If the element at this iterator is a
+non-character element, such as an image embedded in the buffer, the
+Unicode "unknown" character 0xFFFC is returned. If invoked on
+the end iterator, zero is returned; zero is not a valid Unicode character.
+So you can write a loop which ends when gtk_text_iter_get_char ()
+returns 0.
</description>
<parameters>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> an iterator
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter moved and is not the end iterator
+<return> a Unicode character, or 0 if @iter is not dereferenceable
</return>
</function>
-<function name="gtk_window_set_gravity">
+<function name="gtk_text_iter_get_chars_in_line">
<description>
-Window gravity defines the meaning of coordinates passed to
-gtk_window_move(). See gtk_window_move() and #GdkGravity for
-more details.
-
-The default window gravity is #GDK_GRAVITY_NORTH_WEST which will
-typically "do what you mean."
+Returns the number of characters in the line containing @iter,
+including the paragraph delimiters.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
-</parameter_description>
-</parameter>
-<parameter name="gravity">
-<parameter_description> window gravity
+<parameter name="iter">
+<parameter_description> an iterator
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> number of characters in the line
+</return>
</function>
-<function name="gtk_expander_set_use_underline">
+<function name="gtk_text_iter_get_child_anchor">
<description>
-If true, an underline in the text of the expander label indicates
-the next character should be used for the mnemonic accelerator key.
+If the location at @iter contains a child anchor, the
+anchor is returned (with no new reference count added). Otherwise,
+%NULL is returned.
-Since: 2.4
</description>
<parameters>
-<parameter name="expander">
-<parameter_description> a #GtkExpander
-</parameter_description>
-</parameter>
-<parameter name="use_underline">
-<parameter_description> %TRUE if underlines in the text indicate mnemonics
+<parameter name="iter">
+<parameter_description> an iterator
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the anchor at @iter
+</return>
</function>
-<function name="gtk_item_factory_popup_data_from_widget">
+<function name="gtk_text_iter_get_language">
<description>
-Obtains the @popup_data which was passed to
-gtk_item_factory_popup_with_data(). This data is available until the menu
-is popped down again.
+A convenience wrapper around gtk_text_iter_get_attributes (),
+which returns the language in effect at @iter. If no tags affecting
+language apply to @iter, the return value is identical to that of
+gtk_get_default_language ().
-Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a widget
+<parameter name="iter">
+<parameter_description> an iterator
</parameter_description>
</parameter>
</parameters>
-<return> @popup_data associated with the item factory from
-which @widget was created, or %NULL if @widget wasn't created
-by an item factory
+<return> language in effect at @iter
</return>
</function>
-<function name="gtk_combo_box_set_row_separator_func">
+<function name="gtk_text_iter_get_line">
<description>
-Sets the row separator function, which is used to determine
-whether a row should be drawn as a separator. If the row separator
-function is %NULL, no separators are drawn. This is the default value.
+Returns the line number containing the iterator. Lines in
+a #GtkTextBuffer are numbered beginning with 0 for the first
+line in the buffer.
-Since: 2.6
</description>
<parameters>
-<parameter name="combo_box">
-<parameter_description> a #GtkComboBox
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> a #GtkTreeViewRowSeparatorFunc
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> user data to pass to @func, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="destroy">
-<parameter_description> destroy notifier for @data, or %NULL
+<parameter name="iter">
+<parameter_description> an iterator
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a line number
+</return>
</function>
-<function name="gtk_notebook_set_group_id">
+<function name="gtk_text_iter_get_line_index">
<description>
-Sets an group identificator for @notebook, notebooks sharing
-the same group identificator will be able to exchange tabs
-via drag and drop. A notebook with group identificator -1 will
-not be able to exchange tabs with any other notebook.
+Returns the byte index of the iterator, counting
+from the start of a newline-terminated line.
+Remember that #GtkTextBuffer encodes text in
+UTF-8, and that characters can require a variable
+number of bytes to represent.
-Since: 2.10
-Deprecated: 2.12: use gtk_notebook_set_group() instead.
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
-</parameter_description>
-</parameter>
-<parameter name="group_id">
-<parameter_description> a group identificator, or -1 to unset it
+<parameter name="iter">
+<parameter_description> an iterator
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> distance from start of line, in bytes
+</return>
</function>
-<function name="gtk_file_filter_get_name">
+<function name="gtk_text_iter_get_line_offset">
<description>
-Gets the human-readable name for the filter. See gtk_file_filter_set_name().
+Returns the character offset of the iterator,
+counting from the start of a newline-terminated line.
+The first character on the line has offset 0.
-Since: 2.4
</description>
<parameters>
-<parameter name="filter">
-<parameter_description> a #GtkFileFilter
+<parameter name="iter">
+<parameter_description> an iterator
</parameter_description>
</parameter>
</parameters>
-<return> The human-readable name of the filter,
-or %NULL. This value is owned by GTK+ and must not
-be modified or freed.
-
+<return> offset from start of line
</return>
</function>
-<function name="gtk_file_chooser_button_new_with_dialog">
+<function name="gtk_text_iter_get_marks">
<description>
-Creates a #GtkFileChooserButton widget which uses @dialog as its
-file-picking window.
-
-Note that @dialog must be a #GtkDialog (or subclass) which
-implements the #GtkFileChooser interface and must not have
-%GTK_DIALOG_DESTROY_WITH_PARENT set.
-
-Also note that the dialog needs to have its confirmative button
-added with response %GTK_RESPONSE_ACCEPT or %GTK_RESPONSE_OK in
-order for the button to take over the file selected in the dialog.
+Returns a list of all #GtkTextMark at this location. Because marks
+are not iterable (they don't take up any "space" in the buffer,
+they are just marks in between iterable locations), multiple marks
+can exist in the same place. The returned list is not in any
+meaningful order.
-Since: 2.6
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> the widget to use as dialog
+<parameter name="iter">
+<parameter_description> an iterator
</parameter_description>
</parameter>
</parameters>
-<return> a new button widget.
-
+<return> list of #GtkTextMark
</return>
</function>
-<function name="gtk_page_setup_unix_dialog_get_page_setup">
+<function name="gtk_text_iter_get_offset">
<description>
-Gets the currently selected page setup from the dialog.
+Returns the character offset of an iterator.
+Each character in a #GtkTextBuffer has an offset,
+starting with 0 for the first character in the buffer.
+Use gtk_text_buffer_get_iter_at_offset () to convert an
+offset back into an iterator.
-Since: 2.10
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkPageSetupUnixDialog
+<parameter name="iter">
+<parameter_description> an iterator
</parameter_description>
</parameter>
</parameters>
-<return> the current page setup
-
+<return> a character offset
</return>
</function>
-<function name="gtk_spin_button_get_numeric">
+<function name="gtk_text_iter_get_pixbuf">
<description>
-Returns whether non-numeric text can be typed into the spin button.
-See gtk_spin_button_set_numeric().
+If the element at @iter is a pixbuf, the pixbuf is returned
+(with no new reference count added). Otherwise,
+%NULL is returned.
</description>
<parameters>
-<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter name="iter">
+<parameter_description> an iterator
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if only numeric text can be entered
+<return> the pixbuf at @iter
</return>
</function>
-<function name="gtk_combo_box_set_model">
+<function name="gtk_text_iter_get_slice">
<description>
-Sets the model used by @combo_box to be @model. Will unset a previously set
-model (if applicable). If model is %NULL, then it will unset the model.
-
-Note that this function does not clear the cell renderers, you have to
-call gtk_cell_layout_clear() yourself if you need to set up different
-cell renderers for the new model.
+Returns the text in the given range. A "slice" is an array of
+characters encoded in UTF-8 format, including the Unicode "unknown"
+character 0xFFFC for iterable non-character elements in the buffer,
+such as images. Because images are encoded in the slice, byte and
+character offsets in the returned array will correspond to byte
+offsets in the text buffer. Note that 0xFFFC can occur in normal
+text as well, so it is not a reliable indicator that a pixbuf or
+widget is in the buffer.
-Since: 2.4
</description>
<parameters>
-<parameter name="combo_box">
-<parameter_description> A #GtkComboBox
+<parameter name="start">
+<parameter_description> iterator at start of a range
</parameter_description>
</parameter>
-<parameter name="model">
-<parameter_description> A #GtkTreeModel
+<parameter name="end">
+<parameter_description> iterator at end of a range
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> slice of text from the buffer
+</return>
</function>
-<function name="gtk_file_chooser_set_action">
+<function name="gtk_text_iter_get_tags">
<description>
-Sets the type of operation that the chooser is performing; the
-user interface is adapted to suit the selected action. For example,
-an option to create a new folder might be shown if the action is
-%GTK_FILE_CHOOSER_ACTION_SAVE but not if the action is
-%GTK_FILE_CHOOSER_ACTION_OPEN.
+Returns a list of tags that apply to @iter, in ascending order of
+priority (highest-priority tags are last). The #GtkTextTag in the
+list don't have a reference added, but you have to free the list
+itself.
-Since: 2.4
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
-</parameter_description>
-</parameter>
-<parameter name="action">
-<parameter_description> the action that the file selector is performing
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> list of #GtkTextTag
+</return>
</function>
-<function name="gtk_icon_view_get_item_padding">
+<function name="gtk_text_iter_get_text">
<description>
-Returns the value of the ::item-padding property.
+Returns <emphasis>text</emphasis> in the given range. If the range
+contains non-text elements such as images, the character and byte
+offsets in the returned string will not correspond to character and
+byte offsets in the buffer. If you want offsets to correspond, see
+gtk_text_iter_get_slice ().
-Since: 2.18
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
+<parameter name="start">
+<parameter_description> iterator at start of a range
+</parameter_description>
+</parameter>
+<parameter name="end">
+<parameter_description> iterator at end of a range
</parameter_description>
</parameter>
</parameters>
-<return> the padding around items
-
+<return> array of characters from the buffer
</return>
</function>
-<function name="gtk_label_get_width_chars">
+<function name="gtk_text_iter_get_toggled_tags">
<description>
-Retrieves the desired width of @label, in characters. See
-gtk_label_set_width_chars().
+Returns a list of #GtkTextTag that are toggled on or off at this
+point. (If @toggled_on is %TRUE, the list contains tags that are
+toggled on.) If a tag is toggled on at @iter, then some non-empty
+range of characters following @iter has that tag applied to it. If
+a tag is toggled off, then some non-empty range following @iter
+does <emphasis>not</emphasis> have the tag applied to it.
-Since: 2.6
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="iter">
+<parameter_description> an iterator
+</parameter_description>
+</parameter>
+<parameter name="toggled_on">
+<parameter_description> %TRUE to get toggled-on tags
</parameter_description>
</parameter>
</parameters>
-<return> the width of the label in characters.
-
+<return> tags toggled at this point
</return>
</function>
-<function name="gtk_widget_get_state">
+<function name="gtk_text_iter_get_visible_line_index">
<description>
-Returns the widget's state. See gtk_widget_set_state().
+Returns the number of bytes from the start of the
+line to the given @iter, not counting bytes that
+are invisible due to tags with the "invisible" flag
+toggled on.
-Since: 2.18
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return> the state of @widget.
-
+<return> byte index of @iter with respect to the start of the line
</return>
</function>
-<function name="gtk_paper_size_get_name">
+<function name="gtk_text_iter_get_visible_line_offset">
<description>
-Gets the name of the #GtkPaperSize.
+Returns the offset in characters from the start of the
+line to the given @iter, not counting characters that
+are invisible due to tags with the "invisible" flag
+toggled on.
-Since: 2.10
</description>
<parameters>
-<parameter name="size">
-<parameter_description> a #GtkPaperSize object
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return> the name of @size
-
+<return> offset in visible characters from the start of the line
</return>
</function>
-<function name="gtk_color_selection_set_previous_alpha">
+<function name="gtk_text_iter_get_visible_slice">
<description>
-Sets the 'previous' alpha to be @alpha. This function should be called with
-some hesitations, as it might seem confusing to have that alpha change.
+Like gtk_text_iter_get_slice (), but invisible text is not included.
+Invisible text is usually invisible because a #GtkTextTag with the
+"invisible" attribute turned on has been applied to it.
+
</description>
<parameters>
-<parameter name="colorsel">
-<parameter_description> a #GtkColorSelection.
+<parameter name="start">
+<parameter_description> iterator at start of range
</parameter_description>
</parameter>
-<parameter name="alpha">
-<parameter_description> an integer between 0 and 65535.
+<parameter name="end">
+<parameter_description> iterator at end of range
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> slice of text from the buffer
+</return>
</function>
-<function name="gtk_combo_box_get_button_sensitivity">
+<function name="gtk_text_iter_get_visible_text">
<description>
-Returns whether the combo box sets the dropdown button
-sensitive or not when there are no items in the model.
+Like gtk_text_iter_get_text (), but invisible text is not included.
+Invisible text is usually invisible because a #GtkTextTag with the
+"invisible" attribute turned on has been applied to it.
-Since: 2.14
</description>
<parameters>
-<parameter name="combo_box">
-<parameter_description> a #GtkComboBox
+<parameter name="start">
+<parameter_description> iterator at start of range
+</parameter_description>
+</parameter>
+<parameter name="end">
+<parameter_description> iterator at end of range
</parameter_description>
</parameter>
</parameters>
-<return> %GTK_SENSITIVITY_ON if the dropdown button
-is sensitive when the model is empty, %GTK_SENSITIVITY_OFF
-if the button is always insensitive or
-%GTK_SENSITIVITY_AUTO if it is only sensitive as long as
-the model has one item to be selected.
-
+<return> string containing visible text in the range
</return>
</function>
-<function name="gtk_page_setup_new_from_file">
+<function name="gtk_text_iter_has_tag">
<description>
-Reads the page setup from the file @file_name. Returns a
-new #GtkPageSetup object with the restored page setup,
-or %NULL if an error occurred. See gtk_page_setup_to_file().
+Returns %TRUE if @iter is within a range tagged with @tag.
-Since: 2.12
</description>
<parameters>
-<parameter name="file_name">
-<parameter_description> the filename to read the page setup from
+<parameter name="iter">
+<parameter_description> an iterator
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for an error, or %NULL
+<parameter name="tag">
+<parameter_description> a #GtkTextTag
</parameter_description>
</parameter>
</parameters>
-<return> the restored #GtkPageSetup
-
+<return> whether @iter is tagged with @tag
</return>
</function>
-<function name="gtk_item_factory_popup">
+<function name="gtk_text_iter_in_range">
<description>
-Pops up the menu constructed from the item factory at (@x, @y).
-
-The @mouse_button parameter should be the mouse button pressed to initiate
-the menu popup. If the menu popup was initiated by something other than
-a mouse button press, such as a mouse button release or a keypress,
- mouse_button should be 0.
-
-The @time_ parameter should be the time stamp of the event that
-initiated the popup. If such an event is not available, use
-gtk_get_current_event_time() instead.
-
-The operation of the @mouse_button and the @time_ parameter is the same
-as the @button and @activation_time parameters for gtk_menu_popup().
+Checks whether @iter falls in the range [ start, @end).
+ start and @end must be in ascending order.
-Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="ifactory">
-<parameter_description> a #GtkItemFactory of type #GTK_TYPE_MENU (see gtk_item_factory_new())
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> the x position
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> the y position
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
-<parameter name="mouse_button">
-<parameter_description> the mouse button which was pressed to initiate the popup
+<parameter name="start">
+<parameter_description> start of range
</parameter_description>
</parameter>
-<parameter name="time_">
-<parameter_description> the time at which the activation event occurred
+<parameter name="end">
+<parameter_description> end of range
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @iter is in the range
+</return>
</function>
-<function name="gtk_color_selection_set_current_color">
+<function name="gtk_text_iter_inside_sentence">
<description>
-Sets the current color to be @color. The first time this is called, it will
-also set the original color to be @color too.
+Determines whether @iter is inside a sentence (as opposed to in
+between two sentences, e.g. after a period and before the first
+letter of the next sentence). Sentence boundaries are determined
+by Pango and should be correct for nearly any language (if not, the
+correct fix would be to the Pango text boundary algorithms).
+
</description>
<parameters>
-<parameter name="colorsel">
-<parameter_description> a #GtkColorSelection.
-</parameter_description>
-</parameter>
-<parameter name="color">
-<parameter_description> A #GdkColor to set the current color with.
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @iter is inside a sentence.
+</return>
</function>
-<function name="gtk_print_settings_set_printer_lpi">
+<function name="gtk_text_iter_inside_word">
<description>
-Sets the value of %GTK_PRINT_SETTINGS_PRINTER_LPI.
+Determines whether @iter is inside a natural-language word (as
+opposed to say inside some whitespace). Word breaks are determined
+by Pango and should be correct for nearly any language (if not, the
+correct fix would be to the Pango word break algorithms).
-Since: 2.16
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
-</parameter_description>
-</parameter>
-<parameter name="lpi">
-<parameter_description> the resolution in lpi (lines per inch)
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @iter is inside a word
+</return>
</function>
-<function name="gtk_tree_model_sort_convert_iter_to_child_iter">
+<function name="gtk_text_iter_is_cursor_position">
<description>
-Sets @child_iter to point to the row pointed to by @sorted_iter.
+See gtk_text_iter_forward_cursor_position() or #PangoLogAttr or
+pango_break() for details on what a cursor position is.
+
</description>
<parameters>
-<parameter name="tree_model_sort">
-<parameter_description> A #GtkTreeModelSort
-</parameter_description>
-</parameter>
-<parameter name="child_iter">
-<parameter_description> An uninitialized #GtkTreeIter
-</parameter_description>
-</parameter>
-<parameter name="sorted_iter">
-<parameter_description> A valid #GtkTreeIter pointing to a row on @tree_model_sort.
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the cursor can be placed at @iter
+</return>
</function>
-<function name="gtk_widget_class_path">
+<function name="gtk_text_iter_is_end">
<description>
-Same as gtk_widget_path(), but always uses the name of a widget's type,
-never uses a custom name set with gtk_widget_set_name().
+Returns %TRUE if @iter is the end iterator, i.e. one past the last
+dereferenceable iterator in the buffer. gtk_text_iter_is_end () is
+the most efficient way to check whether an iterator is the end
+iterator.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="path_length">
-<parameter_description> location to store the length of the class path, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> location to store the class path as an allocated string, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="path_reversed">
-<parameter_description> location to store the reverse class path as an allocated
-string, or %NULL
+<parameter name="iter">
+<parameter_description> an iterator
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether @iter is the end iterator
+</return>
</function>
-<function name="gtk_print_operation_get_support_selection">
+<function name="gtk_text_iter_is_start">
<description>
-Gets the value of #GtkPrintOperation::support-selection property.
+Returns %TRUE if @iter is the first iterator in the buffer, that is
+if @iter has a character offset of 0.
-Since: 2.18
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter name="iter">
+<parameter_description> an iterator
</parameter_description>
</parameter>
</parameters>
-<return> whether the application supports print of selection
-
+<return> whether @iter is the first in the buffer
</return>
</function>
-<function name="gtk_expander_set_label_widget">
+<function name="gtk_text_iter_order">
<description>
-Set the label widget for the expander. This is the widget
-that will appear embedded alongside the expander arrow.
+Swaps the value of @first and @second if @second comes before
+ first in the buffer. That is, ensures that @first and @second are
+in sequence. Most text buffer functions that take a range call this
+automatically on your behalf, so there's no real reason to call it yourself
+in those cases. There are some exceptions, such as gtk_text_iter_in_range(),
+that expect a pre-sorted range.
-Since: 2.4
</description>
<parameters>
-<parameter name="expander">
-<parameter_description> a #GtkExpander
+<parameter name="first">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
-<parameter name="label_widget">
-<parameter_description> the new label widget
+<parameter name="second">
+<parameter_description> another #GtkTextIter
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_cell_renderer_toggle_new">
+<function name="gtk_text_iter_set_line">
<description>
-Creates a new #GtkCellRendererToggle. Adjust rendering
-parameters using object properties. Object properties can be set
-globally (with g_object_set()). Also, with #GtkTreeViewColumn, you
-can bind a property to a value in a #GtkTreeModel. For example, you
-can bind the "active" property on the cell renderer to a boolean value
-in the model, thus causing the check button to reflect the state of
-the model.
+Moves iterator @iter to the start of the line @line_number. If
+ line_number is negative or larger than the number of lines in the
+buffer, moves @iter to the start of the last line in the buffer.
</description>
<parameters>
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
+</parameter_description>
+</parameter>
+<parameter name="line_number">
+<parameter_description> line number (counted from 0)
+</parameter_description>
+</parameter>
</parameters>
-<return> the new cell renderer
-</return>
+<return></return>
</function>
-<function name="gtk_icon_view_unset_model_drag_dest">
+<function name="gtk_text_iter_set_line_index">
<description>
-Undoes the effect of gtk_icon_view_enable_model_drag_dest(). Calling this
-method sets #GtkIconView:reorderable to %FALSE.
+Same as gtk_text_iter_set_line_offset(), but works with a
+<emphasis>byte</emphasis> index. The given byte index must be at
+the start of a character, it can't be in the middle of a UTF-8
+encoded character.
-Since: 2.8
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
+</parameter_description>
+</parameter>
+<parameter name="byte_on_line">
+<parameter_description> a byte index relative to the start of @iter's current line
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tool_palette_set_icon_size">
+<function name="gtk_text_iter_set_line_offset">
<description>
-Sets the size of icons in the tool palette.
+Moves @iter within a line, to a new <emphasis>character</emphasis>
+(not byte) offset. The given character offset must be less than or
+equal to the number of characters in the line; if equal, @iter
+moves to the start of the next line. See
+gtk_text_iter_set_line_index() if you have a byte index rather than
+a character offset.
-Since: 2.20
</description>
<parameters>
-<parameter name="palette">
-<parameter_description> a #GtkToolPalette
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
-<parameter name="icon_size">
-<parameter_description> the #GtkIconSize that icons in the tool
-palette shall have
+<parameter name="char_on_line">
+<parameter_description> a character offset relative to the start of @iter's current line
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_insert_pixbuf">
+<function name="gtk_text_iter_set_offset">
<description>
-Inserts an image into the text buffer at @iter. The image will be
-counted as one character in character counts, and when obtaining
-the buffer contents as a string, will be represented by the Unicode
-"object replacement character" 0xFFFC. Note that the "slice"
-variants for obtaining portions of the buffer as a string include
-this character for pixbufs, but the "text" variants do
-not. e.g. see gtk_text_buffer_get_slice() and
-gtk_text_buffer_get_text().
+Sets @iter to point to @char_offset. @char_offset counts from the start
+of the entire text buffer, starting with 0.
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
<parameter name="iter">
-<parameter_description> location to insert the pixbuf
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
-<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf
+<parameter name="char_offset">
+<parameter_description> a character number
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tooltip_set_icon_from_gicon">
+<function name="gtk_text_iter_set_visible_line_index">
<description>
-Sets the icon of the tooltip (which is in front of the text)
-to be the icon indicated by @gicon with the size indicated
-by @size. If @gicon is %NULL, the image will be hidden.
-
-Since: 2.20
+Like gtk_text_iter_set_line_index(), but the index is in visible
+bytes, i.e. text with a tag making it invisible is not counted
+in the index.
</description>
<parameters>
-<parameter name="tooltip">
-<parameter_description> a #GtkTooltip
-</parameter_description>
-</parameter>
-<parameter name="gicon">
-<parameter_description> a #GIcon representing the icon, or %NULL
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> a stock icon size
+<parameter name="byte_on_line">
+<parameter_description> a byte index
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_scrolled_window_get_placement">
+<function name="gtk_text_iter_set_visible_line_offset">
<description>
-Gets the placement of the contents with respect to the scrollbars
-for the scrolled window. See gtk_scrolled_window_set_placement().
-
+Like gtk_text_iter_set_line_offset(), but the offset is in visible
+characters, i.e. text with a tag making it invisible is not
+counted in the offset.
</description>
<parameters>
-<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
+</parameter_description>
+</parameter>
+<parameter name="char_on_line">
+<parameter_description> a character offset
</parameter_description>
</parameter>
</parameters>
-<return> the current placement value.
-
-See also gtk_scrolled_window_set_placement() and
-gtk_scrolled_window_unset_placement().
-</return>
+<return></return>
</function>
-<function name="gtk_stock_add_static">
+<function name="gtk_text_iter_starts_line">
<description>
-Same as gtk_stock_add(), but doesn't copy @items, so
- items must persist until application exit.
+Returns %TRUE if @iter begins a paragraph,
+i.e. if gtk_text_iter_get_line_offset () would return 0.
+However this function is potentially more efficient than
+gtk_text_iter_get_line_offset () because it doesn't have to compute
+the offset, it just has to see whether it's 0.
</description>
<parameters>
-<parameter name="items">
-<parameter_description> a #GtkStockItem or array of #GtkStockItem
-</parameter_description>
-</parameter>
-<parameter name="n_items">
-<parameter_description> number of items
+<parameter name="iter">
+<parameter_description> an iterator
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether @iter begins a line
+</return>
</function>
-<function name="gtk_assistant_get_page_type">
+<function name="gtk_text_iter_starts_sentence">
<description>
-Gets the page type of @page.
+Determines whether @iter begins a sentence. Sentence boundaries are
+determined by Pango and should be correct for nearly any language
+(if not, the correct fix would be to the Pango text boundary
+algorithms).
-Since: 2.10
</description>
<parameters>
-<parameter name="assistant">
-<parameter_description> a #GtkAssistant
-</parameter_description>
-</parameter>
-<parameter name="page">
-<parameter_description> a page of @assistant
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return> the page type of @page.
-
+<return> %TRUE if @iter is at the start of a sentence.
</return>
</function>
-<function name="gtk_tree_sortable_has_default_sort_func">
+<function name="gtk_text_iter_starts_word">
<description>
-Returns %TRUE if the model has a default sort function. This is used
-primarily by GtkTreeViewColumns in order to determine if a model can
-go back to the default state, or not.
+Determines whether @iter begins a natural-language word. Word
+breaks are determined by Pango and should be correct for nearly any
+language (if not, the correct fix would be to the Pango word break
+algorithms).
</description>
<parameters>
-<parameter name="sortable">
-<parameter_description> A #GtkTreeSortable
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE, if the model has a default sort function
+<return> %TRUE if @iter is at the start of a word
</return>
</function>
-<function name="gtk_ui_manager_get_add_tearoffs">
+<function name="gtk_text_iter_toggles_tag">
<description>
-Returns whether menus generated by this #GtkUIManager
-will have tearoff menu items.
+This is equivalent to (gtk_text_iter_begins_tag () ||
+gtk_text_iter_ends_tag ()), i.e. it tells you whether a range with
+ tag applied to it begins <emphasis>or</emphasis> ends at @iter.
-Since: 2.4
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #GtkUIManager
+<parameter name="iter">
+<parameter_description> an iterator
+</parameter_description>
+</parameter>
+<parameter name="tag">
+<parameter_description> a #GtkTextTag, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> whether tearoff menu items are added
-
+<return> whether @tag is toggled on or off at @iter
</return>
</function>
-<function name="gtk_ui_manager_add_ui_from_string">
+<function name="gtk_text_layout_clamp_iter_to_vrange">
<description>
-Parses a string containing a <link linkend="XML-UI">UI definition</link> and
-merges it with the current contents of @self. An enclosing <ui>
-element is added if it is missing.
+If the iterator is not fully in the range @top <= y < @bottom,
+then, if possible, move it the minimum distance so that the
+iterator in this range.
-Since: 2.4
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #GtkUIManager object
+<parameter name="layout">
+<parameter_description> a #GtkTextLayout
</parameter_description>
</parameter>
-<parameter name="buffer">
-<parameter_description> the string to parse
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> the length of @buffer (may be -1 if @buffer is nul-terminated)
+<parameter name="top">
+<parameter_description> the top of the range
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for an error
+<parameter name="bottom">
+<parameter_description> the bottom the range
</parameter_description>
</parameter>
</parameters>
-<return> The merge id for the merged UI. The merge id can be used
-to unmerge the UI with gtk_ui_manager_remove_ui(). If an error occurred,
-the return value is 0.
-
+<return> %TRUE if the iterator was moved, otherwise %FALSE.
</return>
</function>
-<function name="gtk_printer_get_capabilities">
+<function name="gtk_text_layout_get_buffer">
<description>
-Returns the printer's capabilities.
-
-This is useful when you're using #GtkPrintUnixDialog's manual-capabilities
-setting and need to know which settings the printer can handle and which
-you must handle yourself.
-
-This will return 0 unless the printer's details are available, see
-gtk_printer_has_details() and gtk_printer_request_details().
+Gets the text buffer used by the layout. See
+gtk_text_layout_set_buffer().
-Since: 2.12
</description>
<parameters>
-<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter name="layout">
+<parameter_description> a #GtkTextLayout
</parameter_description>
</parameter>
</parameters>
-<return> the printer's capabilities
-
+<return> the text buffer used by the layout.
</return>
</function>
-<function name="gtk_tool_item_group_set_header_relief">
+<function name="gtk_text_layout_get_cursor_locations">
<description>
-Set the button relief of the group header.
-See gtk_button_set_relief() for details.
-
-Since: 2.20
+Given an iterator within a text layout, determine the positions of the
+strong and weak cursors if the insertion point is at that
+iterator. The position of each cursor is stored as a zero-width
+rectangle. The strong cursor location is the location where
+characters of the directionality equal to the base direction of the
+paragraph are inserted. The weak cursor location is the location
+where characters of the directionality opposite to the base
+direction of the paragraph are inserted.
</description>
<parameters>
-<parameter name="group">
-<parameter_description> a #GtkToolItemGroup
+<parameter name="layout">
+<parameter_description> a #GtkTextLayout
</parameter_description>
</parameter>
-<parameter name="style">
-<parameter_description> the #GtkReliefStyle
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
+</parameter_description>
+</parameter>
+<parameter name="strong_pos">
+<parameter_description> location to store the strong cursor position (may be %NULL)
+</parameter_description>
+</parameter>
+<parameter name="weak_pos">
+<parameter_description> location to store the weak cursor position (may be %NULL)
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_view_get_visible_range">
+<function name="gtk_text_layout_get_cursor_visible">
<description>
-Sets @start_path and @end_path to be the first and last visible path.
-Note that there may be invisible paths in between.
-
-Both paths should be freed with gtk_tree_path_free() after use.
+Returns whether the insertion cursor will be shown.
-Since: 2.8
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> A #GtkIconView
-</parameter_description>
-</parameter>
-<parameter name="start_path">
-<parameter_description> Return location for start of region, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="end_path">
-<parameter_description> Return location for end of region, or %NULL
+<parameter name="layout">
+<parameter_description> a #GtkTextLayout
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE, if valid paths were placed in @start_path and @end_path
-
+<return> if %FALSE, the insertion cursor will not be
+shown, even if the text is editable.
</return>
</function>
-<function name="gtk_text_view_get_editable">
+<function name="gtk_text_layout_get_line_at_y">
<description>
-Returns the default editability of the #GtkTextView. Tags in the
-buffer may override this setting for some ranges of text.
-
+Get the iter at the beginning of the line which is displayed
+at the given y.
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="layout">
+<parameter_description> a #GtkLayout
+</parameter_description>
+</parameter>
+<parameter name="target_iter">
+<parameter_description> the iterator in which the result is stored
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> the y positition
+</parameter_description>
+</parameter>
+<parameter name="line_top">
+<parameter_description> location to store the y coordinate of the
+top of the line. (Can by %NULL)
</parameter_description>
</parameter>
</parameters>
-<return> whether text is editable by default
-</return>
+<return></return>
</function>
-<function name="gtk_icon_view_new_with_model">
+<function name="gtk_text_layout_get_line_yrange">
<description>
-Creates a new #GtkIconView widget with the model @model.
-
-Since: 2.6
+Find the range of y coordinates for the paragraph containing
+the given iter.
</description>
<parameters>
-<parameter name="model">
-<parameter_description> The model.
+<parameter name="layout">
+<parameter_description> a #GtkTextLayout
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> location to store the top of the paragraph in pixels,
+or %NULL.
+ height location to store the height of the paragraph in pixels,
+or %NULL.
</parameter_description>
</parameter>
</parameters>
-<return> A newly created #GtkIconView widget.
-
-</return>
+<return></return>
</function>
-<function name="gtk_window_get_deletable">
+<function name="gtk_text_layout_get_lines">
<description>
-Returns whether the window has been set to have a close button
-via gtk_window_set_deletable().
-
-Since: 2.10
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
-</parameter_description>
-</parameter>
</parameters>
-<return> %TRUE if the window has been set to have a close button
-
+<return>
</return>
</function>
-<function name="gtk_label_new_with_mnemonic">
+<function name="gtk_text_layout_is_valid">
<description>
-Creates a new #GtkLabel, containing the text in @str.
-
-If characters in @str are preceded by an underscore, they are
-underlined. If you need a literal underscore character in a label, use
-'__' (two underscores). The first underlined character represents a
-keyboard accelerator called a mnemonic. The mnemonic key can be used
-to activate another widget, chosen automatically, or explicitly using
-gtk_label_set_mnemonic_widget().
-
-If gtk_label_set_mnemonic_widget() is not called, then the first
-activatable ancestor of the #GtkLabel will be chosen as the mnemonic
-widget. For instance, if the label is inside a button or menu item,
-the button or menu item will automatically become the mnemonic widget
-and be activated by the mnemonic.
+Check if there are any invalid regions in a #GtkTextLayout's buffer
</description>
<parameters>
-<parameter name="str">
-<parameter_description> The text of the label, with an underscore in front of the
-mnemonic character
+<parameter name="layout">
+<parameter_description> a #GtkTextLayout
</parameter_description>
</parameter>
</parameters>
-<return> the new #GtkLabel
+<return> %TRUE if any invalid regions were found
</return>
</function>
-<function name="gtk_tree_path_down">
+<function name="gtk_text_layout_iter_starts_line">
<description>
-Moves @path to point to the first child of the current path.
+Tests whether an iterator is at the start of a display line.
</description>
<parameters>
-<parameter name="path">
-<parameter_description> A #GtkTreePath.
+<parameter name="layout">
+<parameter_description> a #GtkTextLayout
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> iterator to test
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_get_gravity">
+<function name="gtk_text_layout_move_iter_to_line_end">
<description>
-Gets the value set by gtk_window_set_gravity().
-
+Move to the beginning or end of a display line.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="layout">
+<parameter_description> a #GtkTextLayout
</parameter_description>
</parameter>
-</parameters>
-<return> window gravity
-</return>
-</function>
-
-<function name="gtk_tool_palette_unset_icon_size">
-<description>
-Unsets the tool palette icon size set with gtk_tool_palette_set_icon_size(),
-so that user preferences will be used to determine the icon size.
-
-Since: 2.20
-
-</description>
-<parameters>
-<parameter name="palette">
-<parameter_description> a #GtkToolPalette
+<parameter name="direction">
+<parameter_description> if negative, move to beginning of line, otherwise
+ move to end of line.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_get_mnemonic_modifier">
+<function name="gtk_text_layout_move_iter_to_next_line">
<description>
-Returns the mnemonic modifier for this window. See
-gtk_window_set_mnemonic_modifier().
-
+Move the iterator to the beginning of the next line. The
+lines of a wrapped paragraph are treated as distinct for
+this operation.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="layout">
+<parameter_description> a #GtkLayout
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return> the modifier mask used to activate
-mnemonics on this window.
-</return>
+<return></return>
</function>
-<function name="gtk_separator_tool_item_new">
+<function name="gtk_text_layout_move_iter_to_previous_line">
<description>
-Create a new #GtkSeparatorToolItem
-
-Since: 2.4
+Move the iterator to the beginning of the previous line. The lines
+of a wrapped paragraph are treated as distinct for this operation.
</description>
<parameters>
+<parameter name="layout">
+<parameter_description> a #GtkLayout
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
+</parameter_description>
+</parameter>
</parameters>
-<return> the new #GtkSeparatorToolItem
-
-</return>
+<return></return>
</function>
-<function name="gtk_status_icon_get_title">
+<function name="gtk_text_layout_move_iter_to_x">
<description>
-Gets the title of this tray icon. See gtk_status_icon_set_title().
-
-Since: 2.18
+Keeping the iterator on the same line of the layout, move it to the
+specified X coordinate. The lines of a wrapped paragraph are
+treated as distinct for this operation.
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
+<parameter name="layout">
+<parameter_description> a #GtkTextLayout
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> X coordinate
</parameter_description>
</parameter>
</parameters>
-<return> the title of the status icon
-
-</return>
+<return></return>
</function>
-<function name="gtk_ui_manager_new_merge_id">
+<function name="gtk_text_layout_move_iter_visually">
<description>
-Returns an unused merge id, suitable for use with
-gtk_ui_manager_add_ui().
+Move the iterator a given number of characters visually, treating
+it as the strong cursor position. If @count is positive, then the
+new strong cursor position will be @count positions to the right of
+the old cursor position. If @count is negative then the new strong
+cursor position will be @count positions to the left of the old
+cursor position.
-Since: 2.4
+In the presence of bidirection text, the correspondence
+between logical and visual order will depend on the direction
+of the current run, and there may be jumps when the cursor
+is moved off of the end of a run.
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #GtkUIManager
+<parameter name="layout">
+<parameter_description> a #GtkTextLayout
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
+</parameter_description>
+</parameter>
+<parameter name="count">
+<parameter_description> number of characters to move (negative moves left, positive moves right)
</parameter_description>
</parameter>
</parameters>
-<return> an unused merge id.
-
-</return>
+<return></return>
</function>
-<function name="gtk_print_job_set_source_file">
+<function name="gtk_text_layout_set_buffer">
<description>
-Make the #GtkPrintJob send an existing document to the
-printing system. The file can be in any format understood
-by the platforms printing system (typically PostScript,
-but on many platforms PDF may work too). See
-gtk_printer_accepts_pdf() and gtk_printer_accepts_ps().
-
-Since: 2.10
</description>
<parameters>
-<parameter name="job">
-<parameter_description> a #GtkPrintJob
-</parameter_description>
-</parameter>
-<parameter name="filename">
-<parameter_description> the file to be printed
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for errors
+<parameter name="buffer">
+<parameter_description>
</parameter_description>
</parameter>
</parameters>
-<return> %FALSE if an error occurred
-
-</return>
+<return></return>
</function>
-<function name="gtk_recent_filter_get_name">
+<function name="gtk_text_layout_set_cursor_direction">
<description>
-Gets the human-readable name for the filter.
-See gtk_recent_filter_set_name().
-
-Since: 2.10
+Sets which text directions (left-to-right and/or right-to-left) for
+which cursors will be drawn for the insertion point. The visual
+point at which new text is inserted depends on whether the new
+text is right-to-left or left-to-right, so it may be desired to
+make the drawn position of the cursor depend on the keyboard state.
</description>
<parameters>
-<parameter name="filter">
-<parameter_description> a #GtkRecentFilter
+<parameter name="direction">
+<parameter_description> the new direction(s) for which to draw cursors.
+%GTK_TEXT_DIR_NONE means draw cursors for both
+left-to-right insertion and right-to-left insertion.
+(The two cursors will be visually distinguished.)
</parameter_description>
</parameter>
</parameters>
-<return> the name of the filter, or %NULL. The returned string
-is owned by the filter object and should not be freed.
-
-</return>
+<return></return>
</function>
-<function name="gtk_dialog_set_response_sensitive">
+<function name="gtk_text_layout_set_cursor_visible">
<description>
-Calls <literal>gtk_widget_set_sensitive (widget, @setting)</literal>
-for each widget in the dialog's action area with the given @response_id.
-A convenient way to sensitize/desensitize dialog buttons.
+Sets whether the insertion cursor should be shown. Generally,
+widgets using #GtkTextLayout will hide the cursor when the
+widget does not have the input focus.
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkDialog
-</parameter_description>
-</parameter>
-<parameter name="response_id">
-<parameter_description> a response ID
+<parameter name="layout">
+<parameter_description> a #GtkTextLayout
</parameter_description>
</parameter>
-<parameter name="setting">
-<parameter_description> %TRUE for sensitive
+<parameter name="cursor_visible">
+<parameter_description> If %FALSE, then the insertion cursor will not
+be shown, even if the text is editable.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_recent_chooser_get_limit">
+<function name="gtk_text_layout_set_keyboard_direction">
<description>
-Gets the number of items returned by gtk_recent_chooser_get_items()
-and gtk_recent_chooser_get_uris().
-
-Since: 2.10
+Sets the keyboard direction; this is used as for the bidirectional
+base direction for the line with the cursor if the line contains
+only neutral characters.
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
+<parameter name="keyboard_dir">
+<parameter_description> the current direction of the keyboard.
</parameter_description>
</parameter>
</parameters>
-<return> A positive integer, or -1 meaning that all items are
-returned.
-
-</return>
+<return></return>
</function>
-<function name="gtk_tree_view_get_visible_rect">
+<function name="gtk_text_layout_set_overwrite_mode">
<description>
-Fills @visible_rect with the currently-visible region of the
-buffer, in tree coordinates. Convert to bin_window coordinates with
-gtk_tree_view_convert_tree_to_bin_window_coords().
-Tree coordinates start at 0,0 for row 0 of the tree, and cover the entire
-scrollable area of the tree.
+Sets overwrite mode
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
+<parameter name="layout">
+<parameter_description> a #GtkTextLayout
</parameter_description>
</parameter>
-<parameter name="visible_rect">
-<parameter_description> rectangle to fill
+<parameter name="overwrite">
+<parameter_description> overwrite mode
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_activatable_set_use_action_appearance">
+<function name="gtk_text_layout_set_preedit_string">
<description>
-Sets whether this activatable should reset its layout and appearance
-when setting the related action or when the action changes appearance
-
-<note><para>#GtkActivatable implementors need to handle the
-#GtkActivatable:use-action-appearance property and call
-gtk_activatable_sync_action_properties() to update @activatable
-if needed.</para></note>
-
-Since: 2.16
+Set the preedit string and attributes. The preedit string is a
+string showing text that is currently being edited and not
+yet committed into the buffer.
</description>
<parameters>
-<parameter name="activatable">
-<parameter_description> a #GtkActivatable
+<parameter name="layout">
+<parameter_description> a #PangoLayout
</parameter_description>
</parameter>
-<parameter name="use_appearance">
-<parameter_description> whether to use the actions appearance
+<parameter name="preedit_string">
+<parameter_description> a string to display at the insertion point
+</parameter_description>
+</parameter>
+<parameter name="preedit_attrs">
+<parameter_description> a #PangoAttrList of attributes that apply to @preedit_string
+</parameter_description>
+</parameter>
+<parameter name="cursor_pos">
+<parameter_description> position of cursor within preedit string in chars
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_model_filter_clear_cache">
+<function name="gtk_text_layout_validate">
<description>
-This function should almost never be called. It clears the @filter
-of any cached iterators that haven't been reffed with
-gtk_tree_model_ref_node(). This might be useful if the child model
-being filtered is static (and doesn't change often) and there has been
-a lot of unreffed access to nodes. As a side effect of this function,
-all unreffed iters will be invalid.
-
-Since: 2.4
+Validate regions of a #GtkTextLayout. The ::changed signal will
+be emitted for each region validated.
</description>
<parameters>
-<parameter name="filter">
-<parameter_description> A #GtkTreeModelFilter.
+<parameter name="tree">
+<parameter_description> a #GtkTextLayout
+</parameter_description>
+</parameter>
+<parameter name="max_pixels">
+<parameter_description> the maximum number of pixels to validate. (No more
+than one paragraph beyond this limit will be validated)
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tool_item_get_proxy_menu_item">
+<function name="gtk_text_layout_validate_yrange">
<description>
-If @menu_item_id matches the string passed to
-gtk_tool_item_set_proxy_menu_item() return the corresponding #GtkMenuItem.
-
-Custom subclasses of #GtkToolItem should use this function to update
-their menu item when the #GtkToolItem changes. That the
- menu_item_id<!-- -->s must match ensures that a #GtkToolItem will not
-inadvertently change a menu item that they did not create.
-
-Since: 2.4
+Ensure that a region of a #GtkTextLayout is valid. The ::changed
+signal will be emitted if any lines are validated.
</description>
<parameters>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem
+<parameter name="layout">
+<parameter_description> a #GtkTextLayout
</parameter_description>
</parameter>
-<parameter name="menu_item_id">
-<parameter_description> a string used to identify the menu item
+<parameter name="anchor">
+<parameter_description> iter pointing into a line that will be used as the
+coordinate origin
+</parameter_description>
+</parameter>
+<parameter name="y0_">
+<parameter_description> offset from the top of the line pointed to by @anchor at
+which to begin validation. (The offset here is in pixels
+after validation.)
+</parameter_description>
+</parameter>
+<parameter name="y1_">
+<parameter_description> offset from the top of the line pointed to by @anchor at
+which to end validation. (The offset here is in pixels
+after validation.)
</parameter_description>
</parameter>
</parameters>
-<return> The #GtkMenuItem passed to
-gtk_tool_item_set_proxy_menu_item(), if the @menu_item_id<!-- -->s match.
-
-</return>
+<return></return>
</function>
-<function name="gtk_test_text_get">
+<function name="gtk_text_mark_get_buffer">
<description>
-Retrive the text string of @widget if it is a GtkLabel,
-GtkEditable (entry and text widgets) or GtkTextView.
+Gets the buffer this mark is located inside,
+or %NULL if the mark is deleted.
-Since: 2.14
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> valid widget pointer.
+<parameter name="mark">
+<parameter_description> a #GtkTextMark
</parameter_description>
</parameter>
</parameters>
-<return> new 0-terminated C string, needs to be released with g_free().
-
+<return> the mark's #GtkTextBuffer
</return>
</function>
-<function name="gtk_text_layout_move_iter_to_next_line">
+<function name="gtk_text_mark_get_deleted">
<description>
-Move the iterator to the beginning of the next line. The
-lines of a wrapped paragraph are treated as distinct for
-this operation.
+Returns %TRUE if the mark has been removed from its buffer
+with gtk_text_buffer_delete_mark(). See gtk_text_buffer_add_mark()
+for a way to add it to a buffer again.
+
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #GtkLayout
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="mark">
+<parameter_description> a #GtkTextMark
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether the mark is deleted
+</return>
</function>
-<function name="gtk_tree_model_sort_convert_path_to_child_path">
+<function name="gtk_text_mark_get_left_gravity">
<description>
-Converts @sorted_path to a path on the child model of @tree_model_sort.
-That is, @sorted_path points to a location in @tree_model_sort. The
-returned path will point to the same location in the model not being
-sorted. If @sorted_path does not point to a location in the child model,
-%NULL is returned.
+Determines whether the mark has left gravity.
</description>
<parameters>
-<parameter name="tree_model_sort">
-<parameter_description> A #GtkTreeModelSort
-</parameter_description>
-</parameter>
-<parameter name="sorted_path">
-<parameter_description> A #GtkTreePath to convert
+<parameter name="mark">
+<parameter_description> a #GtkTextMark
</parameter_description>
</parameter>
</parameters>
-<return> A newly allocated #GtkTreePath, or %NULL
+<return> %TRUE if the mark has left gravity, %FALSE otherwise
</return>
</function>
-<function name="gtk_about_dialog_set_authors">
+<function name="gtk_text_mark_get_name">
<description>
-Sets the strings which are displayed in the authors tab
-of the secondary credits dialog.
+Returns the mark name; returns NULL for anonymous marks.
-Since: 2.6
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
-</parameter_description>
-</parameter>
-<parameter name="authors">
-<parameter_description> a %NULL-terminated array of strings
+<parameter name="mark">
+<parameter_description> a #GtkTextMark
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> mark name
+</return>
</function>
-<function name="gtk_entry_buffer_emit_inserted_text">
+<function name="gtk_text_mark_get_visible">
<description>
-Used when subclassing #GtkEntryBuffer
+Returns %TRUE if the mark is visible (i.e. a cursor is displayed
+for it).
-Since: 2.18
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkEntryBuffer
-</parameter_description>
-</parameter>
-<parameter name="position">
-<parameter_description> position at which text was inserted
-</parameter_description>
-</parameter>
-<parameter name="chars">
-<parameter_description> text that was inserted
-</parameter_description>
-</parameter>
-<parameter name="n_chars">
-<parameter_description> number of characters inserted
+<parameter name="mark">
+<parameter_description> a #GtkTextMark
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if visible
+</return>
</function>
-<function name="gtk_widget_get_can_default">
+<function name="gtk_text_mark_new">
<description>
-Determines whether @widget can be a default widget. See
-gtk_widget_set_can_default().
+Creates a text mark. Add it to a buffer using gtk_text_buffer_add_mark().
+If @name is %NULL, the mark is anonymous; otherwise, the mark can be
+retrieved by name using gtk_text_buffer_get_mark(). If a mark has left
+gravity, and text is inserted at the mark's current location, the mark
+will be moved to the left of the newly-inserted text. If the mark has
+right gravity (@left_gravity = %FALSE), the mark will end up on the
+right of newly-inserted text. The standard left-to-right cursor is a
+mark with right gravity (when you type, the cursor stays on the right
+side of the text you're typing).
-Since: 2.18
+Since: 2.12
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="name">
+<parameter_description> mark name or %NULL
+</parameter_description>
+</parameter>
+<parameter name="left_gravity">
+<parameter_description> whether the mark should have left gravity
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @widget can be a default widget, %FALSE otherwise
+<return> new #GtkTextMark
</return>
</function>
-<function name="gtk_action_group_set_visible">
+<function name="gtk_text_mark_set_visible">
<description>
-Changes the visible of @action_group.
+Sets the visibility of @mark; the insertion point is normally
+visible, i.e. you can see it as a vertical bar. Also, the text
+widget uses a visible mark to indicate where a drop will occur when
+dragging-and-dropping text. Most other marks are not visible.
+Marks are not visible by default.
-Since: 2.4
</description>
<parameters>
-<parameter name="action_group">
-<parameter_description> the action group
+<parameter name="mark">
+<parameter_description> a #GtkTextMark
</parameter_description>
</parameter>
-<parameter name="visible">
-<parameter_description> new visiblity
+<parameter name="setting">
+<parameter_description> visibility of mark
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_paint_tab">
+<function name="gtk_text_tag_event">
<description>
-Draws an option menu tab (i.e. the up and down pointing arrows)
-in the given rectangle on @window using the given parameters.
+Emits the "event" signal on the #GtkTextTag.
+
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
-</parameter_description>
-</parameter>
-<parameter name="shadow_type">
-<parameter_description> the type of shadow to draw
-</parameter_description>
-</parameter>
-<parameter name="area">
-<parameter_description> clip rectangle, or %NULL if the
-output should not be clipped
-</parameter_description>
-</parameter>
-<parameter name="widget">
-<parameter_description> the widget
-</parameter_description>
-</parameter>
-<parameter name="detail">
-<parameter_description> a style detail
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> x origin of the rectangle to draw the tab in
+<parameter name="tag">
+<parameter_description> a #GtkTextTag
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> y origin of the rectangle to draw the tab in
+<parameter name="event_object">
+<parameter_description> object that received the event, such as a widget
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> the width of the rectangle to draw the tab in
+<parameter name="event">
+<parameter_description> the event
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> the height of the rectangle to draw the tab in
+<parameter name="iter">
+<parameter_description> location where the event was received
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> result of signal emission (whether the event was handled)
+</return>
</function>
-<function name="gtk_widget_set_child_visible">
+<function name="gtk_text_tag_get_priority">
<description>
-Sets whether @widget should be mapped along with its when its parent
-is mapped and @widget has been shown with gtk_widget_show().
-
-The child visibility can be set for widget before it is added to
-a container with gtk_widget_set_parent(), to avoid mapping
-children unnecessary before immediately unmapping them. However
-it will be reset to its default state of %TRUE when the widget
-is removed from a container.
-
-Note that changing the child visibility of a widget does not
-queue a resize on the widget. Most of the time, the size of
-a widget is computed from all visible children, whether or
-not they are mapped. If this is not the case, the container
-can queue a resize itself.
+Get the tag priority.
-This function is only useful for container implementations and
-never should be called by an application.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="is_visible">
-<parameter_description> if %TRUE, @widget should be mapped along with its parent.
+<parameter name="tag">
+<parameter_description> a #GtkTextTag
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The tag's priority.
+</return>
</function>
-<function name="gtk_button_set_image_position">
+<function name="gtk_text_tag_new">
<description>
-Sets the position of the image relative to the text
-inside the button.
+Creates a #GtkTextTag. Configure the tag using object arguments,
+i.e. using g_object_set().
-Since: 2.10
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkButton
-</parameter_description>
-</parameter>
-<parameter name="position">
-<parameter_description> the position
+<parameter name="name">
+<parameter_description> tag name, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
-</function>
-
-<function name="gtk_accelerator_get_default_mod_mask">
-<description>
-Gets the value set by gtk_accelerator_set_default_mod_mask().
-
-</description>
-<parameters>
-</parameters>
-<return> the default accelerator modifier mask
+<return> a new #GtkTextTag
</return>
</function>
-<function name="gtk_print_operation_set_n_pages">
+<function name="gtk_text_tag_set_priority">
<description>
-Sets the number of pages in the document.
-
-This <emphasis>must</emphasis> be set to a positive number
-before the rendering starts. It may be set in a
-#GtkPrintOperation::begin-print signal hander.
-
-Note that the page numbers passed to the
-#GtkPrintOperation::request-page-setup
-and #GtkPrintOperation::draw-page signals are 0-based, i.e. if
-the user chooses to print all pages, the last ::draw-page signal
-will be for page @n_pages - 1.
-
-Since: 2.10
+Sets the priority of a #GtkTextTag. Valid priorities are
+start at 0 and go to one less than gtk_text_tag_table_get_size().
+Each tag in a table has a unique priority; setting the priority
+of one tag shifts the priorities of all the other tags in the
+table to maintain a unique priority for each tag. Higher priority
+tags "win" if two tags both set the same text attribute. When adding
+a tag to a tag table, it will be assigned the highest priority in
+the table by default; so normally the precedence of a set of tags
+is the order in which they were added to the table, or created with
+gtk_text_buffer_create_tag(), which adds the tag to the buffer's table
+automatically.
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter name="tag">
+<parameter_description> a #GtkTextTag
</parameter_description>
</parameter>
-<parameter name="n_pages">
-<parameter_description> the number of pages
+<parameter name="priority">
+<parameter_description> the new priority
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_container_class_install_child_property">
+<function name="gtk_text_tag_table_add">
<description>
-Installs a child property on a container class.
+Add a tag to the table. The tag is assigned the highest priority
+in the table.
+
+ tag must not be in a tag table already, and may not have
+the same name as an already-added tag.
</description>
<parameters>
-<parameter name="cclass">
-<parameter_description> a #GtkContainerClass
-</parameter_description>
-</parameter>
-<parameter name="property_id">
-<parameter_description> the id for the property
+<parameter name="table">
+<parameter_description> a #GtkTextTagTable
</parameter_description>
</parameter>
-<parameter name="pspec">
-<parameter_description> the #GParamSpec for the property
+<parameter name="tag">
+<parameter_description> a #GtkTextTag
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_layout_get_line_at_y">
+<function name="gtk_text_tag_table_foreach">
<description>
-Get the iter at the beginning of the line which is displayed
-at the given y.
+Calls @func on each tag in @table, with user data @data.
+Note that the table may not be modified while iterating
+over it (you can't add/remove tags).
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #GtkLayout
-</parameter_description>
-</parameter>
-<parameter name="target_iter">
-<parameter_description> the iterator in which the result is stored
+<parameter name="table">
+<parameter_description> a #GtkTextTagTable
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> the y positition
+<parameter name="func">
+<parameter_description> a function to call on each tag
</parameter_description>
</parameter>
-<parameter name="line_top">
-<parameter_description> location to store the y coordinate of the
-top of the line. (Can by %NULL)
+<parameter name="data">
+<parameter_description> user data
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_scrolled_window_get_shadow_type">
+<function name="gtk_text_tag_table_get_size">
<description>
-Gets the shadow type of the scrolled window. See
-gtk_scrolled_window_set_shadow_type().
+Returns the size of the table (number of tags)
</description>
<parameters>
-<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter name="table">
+<parameter_description> a #GtkTextTagTable
</parameter_description>
</parameter>
</parameters>
-<return> the current shadow type
+<return> number of tags in @table
</return>
</function>
-<function name="gtk_widget_create_pango_context">
+<function name="gtk_text_tag_table_lookup">
<description>
-Creates a new #PangoContext with the appropriate font map,
-font description, and base direction for drawing text for
-this widget. See also gtk_widget_get_pango_context().
+Look up a named tag.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="table">
+<parameter_description> a #GtkTextTagTable
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> name of a tag
</parameter_description>
</parameter>
</parameters>
-<return> the new #PangoContext
+<return> The tag, or %NULL if none by that name is in the table.
</return>
</function>
-<function name="gtk_action_is_sensitive">
+<function name="gtk_text_tag_table_new">
<description>
-Returns whether the action is effectively sensitive.
+Creates a new #GtkTextTagTable. The table contains no tags by
+default.
-Since: 2.4
</description>
<parameters>
-<parameter name="action">
-<parameter_description> the action object
-</parameter_description>
-</parameter>
</parameters>
-<return> %TRUE if the action and its associated action group
-are both sensitive.
-
+<return> a new #GtkTextTagTable
</return>
</function>
-<function name="gtk_action_set_label">
+<function name="gtk_text_tag_table_remove">
<description>
-Sets the label of @action.
-
-Since: 2.16
+Remove a tag from the table. This will remove the table's
+reference to the tag, so be careful - the tag will end
+up destroyed if you don't have a reference to it.
</description>
<parameters>
-<parameter name="action">
-<parameter_description> a #GtkAction
+<parameter name="table">
+<parameter_description> a #GtkTextTagTable
</parameter_description>
</parameter>
-<parameter name="label">
-<parameter_description> the label text to set
+<parameter name="tag">
+<parameter_description> a #GtkTextTag
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_font_selection_dialog_new">
+<function name="gtk_text_view_add_child_at_anchor">
<description>
-Creates a new #GtkFontSelectionDialog.
-
+Adds a child widget in the text buffer, at the given @anchor.
</description>
<parameters>
-<parameter name="title">
-<parameter_description> the title of the dialog window
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="anchor">
+<parameter_description> a #GtkTextChildAnchor in the #GtkTextBuffer for @text_view
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkFontSelectionDialog
-</return>
+<return></return>
</function>
-<function name="gtk_icon_source_get_direction">
+<function name="gtk_text_view_add_child_in_window">
<description>
-Obtains the text direction this icon source applies to. The return
-value is only useful/meaningful if the text direction is <emphasis>not</emphasis>
-wildcarded.
-
+Adds a child at fixed coordinates in one of the text widget's
+windows. The window must have nonzero size (see
+gtk_text_view_set_border_window_size()). Note that the child
+coordinates are given relative to the #GdkWindow in question, and
+that these coordinates have no sane relationship to scrolling. When
+placing a child in #GTK_TEXT_WINDOW_WIDGET, scrolling is
+irrelevant, the child floats above all scrollable areas. But when
+placing a child in one of the scrollable windows (border windows or
+text window), you'll need to compute the child's correct position
+in buffer coordinates any time scrolling occurs or buffer changes
+occur, and then call gtk_text_view_move_child() to update the
+child's position. Unfortunately there's no good way to detect that
+scrolling has occurred, using the current API; a possible hack
+would be to update all child positions when the scroll adjustments
+change or the text buffer changes. See bug 64518 on
+bugzilla.gnome.org for status of fixing this issue.
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GtkIconSource
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="which_window">
+<parameter_description> which window the child should appear in
+</parameter_description>
+</parameter>
+<parameter name="xpos">
+<parameter_description> X position of child in window coordinates
+</parameter_description>
+</parameter>
+<parameter name="ypos">
+<parameter_description> Y position of child in window coordinates
</parameter_description>
</parameter>
</parameters>
-<return> text direction this source matches
-</return>
+<return></return>
</function>
-<function name="gtk_ui_manager_get_widget">
+<function name="gtk_text_view_backward_display_line">
<description>
-Looks up a widget by following a path.
-The path consists of the names specified in the XML description of the UI.
-separated by '/'. Elements which don't have a name or action attribute in
-the XML (e.g. <popup>) can be addressed by their XML element name
-(e.g. "popup"). The root element ("/ui") can be omitted in the path.
-
-Note that the widget found by following a path that ends in a <menu>
-element is the menuitem to which the menu is attached, not the menu itself.
-
-Also note that the widgets constructed by a ui manager are not tied to
-the lifecycle of the ui manager. If you add the widgets returned by this
-function to some container or explicitly ref them, they will survive the
-destruction of the ui manager.
+Moves the given @iter backward by one display (wrapped) line.
+A display line is different from a paragraph. Paragraphs are
+separated by newlines or other paragraph separator characters.
+Display lines are created by line-wrapping a paragraph. If
+wrapping is turned off, display lines and paragraphs will be the
+same. Display lines are divided differently for each view, since
+they depend on the view's width; paragraphs are the same in all
+views, since they depend on the contents of the #GtkTextBuffer.
-Since: 2.4
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #GtkUIManager
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> a path
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return> the widget found by following the path, or %NULL if no widget
-was found.
-
+<return> %TRUE if @iter was moved and is not on the end iterator
</return>
</function>
-<function name="gtk_accel_group_query">
+<function name="gtk_text_view_backward_display_line_start">
<description>
-Queries an accelerator group for all entries matching @accel_key and
- accel_mods
+Moves the given @iter backward to the next display line start.
+A display line is different from a paragraph. Paragraphs are
+separated by newlines or other paragraph separator characters.
+Display lines are created by line-wrapping a paragraph. If
+wrapping is turned off, display lines and paragraphs will be the
+same. Display lines are divided differently for each view, since
+they depend on the view's width; paragraphs are the same in all
+views, since they depend on the contents of the #GtkTextBuffer.
+
</description>
<parameters>
-<parameter name="accel_group">
-<parameter_description> the accelerator group to query
-</parameter_description>
-</parameter>
-<parameter name="accel_key">
-<parameter_description> key value of the accelerator
-</parameter_description>
-</parameter>
-<parameter name="accel_mods">
-<parameter_description> modifier combination of the accelerator
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
-<parameter name="n_entries">
-<parameter_description> location to return the number of entries found, or %NULL
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return> an array of @n_entries #GtkAccelGroupEntry elements, or %NULL. The array is owned by GTK+ and must not be freed.
+<return> %TRUE if @iter was moved and is not on the end iterator
</return>
</function>
-<function name="gtk_cell_layout_pack_start">
+<function name="gtk_text_view_buffer_to_window_coords">
<description>
-Packs the @cell into the beginning of @cell_layout. If @expand is %FALSE,
-then the @cell is allocated no more space than it needs. Any unused space
-is divided evenly between cells for which @expand is %TRUE.
-
-Note that reusing the same cell renderer is not supported.
+Converts coordinate (@buffer_x, @buffer_y) to coordinates for the window
+ win, and stores the result in (@window_x, @window_y).
-Since: 2.4
+Note that you can't convert coordinates for a nonexisting window (see
+gtk_text_view_set_border_window_size()).
</description>
<parameters>
-<parameter name="cell_layout">
-<parameter_description> A #GtkCellLayout.
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
-<parameter name="cell">
-<parameter_description> A #GtkCellRenderer.
+<parameter name="win">
+<parameter_description> a #GtkTextWindowType except #GTK_TEXT_WINDOW_PRIVATE
</parameter_description>
</parameter>
-<parameter name="expand">
-<parameter_description> %TRUE if @cell is to be given extra space allocated to @cell_layout.
+<parameter name="buffer_x">
+<parameter_description> buffer x coordinate
+</parameter_description>
+</parameter>
+<parameter name="buffer_y">
+<parameter_description> buffer y coordinate
+</parameter_description>
+</parameter>
+<parameter name="window_x">
+<parameter_description> window x coordinate return location or %NULL
+</parameter_description>
+</parameter>
+<parameter name="window_y">
+<parameter_description> window y coordinate return location or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_vscale_new">
+<function name="gtk_text_view_forward_display_line">
<description>
-Creates a new #GtkVScale.
+Moves the given @iter forward by one display (wrapped) line.
+A display line is different from a paragraph. Paragraphs are
+separated by newlines or other paragraph separator characters.
+Display lines are created by line-wrapping a paragraph. If
+wrapping is turned off, display lines and paragraphs will be the
+same. Display lines are divided differently for each view, since
+they depend on the view's width; paragraphs are the same in all
+views, since they depend on the contents of the #GtkTextBuffer.
</description>
<parameters>
-<parameter name="adjustment">
-<parameter_description> the #GtkAdjustment which sets the range of the scale.
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkVScale.
+<return> %TRUE if @iter was moved and is not on the end iterator
</return>
</function>
-<function name="gtk_print_settings_get_resolution_x">
+<function name="gtk_text_view_forward_display_line_end">
<description>
-Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION_X.
+Moves the given @iter forward to the next display line end.
+A display line is different from a paragraph. Paragraphs are
+separated by newlines or other paragraph separator characters.
+Display lines are created by line-wrapping a paragraph. If
+wrapping is turned off, display lines and paragraphs will be the
+same. Display lines are divided differently for each view, since
+they depend on the view's width; paragraphs are the same in all
+views, since they depend on the contents of the #GtkTextBuffer.
-Since: 2.16
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return> the horizontal resolution in dpi
-
+<return> %TRUE if @iter was moved and is not on the end iterator
</return>
</function>
-<function name="gtk_print_settings_get_resolution_y">
+<function name="gtk_text_view_get_accepts_tab">
<description>
-Gets the value of %GTK_PRINT_SETTINGS_RESOLUTION_Y.
+Returns whether pressing the Tab key inserts a tab characters.
+gtk_text_view_set_accepts_tab().
-Since: 2.16
+Since: 2.4
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="text_view">
+<parameter_description> A #GtkTextView
</parameter_description>
</parameter>
</parameters>
-<return> the vertical resolution in dpi
+<return> %TRUE if pressing the Tab key inserts a tab character,
+%FALSE if pressing the Tab key moves the keyboard focus.
</return>
</function>
-<function name="gtk_color_selection_set_current_alpha">
+<function name="gtk_text_view_get_border_window_size">
<description>
-Sets the current opacity to be @alpha. The first time this is called, it will
-also set the original opacity to be @alpha too.
+Gets the width of the specified border window. See
+gtk_text_view_set_border_window_size().
+
</description>
<parameters>
-<parameter name="colorsel">
-<parameter_description> a #GtkColorSelection.
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
-<parameter name="alpha">
-<parameter_description> an integer between 0 and 65535.
+<parameter name="type">
+<parameter_description> window to return size from
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> width of window
+</return>
</function>
-<function name="gtk_label_get_mnemonic_widget">
+<function name="gtk_text_view_get_buffer">
<description>
-Retrieves the target of the mnemonic (keyboard shortcut) of this
-label. See gtk_label_set_mnemonic_widget().
+Returns the #GtkTextBuffer being displayed by this text view.
+The reference count on the buffer is not incremented; the caller
+of this function won't own a new reference.
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
</parameters>
-<return> the target of the label's mnemonic, or %NULL if none
-has been set and the default algorithm will be used.
+<return> a #GtkTextBuffer
</return>
</function>
-<function name="gtk_tool_shell_get_text_alignment">
+<function name="gtk_text_view_get_cursor_visible">
<description>
-Retrieves the current text alignment for the tool shell. Tool items must not
-call this function directly, but rely on gtk_tool_item_get_text_alignment()
-instead.
+Find out whether the cursor is being displayed.
-Since: 2.20
</description>
<parameters>
-<parameter name="shell">
-<parameter_description> a #GtkToolShell
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
</parameters>
-<return> the current text alignment of @shell
-
+<return> whether the insertion mark is visible
</return>
</function>
-<function name="gtk_expander_get_label">
+<function name="gtk_text_view_get_default_attributes">
<description>
-Fetches the text from a label widget including any embedded
-underlines indicating mnemonics and Pango markup, as set by
-gtk_expander_set_label(). If the label text has not been set the
-return value will be %NULL. This will be the case if you create an
-empty button with gtk_button_new() to use as a container.
+Obtains a copy of the default text attributes. These are the
+attributes used for text unless a tag overrides them.
+You'd typically pass the default attributes in to
+gtk_text_iter_get_attributes() in order to get the
+attributes in effect at a given text position.
-Note that this function behaved differently in versions prior to
-2.14 and used to return the label text stripped of embedded
-underlines indicating mnemonics and Pango markup. This problem can
-be avoided by fetching the label text directly from the label
-widget.
+The return value is a copy owned by the caller of this function,
+and should be freed.
-Since: 2.4
</description>
<parameters>
-<parameter name="expander">
-<parameter_description> a #GtkExpander
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
</parameters>
-<return> The text of the label widget. This string is owned
-by the widget and must not be modified or freed.
-
+<return> a new #GtkTextAttributes
</return>
</function>
-<function name="gtk_menu_bar_get_child_pack_direction">
+<function name="gtk_text_view_get_editable">
<description>
-Retrieves the current child pack direction of the menubar.
-See gtk_menu_bar_set_child_pack_direction().
+Returns the default editability of the #GtkTextView. Tags in the
+buffer may override this setting for some ranges of text.
-Since: 2.8
</description>
<parameters>
-<parameter name="menubar">
-<parameter_description> a #GtkMenuBar
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
</parameters>
-<return> the child pack direction
-
+<return> whether text is editable by default
</return>
</function>
-<function name="gtk_print_settings_load_file">
+<function name="gtk_text_view_get_hadjustment">
<description>
-Reads the print settings from @file_name. If the file could not be loaded
-then error is set to either a #GFileError or #GKeyFileError.
-See gtk_print_settings_to_file().
+Gets the horizontal-scrolling #GtkAdjustment.
-Since: 2.14
+Since: 2.22
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
-</parameter_description>
-</parameter>
-<parameter name="file_name">
-<parameter_description> the filename to read the settings from
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for errors, or %NULL
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success
+<return> pointer to the horizontal #GtkAdjustment
</return>
</function>
-<function name="gtk_about_dialog_get_translator_credits">
+<function name="gtk_text_view_get_indent">
<description>
-Returns the translator credits string which is displayed
-in the translators tab of the secondary credits dialog.
+Gets the default indentation of paragraphs in @text_view.
+Tags in the view's buffer may override the default.
+The indentation may be negative.
-Since: 2.6
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
</parameters>
-<return> The translator credits string. The string is
-owned by the about dialog and must not be modified.
-
+<return> number of pixels of indentation
</return>
</function>
-<function name="gtk_tree_model_sort_reset_default_sort_func">
+<function name="gtk_text_view_get_iter_at_location">
<description>
-This resets the default sort function to be in the 'unsorted' state. That
-is, it is in the same order as the child model. It will re-sort the model
-to be in the same order as the child model only if the #GtkTreeModelSort
-is in 'unsorted' state.
+Retrieves the iterator at buffer coordinates @x and @y. Buffer
+coordinates are coordinates for the entire buffer, not just the
+currently-displayed portion. If you have coordinates from an
+event, you have to convert those to buffer coordinates with
+gtk_text_view_window_to_buffer_coords().
</description>
<parameters>
-<parameter name="tree_model_sort">
-<parameter_description> A #GtkTreeModelSort
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> x position, in buffer coordinates
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y position, in buffer coordinates
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_size_group_set_ignore_hidden">
+<function name="gtk_text_view_get_iter_at_position">
<description>
-Sets whether unmapped widgets should be ignored when
-calculating the size.
+Retrieves the iterator pointing to the character at buffer
+coordinates @x and @y. Buffer coordinates are coordinates for
+the entire buffer, not just the currently-displayed portion.
+If you have coordinates from an event, you have to convert
+those to buffer coordinates with
+gtk_text_view_window_to_buffer_coords().
-Since: 2.8
+Note that this is different from gtk_text_view_get_iter_at_location(),
+which returns cursor locations, i.e. positions <emphasis>between</emphasis>
+characters.
+
+Since: 2.6
</description>
<parameters>
-<parameter name="size_group">
-<parameter_description> a #GtkSizeGroup
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
-<parameter name="ignore_hidden">
-<parameter_description> whether unmapped widgets should be ignored
-when calculating the size
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
+</parameter_description>
+</parameter>
+<parameter name="trailing">
+<parameter_description> if non-%NULL, location to store an integer indicating where
+in the grapheme the user clicked. It will either be
+zero, or the number of characters in the grapheme.
+0 represents the trailing edge of the grapheme.
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> x position, in buffer coordinates
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y position, in buffer coordinates
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_path_compare">
+<function name="gtk_text_view_get_iter_location">
<description>
-Compares two paths. If @a appears before @b in a tree, then -1 is returned.
-If @b appears before @a, then 1 is returned. If the two nodes are equal,
-then 0 is returned.
-
+Gets a rectangle which roughly contains the character at @iter.
+The rectangle position is in buffer coordinates; use
+gtk_text_view_buffer_to_window_coords() to convert these
+coordinates to coordinates for one of the windows in the text view.
</description>
<parameters>
-<parameter name="a">
-<parameter_description> A #GtkTreePath.
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
-<parameter name="b">
-<parameter_description> A #GtkTreePath to compare with.
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
+</parameter_description>
+</parameter>
+<parameter name="location">
+<parameter_description> bounds of the character at @iter
</parameter_description>
</parameter>
</parameters>
-<return> The relative positions of @a and @b
-</return>
+<return></return>
</function>
-<function name="gtk_notebook_get_tab_vborder">
+<function name="gtk_text_view_get_justification">
<description>
-Returns the vertical width of a tab border.
+Gets the default justification of paragraphs in @text_view.
+Tags in the buffer may override the default.
-Since: 2.22
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
</parameters>
-<return> vertical width of a tab border
-
+<return> default justification
</return>
</function>
-<function name="gtk_combo_box_get_focus_on_click">
+<function name="gtk_text_view_get_left_margin">
<description>
-Returns whether the combo box grabs focus when it is clicked
-with the mouse. See gtk_combo_box_set_focus_on_click().
+Gets the default left margin size of paragraphs in the @text_view.
+Tags in the buffer may override the default.
-Since: 2.6
</description>
<parameters>
-<parameter name="combo">
-<parameter_description> a #GtkComboBox
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the combo box grabs focus when it is
-clicked with the mouse.
-
+<return> left margin in pixels
</return>
</function>
-<function name="gtk_icon_view_set_row_spacing">
+<function name="gtk_text_view_get_line_at_y">
<description>
-Sets the ::row-spacing property which specifies the space
-which is inserted between the rows of the icon view.
-
-Since: 2.6
+Gets the #GtkTextIter at the start of the line containing
+the coordinate @y. @y is in buffer coordinates, convert from
+window coordinates with gtk_text_view_window_to_buffer_coords().
+If non-%NULL, @line_top will be filled with the coordinate of the top
+edge of the line.
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
-<parameter name="row_spacing">
-<parameter_description> the row spacing
+<parameter name="target_iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_image_new_from_pixmap">
-<description>
-Creates a #GtkImage widget displaying @pixmap with a @mask.
-A #GdkPixmap is a server-side image buffer in the pixel format of the
-current display. The #GtkImage does not assume a reference to the
-pixmap or mask; you still need to unref them if you own references.
-#GtkImage will add its own reference rather than adopting yours.
-
-
-</description>
-<parameters>
-<parameter name="pixmap">
-<parameter_description> a #GdkPixmap, or %NULL
+<parameter name="y">
+<parameter_description> a y coordinate
</parameter_description>
</parameter>
-<parameter name="mask">
-<parameter_description> a #GdkBitmap, or %NULL
+<parameter name="line_top">
+<parameter_description> return location for top coordinate of the line
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkImage
-</return>
+<return></return>
</function>
-<function name="gtk_widget_queue_draw_area">
+<function name="gtk_text_view_get_line_yrange">
<description>
-Invalidates the rectangular area of @widget defined by @x, @y,
- width and @height by calling gdk_window_invalidate_rect() on the
-widget's window and all its child windows. Once the main loop
-becomes idle (after the current batch of events has been processed,
-roughly), the window will receive expose events for the union of
-all regions that have been invalidated.
-
-Normally you would only use this function in widget
-implementations. You might also use it, or
-gdk_window_invalidate_rect() directly, to schedule a redraw of a
-#GtkDrawingArea or some portion thereof.
-
-Frequently you can just call gdk_window_invalidate_rect() or
-gdk_window_invalidate_region() instead of this function. Those
-functions will invalidate only a single window, instead of the
-widget and all its children.
-
-The advantage of adding to the invalidated region compared to
-simply drawing immediately is efficiency; using an invalid region
-ensures that you only have to redraw one time.
+Gets the y coordinate of the top of the line containing @iter,
+and the height of the line. The coordinate is a buffer coordinate;
+convert to window coordinates with gtk_text_view_buffer_to_window_coords().
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> x coordinate of upper-left corner of rectangle to redraw
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
<parameter name="y">
-<parameter_description> y coordinate of upper-left corner of rectangle to redraw
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> width of region to draw
+<parameter_description> return location for a y coordinate
</parameter_description>
</parameter>
<parameter name="height">
-<parameter_description> height of region to draw
+<parameter_description> return location for a height
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_deserialize_get_can_create_tags">
+<function name="gtk_text_view_get_overwrite">
<description>
-This functions returns the value set with
-gtk_text_buffer_deserialize_set_can_create_tags()
+Returns whether the #GtkTextView is in overwrite mode or not.
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="format">
-<parameter_description> a #GdkAtom representing a registered rich text format
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
</parameters>
-<return> whether deserializing this format may create tags
+<return> whether @text_view is in overwrite mode or not.
</return>
</function>
-<function name="gtk_icon_source_get_pixbuf">
+<function name="gtk_text_view_get_pixels_above_lines">
<description>
-Retrieves the source pixbuf, or %NULL if none is set.
-In addition, if a filename source is in use, this
-function in some cases will return the pixbuf from
-loaded from the filename. This is, for example, true
-for the GtkIconSource passed to the GtkStyle::render_icon()
-virtual function. The reference count on the pixbuf is
-not incremented.
+Gets the default number of pixels to put above paragraphs.
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GtkIconSource
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
</parameters>
-<return> source pixbuf
+<return> default number of pixels above paragraphs
</return>
</function>
-<function name="gtk_tree_view_get_show_expanders">
+<function name="gtk_text_view_get_pixels_below_lines">
<description>
-Returns whether or not expanders are drawn in @tree_view.
+Gets the value set by gtk_text_view_set_pixels_below_lines().
-Since: 2.12
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView.
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if expanders are drawn in @tree_view, %FALSE
-otherwise.
-
+<return> default number of blank pixels below paragraphs
</return>
</function>
-<function name="gtk_tree_iter_free">
+<function name="gtk_text_view_get_pixels_inside_wrap">
<description>
-Frees an iterator that has been allocated by gtk_tree_iter_copy().
-This function is mainly used for language bindings.
-
-</description>
-<parameters>
-<parameter name="iter">
-<parameter_description> A dynamically allocated tree iterator.
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
-</function>
+Gets the value set by gtk_text_view_set_pixels_inside_wrap().
-<function name="gtk_editable_paste_clipboard">
-<description>
-Pastes the content of the clipboard to the current position of the
-cursor in the editable.
</description>
<parameters>
-<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> default number of pixels of blank space between wrapped lines
+</return>
</function>
-<function name="gtk_tree_view_column_get_title">
+<function name="gtk_text_view_get_right_margin">
<description>
-Returns the title of the widget.
+Gets the default right margin for text in @text_view. Tags
+in the buffer may override the default.
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn.
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
</parameters>
-<return> the title of the column. This string should not be
-modified or freed.
+<return> right margin in pixels
</return>
</function>
-<function name="gtk_window_set_icon_name">
+<function name="gtk_text_view_get_tabs">
<description>
-Sets the icon for the window from a named themed icon. See
-the docs for #GtkIconTheme for more details.
-
-Note that this has nothing to do with the WM_ICON_NAME
-property which is mentioned in the ICCCM.
+Gets the default tabs for @text_view. Tags in the buffer may
+override the defaults. The returned array will be %NULL if
+"standard" (8-space) tabs are used. Free the return value
+with pango_tab_array_free().
-Since: 2.6
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
-</parameter_description>
-</parameter>
-<parameter name="name">
-<parameter_description> the name of the themed icon
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> copy of default tab array, or %NULL if "standard"
+tabs are used; must be freed with pango_tab_array_free().
+</return>
</function>
-<function name="gtk_action_group_add_actions_full">
+<function name="gtk_text_view_get_vadjustment">
<description>
-This variant of gtk_action_group_add_actions() adds a #GDestroyNotify
-callback for @user_data.
+Gets the vertical-scrolling #GtkAdjustment.
-Since: 2.4
+Since: 2.22
</description>
<parameters>
-<parameter name="action_group">
-<parameter_description> the action group
-</parameter_description>
-</parameter>
-<parameter name="entries">
-<parameter_description> an array of action descriptions
-</parameter_description>
-</parameter>
-<parameter name="n_entries">
-<parameter_description> the number of entries
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> data to pass to the action callbacks
-</parameter_description>
-</parameter>
-<parameter name="destroy">
-<parameter_description> destroy notification callback for @user_data
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> pointer to the vertical #GtkAdjustment
+
+</return>
</function>
-<function name="gtk_window_set_default">
+<function name="gtk_text_view_get_visible_rect">
<description>
-The default widget is the widget that's activated when the user
-presses Enter in a dialog (for example). This function sets or
-unsets the default widget for a #GtkWindow about. When setting
-(rather than unsetting) the default widget it's generally easier to
-call gtk_widget_grab_focus() on the widget. Before making a widget
-the default widget, you must set the #GTK_CAN_DEFAULT flag on the
-widget you'd like to make the default using GTK_WIDGET_SET_FLAGS().
+Fills @visible_rect with the currently-visible
+region of the buffer, in buffer coordinates. Convert to window coordinates
+with gtk_text_view_buffer_to_window_coords().
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
-<parameter name="default_widget">
-<parameter_description> widget to be the default, or %NULL to unset the
-default widget for the toplevel.
+<parameter name="visible_rect">
+<parameter_description> rectangle to fill
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_row_reference_new">
+<function name="gtk_text_view_get_window">
<description>
-Creates a row reference based on @path. This reference will keep pointing
-to the node pointed to by @path, so long as it exists. It listens to all
-signals emitted by @model, and updates its path appropriately. If @path
-isn't a valid path in @model, then %NULL is returned.
+Retrieves the #GdkWindow corresponding to an area of the text view;
+possible windows include the overall widget window, child windows
+on the left, right, top, bottom, and the window that displays the
+text buffer. Windows are %NULL and nonexistent if their width or
+height is 0, and are nonexistent before the widget has been
+realized.
</description>
<parameters>
-<parameter name="model">
-<parameter_description> A #GtkTreeModel
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> A valid #GtkTreePath to monitor
+<parameter name="win">
+<parameter_description> window to get
</parameter_description>
</parameter>
</parameters>
-<return> A newly allocated #GtkTreeRowReference, or %NULL
+<return> a #GdkWindow, or %NULL
</return>
</function>
-<function name="gtk_widget_new">
+<function name="gtk_text_view_get_window_type">
<description>
-This is a convenience function for creating a widget and setting
-its properties in one go. For example you might write:
-<literal>gtk_widget_new (GTK_TYPE_LABEL, "label", "Hello World", "xalign",
-0.0, NULL)</literal> to create a left-aligned label. Equivalent to
-g_object_new(), but returns a widget so you don't have to
-cast the object yourself.
+Usually used to find out which window an event corresponds to.
+If you connect to an event signal on @text_view, this function
+should be called on <literal>event->window</literal> to
+see which window it was.
</description>
<parameters>
-<parameter name="type">
-<parameter_description> type ID of the widget to create
-</parameter_description>
-</parameter>
-<parameter name="first_property_name">
-<parameter_description> name of first property to set
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> value of first property, followed by more properties,
-%NULL-terminated
+<parameter name="window">
+<parameter_description> a window type
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkWidget of type @widget_type
+<return> the window type.
</return>
</function>
-<function name="gtk_window_get_icon_name">
+<function name="gtk_text_view_get_wrap_mode">
<description>
-Returns the name of the themed icon for the window,
-see gtk_window_set_icon_name().
+Gets the line wrapping for the view.
-Since: 2.6
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
</parameters>
-<return> the icon name or %NULL if the window has
-no themed icon
-
+<return> the line wrap setting
</return>
</function>
-<function name="gtk_entry_get_icon_gicon">
+<function name="gtk_text_view_im_context_filter_keypress">
<description>
-Retrieves the #GIcon used for the icon, or %NULL if there is
-no icon or if the icon was set by some other method (e.g., by
-stock, pixbuf, or icon name).
+Allow the #GtkTextView input method to internally handle key press
+and release events. If this function returns %TRUE, then no further
+processing should be done for this key event. See
+gtk_im_context_filter_keypress().
-Since: 2.16
+Note that you are expected to call this function from your handler
+when overriding key event handling. This is needed in the case when
+you need to insert your own key handling between the input method
+and the default key event handling of the #GtkTextView.
-</description>
-<parameters>
-<parameter name="entry">
-<parameter_description> A #GtkEntry
-</parameter_description>
-</parameter>
-<parameter name="icon_pos">
-<parameter_description> Icon position
-</parameter_description>
-</parameter>
-</parameters>
-<return> A #GIcon, or %NULL if no icon is set or if the icon
-is not a #GIcon
+|[
+static gboolean
+gtk_foo_bar_key_press_event (GtkWidget *widget,
+GdkEventKey *event)
+{
+if ((key->keyval == GDK_Return || key->keyval == GDK_KP_Enter))
+{
+if (gtk_text_view_im_context_filter_keypress (GTK_TEXT_VIEW (view), event))
+return TRUE;
+}
-</return>
-</function>
+/ * Do some stuff * /
-<function name="gtk_tree_view_column_get_min_width">
-<description>
-Returns the minimum width in pixels of the @tree_column, or -1 if no minimum
-width is set.
+return GTK_WIDGET_CLASS (gtk_foo_bar_parent_class)->key_press_event (widget, event);
+}
+]|
+Since: 2.22
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn.
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
+</parameter_description>
+</parameter>
+<parameter name="event">
+<parameter_description> the key event
</parameter_description>
</parameter>
</parameters>
-<return> The minimum width of the @tree_column.
+<return> %TRUE if the input method handled the key event.
+
</return>
</function>
-<function name="gtk_range_get_slider_range">
+<function name="gtk_text_view_move_child">
<description>
-This function returns sliders range along the long dimension,
-in widget->window coordinates.
-
-This function is useful mainly for #GtkRange subclasses.
-
-Since: 2.20
+Updates the position of a child, as for gtk_text_view_add_child_in_window().
</description>
<parameters>
-<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
-<parameter name="slider_start">
-<parameter_description> return location for the slider's start, or %NULL
+<parameter name="child">
+<parameter_description> child widget already added to the text view
</parameter_description>
</parameter>
-<parameter name="slider_end">
-<parameter_description> return location for the slider's end, or %NULL
+<parameter name="xpos">
+<parameter_description> new X position in window coordinates
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_icon_view_unset_model_drag_source">
-<description>
-Undoes the effect of gtk_icon_view_enable_model_drag_source(). Calling this
-method sets #GtkIconView:reorderable to %FALSE.
-
-Since: 2.8
-
-</description>
-<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
+<parameter name="ypos">
+<parameter_description> new Y position in window coordinates
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_view_get_pixels_above_lines">
+<function name="gtk_text_view_move_mark_onscreen">
<description>
-Gets the default number of pixels to put above paragraphs.
+Moves a mark within the buffer so that it's
+located within the currently-visible text area.
</description>
@@ -51289,4763 +52286,4603 @@ Gets the default number of pixels to put above paragraphs.
<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
+<parameter name="mark">
+<parameter_description> a #GtkTextMark
+</parameter_description>
+</parameter>
</parameters>
-<return> default number of pixels above paragraphs
+<return> %TRUE if the mark moved (wasn't already onscreen)
</return>
</function>
-<function name="gtk_tree_view_set_expander_column">
+<function name="gtk_text_view_move_visually">
<description>
-Sets the column to draw the expander arrow at. It must be in @tree_view.
-If @column is %NULL, then the expander arrow is always at the first
-visible column.
+Move the iterator a given number of characters visually, treating
+it as the strong cursor position. If @count is positive, then the
+new strong cursor position will be @count positions to the right of
+the old cursor position. If @count is negative then the new strong
+cursor position will be @count positions to the left of the old
+cursor position.
+
+In the presence of bi-directional text, the correspondence
+between logical and visual order will depend on the direction
+of the current run, and there may be jumps when the cursor
+is moved off of the end of a run.
-If you do not want expander arrow to appear in your tree, set the
-expander column to a hidden column.
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
-<parameter name="column">
-<parameter_description> %NULL, or the column to draw the expander arrow at.
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
+</parameter_description>
+</parameter>
+<parameter name="count">
+<parameter_description> number of characters to move (negative moves left,
+positive moves right)
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @iter moved and is not on the end iterator
+</return>
</function>
-<function name="gtk_editable_copy_clipboard">
+<function name="gtk_text_view_new">
<description>
-Copies the contents of the currently selected content in the editable and
-puts it on the clipboard.
+Creates a new #GtkTextView. If you don't call gtk_text_view_set_buffer()
+before using the text view, an empty default buffer will be created
+for you. Get the buffer with gtk_text_view_get_buffer(). If you want
+to specify your own buffer, consider gtk_text_view_new_with_buffer().
+
</description>
<parameters>
-<parameter name="editable">
-<parameter_description> a #GtkEditable
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> a new #GtkTextView
+</return>
</function>
-<function name="gtk_icon_info_free">
+<function name="gtk_text_view_new_with_buffer">
<description>
-Free a #GtkIconInfo and associated information
+Creates a new #GtkTextView widget displaying the buffer
+ buffer One buffer can be shared among many widgets.
+ buffer may be %NULL to create a default buffer, in which case
+this function is equivalent to gtk_text_view_new(). The
+text view adds its own reference count to the buffer; it does not
+take over an existing reference.
-Since: 2.4
</description>
<parameters>
-<parameter name="icon_info">
-<parameter_description> a #GtkIconInfo
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GtkTextView.
+</return>
</function>
-<function name="gtk_tree_view_column_get_alignment">
+<function name="gtk_text_view_place_cursor_onscreen">
<description>
-Returns the current x alignment of @tree_column. This value can range
-between 0.0 and 1.0.
+Moves the cursor to the currently visible region of the
+buffer, it it isn't there already.
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn.
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
</parameters>
-<return> The current alignent of @tree_column.
+<return> %TRUE if the cursor had to be moved.
</return>
</function>
-<function name="gtk_window_get_resizable">
+<function name="gtk_text_view_reset_im_context">
<description>
-Gets the value set by gtk_window_set_resizable().
+Reset the input method context of the text view if needed.
+
+This can be necessary in the case where modifying the buffer
+would confuse on-going input method behavior.
+Since: 2.22
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the user can resize the window
-</return>
+<return></return>
</function>
-<function name="gtk_text_layout_move_iter_visually">
+<function name="gtk_text_view_scroll_mark_onscreen">
<description>
-Move the iterator a given number of characters visually, treating
-it as the strong cursor position. If @count is positive, then the
-new strong cursor position will be @count positions to the right of
-the old cursor position. If @count is negative then the new strong
-cursor position will be @count positions to the left of the old
-cursor position.
-
-In the presence of bidirection text, the correspondence
-between logical and visual order will depend on the direction
-of the current run, and there may be jumps when the cursor
-is moved off of the end of a run.
+Scrolls @text_view the minimum distance such that @mark is contained
+within the visible area of the widget.
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #GtkTextLayout
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
-<parameter name="count">
-<parameter_description> number of characters to move (negative moves left, positive moves right)
+<parameter name="mark">
+<parameter_description> a mark in the buffer for @text_view
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tooltip_set_icon_from_icon_name">
+<function name="gtk_text_view_scroll_to_iter">
<description>
-Sets the icon of the tooltip (which is in front of the text) to be
-the icon indicated by @icon_name with the size indicated
-by @size. If @icon_name is %NULL, the image will be hidden.
+Scrolls @text_view so that @iter is on the screen in the position
+indicated by @xalign and @yalign. An alignment of 0.0 indicates
+left or top, 1.0 indicates right or bottom, 0.5 means center.
+If @use_align is %FALSE, the text scrolls the minimal distance to
+get the mark onscreen, possibly not scrolling at all. The effective
+screen for purposes of this function is reduced by a margin of size
+ within_margin
+
+Note that this function uses the currently-computed height of the
+lines in the text buffer. Line heights are computed in an idle
+handler; so this function may not have the desired effect if it's
+called before the height computations. To avoid oddness, consider
+using gtk_text_view_scroll_to_mark() which saves a point to be
+scrolled to after line validation.
-Since: 2.14
</description>
<parameters>
-<parameter name="tooltip">
-<parameter_description> a #GtkTooltip
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
-<parameter name="icon_name">
-<parameter_description> an icon name, or %NULL
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> a stock icon size
+<parameter name="within_margin">
+<parameter_description> margin as a [0.0,0.5) fraction of screen size
+</parameter_description>
+</parameter>
+<parameter name="use_align">
+<parameter_description> whether to use alignment arguments (if %FALSE,
+just get the mark onscreen)
+</parameter_description>
+</parameter>
+<parameter name="xalign">
+<parameter_description> horizontal alignment of mark within visible area
+</parameter_description>
+</parameter>
+<parameter name="yalign">
+<parameter_description> vertical alignment of mark within visible area
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if scrolling occurred
+</return>
</function>
-<function name="gtk_rgb_to_hsv">
+<function name="gtk_text_view_scroll_to_mark">
<description>
-Converts a color from RGB space to HSV.
-Input values must be in the [0.0, 1.0] range;
-output values will be in the same range.
-
-Since: 2.14
+Scrolls @text_view so that @mark is on the screen in the position
+indicated by @xalign and @yalign. An alignment of 0.0 indicates
+left or top, 1.0 indicates right or bottom, 0.5 means center.
+If @use_align is %FALSE, the text scrolls the minimal distance to
+get the mark onscreen, possibly not scrolling at all. The effective
+screen for purposes of this function is reduced by a margin of size
+ within_margin
</description>
<parameters>
-<parameter name="r">
-<parameter_description> Red
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
-<parameter name="g">
-<parameter_description> Green
+<parameter name="mark">
+<parameter_description> a #GtkTextMark
</parameter_description>
</parameter>
-<parameter name="b">
-<parameter_description> Blue
+<parameter name="within_margin">
+<parameter_description> margin as a [0.0,0.5) fraction of screen size
</parameter_description>
</parameter>
-<parameter name="h">
-<parameter_description> Return value for the hue component
+<parameter name="use_align">
+<parameter_description> whether to use alignment arguments (if %FALSE, just
+get the mark onscreen)
</parameter_description>
</parameter>
-<parameter name="s">
-<parameter_description> Return value for the saturation component
+<parameter name="xalign">
+<parameter_description> horizontal alignment of mark within visible area
</parameter_description>
</parameter>
-<parameter name="v">
-<parameter_description> Return value for the value component
+<parameter name="yalign">
+<parameter_description> vertical alignment of mark within visible area
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_toggle_button_get_mode">
+<function name="gtk_text_view_set_accepts_tab">
<description>
-Retrieves whether the button is displayed as a separate indicator
-and label. See gtk_toggle_button_set_mode().
+Sets the behavior of the text widget when the Tab key is pressed.
+If @accepts_tab is %TRUE, a tab character is inserted. If @accepts_tab
+is %FALSE the keyboard focus is moved to the next widget in the focus
+chain.
+Since: 2.4
</description>
<parameters>
-<parameter name="toggle_button">
-<parameter_description> a #GtkToggleButton
+<parameter name="text_view">
+<parameter_description> A #GtkTextView
+</parameter_description>
+</parameter>
+<parameter name="accepts_tab">
+<parameter_description> %TRUE if pressing the Tab key should insert a tab
+character, %FALSE, if pressing the Tab key should move the
+keyboard focus.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the togglebutton is drawn as a separate indicator
-and label.
-</return>
+<return></return>
</function>
-<function name="gtk_viewport_new">
+<function name="gtk_text_view_set_border_window_size">
<description>
-Creates a new #GtkViewport with the given adjustments.
-
+Sets the width of %GTK_TEXT_WINDOW_LEFT or %GTK_TEXT_WINDOW_RIGHT,
+or the height of %GTK_TEXT_WINDOW_TOP or %GTK_TEXT_WINDOW_BOTTOM.
+Automatically destroys the corresponding window if the size is set
+to 0, and creates the window if the size is set to non-zero. This
+function can only be used for the "border windows," it doesn't work
+with #GTK_TEXT_WINDOW_WIDGET, #GTK_TEXT_WINDOW_TEXT, or
+#GTK_TEXT_WINDOW_PRIVATE.
</description>
<parameters>
-<parameter name="hadjustment">
-<parameter_description> horizontal adjustment.
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
-<parameter name="vadjustment">
-<parameter_description> vertical adjustment.
+<parameter name="type">
+<parameter_description> window to affect
+</parameter_description>
+</parameter>
+<parameter name="size">
+<parameter_description> width or height of the window
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkViewport.
-</return>
+<return></return>
</function>
-<function name="gtk_im_multicontext_append_menuitems">
+<function name="gtk_text_view_set_buffer">
<description>
-Add menuitems for various available input methods to a menu;
-the menuitems, when selected, will switch the input method
-for the context and the global default input method.
+Sets @buffer as the buffer being displayed by @text_view. The previous
+buffer displayed by the text view is unreferenced, and a reference is
+added to @buffer. If you owned a reference to @buffer before passing it
+to this function, you must remove that reference yourself; #GtkTextView
+will not "adopt" it.
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GtkIMMulticontext
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
-<parameter name="menushell">
-<parameter_description> a #GtkMenuShell
+<parameter name="buffer">
+<parameter_description> a #GtkTextBuffer
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_container_child_type">
+<function name="gtk_text_view_set_cursor_visible">
<description>
-Returns the type of the children supported by the container.
-
-Note that this may return %G_TYPE_NONE to indicate that no more
-children can be added, e.g. for a #GtkPaned which already has two
-children.
-
+Toggles whether the insertion point is displayed. A buffer with no editable
+text probably shouldn't have a visible cursor, so you may want to turn
+the cursor off.
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
+</parameter_description>
+</parameter>
+<parameter name="setting">
+<parameter_description> whether to show the insertion cursor
</parameter_description>
</parameter>
</parameters>
-<return> a #GType.
-</return>
+<return></return>
</function>
-<function name="gtk_bin_get_child">
+<function name="gtk_text_view_set_editable">
<description>
-Gets the child of the #GtkBin, or %NULL if the bin contains
-no child widget. The returned widget does not have a reference
-added, so you do not need to unref it.
-
+Sets the default editability of the #GtkTextView. You can override
+this default setting with tags in the buffer, using the "editable"
+attribute of tags.
</description>
<parameters>
-<parameter name="bin">
-<parameter_description> a #GtkBin
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
+</parameter_description>
+</parameter>
+<parameter name="setting">
+<parameter_description> whether it's editable
</parameter_description>
</parameter>
</parameters>
-<return> pointer to child of the #GtkBin
-</return>
+<return></return>
</function>
-<function name="gtk_button_set_alignment">
+<function name="gtk_text_view_set_indent">
<description>
-Sets the alignment of the child. This property has no effect unless
-the child is a #GtkMisc or a #GtkAligment.
-
-Since: 2.4
+Sets the default indentation for paragraphs in @text_view.
+Tags in the buffer may override the default.
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkButton
-</parameter_description>
-</parameter>
-<parameter name="xalign">
-<parameter_description> the horizontal position of the child, 0.0 is left aligned,
-1.0 is right aligned
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
-<parameter name="yalign">
-<parameter_description> the vertical position of the child, 0.0 is top aligned,
-1.0 is bottom aligned
+<parameter name="indent">
+<parameter_description> indentation in pixels
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_get_default_widget">
+<function name="gtk_text_view_set_justification">
<description>
-Returns the default widget for @window. See gtk_window_set_default()
-for more details.
+Sets the default justification of text in @text_view.
+Tags in the view's buffer may override the default.
-Since: 2.14
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
+</parameter_description>
+</parameter>
+<parameter name="justification">
+<parameter_description> justification
</parameter_description>
</parameter>
</parameters>
-<return> the default widget, or %NULL if there is none.
-
-</return>
+<return></return>
</function>
-<function name="gtk_plug_new_for_display">
+<function name="gtk_text_view_set_left_margin">
<description>
-Create a new plug widget inside the #GtkSocket identified by socket_id.
-
-Since: 2.2
+Sets the default left margin for text in @text_view.
+Tags in the buffer may override the default.
</description>
<parameters>
-<parameter name="display">
-<parameter_description> the #GdkDisplay on which @socket_id is displayed
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
-<parameter name="socket_id">
-<parameter_description> the XID of the socket's window.
+<parameter name="left_margin">
+<parameter_description> left margin in pixels
</parameter_description>
</parameter>
</parameters>
-<return> the new #GtkPlug widget.
-
-</return>
+<return></return>
</function>
-<function name="gtk_tree_view_column_clicked">
+<function name="gtk_text_view_set_overwrite">
<description>
-Emits the "clicked" signal on the column. This function will only work if
- tree_column is clickable.
+Changes the #GtkTextView overwrite mode.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> a #GtkTreeViewColumn
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
+</parameter_description>
+</parameter>
+<parameter name="overwrite">
+<parameter_description> %TRUE to turn on overwrite mode, %FALSE to turn it off
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_combo_box_get_popup_accessible">
+<function name="gtk_text_view_set_pixels_above_lines">
<description>
-Gets the accessible object corresponding to the combo box's popup.
-
-This function is mostly intended for use by accessibility technologies;
-applications should have little use for it.
-
-Since: 2.6
+Sets the default number of blank pixels above paragraphs in @text_view.
+Tags in the buffer for @text_view may override the defaults.
</description>
<parameters>
-<parameter name="combo_box">
-<parameter_description> a #GtkComboBox
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
+</parameter_description>
+</parameter>
+<parameter name="pixels_above_lines">
+<parameter_description> pixels above paragraphs
</parameter_description>
</parameter>
</parameters>
-<return> the accessible object corresponding to the combo box's popup.
-
-</return>
+<return></return>
</function>
-<function name="remove_file">
+<function name="gtk_text_view_set_pixels_below_lines">
<description>
-Removes the given file from the model. If the file is not part of
- model, this function does nothing.
+Sets the default number of pixels of blank space
+to put below paragraphs in @text_view. May be overridden
+by tags applied to @text_view's buffer.
</description>
<parameters>
-<parameter name="model">
-<parameter_description> the model
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
-<parameter name="file">
-<parameter_description> file to remove from the model. The file must have been
-added to the model previously
+<parameter name="pixels_below_lines">
+<parameter_description> pixels below paragraphs
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_get_display">
+<function name="gtk_text_view_set_pixels_inside_wrap">
<description>
-Get the #GdkDisplay for the toplevel window associated with
-this widget. This function can only be called after the widget
-has been added to a widget hierarchy with a #GtkWindow at the top.
-
-In general, you should only create display specific
-resources when a widget has been realized, and you should
-free those resources when the widget is unrealized.
-
-Since: 2.2
+Sets the default number of pixels of blank space to leave between
+display/wrapped lines within a paragraph. May be overridden by
+tags in @text_view's buffer.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
+</parameter_description>
+</parameter>
+<parameter name="pixels_inside_wrap">
+<parameter_description> default number of pixels between wrapped lines
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkDisplay for the toplevel for this widget.
-
-</return>
+<return></return>
</function>
-<function name="gtk_recent_manager_move_item">
+<function name="gtk_text_view_set_right_margin">
<description>
-Changes the location of a recently used resource from @uri to @new_uri.
-
-Please note that this function will not affect the resource pointed
-by the URIs, but only the URI used in the recently used resources list.
-
-Since: 2.10
+Sets the default right margin for text in the text view.
+Tags in the buffer may override the default.
</description>
<parameters>
-<parameter name="manager">
-<parameter_description> a #GtkRecentManager
-</parameter_description>
-</parameter>
-<parameter name="uri">
-<parameter_description> the URI of a recently used resource
-</parameter_description>
-</parameter>
-<parameter name="new_uri">
-<parameter_description> the new URI of the recently used resource, or %NULL to
-remove the item pointed by @uri in the list
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> a return location for a #GError, or %NULL
+<parameter name="right_margin">
+<parameter_description> right margin in pixels
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success.
-
-</return>
+<return></return>
</function>
-<function name="gtk_text_buffer_get_paste_target_list">
+<function name="gtk_text_view_set_tabs">
<description>
-This function returns the list of targets this text buffer supports
-for pasting and as DND destination. The targets in the list are
-added with %info values from the #GtkTextBufferTargetInfo enum,
-using gtk_target_list_add_rich_text_targets() and
-gtk_target_list_add_text_targets().
-
-Since: 2.10
+Sets the default tab stops for paragraphs in @text_view.
+Tags in the buffer may override the default.
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
+</parameter_description>
+</parameter>
+<parameter name="tabs">
+<parameter_description> tabs as a #PangoTabArray
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkTargetList
-
-</return>
+<return></return>
</function>
-<function name="gtk_action_get_name">
+<function name="gtk_text_view_set_wrap_mode">
<description>
-Returns the name of the action.
-
-Since: 2.4
+Sets the line wrapping for the view.
</description>
<parameters>
-<parameter name="action">
-<parameter_description> the action object
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
+</parameter_description>
+</parameter>
+<parameter name="wrap_mode">
+<parameter_description> a #GtkWrapMode
</parameter_description>
</parameter>
</parameters>
-<return> the name of the action. The string belongs to GTK+ and should not
-be freed.
-
-</return>
+<return></return>
</function>
-<function name="gtk_toolbar_get_tooltips">
+<function name="gtk_text_view_starts_display_line">
<description>
-Retrieves whether tooltips are enabled. See
-gtk_toolbar_set_tooltips().
+Determines whether @iter is at the start of a display line.
+See gtk_text_view_forward_display_line() for an explanation of
+display lines vs. paragraphs.
-Deprecated: 2.14: The toolkit-wide #GtkSettings:gtk-enable-tooltips property
-is now used instead.
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> a #GtkTextIter
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if tooltips are enabled
-
+<return> %TRUE if @iter begins a wrapped line
</return>
</function>
-<function name="gtk_notebook_set_tab_hborder">
+<function name="gtk_text_view_window_to_buffer_coords">
<description>
-Sets the width of the horizontal border of tab labels.
+Converts coordinates on the window identified by @win to buffer
+coordinates, storing the result in (@buffer_x,@buffer_y).
+
+Note that you can't convert coordinates for a nonexisting window (see
+gtk_text_view_set_border_window_size()).
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="text_view">
+<parameter_description> a #GtkTextView
</parameter_description>
</parameter>
-<parameter name="tab_hborder">
-<parameter_description> width of the horizontal border of tab labels.
+<parameter name="win">
+<parameter_description> a #GtkTextWindowType except #GTK_TEXT_WINDOW_PRIVATE
+</parameter_description>
+</parameter>
+<parameter name="window_x">
+<parameter_description> window x coordinate
+</parameter_description>
+</parameter>
+<parameter name="window_y">
+<parameter_description> window y coordinate
+</parameter_description>
+</parameter>
+<parameter name="buffer_x">
+<parameter_description> buffer x coordinate return location or %NULL
+</parameter_description>
+</parameter>
+<parameter name="buffer_y">
+<parameter_description> buffer y coordinate return location or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_ruler_new">
+<function name="gtk_toggle_action_get_active">
<description>
-Creates a new #GtkRuler with the given orientation.
+Returns the checked state of the toggle action.
-Since: 2.16
+Since: 2.4
</description>
<parameters>
-<parameter name="orientation">
-<parameter_description> the ruler's orientation.
+<parameter name="action">
+<parameter_description> the action object
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkRuler.
+<return> the checked state of the toggle action
</return>
</function>
-<function name="gtk_entry_get_text">
+<function name="gtk_toggle_action_get_draw_as_radio">
<description>
-Retrieves the contents of the entry widget.
-See also gtk_editable_get_chars().
-
-This is equivalent to:
-
-<informalexample><programlisting>
-gtk_entry_buffer_get_text (gtk_entry_get_buffer (entry));
-</programlisting></informalexample>
+Returns whether the action should have proxies like a radio action.
+Since: 2.4
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="action">
+<parameter_description> the action object
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the contents of the widget as a
-string. This string points to internally allocated
-storage in the widget and must not be freed, modified or
-stored.
+<return> whether the action should have proxies like a radio action.
+
</return>
</function>
-<function name="gtk_about_dialog_get_website">
+<function name="gtk_toggle_action_new">
<description>
-Returns the website URL.
+Creates a new #GtkToggleAction object. To add the action to
+a #GtkActionGroup and set the accelerator for the action,
+call gtk_action_group_add_action_with_accel().
-Since: 2.6
+Since: 2.4
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter name="name">
+<parameter_description> A unique name for the action
+</parameter_description>
+</parameter>
+<parameter name="label">
+<parameter_description> The label displayed in menu items and on buttons, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="tooltip">
+<parameter_description> A tooltip for the action, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="stock_id">
+<parameter_description> The stock icon to display in widgets representing the
+action, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> The website URL. The string is owned by the about
-dialog and must not be modified.
+<return> a new #GtkToggleAction
</return>
</function>
-<function name="gtk_tree_view_column_get_sort_column_id">
+<function name="gtk_toggle_action_set_active">
<description>
-Gets the logical @sort_column_id that the model sorts on when this
-column is selected for sorting.
-See gtk_tree_view_column_set_sort_column_id().
+Sets the checked state on the toggle action.
+Since: 2.4
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> a #GtkTreeViewColumn
+<parameter name="action">
+<parameter_description> the action object
+</parameter_description>
+</parameter>
+<parameter name="is_active">
+<parameter_description> whether the action should be checked or not
</parameter_description>
</parameter>
</parameters>
-<return> the current @sort_column_id for this column, or -1 if
-this column can't be used for sorting.
-</return>
+<return></return>
</function>
-<function name="gtk_drag_dest_set">
+<function name="gtk_toggle_action_set_draw_as_radio">
<description>
-Sets a widget as a potential drop destination, and adds default behaviors.
-
-The default behaviors listed in @flags have an effect similar
-to installing default handlers for the widget's drag-and-drop signals
-(#GtkWidget:drag-motion, #GtkWidget:drag-drop, ...). They all exist
-for convenience. When passing #GTK_DEST_DEFAULT_ALL for instance it is
-sufficient to connect to the widget's #GtkWidget::drag-data-received
-signal to get primitive, but consistent drag-and-drop support.
-
-Things become more complicated when you try to preview the dragged data,
-as described in the documentation for #GtkWidget:drag-motion. The default
-behaviors described by @flags make some assumptions, that can conflict
-with your own signal handlers. For instance #GTK_DEST_DEFAULT_DROP causes
-invokations of gdk_drag_status() in the context of #GtkWidget:drag-motion,
-and invokations of gtk_drag_finish() in #GtkWidget:drag-data-received.
-Especially the later is dramatic, when your own #GtkWidget:drag-motion
-handler calls gtk_drag_get_data() to inspect the dragged data.
-
-There's no way to set a default action here, you can use the
-#GtkWidget:drag-motion callback for that. Here's an example which selects
-the action to use depending on whether the control key is pressed or not:
-|[
-static void
-drag_motion (GtkWidget *widget,
-GdkDragContext *context,
-gint x,
-gint y,
-guint time)
-{
-GdkModifierType mask;
+Sets whether the action should have proxies like a radio action.
-gdk_window_get_pointer (gtk_widget_get_window (widget),
-NULL, NULL, &mask);
-if (mask & GDK_CONTROL_MASK)
-gdk_drag_status (context, GDK_ACTION_COPY, time);
-else
-gdk_drag_status (context, GDK_ACTION_MOVE, time);
-}
-]|
+Since: 2.4
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> which types of default drag behavior to use
-</parameter_description>
-</parameter>
-<parameter name="targets">
-<parameter_description> a pointer to an array of #GtkTargetEntry<!-- -->s
-indicating the drop types that this @widget will accept, or %NULL.
-Later you can access the list with gtk_drag_dest_get_target_list()
-and gtk_drag_dest_find_target().
-</parameter_description>
-</parameter>
-<parameter name="n_targets">
-<parameter_description> the number of entries in @targets
+<parameter name="action">
+<parameter_description> the action object
</parameter_description>
</parameter>
-<parameter name="actions">
-<parameter_description> a bitmask of possible actions for a drop onto this @widget.
+<parameter name="draw_as_radio">
+<parameter_description> whether the action should have proxies like a radio
+action
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_create_tag">
+<function name="gtk_toggle_action_toggled">
<description>
-Creates a tag and adds it to the tag table for @buffer.
-Equivalent to calling gtk_text_tag_new() and then adding the
-tag to the buffer's tag table. The returned tag is owned by
-the buffer's tag table, so the ref count will be equal to one.
-
-If @tag_name is %NULL, the tag is anonymous.
-
-If @tag_name is non-%NULL, a tag called @tag_name must not already
-exist in the tag table for this buffer.
-
-The @first_property_name argument and subsequent arguments are a list
-of properties to set on the tag, as with g_object_set().
+Emits the "toggled" signal on the toggle action.
+Since: 2.4
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="tag_name">
-<parameter_description> name of the new tag, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="first_property_name">
-<parameter_description> name of first property to set, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="Varargs">
-<parameter_description> %NULL-terminated list of property names and values
+<parameter name="action">
+<parameter_description> the action object
</parameter_description>
</parameter>
</parameters>
-<return> a new tag
-</return>
+<return></return>
</function>
-<function name="gtk_icon_info_get_attach_points">
+<function name="gtk_toggle_button_get_inconsistent">
<description>
-Fetches the set of attach points for an icon. An attach point
-is a location in the icon that can be used as anchor points for attaching
-emblems or overlays to the icon.
+Gets the value set by gtk_toggle_button_set_inconsistent().
-Since: 2.4
</description>
<parameters>
-<parameter name="icon_info">
-<parameter_description> a #GtkIconInfo
-</parameter_description>
-</parameter>
-<parameter name="points">
-<parameter_description> location to store pointer to an array of points, or %NULL
-free the array of points with g_free().
-</parameter_description>
-</parameter>
-<parameter name="n_points">
-<parameter_description> location to store the number of points in @points, or %NULL
+<parameter name="toggle_button">
+<parameter_description> a #GtkToggleButton
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if there are any attach points for the icon.
-
+<return> %TRUE if the button is displayed as inconsistent, %FALSE otherwise
</return>
</function>
-<function name="gtk_hbox_new">
+<function name="gtk_toggle_button_get_mode">
<description>
-Creates a new #GtkHBox.
+Retrieves whether the button is displayed as a separate indicator
+and label. See gtk_toggle_button_set_mode().
</description>
<parameters>
-<parameter name="homogeneous">
-<parameter_description> %TRUE if all children are to be given equal space allotments.
-</parameter_description>
-</parameter>
-<parameter name="spacing">
-<parameter_description> the number of pixels to place by default between children.
+<parameter name="toggle_button">
+<parameter_description> a #GtkToggleButton
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkHBox.
+<return> %TRUE if the togglebutton is drawn as a separate indicator
+and label.
</return>
</function>
-<function name="gtk_text_buffer_get_start_iter">
+<function name="gtk_toggle_button_new_with_mnemonic">
<description>
-Initialized @iter with the first position in the text buffer. This
-is the same as using gtk_text_buffer_get_iter_at_offset() to get
-the iter at character offset 0.
+Creates a new #GtkToggleButton containing a label. The label
+will be created using gtk_label_new_with_mnemonic(), so underscores
+in @label indicate the mnemonic for the button.
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> iterator to initialize
+<parameter name="label">
+<parameter_description> the text of the button, with an underscore in front of the
+mnemonic character
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GtkToggleButton
+</return>
</function>
-<function name="gtk_target_list_add_rich_text_targets">
+<function name="gtk_toggle_button_set_inconsistent">
<description>
-Appends the rich text targets registered with
-gtk_text_buffer_register_serialize_format() or
-gtk_text_buffer_register_deserialize_format() to the target list. All
-targets are added with the same @info.
+If the user has selected a range of elements (such as some text or
+spreadsheet cells) that are affected by a toggle button, and the
+current values in that range are inconsistent, you may want to
+display the toggle in an "in between" state. This function turns on
+"in between" display. Normally you would turn off the inconsistent
+state again if the user toggles the toggle button. This has to be
+done manually, gtk_toggle_button_set_inconsistent() only affects
+visual appearance, it doesn't affect the semantics of the button.
-Since: 2.10
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GtkTargetList
-</parameter_description>
-</parameter>
-<parameter name="info">
-<parameter_description> an ID that will be passed back to the application
-</parameter_description>
-</parameter>
-<parameter name="deserializable">
-<parameter_description> if %TRUE, then deserializable rich text formats
-will be added, serializable formats otherwise.
+<parameter name="toggle_button">
+<parameter_description> a #GtkToggleButton
</parameter_description>
</parameter>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer.
+<parameter name="setting">
+<parameter_description> %TRUE if state is inconsistent
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_move_mark">
+<function name="gtk_toggle_button_set_mode">
<description>
-Moves @mark to the new location @where. Emits the "mark-set" signal
-as notification of the move.
+Sets whether the button is displayed as a separate indicator and label.
+You can call this function on a checkbutton or a radiobutton with
+ draw_indicator = %FALSE to make the button look like a normal button
+
+This function only affects instances of classes like #GtkCheckButton
+and #GtkRadioButton that derive from #GtkToggleButton,
+not instances of #GtkToggleButton itself.
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="mark">
-<parameter_description> a #GtkTextMark
+<parameter name="toggle_button">
+<parameter_description> a #GtkToggleButton
</parameter_description>
</parameter>
-<parameter name="where">
-<parameter_description> new location for @mark in @buffer
+<parameter name="draw_indicator">
+<parameter_description> if %TRUE, draw the button as a separate indicator
+and label; if %FALSE, draw the button like a normal button
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_column_cell_is_visible">
+<function name="gtk_toggle_tool_button_get_active">
<description>
-Returns %TRUE if any of the cells packed into the @tree_column are visible.
-For this to be meaningful, you must first initialize the cells with
-gtk_tree_view_column_cell_set_cell_data()
+Queries a #GtkToggleToolButton and returns its current state.
+Returns %TRUE if the toggle button is pressed in and %FALSE if it is raised.
+Since: 2.4
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn
+<parameter name="button">
+<parameter_description> a #GtkToggleToolButton
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE, if any of the cells packed into the @tree_column are currently visible
-</return>
-</function>
-
-<function name="gtk_text_iter_backward_to_tag_toggle">
-<description>
-Moves backward to the next toggle (on or off) of the
-#GtkTextTag @tag, or to the next toggle of any tag if
- tag is %NULL. If no matching tag toggles are found,
-returns %FALSE, otherwise %TRUE. Does not return toggles
-located at @iter, only toggles before @iter. Sets @iter
-to the location of the toggle, or the start of the buffer
-if no toggle is found.
-
+<return> %TRUE if the toggle tool button is pressed in, %FALSE if not
-</description>
-<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
-</parameter_description>
-</parameter>
-<parameter name="tag">
-<parameter_description> a #GtkTextTag, or %NULL
-</parameter_description>
-</parameter>
-</parameters>
-<return> whether we found a tag toggle before @iter
</return>
</function>
-<function name="gtk_recent_chooser_set_show_not_found">
+<function name="gtk_toggle_tool_button_new">
<description>
-Sets whether @chooser should display the recently used resources that
-it didn't find. This only applies to local resources.
+Returns a new #GtkToggleToolButton
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
-</parameter_description>
-</parameter>
-<parameter name="show_not_found">
-<parameter_description> whether to show the local items we didn't find
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> a newly created #GtkToggleToolButton
+
+</return>
</function>
-<function name="gtk_recent_filter_filter">
+<function name="gtk_toggle_tool_button_new_from_stock">
<description>
-Tests whether a file should be displayed according to @filter.
-The #GtkRecentFilterInfo structure @filter_info should include
-the fields returned from gtk_recent_filter_get_needed().
+Creates a new #GtkToggleToolButton containing the image and text from a
+stock item. Some stock ids have preprocessor macros like #GTK_STOCK_OK
+and #GTK_STOCK_APPLY.
-This function will not typically be used by applications; it
-is intended principally for use in the implementation of
-#GtkRecentChooser.
+It is an error if @stock_id is not a name of a stock item.
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="filter">
-<parameter_description> a #GtkRecentFilter
-</parameter_description>
-</parameter>
-<parameter name="filter_info">
-<parameter_description> a #GtkRecentFilterInfo structure containing information
-about a recently used resource
+<parameter name="stock_id">
+<parameter_description> the name of the stock item
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the file should be displayed
+<return> A new #GtkToggleToolButton
</return>
</function>
-<function name="gtk_notebook_set_show_tabs">
+<function name="gtk_toggle_tool_button_set_active">
<description>
-Sets whether to show the tabs for the notebook or not.
+Sets the status of the toggle tool button. Set to %TRUE if you
+want the GtkToggleButton to be 'pressed in', and %FALSE to raise it.
+This action causes the toggled signal to be emitted.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="button">
+<parameter_description> a #GtkToggleToolButton
</parameter_description>
</parameter>
-<parameter name="show_tabs">
-<parameter_description> %TRUE if the tabs should be shown.
+<parameter name="is_active">
+<parameter_description> whether @button should be active
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_scrolled_window_unset_placement">
+<function name="gtk_tool_button_get_icon_name">
<description>
-Unsets the placement of the contents with respect to the scrollbars
-for the scrolled window. If no window placement is set for a scrolled
-window, it obeys the "gtk-scrolled-window-placement" XSETTING.
-
-See also gtk_scrolled_window_set_placement() and
-gtk_scrolled_window_get_placement().
+Returns the name of the themed icon for the tool button,
+see gtk_tool_button_set_icon_name().
-Since: 2.10
+Since: 2.8
</description>
<parameters>
-<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter name="button">
+<parameter_description> a #GtkToolButton
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the icon name or %NULL if the tool button has
+no themed icon
+
+</return>
</function>
-<function name="gtk_icon_view_get_column_spacing">
+<function name="gtk_tool_button_get_icon_widget">
<description>
-Returns the value of the ::column-spacing property.
+Return the widget used as icon widget on @button.
+See gtk_tool_button_set_icon_widget().
-Since: 2.6
+Since: 2.4
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
+<parameter name="button">
+<parameter_description> a #GtkToolButton
</parameter_description>
</parameter>
</parameters>
-<return> the space between columns
+<return> The widget used as icon
+on @button, or %NULL.
</return>
</function>
-<function name="gtk_icon_view_set_item_padding">
+<function name="gtk_tool_button_get_label">
<description>
-Sets the #GtkIconView:item-padding property which specifies the padding
-around each of the icon view's items.
+Returns the label used by the tool button, or %NULL if the tool button
+doesn't have a label. or uses a the label from a stock item. The returned
+string is owned by GTK+, and must not be modified or freed.
-Since: 2.18
+Since: 2.4
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
-</parameter_description>
-</parameter>
-<parameter name="item_padding">
-<parameter_description> the item padding
+<parameter name="button">
+<parameter_description> a #GtkToolButton
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The label, or %NULL
+
+</return>
</function>
-<function name="gtk_color_button_set_use_alpha">
+<function name="gtk_tool_button_get_label_widget">
<description>
-Sets whether or not the color button should use the alpha channel.
+Returns the widget used as label on @button.
+See gtk_tool_button_set_label_widget().
Since: 2.4
</description>
<parameters>
-<parameter name="color_button">
-<parameter_description> a #GtkColorButton.
-</parameter_description>
-</parameter>
-<parameter name="use_alpha">
-<parameter_description> %TRUE if color button should use alpha channel, %FALSE if not.
+<parameter name="button">
+<parameter_description> a #GtkToolButton
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The widget used as label
+on @button, or %NULL.
+
+</return>
</function>
-<function name="gtk_label_set_justify">
+<function name="gtk_tool_button_get_stock_id">
<description>
-Sets the alignment of the lines in the text of the label relative to
-each other. %GTK_JUSTIFY_LEFT is the default value when the
-widget is first created with gtk_label_new(). If you instead want
-to set the alignment of the label as a whole, use
-gtk_misc_set_alignment() instead. gtk_label_set_justify() has no
-effect on labels containing only a single line.
+Returns the name of the stock item. See gtk_tool_button_set_stock_id().
+The returned string is owned by GTK+ and must not be freed or modifed.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
-</parameter_description>
-</parameter>
-<parameter name="jtype">
-<parameter_description> a #GtkJustification
+<parameter name="button">
+<parameter_description> a #GtkToolButton
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the name of the stock item for @button.
+
+</return>
</function>
-<function name="gtk_tree_row_reference_valid">
+<function name="gtk_tool_button_get_use_underline">
<description>
-Returns %TRUE if the @reference is non-%NULL and refers to a current valid
-path.
+Returns whether underscores in the label property are used as mnemonics
+on menu items on the overflow menu. See gtk_tool_button_set_use_underline().
+Since: 2.4
</description>
<parameters>
-<parameter name="reference">
-<parameter_description> A #GtkTreeRowReference, or %NULL
+<parameter name="button">
+<parameter_description> a #GtkToolButton
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @reference points to a valid path.
+<return> %TRUE if underscores in the label property are used as
+mnemonics on menu items on the overflow menu.
+
</return>
</function>
-<function name="gtk_icon_source_set_pixbuf">
+<function name="gtk_tool_button_new">
<description>
-Sets a pixbuf to use as a base image when creating icon variants
-for #GtkIconSet.
+Creates a new %GtkToolButton using @icon_widget as icon and @label as
+label.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GtkIconSource
+<parameter name="label">
+<parameter_description> a string that will be used as label, or %NULL
</parameter_description>
</parameter>
-<parameter name="pixbuf">
-<parameter_description> pixbuf to use as a source
+<parameter name="icon_widget">
+<parameter_description> a #GtkMisc widget that will be used as icon widget, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A new #GtkToolButton
+
+</return>
</function>
-<function name="gtk_bindings_activate_event">
+<function name="gtk_tool_button_new_from_stock">
<description>
-Looks up key bindings for @object to find one matching
- event, and if one was found, activate it.
+Creates a new #GtkToolButton containing the image and text from a
+stock item. Some stock ids have preprocessor macros like #GTK_STOCK_OK
+and #GTK_STOCK_APPLY.
+
+It is an error if @stock_id is not a name of a stock item.
Since: 2.4
</description>
<parameters>
-<parameter name="object">
-<parameter_description> a #GtkObject (generally must be a widget)
-</parameter_description>
-</parameter>
-<parameter name="event">
-<parameter_description> a #GdkEventKey
+<parameter name="stock_id">
+<parameter_description> the name of the stock item
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if a matching key binding was found
+<return> A new #GtkToolButton
</return>
</function>
-<function name="gtk_tree_selection_set_mode">
+<function name="gtk_tool_button_set_icon_name">
<description>
-Sets the selection mode of the @selection. If the previous type was
-#GTK_SELECTION_MULTIPLE, then the anchor is kept selected, if it was
-previously selected.
+Sets the icon for the tool button from a named themed icon.
+See the docs for #GtkIconTheme for more details.
+The "icon_name" property only has an effect if not
+overridden by non-%NULL "label", "icon_widget" and "stock_id"
+properties.
+
+Since: 2.8
</description>
<parameters>
-<parameter name="selection">
-<parameter_description> A #GtkTreeSelection.
+<parameter name="button">
+<parameter_description> a #GtkToolButton
</parameter_description>
</parameter>
-<parameter name="type">
-<parameter_description> The selection mode
+<parameter name="icon_name">
+<parameter_description> the name of the themed icon
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_im_context_focus_out">
+<function name="gtk_tool_button_set_icon_widget">
<description>
-Notify the input method that the widget to which this
-input context corresponds has lost focus. The input method
-may, for example, change the displayed feedback or reset the contexts
-state to reflect this change.
+Sets @icon as the widget used as icon on @button. If @icon_widget is
+%NULL the icon is determined by the "stock_id" property. If the
+"stock_id" property is also %NULL, @button will not have an icon.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GtkIMContext
+<parameter name="button">
+<parameter_description> a #GtkToolButton
+</parameter_description>
+</parameter>
+<parameter name="icon_widget">
+<parameter_description> the widget used as icon, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_event_box_set_above_child">
+<function name="gtk_tool_button_set_label">
<description>
-Set whether the event box window is positioned above the windows of its child,
-as opposed to below it. If the window is above, all events inside the
-event box will go to the event box. If the window is below, events
-in windows of child widgets will first got to that widget, and then
-to its parents.
-
-The default is to keep the window below the child.
+Sets @label as the label used for the tool button. The "label" property
+only has an effect if not overridden by a non-%NULL "label_widget" property.
+If both the "label_widget" and "label" properties are %NULL, the label
+is determined by the "stock_id" property. If the "stock_id" property is also
+%NULL, @button will not have a label.
Since: 2.4
</description>
<parameters>
-<parameter name="event_box">
-<parameter_description> a #GtkEventBox
+<parameter name="button">
+<parameter_description> a #GtkToolButton
</parameter_description>
</parameter>
-<parameter name="above_child">
-<parameter_description> %TRUE if the event box window is above the windows of its child
+<parameter name="label">
+<parameter_description> a string that will be used as label, or %NULL.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_item_factories_path_delete">
+<function name="gtk_tool_button_set_label_widget">
<description>
-Deletes all widgets constructed from the specified path.
+Sets @label_widget as the widget that will be used as the label
+for @button. If @label_widget is %NULL the "label" property is used
+as label. If "label" is also %NULL, the label in the stock item
+determined by the "stock_id" property is used as label. If
+"stock_id" is also %NULL, @button does not have a label.
-Deprecated: 2.4: Use #GtkUIManager instead.
+Since: 2.4
</description>
<parameters>
-<parameter name="ifactory_path">
-<parameter_description> a factory path to prepend to @path. May be %NULL if @path
-starts with a factory path
+<parameter name="button">
+<parameter_description> a #GtkToolButton
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> a path
+<parameter name="label_widget">
+<parameter_description> the widget used as label, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_builder_get_translation_domain">
+<function name="gtk_tool_button_set_stock_id">
<description>
-Gets the translation domain of @builder.
+Sets the name of the stock item. See gtk_tool_button_new_from_stock().
+The stock_id property only has an effect if not
+overridden by non-%NULL "label" and "icon_widget" properties.
-Since: 2.12
+Since: 2.4
</description>
<parameters>
-<parameter name="builder">
-<parameter_description> a #GtkBuilder
+<parameter name="button">
+<parameter_description> a #GtkToolButton
+</parameter_description>
+</parameter>
+<parameter name="stock_id">
+<parameter_description> a name of a stock item, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the translation domain. This string is owned
-by the builder object and must not be modified or freed.
-
-</return>
+<return></return>
</function>
-<function name="gtk_builder_connect_signals_full">
+<function name="gtk_tool_button_set_use_underline">
<description>
-This function can be thought of the interpreted language binding
-version of gtk_builder_connect_signals(), except that it does not
-require GModule to function correctly.
+If set, an underline in the label property indicates that the next character
+should be used for the mnemonic accelerator key in the overflow menu. For
+example, if the label property is "_Open" and @use_underline is %TRUE,
+the label on the tool button will be "Open" and the item on the overflow
+menu will have an underlined 'O'.
-Since: 2.12
+Labels shown on tool buttons never have mnemonics on them; this property
+only affects the menu item on the overflow menu.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="builder">
-<parameter_description> a #GtkBuilder
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> the function used to connect the signals
+<parameter name="button">
+<parameter_description> a #GtkToolButton
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> arbitrary data that will be passed to the connection function
+<parameter name="use_underline">
+<parameter_description> whether the button label has the form "_Open"
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_model_get_flags">
+<function name="gtk_tool_item_get_ellipsize_mode">
<description>
-Returns a set of flags supported by this interface. The flags are a bitwise
-combination of #GtkTreeModelFlags. The flags supported should not change
-during the lifecycle of the @tree_model.
+Returns the ellipsize mode used for @tool_item. Custom subclasses of
+#GtkToolItem should call this function to find out how text should
+be ellipsized.
+Since: 2.20
</description>
<parameters>
-<parameter name="tree_model">
-<parameter_description> A #GtkTreeModel.
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem
</parameter_description>
</parameter>
</parameters>
-<return> The flags supported by this interface.
+<return> a #PangoEllipsizeMode indicating how text in @tool_item
+should be ellipsized.
+
</return>
</function>
-<function name="gtk_buildable_get_name">
+<function name="gtk_tool_item_get_expand">
<description>
-Gets the name of the @buildable object.
-
-#GtkBuilder sets the name based on the the
-<link linkend="BUILDER-UI">GtkBuilder UI definition</link>
-used to construct the @buildable.
+Returns whether @tool_item is allocated extra space.
+See gtk_tool_item_set_expand().
-Since: 2.12
+Since: 2.4
</description>
<parameters>
-<parameter name="buildable">
-<parameter_description> a #GtkBuildable
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem
</parameter_description>
</parameter>
</parameters>
-<return> the name set with gtk_buildable_set_name()
+<return> %TRUE if @tool_item is allocated extra space.
</return>
</function>
-<function name="gtk_clist_set_pixmap">
+<function name="gtk_tool_item_get_homogeneous">
<description>
+Returns whether @tool_item is the same size as other homogeneous
+items. See gtk_tool_item_set_homogeneous().
+
+Since: 2.4
</description>
<parameters>
-<parameter name="mask">
-<parameter_description>
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the item is the same size as other homogeneous
+items.
+
+</return>
</function>
-<function name="gtk_notebook_set_action_widget">
+<function name="gtk_tool_item_get_icon_size">
<description>
-Sets @widget as one of the action widgets. Depending on the pack type
-the widget will be placed before or after the tabs. You can use
-a #GtkBox if you need to pack more than one widget on the same side.
-
-Note that action widgets are "internal" children of the notebook and thus
-not included in the list returned from gtk_container_foreach().
+Returns the icon size used for @tool_item. Custom subclasses of
+#GtkToolItem should call this function to find out what size icons
+they should use.
-Since: 2.20
+Since: 2.4
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
-</parameter_description>
-</parameter>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="pack_type">
-<parameter_description> pack type of the action widget
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #GtkIconSize indicating the icon size
+used for @tool_item
+
+</return>
</function>
-<function name="gtk_item_factory_add_foreign">
+<function name="gtk_tool_item_get_is_important">
<description>
-Installs an accelerator for @accel_widget in @accel_group, that causes
-the ::activate signal to be emitted if the accelerator is activated.
-
-This function can be used to make widgets participate in the accel
-saving/restoring functionality provided by gtk_accel_map_save() and
-gtk_accel_map_load(), even if they haven't been created by an item
-factory.
+Returns whether @tool_item is considered important. See
+gtk_tool_item_set_is_important()
-Deprecated: 2.4: The recommended API for this purpose are the functions
-gtk_menu_item_set_accel_path() and gtk_widget_set_accel_path(); don't
-use gtk_item_factory_add_foreign() in new code, since it is likely to
-be removed in the future.
+Since: 2.4
</description>
<parameters>
-<parameter name="accel_widget">
-<parameter_description> widget to install an accelerator on
-</parameter_description>
-</parameter>
-<parameter name="full_path">
-<parameter_description> the full path for the @accel_widget
-</parameter_description>
-</parameter>
-<parameter name="accel_group">
-<parameter_description> the accelerator group to install the accelerator in
-</parameter_description>
-</parameter>
-<parameter name="keyval">
-<parameter_description> key value of the accelerator
-</parameter_description>
-</parameter>
-<parameter name="modifiers">
-<parameter_description> modifier combination of the accelerator
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @tool_item is considered important.
+
+</return>
</function>
-<function name="gtk_label_get_line_wrap_mode">
+<function name="gtk_tool_item_get_orientation">
<description>
-Returns line wrap mode used by the label. See gtk_label_set_line_wrap_mode().
+Returns the orientation used for @tool_item. Custom subclasses of
+#GtkToolItem should call this function to find out what size icons
+they should use.
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the lines of the label are automatically wrapped.
+<return> a #GtkOrientation indicating the orientation
+used for @tool_item
</return>
</function>
-<function name="gtk_paned_set_position">
+<function name="gtk_tool_item_get_proxy_menu_item">
<description>
-Sets the position of the divider between the two panes.
+If @menu_item_id matches the string passed to
+gtk_tool_item_set_proxy_menu_item() return the corresponding #GtkMenuItem.
+
+Custom subclasses of #GtkToolItem should use this function to
+update their menu item when the #GtkToolItem changes. That the
+ menu_item_id<!-- -->s must match ensures that a #GtkToolItem
+will not inadvertently change a menu item that they did not create.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="paned">
-<parameter_description> a #GtkPaned widget
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> pixel position of divider, a negative value means that the position
-is unset.
+<parameter name="menu_item_id">
+<parameter_description> a string used to identify the menu item
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The #GtkMenuItem passed to
+gtk_tool_item_set_proxy_menu_item(), if the @menu_item_id<!-- -->s
+match.
+
+</return>
</function>
-<function name="gtk_window_get_urgency_hint">
+<function name="gtk_tool_item_get_relief_style">
<description>
-Gets the value set by gtk_window_set_urgency_hint()
+Returns the relief style of @tool_item. See gtk_button_set_relief_style().
+Custom subclasses of #GtkToolItem should call this function in the handler
+of the #GtkToolItem::toolbar_reconfigured signal to find out the
+relief style of buttons.
-Since: 2.8
+Since: 2.4
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if window is urgent
+<return> a #GtkReliefStyle indicating the relief style used
+for @tool_item.
</return>
</function>
-<function name="gtk_tree_sortable_get_sort_column_id">
+<function name="gtk_tool_item_get_text_alignment">
<description>
-Fills in @sort_column_id and @order with the current sort column and the
-order. It returns %TRUE unless the @sort_column_id is
-%GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID or
-%GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID.
+Returns the text alignment used for @tool_item. Custom subclasses of
+#GtkToolItem should call this function to find out how text should
+be aligned.
+Since: 2.20
</description>
<parameters>
-<parameter name="sortable">
-<parameter_description> A #GtkTreeSortable
-</parameter_description>
-</parameter>
-<parameter name="sort_column_id">
-<parameter_description> The sort column id to be filled in
-</parameter_description>
-</parameter>
-<parameter name="order">
-<parameter_description> The #GtkSortType to be filled in
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem:
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the sort column is not one of the special sort
-column ids.
+<return> a #gfloat indicating the horizontal text alignment
+used for @tool_item
+
</return>
</function>
-<function name="gtk_cell_editable_remove_widget">
+<function name="gtk_tool_item_get_text_orientation">
<description>
-Emits the #GtkCellEditable::remove-widget signal.
+Returns the text orientation used for @tool_item. Custom subclasses of
+#GtkToolItem should call this function to find out how text should
+be orientated.
+
+Since: 2.20
</description>
<parameters>
-<parameter name="cell_editable">
-<parameter_description> A #GtkTreeEditable
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #GtkOrientation indicating the text orientation
+used for @tool_item
+
+</return>
</function>
-<function name="gtk_drag_dest_get_target_list">
+<function name="gtk_tool_item_get_text_size_group">
<description>
-Returns the list of targets this widget can accept from
-drag-and-drop.
+Returns the size group used for labels in @tool_item.
+Custom subclasses of #GtkToolItem should call this function
+and use the size group for labels.
+Since: 2.20
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkTargetList, or %NULL if none
+<return> a #GtkSizeGroup
+
</return>
</function>
-<function name="gtk_text_view_im_context_filter_keypress">
+<function name="gtk_tool_item_get_toolbar_style">
<description>
-Allow the #GtkTextView input method to internally handle key press
-and release events. If this function returns %TRUE, then no further
-processing should be done for this key event. See
-gtk_im_context_filter_keypress().
-
-Note that you are expected to call this function from your handler
-when overriding key event handling. This is needed in the case when
-you need to insert your own key handling between the input method
-and the default key event handling of the #GtkTextView.
-
-|[
-static gboolean
-gtk_foo_bar_key_press_event (GtkWidget *widget,
-GdkEventKey *event)
-{
-if ((key->keyval == GDK_Return || key->keyval == GDK_KP_Enter))
-{
-if (gtk_text_view_im_context_filter_keypress (GTK_TEXT_VIEW (view), event))
-return TRUE;
-}
-
-/ * Do some stuff * /
+Returns the toolbar style used for @tool_item. Custom subclasses of
+#GtkToolItem should call this function in the handler of the
+GtkToolItem::toolbar_reconfigured signal to find out in what style
+the toolbar is displayed and change themselves accordingly
-return GTK_WIDGET_CLASS (gtk_foo_bar_parent_class)->key_press_event (widget, event);
-}
-]|
+Possibilities are:
+<itemizedlist>
+<listitem> GTK_TOOLBAR_BOTH, meaning the tool item should show
+both an icon and a label, stacked vertically </listitem>
+<listitem> GTK_TOOLBAR_ICONS, meaning the toolbar shows
+only icons </listitem>
+<listitem> GTK_TOOLBAR_TEXT, meaning the tool item should only
+show text</listitem>
+<listitem> GTK_TOOLBAR_BOTH_HORIZ, meaning the tool item should show
+both an icon and a label, arranged horizontally (however, note the
+#GtkToolButton::has_text_horizontally that makes tool buttons not
+show labels when the toolbar style is GTK_TOOLBAR_BOTH_HORIZ.
+</listitem>
+</itemizedlist>
-Since: 2.22
+Since: 2.4
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
-</parameter_description>
-</parameter>
-<parameter name="event">
-<parameter_description> the key event
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the input method handled the key event.
+<return> A #GtkToolbarStyle indicating the toolbar style used
+for @tool_item.
</return>
</function>
-<function name="gtk_print_operation_new">
+<function name="gtk_tool_item_get_use_drag_window">
<description>
-Creates a new #GtkPrintOperation.
+Returns whether @tool_item has a drag window. See
+gtk_tool_item_set_use_drag_window().
-Since: 2.10
+Since: 2.4
</description>
<parameters>
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GtkPrintOperation
+<return> %TRUE if @tool_item uses a drag window.
</return>
</function>
-<function name="gtk_icon_view_set_selection_mode">
+<function name="gtk_tool_item_get_visible_horizontal">
<description>
-Sets the selection mode of the @icon_view.
+Returns whether the @tool_item is visible on toolbars that are
+docked horizontally.
-Since: 2.6
+Since: 2.4
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> A #GtkIconView.
-</parameter_description>
-</parameter>
-<parameter name="mode">
-<parameter_description> The selection mode
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @tool_item is visible on toolbars that are
+docked horizontally.
+
+</return>
</function>
-<function name="gtk_tree_view_get_rubber_banding">
+<function name="gtk_tool_item_get_visible_vertical">
<description>
-Returns whether rubber banding is turned on for @tree_view. If the
-selection mode is #GTK_SELECTION_MULTIPLE, rubber banding will allow the
-user to select multiple rows by dragging the mouse.
+Returns whether @tool_item is visible when the toolbar is docked vertically.
+See gtk_tool_item_set_visible_vertical().
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if rubber banding in @tree_view is enabled.
+<return> Whether @tool_item is visible when the toolbar is docked vertically
</return>
</function>
-<function name="gtk_recent_info_match">
+<function name="gtk_tool_item_group_get_collapsed">
<description>
-Checks whether two #GtkRecentInfo structures point to the same
-resource.
+Gets whether @group is collapsed or expanded.
-Since: 2.10
+Since: 2.20
</description>
<parameters>
-<parameter name="info_a">
-<parameter_description> a #GtkRecentInfo
-</parameter_description>
-</parameter>
-<parameter name="info_b">
-<parameter_description> a #GtkRecentInfo
+<parameter name="group">
+<parameter_description> a GtkToolItemGroup
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if both #GtkRecentInfo structures point to se same
-resource, %FALSE otherwise.
+<return> %TRUE if @group is collapsed, %FALSE if it is expanded
</return>
</function>
-<function name="gtk_window_present">
+<function name="gtk_tool_item_group_get_drop_item">
<description>
-Presents a window to the user. This may mean raising the window
-in the stacking order, deiconifying it, moving it to the current
-desktop, and/or giving it the keyboard focus, possibly dependent
-on the user's platform, window manager, and preferences.
-
-If @window is hidden, this function calls gtk_widget_show()
-as well.
-
-This function should be used when the user tries to open a window
-that's already open. Say for example the preferences dialog is
-currently open, and the user chooses Preferences from the menu
-a second time; use gtk_window_present() to move the already-open dialog
-where the user can see it.
-
-If you are calling this function in response to a user interaction,
-it is preferable to use gtk_window_present_with_time().
+Gets the tool item at position (x, y).
+Since: 2.20
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="group">
+<parameter_description> a #GtkToolItemGroup
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_file_chooser_unselect_filename">
-<description>
-Unselects a currently selected filename. If the filename
-is not in the current directory, does not exist, or
-is otherwise not currently selected, does nothing.
-
-Since: 2.4
-
-</description>
-<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="x">
+<parameter_description> the x position
</parameter_description>
</parameter>
-<parameter name="filename">
-<parameter_description> the filename to unselect
+<parameter name="y">
+<parameter_description> the y position
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GtkToolItem at position (x, y)
+
+</return>
</function>
-<function name="gtk_notebook_next_page">
+<function name="gtk_tool_item_group_get_ellipsize">
<description>
-Switches to the next page. Nothing happens if the current page is
-the last page.
+Gets the ellipsization mode of @group.
+
+Since: 2.20
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="group">
+<parameter_description> a #GtkToolItemGroup
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #PangoEllipsizeMode of @group
+
+</return>
</function>
-<function name="gtk_box_get_spacing">
+<function name="gtk_tool_item_group_get_header_relief">
<description>
-Gets the value set by gtk_box_set_spacing().
+Gets the relief mode of the header button of @group.
+Since: 2.20
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #GtkBox
+<parameter name="group">
+<parameter_description> a #GtkToolItemGroup
</parameter_description>
</parameter>
</parameters>
-<return> spacing between children
+<return> the #GtkReliefStyle
+
</return>
</function>
-<function name="gtk_image_menu_item_get_always_show_image">
+<function name="gtk_tool_item_group_get_item_position">
<description>
-Returns whether the menu item will ignore the #GtkSettings:gtk-menu-images
-setting and always show the image, if available.
+Gets the position of @item in @group as index.
-Since: 2.16
+Since: 2.20
</description>
<parameters>
-<parameter name="image_menu_item">
-<parameter_description> a #GtkImageMenuItem
+<parameter name="group">
+<parameter_description> a #GtkToolItemGroup
+</parameter_description>
+</parameter>
+<parameter name="item">
+<parameter_description> a #GtkToolItem
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the menu item will always show the image
+<return> the index of @item in @group or -1 if @item is no child of @group
</return>
</function>
-<function name="gtk_mount_operation_set_screen">
+<function name="gtk_tool_item_group_get_label">
<description>
-Sets the screen to show windows of the #GtkMountOperation on.
+Gets the label of @group.
-Since: 2.14
+Since: 2.20
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkMountOperation
-</parameter_description>
-</parameter>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="group">
+<parameter_description> a #GtkToolItemGroup
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the label of @group. The label is an internal string of @group
+and must not be modified. Note that %NULL is returned if a custom
+label has been set with gtk_tool_item_group_set_label_widget()
+
+</return>
</function>
-<function name="gtk_page_setup_set_paper_size_and_default_margins">
+<function name="gtk_tool_item_group_get_label_widget">
<description>
-Sets the paper size of the #GtkPageSetup and modifies
-the margins according to the new paper size.
+Gets the label widget of @group.
+See gtk_tool_item_group_set_label_widget().
-Since: 2.10
+Since: 2.20
</description>
<parameters>
-<parameter name="setup">
-<parameter_description> a #GtkPageSetup
-</parameter_description>
-</parameter>
-<parameter name="size">
-<parameter_description> a #GtkPaperSize
+<parameter name="group">
+<parameter_description> a #GtkToolItemGroup
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the label widget of @group
+
+</return>
</function>
-<function name="gtk_color_button_get_alpha">
+<function name="gtk_tool_item_group_get_n_items">
<description>
-Returns the current alpha value.
+Gets the number of tool items in @group.
-Since: 2.4
+Since: 2.20
</description>
<parameters>
-<parameter name="color_button">
-<parameter_description> a #GtkColorButton.
+<parameter name="group">
+<parameter_description> a #GtkToolItemGroup
</parameter_description>
</parameter>
</parameters>
-<return> an integer between 0 and 65535.
+<return> the number of tool items in @group
</return>
</function>
-<function name="gtk_window_propagate_key_event">
+<function name="gtk_tool_item_group_get_nth_item">
<description>
-Propagate a key press or release event to the focus widget and
-up the focus container chain until a widget handles @event.
-This is normally called by the default ::key_press_event and
-::key_release_event handlers for toplevel windows,
-however in some cases it may be useful to call this directly when
-overriding the standard key handling for a toplevel window.
+Gets the tool item at @index in group.
-Since: 2.4
+Since: 2.20
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="group">
+<parameter_description> a #GtkToolItemGroup
</parameter_description>
</parameter>
-<parameter name="event">
-<parameter_description> a #GdkEventKey
+<parameter name="index">
+<parameter_description> the index
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if a widget in the focus chain handled the event.
+<return> the #GtkToolItem at index
</return>
</function>
-<function name="gtk_type_class">
+<function name="gtk_tool_item_group_insert">
<description>
-Returns a pointer pointing to the class of @type or %NULL if there
-was any trouble identifying @type. Initializes the class if
-necessary.
+Inserts @item at @position in the list of children of @group.
-Deprecated: 2.14: Use g_type_class_peek() or g_type_class_ref() instead.
+Since: 2.20
</description>
<parameters>
-<parameter name="type">
-<parameter_description> a #GtkType.
+<parameter name="group">
+<parameter_description> a #GtkToolItemGroup
+</parameter_description>
+</parameter>
+<parameter name="item">
+<parameter_description> the #GtkToolItem to insert into @group
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> the position of @item in @group, starting with 0.
+The position -1 means end of list.
</parameter_description>
</parameter>
</parameters>
-<return> pointer to the class.
-
-</return>
+<return></return>
</function>
-<function name="gtk_page_setup_get_left_margin">
+<function name="gtk_tool_item_group_new">
<description>
-Gets the left margin in units of @unit.
+Creates a new tool item group with label @label.
-Since: 2.10
+Since: 2.20
</description>
<parameters>
-<parameter name="setup">
-<parameter_description> a #GtkPageSetup
-</parameter_description>
-</parameter>
-<parameter name="unit">
-<parameter_description> the unit for the return value
+<parameter name="label">
+<parameter_description> the label of the new group
</parameter_description>
</parameter>
</parameters>
-<return> the left margin
+<return> a new #GtkToolItemGroup.
</return>
</function>
-<function name="gtk_paper_size_get_default_bottom_margin">
+<function name="gtk_tool_item_group_set_collapsed">
<description>
-Gets the default bottom margin for the #GtkPaperSize.
+Sets whether the @group should be collapsed or expanded.
-Since: 2.10
+Since: 2.20
</description>
<parameters>
-<parameter name="size">
-<parameter_description> a #GtkPaperSize object
+<parameter name="group">
+<parameter_description> a #GtkToolItemGroup
</parameter_description>
</parameter>
-<parameter name="unit">
-<parameter_description> the unit for the return value
+<parameter name="collapsed">
+<parameter_description> whether the @group should be collapsed or expanded
</parameter_description>
</parameter>
</parameters>
-<return> the default bottom margin
-
-</return>
+<return></return>
</function>
-<function name="gtk_assistant_prepend_page">
+<function name="gtk_tool_item_group_set_ellipsize">
<description>
-Prepends a page to the @assistant.
+Sets the ellipsization mode which should be used by labels in @group.
-Since: 2.10
+Since: 2.20
</description>
<parameters>
-<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter name="group">
+<parameter_description> a #GtkToolItemGroup
</parameter_description>
</parameter>
-<parameter name="page">
-<parameter_description> a #GtkWidget
+<parameter name="ellipsize">
+<parameter_description> the #PangoEllipsizeMode labels in @group should use
</parameter_description>
</parameter>
</parameters>
-<return> the index (starting at 0) of the inserted page
-
-</return>
+<return></return>
</function>
-<function name="gtk_tree_model_filter_convert_iter_to_child_iter">
+<function name="gtk_tool_item_group_set_header_relief">
<description>
-Sets @child_iter to point to the row pointed to by @filter_iter.
+Set the button relief of the group header.
+See gtk_button_set_relief() for details.
-Since: 2.4
+Since: 2.20
</description>
<parameters>
-<parameter name="filter">
-<parameter_description> A #GtkTreeModelFilter.
-</parameter_description>
-</parameter>
-<parameter name="child_iter">
-<parameter_description> An uninitialized #GtkTreeIter.
+<parameter name="group">
+<parameter_description> a #GtkToolItemGroup
</parameter_description>
</parameter>
-<parameter name="filter_iter">
-<parameter_description> A valid #GtkTreeIter pointing to a row on @filter.
+<parameter name="style">
+<parameter_description> the #GtkReliefStyle
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_adjustment_set_lower">
+<function name="gtk_tool_item_group_set_item_position">
<description>
-Sets the minimum value of the adjustment.
-
-When setting multiple adjustment properties via their individual
-setters, multiple "changed" signals will be emitted. However, since
-the emission of the "changed" signal is tied to the emission of the
-"GObject::notify" signals of the changed properties, it's possible
-to compress the "changed" signals into one by calling
-g_object_freeze_notify() and g_object_thaw_notify() around the
-calls to the individual setters.
-
-Alternatively, using a single g_object_set() for all the properties
-to change, or using gtk_adjustment_configure() has the same effect
-of compressing "changed" emissions.
+Sets the position of @item in the list of children of @group.
-Since: 2.14
+Since: 2.20
</description>
<parameters>
-<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
+<parameter name="group">
+<parameter_description> a #GtkToolItemGroup
</parameter_description>
</parameter>
-<parameter name="lower">
-<parameter_description> the new minimum value
+<parameter name="item">
+<parameter_description> the #GtkToolItem to move to a new position, should
+be a child of @group.
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> the new position of @item in @group, starting with 0.
+The position -1 means end of list.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_action_group_add_toggle_actions">
+<function name="gtk_tool_item_group_set_label">
<description>
-This is a convenience function to create a number of toggle actions and add them
-to the action group.
-
-The "activate" signals of the actions are connected to the callbacks and
-their accel paths are set to
-<literal><Actions>/<replaceable>group-name</replaceable>/<replaceable>action-name</replaceable></literal>.
+Sets the label of the tool item group. The label is displayed in the header
+of the group.
-Since: 2.4
+Since: 2.20
</description>
<parameters>
-<parameter name="action_group">
-<parameter_description> the action group
-</parameter_description>
-</parameter>
-<parameter name="entries">
-<parameter_description> an array of toggle action descriptions
-</parameter_description>
-</parameter>
-<parameter name="n_entries">
-<parameter_description> the number of entries
+<parameter name="group">
+<parameter_description> a #GtkToolItemGroup
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> data to pass to the action callbacks
+<parameter name="label">
+<parameter_description> the new human-readable label of of the group
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_settings_set_media_type">
+<function name="gtk_tool_item_group_set_label_widget">
<description>
-Sets the value of %GTK_PRINT_SETTINGS_MEDIA_TYPE.
-
-The set of media types is defined in PWG 5101.1-2002 PWG.
-<!-- FIXME link here -->
+Sets the label of the tool item group.
+The label widget is displayed in the header of the group, in place
+of the usual label.
-Since: 2.10
+Since: 2.20
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="group">
+<parameter_description> a #GtkToolItemGroup
</parameter_description>
</parameter>
-<parameter name="media_type">
-<parameter_description> the media type
+<parameter name="label_widget">
+<parameter_description> the widget to be displayed in place of the usual label
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_pixmap_new">
+<function name="gtk_tool_item_new">
<description>
+Creates a new #GtkToolItem
+
+Since: 2.4
</description>
<parameters>
-<parameter name="mask">
-<parameter_description>
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> the new #GtkToolItem
+
+</return>
</function>
-<function name="gtk_action_block_activate">
+<function name="gtk_tool_item_rebuild_menu">
<description>
-Disable activation signals from the action
+Calling this function signals to the toolbar that the
+overflow menu item for @tool_item has changed. If the
+overflow menu is visible when this function it called,
+the menu will be rebuilt.
-This is needed when updating the state of your proxy
-#GtkActivatable widget could result in calling gtk_action_activate(),
-this is a convenience function to avoid recursing in those
-cases (updating toggle state for instance).
+The function must be called when the tool item changes what it
+will do in response to the #GtkToolItem::create-menu-proxy signal.
-Since: 2.16
+Since: 2.6
</description>
<parameters>
-<parameter name="action">
-<parameter_description> a #GtkAction
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_clipboard_wait_for_rich_text">
+<function name="gtk_tool_item_retrieve_proxy_menu_item">
<description>
-Requests the contents of the clipboard as rich text. This function
-waits for the data to be received using the main loop, so events,
-timeouts, etc, may be dispatched during the wait.
+Returns the #GtkMenuItem that was last set by
+gtk_tool_item_set_proxy_menu_item(), ie. the #GtkMenuItem
+that is going to appear in the overflow menu.
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="clipboard">
-<parameter_description> a #GtkClipboard
-</parameter_description>
-</parameter>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="format">
-<parameter_description> return location for the format of the returned data
-</parameter_description>
-</parameter>
-<parameter name="length">
-<parameter_description> return location for the length of the returned data
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated binary block of data which must
-be freed with g_free(), or %NULL if retrieving
-the selection data failed. (This could happen
-for various reasons, in particular if the
-clipboard was empty or if the contents of the
-clipboard could not be converted into text form.)
+<return> The #GtkMenuItem that is going to appear in the
+overflow menu for @tool_item.
</return>
</function>
-<function name="gtk_window_get_group">
+<function name="gtk_tool_item_set_expand">
<description>
-Returns the group for @window or the default group, if
- window is %NULL or if @window does not have an explicit
-window group.
+Sets whether @tool_item is allocated extra space when there
+is more room on the toolbar then needed for the items. The
+effect is that the item gets bigger when the toolbar gets bigger
+and smaller when the toolbar gets smaller.
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow, or %NULL
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem
+</parameter_description>
+</parameter>
+<parameter name="expand">
+<parameter_description> Whether @tool_item is allocated extra space
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkWindowGroup for a window or the default group
-
-</return>
+<return></return>
</function>
-<function name="gtk_window_set_destroy_with_parent">
+<function name="gtk_tool_item_set_homogeneous">
<description>
-If @setting is %TRUE, then destroying the transient parent of @window
-will also destroy @window itself. This is useful for dialogs that
-shouldn't persist beyond the lifetime of the main window they're
-associated with, for example.
+Sets whether @tool_item is to be allocated the same size as other
+homogeneous items. The effect is that all homogeneous items will have
+the same width as the widest of the items.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem
</parameter_description>
</parameter>
-<parameter name="setting">
-<parameter_description> whether to destroy @window with its transient parent
+<parameter name="homogeneous">
+<parameter_description> whether @tool_item is the same size as other homogeneous items
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_editable_get_selection_bounds">
+<function name="gtk_tool_item_set_is_important">
<description>
-Retrieves the selection bound of the editable. start_pos will be filled
-with the start of the selection and @end_pos with end. If no text was
-selected both will be identical and %FALSE will be returned.
-
-Note that positions are specified in characters, not bytes.
+Sets whether @tool_item should be considered important. The #GtkToolButton
+class uses this property to determine whether to show or hide its label
+when the toolbar style is %GTK_TOOLBAR_BOTH_HORIZ. The result is that
+only tool buttons with the "is_important" property set have labels, an
+effect known as "priority text"
+Since: 2.4
</description>
<parameters>
-<parameter name="editable">
-<parameter_description> a #GtkEditable
-</parameter_description>
-</parameter>
-<parameter name="start_pos">
-<parameter_description> location to store the starting position, or %NULL
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem
</parameter_description>
</parameter>
-<parameter name="end_pos">
-<parameter_description> location to store the end position, or %NULL
+<parameter name="is_important">
+<parameter_description> whether the tool item should be considered important
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if an area is selected, %FALSE otherwise
-</return>
+<return></return>
</function>
-<function name="gtk_tree_view_column_cell_render">
+<function name="gtk_tool_item_set_proxy_menu_item">
<description>
-Renders the cell contained by #tree_column. This is used primarily by the
-#GtkTreeView.
+Sets the #GtkMenuItem used in the toolbar overflow menu. The
+ menu_item_id is used to identify the caller of this function and
+should also be used with gtk_tool_item_get_proxy_menu_item().
+
+Since: 2.4
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn.
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkDrawable to draw to
-</parameter_description>
-</parameter>
-<parameter name="background_area">
-<parameter_description> entire cell area (including tree expanders and maybe padding on the sides)
-</parameter_description>
-</parameter>
-<parameter name="cell_area">
-<parameter_description> area normally rendered by a cell renderer
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem
</parameter_description>
</parameter>
-<parameter name="expose_area">
-<parameter_description> area that actually needs updating
+<parameter name="menu_item_id">
+<parameter_description> a string used to identify @menu_item
</parameter_description>
</parameter>
-<parameter name="flags">
-<parameter_description> flags that affect rendering
+<parameter name="menu_item">
+<parameter_description> a #GtkMenuItem to be used in the overflow menu
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_model_filter_set_modify_func">
+<function name="gtk_tool_item_set_tooltip">
<description>
-With the @n_columns and @types parameters, you give an array of column
-types for this model (which will be exposed to the parent model/view).
-The @func, @data and @destroy parameters are for specifying the modify
-function. The modify function will get called for <emphasis>each</emphasis>
-data access, the goal of the modify function is to return the data which
-should be displayed at the location specified using the parameters of the
-modify function.
+Sets the #GtkTooltips object to be used for @tool_item, the
+text to be displayed as tooltip on the item and the private text
+to be used. See gtk_tooltips_set_tip().
Since: 2.4
+Deprecated: 2.12: Use gtk_tool_item_set_tooltip_text() instead.
+
</description>
<parameters>
-<parameter name="filter">
-<parameter_description> A #GtkTreeModelFilter.
-</parameter_description>
-</parameter>
-<parameter name="n_columns">
-<parameter_description> The number of columns in the filter model.
-</parameter_description>
-</parameter>
-<parameter name="types">
-<parameter_description> The #GType<!-- -->s of the columns.
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> A #GtkTreeModelFilterModifyFunc
+<parameter name="tooltips">
+<parameter_description> The #GtkTooltips object to be used
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> User data to pass to the modify function, or %NULL.
+<parameter name="tip_text">
+<parameter_description> text to be used as tooltip text for @tool_item
</parameter_description>
</parameter>
-<parameter name="destroy">
-<parameter_description> Destroy notifier of @data, or %NULL.
+<parameter name="tip_private">
+<parameter_description> text to be used as private tooltip text
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_image_new_from_stock">
+<function name="gtk_tool_item_set_tooltip_markup">
<description>
-Creates a #GtkImage displaying a stock icon. Sample stock icon
-names are #GTK_STOCK_OPEN, #GTK_STOCK_QUIT. Sample stock sizes
-are #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_SMALL_TOOLBAR. If the stock
-icon name isn't known, the image will be empty.
-You can register your own stock icon names, see
-gtk_icon_factory_add_default() and gtk_icon_factory_add().
+Sets the markup text to be displayed as tooltip on the item.
+See gtk_widget_set_tooltip_markup().
+Since: 2.12
</description>
<parameters>
-<parameter name="stock_id">
-<parameter_description> a stock icon name
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> a stock icon size
+<parameter name="markup">
+<parameter_description> markup text to be used as tooltip for @tool_item
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkImage displaying the stock icon
-</return>
+<return></return>
</function>
-<function name="gtk_plug_get_embedded">
+<function name="gtk_tool_item_set_tooltip_text">
<description>
-Determines whether the plug is embedded in a socket.
+Sets the text to be displayed as tooltip on the item.
+See gtk_widget_set_tooltip_text().
-Since: 2.14
+Since: 2.12
</description>
<parameters>
-<parameter name="plug">
-<parameter_description> a #GtkPlug
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem
</parameter_description>
</parameter>
-</parameters>
-<return> %TRUE if the plug is embedded in a socket
-
-</return>
-</function>
-
-<function name="gtk_tree_view_get_selection">
-<description>
-Gets the #GtkTreeSelection associated with @tree_view.
-
-
-</description>
-<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView.
+<parameter name="text">
+<parameter_description> text to be used as tooltip for @tool_item
</parameter_description>
</parameter>
</parameters>
-<return> A #GtkTreeSelection object.
-</return>
+<return></return>
</function>
-<function name="gtk_action_unblock_activate_from">
+<function name="gtk_tool_item_set_use_drag_window">
<description>
-Re-enables calls to the gtk_action_activate()
-function by signals on the given proxy widget. This undoes the
-blocking done by gtk_action_block_activate_from().
-
-This function is intended for use by action implementations.
+Sets whether @tool_item has a drag window. When %TRUE the
+toolitem can be used as a drag source through gtk_drag_source_set().
+When @tool_item has a drag window it will intercept all events,
+even those that would otherwise be sent to a child of @tool_item.
Since: 2.4
-Deprecated: 2.16: activatables are now responsible for activating the
-action directly so this doesnt apply anymore.
-
</description>
<parameters>
-<parameter name="action">
-<parameter_description> the action object
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem
</parameter_description>
</parameter>
-<parameter name="proxy">
-<parameter_description> a proxy widget
+<parameter name="use_drag_window">
+<parameter_description> Whether @tool_item has a drag window.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_view_unselect_all">
+<function name="gtk_tool_item_set_visible_horizontal">
<description>
-Unselects all the icons.
+Sets whether @tool_item is visible when the toolbar is docked horizontally.
-Since: 2.6
+Since: 2.4
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> A #GtkIconView.
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem
+</parameter_description>
+</parameter>
+<parameter name="visible_horizontal">
+<parameter_description> Whether @tool_item is visible when in horizontal mode
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_get_destroy_with_parent">
+<function name="gtk_tool_item_set_visible_vertical">
<description>
-Returns whether the window will be destroyed with its transient parent. See
-gtk_window_set_destroy_with_parent ().
+Sets whether @tool_item is visible when the toolbar is docked
+vertically. Some tool items, such as text entries, are too wide to be
+useful on a vertically docked toolbar. If @visible_vertical is %FALSE
+ tool_item will not appear on toolbars that are docked vertically.
+Since: 2.4
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem
+</parameter_description>
+</parameter>
+<parameter name="visible_vertical">
+<parameter_description> whether @tool_item is visible when the toolbar
+is in vertical mode
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the window will be destroyed with its transient parent.
-</return>
+<return></return>
</function>
-<function name="gtk_tree_drag_dest_row_drop_possible">
+<function name="gtk_tool_item_toolbar_reconfigured">
<description>
-Determines whether a drop is possible before the given @dest_path,
-at the same depth as @dest_path. i.e., can we drop the data in
- selection_data at that location. @dest_path does not have to
-exist; the return value will almost certainly be %FALSE if the
-parent of @dest_path doesn't exist, though.
+Emits the signal #GtkToolItem::toolbar_reconfigured on @tool_item.
+#GtkToolbar and other #GtkToolShell implementations use this function
+to notify children, when some aspect of their configuration changes.
+Since: 2.14
</description>
<parameters>
-<parameter name="drag_dest">
-<parameter_description> a #GtkTreeDragDest
-</parameter_description>
-</parameter>
-<parameter name="dest_path">
-<parameter_description> destination row
-</parameter_description>
-</parameter>
-<parameter name="selection_data">
-<parameter_description> the data being dragged
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if a drop is possible before @dest_path
-</return>
+<return></return>
</function>
-<function name="gtk_draw_check">
+<function name="gtk_tool_palette_add_drag_dest">
<description>
-Draws a check button indicator in the given rectangle on @window with
-the given parameters.
+Sets @palette as drag source (see gtk_tool_palette_set_drag_source())
+and sets @widget as a drag destination for drags from @palette.
+See gtk_drag_dest_set().
-Deprecated: 2.0: Use gtk_paint_check() instead.
+Since: 2.20
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
-</parameter_description>
-</parameter>
-<parameter name="shadow_type">
-<parameter_description> the type of shadow to draw
+<parameter name="palette">
+<parameter_description> a #GtkToolPalette
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> x origin of the rectangle to draw the check in
+<parameter name="widget">
+<parameter_description> a #GtkWidget which should be a drag destination for @palette
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> y origin of the rectangle to draw the check in
+<parameter name="flags">
+<parameter_description> the flags that specify what actions GTK+ should take for drops
+on that widget
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> the width of the rectangle to draw the check in
+<parameter name="targets">
+<parameter_description> the #GtkToolPaletteDragTarget<!-- -->s which the widget
+should support
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> the height of the rectangle to draw the check in
+<parameter name="actions">
+<parameter_description> the #GdkDragAction<!-- -->s which the widget should suppport
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_set_fixed_height_mode">
+<function name="gtk_tool_palette_get_drag_item">
<description>
-Enables or disables the fixed height mode of @tree_view.
-Fixed height mode speeds up #GtkTreeView by assuming that all
-rows have the same height.
-Only enable this option if all rows are the same height and all
-columns are of type %GTK_TREE_VIEW_COLUMN_FIXED.
+Get the dragged item from the selection.
+This could be a #GtkToolItem or a #GtkToolItemGroup.
-Since: 2.6
+Since: 2.20
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
+<parameter name="palette">
+<parameter_description> a #GtkToolPalette
</parameter_description>
</parameter>
-<parameter name="enable">
-<parameter_description> %TRUE to enable fixed height mode
+<parameter name="selection">
+<parameter_description> a #GtkSelectionData
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the dragged item in selection
+
+</return>
</function>
-<function name="gtk_text_layout_move_iter_to_previous_line">
+<function name="gtk_tool_palette_get_drag_target_group">
<description>
-Move the iterator to the beginning of the previous line. The lines
-of a wrapped paragraph are treated as distinct for this operation.
+Get the target entry for a dragged #GtkToolItemGroup.
+
+Since: 2.20
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #GtkLayout
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> the #GtkTargetEntry for a dragged group
+
+</return>
</function>
-<function name="gtk_frame_new">
+<function name="gtk_tool_palette_get_drag_target_item">
<description>
-Creates a new #GtkFrame, with optional label @label.
-If @label is %NULL, the label is omitted.
+Gets the target entry for a dragged #GtkToolItem.
+Since: 2.20
</description>
<parameters>
-<parameter name="label">
-<parameter_description> the text to use as the label of the frame
-</parameter_description>
-</parameter>
</parameters>
-<return> a new #GtkFrame widget
+<return> the #GtkTargetEntry for a dragged item.
+
</return>
</function>
-<function name="gtk_tooltip_set_icon_from_stock">
+<function name="gtk_tool_palette_get_drop_group">
<description>
-Sets the icon of the tooltip (which is in front of the text) to be
-the stock item indicated by @stock_id with the size indicated
-by @size. If @stock_id is %NULL, the image will be hidden.
+Gets the group at position (x, y).
-Since: 2.12
+Since: 2.20
</description>
<parameters>
-<parameter name="tooltip">
-<parameter_description> a #GtkTooltip
+<parameter name="palette">
+<parameter_description> a #GtkToolPalette
</parameter_description>
</parameter>
-<parameter name="stock_id">
-<parameter_description> a stock id, or %NULL
+<parameter name="x">
+<parameter_description> the x position
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> a stock icon size
+<parameter name="y">
+<parameter_description> the y position
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GtkToolItemGroup at position or %NULL
+if there is no such group
+
+</return>
</function>
-<function name="gtk_cell_layout_reorder">
+<function name="gtk_tool_palette_get_drop_item">
<description>
-Re-inserts @cell at @position. Note that @cell has already to be packed
-into @cell_layout for this to function properly.
+Gets the item at position (x, y).
+See gtk_tool_palette_get_drop_group().
-Since: 2.4
+Since: 2.20
</description>
<parameters>
-<parameter name="cell_layout">
-<parameter_description> A #GtkCellLayout.
+<parameter name="palette">
+<parameter_description> a #GtkToolPalette
</parameter_description>
</parameter>
-<parameter name="cell">
-<parameter_description> A #GtkCellRenderer to reorder.
+<parameter name="x">
+<parameter_description> the x position
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> New position to insert @cell at.
+<parameter name="y">
+<parameter_description> the y position
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GtkToolItem at position or %NULL if there is no such item
+
+</return>
</function>
-<function name="gtk_entry_completion_set_popup_single_match">
+<function name="gtk_tool_palette_get_exclusive">
<description>
-Sets whether the completion popup window will appear even if there is
-only a single match. You may want to set this to %FALSE if you
-are using <link linkend="GtkEntryCompletion--inline-completion">inline
-completion</link>.
+Gets whether @group is exclusive or not.
+See gtk_tool_palette_set_exclusive().
-Since: 2.8
+Since: 2.20
</description>
<parameters>
-<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter name="palette">
+<parameter_description> a #GtkToolPalette
</parameter_description>
</parameter>
-<parameter name="popup_single_match">
-<parameter_description> %TRUE if the popup should appear even for a single
-match
+<parameter name="group">
+<parameter_description> a #GtkToolItemGroup which is a child of palette
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @group is exclusive
+
+</return>
</function>
-<function name="gtk_tree_model_get_iter_first">
+<function name="gtk_tool_palette_get_expand">
<description>
-Initializes @iter with the first iterator in the tree (the one at the path
-"0") and returns %TRUE. Returns %FALSE if the tree is empty.
+Gets whether group should be given extra space.
+See gtk_tool_palette_set_expand().
+Since: 2.20
</description>
<parameters>
-<parameter name="tree_model">
-<parameter_description> A #GtkTreeModel.
+<parameter name="palette">
+<parameter_description> a #GtkToolPalette
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> The uninitialized #GtkTreeIter.
+<parameter name="group">
+<parameter_description> a #GtkToolItemGroup which is a child of palette
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE, if @iter was set.
+<return> %TRUE if group should be given extra space, %FALSE otherwise
+
</return>
</function>
-<function name="gtk_print_unix_dialog_set_embed_page_setup">
+<function name="gtk_tool_palette_get_group_position">
<description>
-Embed page size combo box and orientation combo box into page setup page.
+Gets the position of @group in @palette as index.
+See gtk_tool_palette_set_group_position().
-Since: 2.18
+Since: 2.20
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter name="palette">
+<parameter_description> a #GtkToolPalette
</parameter_description>
</parameter>
-<parameter name="embed">
-<parameter_description> embed page setup selection
+<parameter name="group">
+<parameter_description> a #GtkToolItemGroup
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the index of group or -1 if @group is not a child of @palette
+
+</return>
</function>
-<function name="gtk_icon_view_get_tooltip_context">
+<function name="gtk_tool_palette_get_hadjustment">
<description>
-This function is supposed to be used in a #GtkWidget::query-tooltip
-signal handler for #GtkIconView. The @x, @y and @keyboard_tip values
-which are received in the signal handler, should be passed to this
-function without modification.
-
-The return value indicates whether there is an icon view item at the given
-coordinates (%TRUE) or not (%FALSE) for mouse tooltips. For keyboard
-tooltips the item returned will be the cursor item. When %TRUE, then any of
- model, @path and @iter which have been provided will be set to point to
-that row and the corresponding model. @x and @y will always be converted
-to be relative to @icon_view's bin_window if @keyboard_tooltip is %FALSE.
+Gets the horizontal adjustment of the tool palette.
-Since: 2.12
+Since: 2.20
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> an #GtkIconView
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> the x coordinate (relative to widget coordinates)
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> the y coordinate (relative to widget coordinates)
-</parameter_description>
-</parameter>
-<parameter name="keyboard_tip">
-<parameter_description> whether this is a keyboard tooltip or not
-</parameter_description>
-</parameter>
-<parameter name="model">
-<parameter_description> a pointer to receive a #GtkTreeModel or %NULL
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> a pointer to receive a #GtkTreePath or %NULL
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> a pointer to receive a #GtkTreeIter or %NULL
+<parameter name="palette">
+<parameter_description> a #GtkToolPalette
</parameter_description>
</parameter>
</parameters>
-<return> whether or not the given tooltip context points to a item
+<return> the horizontal adjustment of @palette
</return>
</function>
-<function name="gtk_widget_modify_text">
+<function name="gtk_tool_palette_get_icon_size">
<description>
-Sets the text color for a widget in a particular state. All other
-style values are left untouched. The text color is the foreground
-color used along with the base color (see gtk_widget_modify_base())
-for widgets such as #GtkEntry and #GtkTextView. See also
-gtk_widget_modify_style().
+Gets the size of icons in the tool palette.
+See gtk_tool_palette_set_icon_size().
+
+Since: 2.20
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="state">
-<parameter_description> the state for which to set the text color
-</parameter_description>
-</parameter>
-<parameter name="color">
-<parameter_description> the color to assign (does not need to be allocated),
-or %NULL to undo the effect of previous calls to
-of gtk_widget_modify_text().
+<parameter name="palette">
+<parameter_description> a #GtkToolPalette
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GtkIconSize of icons in the tool palette
+
+</return>
</function>
-<function name="gtk_calendar_get_detail_width_chars">
+<function name="gtk_tool_palette_get_style">
<description>
-Queries the width of detail cells, in characters.
-See #GtkCalendar:detail-width-chars.
-
-Since: 2.14
+Gets the style (icons, text or both) of items in the tool palette.
+Since: 2.20
</description>
<parameters>
-<parameter name="calendar">
-<parameter_description> a #GtkCalendar.
+<parameter name="palette">
+<parameter_description> a #GtkToolPalette
</parameter_description>
</parameter>
</parameters>
-<return> The width of detail cells, in characters.
+<return> the #GtkToolbarStyle of items in the tool palette.
+
</return>
</function>
-<function name="gtk_draw_shadow">
+<function name="gtk_tool_palette_get_vadjustment">
<description>
-Draws a shadow around the given rectangle in @window
-using the given style and state and shadow type.
+Gets the vertical adjustment of the tool palette.
-Deprecated: 2.0: Use gtk_paint_shadow() instead.
+Since: 2.20
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
-</parameter_description>
-</parameter>
-<parameter name="shadow_type">
-<parameter_description> type of shadow to draw
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> x origin of the rectangle
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> y origin of the rectangle
+<parameter name="palette">
+<parameter_description> a #GtkToolPalette
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> width of the rectangle
+</parameters>
+<return> the vertical adjustment of @palette
+
+</return>
+</function>
+
+<function name="gtk_tool_palette_new">
+<description>
+Creates a new tool palette.
+
+Since: 2.20
+
+</description>
+<parameters>
+</parameters>
+<return> a new #GtkToolPalette
+
+</return>
+</function>
+
+<function name="gtk_tool_palette_set_drag_source">
+<description>
+Sets the tool palette as a drag source.
+Enables all groups and items in the tool palette as drag sources
+on button 1 and button 3 press with copy and move actions.
+See gtk_drag_source_set().
+
+Since: 2.20
+
+</description>
+<parameters>
+<parameter name="palette">
+<parameter_description> a #GtkToolPalette
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> width of the rectangle
+<parameter name="targets">
+<parameter_description> the #GtkToolPaletteDragTarget<!-- -->s
+which the widget should support
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_column_cell_set_cell_data">
+<function name="gtk_tool_palette_set_exclusive">
<description>
-Sets the cell renderer based on the @tree_model and @iter. That is, for
-every attribute mapping in @tree_column, it will get a value from the set
-column on the @iter, and use that value to set the attribute on the cell
-renderer. This is used primarily by the #GtkTreeView.
+Sets whether the group should be exclusive or not.
+If an exclusive group is expanded all other groups are collapsed.
+
+Since: 2.20
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn.
-</parameter_description>
-</parameter>
-<parameter name="tree_model">
-<parameter_description> The #GtkTreeModel to to get the cell renderers attributes from.
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> The #GtkTreeIter to to get the cell renderer's attributes from.
+<parameter name="palette">
+<parameter_description> a #GtkToolPalette
</parameter_description>
</parameter>
-<parameter name="is_expander">
-<parameter_description> %TRUE, if the row has children
+<parameter name="group">
+<parameter_description> a #GtkToolItemGroup which is a child of palette
</parameter_description>
</parameter>
-<parameter name="is_expanded">
-<parameter_description> %TRUE, if the row has visible children
+<parameter name="exclusive">
+<parameter_description> whether the group should be exclusive or not
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_modify_cursor">
+<function name="gtk_tool_palette_set_expand">
<description>
-Sets the cursor color to use in a widget, overriding the
-#GtkWidget:cursor-color and #GtkWidget:secondary-cursor-color
-style properties. All other style values are left untouched.
-See also gtk_widget_modify_style().
+Sets whether the group should be given extra space.
-Since: 2.12
+Since: 2.20
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="palette">
+<parameter_description> a #GtkToolPalette
</parameter_description>
</parameter>
-<parameter name="primary">
-<parameter_description> the color to use for primary cursor (does not need to be
-allocated), or %NULL to undo the effect of previous calls to
-of gtk_widget_modify_cursor().
+<parameter name="group">
+<parameter_description> a #GtkToolItemGroup which is a child of palette
</parameter_description>
</parameter>
-<parameter name="secondary">
-<parameter_description> the color to use for secondary cursor (does not need to be
-allocated), or %NULL to undo the effect of previous calls to
-of gtk_widget_modify_cursor().
+<parameter name="expand">
+<parameter_description> whether the group should be given extra space
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_set_column_drag_function">
+<function name="gtk_tool_palette_set_group_position">
<description>
-Sets a user function for determining where a column may be dropped when
-dragged. This function is called on every column pair in turn at the
-beginning of a column drag to determine where a drop can take place. The
-arguments passed to @func are: the @tree_view, the #GtkTreeViewColumn being
-dragged, the two #GtkTreeViewColumn s determining the drop spot, and
- user_data If either of the #GtkTreeViewColumn arguments for the drop spot
-are %NULL, then they indicate an edge. If @func is set to be %NULL, then
- tree_view reverts to the default behavior of allowing all columns to be
-dropped everywhere.
+Sets the position of the group as an index of the tool palette.
+If position is 0 the group will become the first child, if position is
+-1 it will become the last child.
+
+Since: 2.20
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView.
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> A function to determine which columns are reorderable, or %NULL.
+<parameter name="palette">
+<parameter_description> a #GtkToolPalette
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> User data to be passed to @func, or %NULL
+<parameter name="group">
+<parameter_description> a #GtkToolItemGroup which is a child of palette
</parameter_description>
</parameter>
-<parameter name="destroy">
-<parameter_description> Destroy notifier for @user_data, or %NULL
+<parameter name="position">
+<parameter_description> a new index for group
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_combo_box_set_active">
+<function name="gtk_tool_palette_set_icon_size">
<description>
-Sets the active item of @combo_box to be the item at @index.
+Sets the size of icons in the tool palette.
-Since: 2.4
+Since: 2.20
</description>
<parameters>
-<parameter name="combo_box">
-<parameter_description> A #GtkComboBox
+<parameter name="palette">
+<parameter_description> a #GtkToolPalette
</parameter_description>
</parameter>
-<parameter name="index_">
-<parameter_description> An index in the model passed during construction, or -1 to have
-no active item
+<parameter name="icon_size">
+<parameter_description> the #GtkIconSize that icons in the tool
+palette shall have
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_notebook_page_num">
+<function name="gtk_tool_palette_set_style">
<description>
-Finds the index of the page which contains the given child
-widget.
+Sets the style (text, icons or both) of items in the tool palette.
+Since: 2.20
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="palette">
+<parameter_description> a #GtkToolPalette
</parameter_description>
</parameter>
-<parameter name="child">
-<parameter_description> a #GtkWidget
+<parameter name="style">
+<parameter_description> the #GtkToolbarStyle that items in the tool palette shall have
</parameter_description>
</parameter>
</parameters>
-<return> the index of the page containing @child, or
--1 if @child is not in the notebook.
-</return>
+<return></return>
</function>
-<function name="gtk_test_init">
+<function name="gtk_tool_palette_unset_icon_size">
<description>
-This function is used to initialize a GTK+ test program.
-
-It will in turn call g_test_init() and gtk_init() to properly
-initialize the testing framework and graphical toolkit. It'll
-also set the program's locale to "C" and prevent loading of rc
-files and Gtk+ modules. This is done to make tets program
-environments as deterministic as possible.
-
-Like gtk_init() and g_test_init(), any known arguments will be
-processed and stripped from @argc and @argv.
+Unsets the tool palette icon size set with gtk_tool_palette_set_icon_size(),
+so that user preferences will be used to determine the icon size.
-Since: 2.14
+Since: 2.20
</description>
<parameters>
-<parameter name="argcp">
-<parameter_description> Address of the <parameter>argc</parameter> parameter of the
-main() function. Changed if any arguments were handled.
-</parameter_description>
-</parameter>
-<parameter name="argvp">
-<parameter_description> Address of the <parameter>argv</parameter> parameter of main().
-Any parameters understood by g_test_init() or gtk_init() are
-stripped before return.
-</parameter_description>
-</parameter>
-<parameter name="Varargs">
-<parameter_description> currently unused
+<parameter name="palette">
+<parameter_description> a #GtkToolPalette
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_size_group_add_widget">
+<function name="gtk_tool_palette_unset_style">
<description>
-Adds a widget to a #GtkSizeGroup. In the future, the requisition
-of the widget will be determined as the maximum of its requisition
-and the requisition of the other widgets in the size group.
-Whether this applies horizontally, vertically, or in both directions
-depends on the mode of the size group. See gtk_size_group_set_mode().
+Unsets a toolbar style set with gtk_tool_palette_set_style(),
+so that user preferences will be used to determine the toolbar style.
-When the widget is destroyed or no longer referenced elsewhere, it will
-be removed from the size group.
+Since: 2.20
</description>
<parameters>
-<parameter name="size_group">
-<parameter_description> a #GtkSizeGroup
-</parameter_description>
-</parameter>
-<parameter name="widget">
-<parameter_description> the #GtkWidget to add
+<parameter name="palette">
+<parameter_description> a #GtkToolPalette
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_paper_size_new_from_key_file">
+<function name="gtk_tool_shell_get_ellipsize_mode">
<description>
-Reads a paper size from the group @group_name in the key file
- key_file
+Retrieves the current ellipsize mode for the tool shell. Tool items must not
+call this function directly, but rely on gtk_tool_item_get_ellipsize_mode()
+instead.
-Since: 2.12
+Since: 2.20
</description>
<parameters>
-<parameter name="key_file">
-<parameter_description> the #GKeyFile to retrieve the papersize from
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> the name ofthe group in the key file to read,
-or %NULL to read the first group
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for an error, or %NULL
+<parameter name="shell">
+<parameter_description> a #GtkToolShell
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPaperSize object with the restored
-paper size, or %NULL if an error occurred.
+<return> the current ellipsize mode of @shell
</return>
</function>
-<function name="gtk_icon_view_set_text_column">
+<function name="gtk_tool_shell_get_icon_size">
<description>
-Sets the column with text for @icon_view to be @column. The text
-column must be of type #G_TYPE_STRING.
+Retrieves the icon size for the tool shell. Tool items must not call this
+function directly, but rely on gtk_tool_item_get_icon_size() instead.
-Since: 2.6
+Since: 2.14
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> A #GtkIconView.
-</parameter_description>
-</parameter>
-<parameter name="column">
-<parameter_description> A column in the currently used model, or -1 to display no text
+<parameter name="shell">
+<parameter_description> a #GtkToolShell
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the current size for icons of @shell
+
+</return>
</function>
-<function name="gtk_entry_completion_get_text_column">
+<function name="gtk_tool_shell_get_orientation">
<description>
-Returns the column in the model of @completion to get strings from.
+Retrieves the current orientation for the tool shell. Tool items must not
+call this function directly, but rely on gtk_tool_item_get_orientation()
+instead.
-Since: 2.6
+Since: 2.14
</description>
<parameters>
-<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter name="shell">
+<parameter_description> a #GtkToolShell
</parameter_description>
</parameter>
</parameters>
-<return> the column containing the strings
+<return> the current orientation of @shell
</return>
</function>
-<function name="gtk_print_settings_set_collate">
+<function name="gtk_tool_shell_get_relief_style">
<description>
-Sets the value of %GTK_PRINT_SETTINGS_COLLATE.
+Returns the relief style of buttons on @shell. Tool items must not call this
+function directly, but rely on gtk_tool_item_get_relief_style() instead.
-Since: 2.10
+Since: 2.14
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
-</parameter_description>
-</parameter>
-<parameter name="collate">
-<parameter_description> whether to collate the output
+<parameter name="shell">
+<parameter_description> a #GtkToolShell
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The relief style of buttons on @shell.
+
+</return>
</function>
-<function name="gtk_action_get_accel_path">
+<function name="gtk_tool_shell_get_style">
<description>
-Returns the accel path for this action.
-
-Since: 2.6
+Retrieves whether the tool shell has text, icons, or both. Tool items must
+not call this function directly, but rely on gtk_tool_item_get_style()
+instead.
+Since: 2.14
</description>
<parameters>
-<parameter name="action">
-<parameter_description> the action object
+<parameter name="shell">
+<parameter_description> a #GtkToolShell
</parameter_description>
</parameter>
</parameters>
-<return> the accel path for this action, or %NULL
-if none is set. The returned string is owned by GTK+
-and must not be freed or modified.
+<return> the current style of @shell
+
</return>
</function>
-<function name="gtk_text_view_forward_display_line">
+<function name="gtk_tool_shell_get_text_alignment">
<description>
-Moves the given @iter forward by one display (wrapped) line.
-A display line is different from a paragraph. Paragraphs are
-separated by newlines or other paragraph separator characters.
-Display lines are created by line-wrapping a paragraph. If
-wrapping is turned off, display lines and paragraphs will be the
-same. Display lines are divided differently for each view, since
-they depend on the view's width; paragraphs are the same in all
-views, since they depend on the contents of the #GtkTextBuffer.
+Retrieves the current text alignment for the tool shell. Tool items must not
+call this function directly, but rely on gtk_tool_item_get_text_alignment()
+instead.
+Since: 2.20
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="shell">
+<parameter_description> a #GtkToolShell
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter was moved and is not on the end iterator
+<return> the current text alignment of @shell
+
</return>
</function>
-<function name="gtk_accessible_set_widget">
+<function name="gtk_tool_shell_get_text_orientation">
<description>
-Sets the #GtkWidget corresponding to the #GtkAccessible.
+Retrieves the current text orientation for the tool shell. Tool items must not
+call this function directly, but rely on gtk_tool_item_get_text_orientation()
+instead.
-Since: 2.22
+Since: 2.20
</description>
<parameters>
-<parameter name="accessible">
-<parameter_description> a #GtkAccessible
-</parameter_description>
-</parameter>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="shell">
+<parameter_description> a #GtkToolShell
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the current text orientation of @shell
+
+</return>
</function>
-<function name="gtk_menu_shell_cancel">
+<function name="gtk_tool_shell_get_text_size_group">
<description>
-Cancels the selection within the menu shell.
+Retrieves the current text size group for the tool shell. Tool items must not
+call this function directly, but rely on gtk_tool_item_get_text_size_group()
+instead.
-Since: 2.4
+Since: 2.20
</description>
<parameters>
-<parameter name="menu_shell">
-<parameter_description> a #GtkMenuShell
+<parameter name="shell">
+<parameter_description> a #GtkToolShell
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the current text size group of @shell
+
+</return>
</function>
-<function name="gtk_font_selection_dialog_get_preview_text">
+<function name="gtk_tool_shell_rebuild_menu">
<description>
-Gets the text displayed in the preview area.
+Calling this function signals the tool shell that the overflow menu item for
+tool items have changed. If there is an overflow menu and if it is visible
+when this function it called, the menu will be rebuilt.
+Tool items must not call this function directly, but rely on
+gtk_tool_item_rebuild_menu() instead.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="fsd">
-<parameter_description> a #GtkFontSelectionDialog
+<parameter name="shell">
+<parameter_description> a #GtkToolShell
</parameter_description>
</parameter>
</parameters>
-<return> the text displayed in the preview area.
-This string is owned by the widget and should not be
-modified or freed
-</return>
+<return></return>
</function>
-<function name="gtk_label_get_layout">
+<function name="gtk_toolbar_append_element">
<description>
-Gets the #PangoLayout used to display the label.
-The layout is useful to e.g. convert text positions to
-pixel positions, in combination with gtk_label_get_layout_offsets().
-The returned layout is owned by the label so need not be
-freed by the caller.
+Adds a new element to the end of a toolbar.
+
+If @type == %GTK_TOOLBAR_CHILD_WIDGET, @widget is used as the new element.
+If @type == %GTK_TOOLBAR_CHILD_RADIOBUTTON, @widget is used to determine
+the radio group for the new element. In all other cases, @widget must
+be %NULL.
+ callback must be a pointer to a function taking a #GtkWidget and a gpointer as
+arguments. Use G_CALLBACK() to cast the function to #GCallback.
+
+Deprecated: 2.4: Use gtk_toolbar_insert() instead.
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar.
+</parameter_description>
+</parameter>
+<parameter name="type">
+<parameter_description> a value of type #GtkToolbarChildType that determines what @widget will be.
+</parameter_description>
+</parameter>
+<parameter name="widget">
+<parameter_description> a #GtkWidget, or %NULL.
+</parameter_description>
+</parameter>
+<parameter name="text">
+<parameter_description> the element's label.
+</parameter_description>
+</parameter>
+<parameter name="tooltip_text">
+<parameter_description> the element's tooltip.
+</parameter_description>
+</parameter>
+<parameter name="tooltip_private_text">
+<parameter_description> used for context-sensitive help about this toolbar element.
+</parameter_description>
+</parameter>
+<parameter name="icon">
+<parameter_description> a #GtkWidget that provides pictorial representation of the element's function.
+</parameter_description>
+</parameter>
+<parameter name="callback">
+<parameter_description> the function to be executed when the button is pressed.
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> any data you wish to pass to the callback.
</parameter_description>
</parameter>
</parameters>
-<return> the #PangoLayout for this label
+<return> the new toolbar element as a #GtkWidget.
+
</return>
</function>
-<function name="gtk_tooltip_set_text">
+<function name="gtk_toolbar_append_item">
<description>
-Sets the text of the tooltip to be @text. If @text is %NULL, the label
-will be hidden. See also gtk_tooltip_set_markup().
+Inserts a new item into the toolbar. You must specify the position
+in the toolbar where it will be inserted.
-Since: 2.12
+ callback must be a pointer to a function taking a #GtkWidget and a gpointer as
+arguments. Use G_CALLBACK() to cast the function to #GCallback.
+
+Deprecated: 2.4: Use gtk_toolbar_insert() instead.
</description>
<parameters>
-<parameter name="tooltip">
-<parameter_description> a #GtkTooltip
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar.
</parameter_description>
</parameter>
<parameter name="text">
-<parameter_description> a text string or %NULL
+<parameter_description> give your toolbar button a label.
+</parameter_description>
+</parameter>
+<parameter name="tooltip_text">
+<parameter_description> a string that appears when the user holds the mouse over this item.
+</parameter_description>
+</parameter>
+<parameter name="tooltip_private_text">
+<parameter_description> use with #GtkTipsQuery.
+</parameter_description>
+</parameter>
+<parameter name="icon">
+<parameter_description> a #GtkWidget that should be used as the button's icon.
+</parameter_description>
+</parameter>
+<parameter name="callback">
+<parameter_description> the function to be executed when the button is pressed.
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> a pointer to any data you wish to be passed to the callback.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the new toolbar item as a #GtkWidget.
+
+</return>
</function>
-<function name="gtk_window_get_position">
+<function name="gtk_toolbar_append_space">
<description>
-This function returns the position you need to pass to
-gtk_window_move() to keep @window in its current position. This
-means that the meaning of the returned value varies with window
-gravity. See gtk_window_move() for more details.
-
-If you haven't changed the window gravity, its gravity will be
-#GDK_GRAVITY_NORTH_WEST. This means that gtk_window_get_position()
-gets the position of the top-left corner of the window manager
-frame for the window. gtk_window_move() sets the position of this
-same top-left corner.
-
-gtk_window_get_position() is not 100% reliable because the X Window System
-does not specify a way to obtain the geometry of the
-decorations placed on a window by the window manager.
-Thus GTK+ is using a "best guess" that works with most
-window managers.
-
-Moreover, nearly all window managers are historically broken with
-respect to their handling of window gravity. So moving a window to
-its current position as returned by gtk_window_get_position() tends
-to result in moving the window slightly. Window managers are
-slowly getting better over time.
-
-If a window has gravity #GDK_GRAVITY_STATIC the window manager
-frame is not relevant, and thus gtk_window_get_position() will
-always produce accurate results. However you can't use static
-gravity to do things like place a window in a corner of the screen,
-because static gravity ignores the window manager decorations.
-
-If you are saving and restoring your application's window
-positions, you should know that it's impossible for applications to
-do this without getting it somewhat wrong because applications do
-not have sufficient knowledge of window manager state. The Correct
-Mechanism is to support the session management protocol (see the
-"GnomeClient" object in the GNOME libraries for example) and allow
-the window manager to save your window sizes and positions.
+Adds a new space to the end of the toolbar.
+Deprecated: 2.4: Use gtk_toolbar_insert() instead.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
-</parameter_description>
-</parameter>
-<parameter name="root_x">
-<parameter_description> return location for X coordinate of gravity-determined reference point
-</parameter_description>
-</parameter>
-<parameter name="root_y">
-<parameter_description> return location for Y coordinate of gravity-determined reference point
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_set_parent_window">
+<function name="gtk_toolbar_append_widget">
<description>
-Sets a non default parent window for @widget.
+Adds a widget to the end of the given toolbar.
+
+Deprecated: 2.4: Use gtk_toolbar_insert() instead.
</description>
<parameters>
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar.
+</parameter_description>
+</parameter>
<parameter name="widget">
-<parameter_description> a #GtkWidget.
+<parameter_description> a #GtkWidget to add to the toolbar.
</parameter_description>
</parameter>
-<parameter name="parent_window">
-<parameter_description> the new parent window.
+<parameter name="tooltip_text">
+<parameter_description> the element's tooltip.
+</parameter_description>
+</parameter>
+<parameter name="tooltip_private_text">
+<parameter_description> used for context-sensitive help about this toolbar element.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_image_set">
+<function name="gtk_toolbar_get_drop_index">
<description>
-Sets the #GtkImage.
+Returns the position corresponding to the indicated point on
+ toolbar This is useful when dragging items to the toolbar:
+this function returns the position a new item should be
+inserted.
-Deprecated: 2.0: Use gtk_image_set_from_image() instead.
+ x and @y are in @toolbar coordinates.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GtkImage
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar
</parameter_description>
</parameter>
-<parameter name="val">
-<parameter_description> a #GdkImage
+<parameter name="x">
+<parameter_description> x coordinate of a point on the toolbar
</parameter_description>
</parameter>
-<parameter name="mask">
-<parameter_description> a #GdkBitmap that indicates which parts of the image should be transparent.
+<parameter name="y">
+<parameter_description> y coordinate of a point on the toolbar
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The position corresponding to the point (@x, @y) on the toolbar.
+
+</return>
</function>
-<function name="gtk_builder_new">
+<function name="gtk_toolbar_get_icon_size">
<description>
-Creates a new builder object.
+Retrieves the icon size for the toolbar. See gtk_toolbar_set_icon_size().
-Since: 2.12
</description>
<parameters>
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GtkBuilder object
-
+<return> the current icon size for the icons on
+the toolbar.
</return>
</function>
-<function name="gtk_font_button_set_show_size">
+<function name="gtk_toolbar_get_item_index">
<description>
-If @show_size is %TRUE, the font size will be displayed along with the name of the selected font.
+Returns the position of @item on the toolbar, starting from 0.
+It is an error if @item is not a child of the toolbar.
Since: 2.4
</description>
<parameters>
-<parameter name="font_button">
-<parameter_description> a #GtkFontButton
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar
</parameter_description>
</parameter>
-<parameter name="show_size">
-<parameter_description> %TRUE if font size should be displayed in dialog.
+<parameter name="item">
+<parameter_description> a #GtkToolItem that is a child of @toolbar
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the position of item on the toolbar.
+
+</return>
</function>
-<function name="gtk_notebook_set_tab_detachable">
+<function name="gtk_toolbar_get_n_items">
<description>
-Sets whether the tab can be detached from @notebook to another
-notebook or widget.
-
-Note that 2 notebooks must share a common group identificator
-(see gtk_notebook_set_group_id ()) to allow automatic tabs
-interchange between them.
-
-If you want a widget to interact with a notebook through DnD
-(i.e.: accept dragged tabs from it) it must be set as a drop
-destination and accept the target "GTK_NOTEBOOK_TAB". The notebook
-will fill the selection with a GtkWidget** pointing to the child
-widget that corresponds to the dropped tab.
-|[
-static void
-on_drop_zone_drag_data_received (GtkWidget *widget,
-GdkDragContext *context,
-gint x,
-gint y,
-GtkSelectionData *selection_data,
-guint info,
-guint time,
-gpointer user_data)
-{
-GtkWidget *notebook;
-GtkWidget **child;
-
-notebook = gtk_drag_get_source_widget (context);
-child = (void*) selection_data->data;
-
-process_widget (*child);
-gtk_container_remove (GTK_CONTAINER (notebook), *child);
-}
-]|
-
-If you want a notebook to accept drags from other widgets,
-you will have to set your own DnD code to do it.
+Returns the number of items on the toolbar.
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
-</parameter_description>
-</parameter>
-<parameter name="child">
-<parameter_description> a child #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="detachable">
-<parameter_description> whether the tab is detachable or not
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the number of items on the toolbar
+
+</return>
</function>
-<function name="gtk_action_set_always_show_image">
+<function name="gtk_toolbar_get_nth_item">
<description>
-Sets whether @action<!-- -->'s menu item proxies will ignore the
-#GtkSettings:gtk-menu-images setting and always show their image, if available.
-
-Use this if the menu item would be useless or hard to use
-without their image.
+Returns the @n<!-- -->'th item on @toolbar, or %NULL if the
+toolbar does not contain an @n<!-- -->'th item.
-Since: 2.20
+Since: 2.4
</description>
<parameters>
-<parameter name="action">
-<parameter_description> a #GtkAction
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar
</parameter_description>
</parameter>
-<parameter name="always_show">
-<parameter_description> %TRUE if menuitem proxies should always show their image
+<parameter name="n">
+<parameter_description> A position on the toolbar
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The @n<!-- -->'th #GtkToolItem on @toolbar,
+or %NULL if there isn't an @n<!-- -->'th item.
+
+</return>
</function>
-<function name="gtk_tool_button_get_label">
+<function name="gtk_toolbar_get_orientation">
<description>
-Returns the label used by the tool button, or %NULL if the tool button
-doesn't have a label. or uses a the label from a stock item. The returned
-string is owned by GTK+, and must not be modified or freed.
+Retrieves the current orientation of the toolbar. See
+gtk_toolbar_set_orientation().
-Since: 2.4
+Deprecated: 2.16: Use gtk_orientable_get_orientation() instead.
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkToolButton
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar
</parameter_description>
</parameter>
</parameters>
-<return> The label, or %NULL
+<return> the orientation
</return>
</function>
-<function name="gtk_entry_set_editable">
+<function name="gtk_toolbar_get_relief_style">
<description>
-Determines if the user can edit the text in the editable
-widget or not.
+Returns the relief style of buttons on @toolbar. See
+gtk_button_set_relief().
-Deprecated: 2.0: Use gtk_editable_set_editable() instead.
+Since: 2.4
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
-</parameter_description>
-</parameter>
-<parameter name="editable">
-<parameter_description> %TRUE if the user is allowed to edit the text
-in the widget
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The relief style of buttons on @toolbar.
+
+</return>
</function>
-<function name="gtk_status_icon_set_has_tooltip">
+<function name="gtk_toolbar_get_show_arrow">
<description>
-Sets the has-tooltip property on @status_icon to @has_tooltip.
-See #GtkStatusIcon:has-tooltip for more information.
+Returns whether the toolbar has an overflow menu.
+See gtk_toolbar_set_show_arrow().
-Since: 2.16
+Since: 2.4
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
-</parameter_description>
-</parameter>
-<parameter name="has_tooltip">
-<parameter_description> whether or not @status_icon has a tooltip
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the toolbar has an overflow menu.
+
+</return>
</function>
-<function name="gtk_color_button_set_title">
+<function name="gtk_toolbar_get_style">
<description>
-Sets the title for the color selection dialog.
-
-Since: 2.4
+Retrieves whether the toolbar has text, icons, or both . See
+gtk_toolbar_set_style().
+
</description>
<parameters>
-<parameter name="color_button">
-<parameter_description> a #GtkColorButton
-</parameter_description>
-</parameter>
-<parameter name="title">
-<parameter_description> String containing new window title.
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the current style of @toolbar
+</return>
</function>
-<function name="gtk_widget_is_ancestor">
+<function name="gtk_toolbar_get_tooltips">
<description>
-Determines whether @widget is somewhere inside @ancestor, possibly with
-intermediate containers.
+Retrieves whether tooltips are enabled. See
+gtk_toolbar_set_tooltips().
+Deprecated: 2.14: The toolkit-wide #GtkSettings:gtk-enable-tooltips property
+is now used instead.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="ancestor">
-<parameter_description> another #GtkWidget
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @ancestor contains @widget as a child,
-grandchild, great grandchild, etc.
+<return> %TRUE if tooltips are enabled
+
</return>
</function>
-<function name="gtk_window_unstick">
+<function name="gtk_toolbar_insert">
<description>
-Asks to unstick @window, which means that it will appear on only
-one of the user's desktops. Note that you shouldn't assume the
-window is definitely unstuck afterward, because other entities
-(e.g. the user or <link linkend="gtk-X11-arch">window
-manager</link>) could stick it again. But normally the window will
-end up stuck. Just don't write code that crashes if not.
-
-You can track stickiness via the "window-state-event" signal
-on #GtkWidget.
+Insert a #GtkToolItem into the toolbar at position @pos. If @pos is
+0 the item is prepended to the start of the toolbar. If @pos is
+negative, the item is appended to the end of the toolbar.
+Since: 2.4
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar
+</parameter_description>
+</parameter>
+<parameter name="item">
+<parameter_description> a #GtkToolItem
+</parameter_description>
+</parameter>
+<parameter name="pos">
+<parameter_description> the position of the new item
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_paint_box">
+<function name="gtk_toolbar_insert_element">
<description>
-Draws a box on @window with the given parameters.
+Inserts a new element in the toolbar at the given position.
+
+If @type == %GTK_TOOLBAR_CHILD_WIDGET, @widget is used as the new element.
+If @type == %GTK_TOOLBAR_CHILD_RADIOBUTTON, @widget is used to determine
+the radio group for the new element. In all other cases, @widget must
+be %NULL.
+
+ callback must be a pointer to a function taking a #GtkWidget and a gpointer as
+arguments. Use G_CALLBACK() to cast the function to #GCallback.
+
+Deprecated: 2.4: Use gtk_toolbar_insert() instead.
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar.
</parameter_description>
</parameter>
-<parameter name="state_type">
-<parameter_description> a state
+<parameter name="type">
+<parameter_description> a value of type #GtkToolbarChildType that determines what @widget
+will be.
</parameter_description>
</parameter>
-<parameter name="shadow_type">
-<parameter_description> the type of shadow to draw
+<parameter name="widget">
+<parameter_description> a #GtkWidget, or %NULL.
</parameter_description>
</parameter>
-<parameter name="area">
-<parameter_description> clip rectangle, or %NULL if the
-output should not be clipped
+<parameter name="text">
+<parameter_description> the element's label.
</parameter_description>
</parameter>
-<parameter name="widget">
-<parameter_description> the widget
+<parameter name="tooltip_text">
+<parameter_description> the element's tooltip.
</parameter_description>
</parameter>
-<parameter name="detail">
-<parameter_description> a style detail
+<parameter name="tooltip_private_text">
+<parameter_description> used for context-sensitive help about this toolbar element.
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> x origin of the box
+<parameter name="icon">
+<parameter_description> a #GtkWidget that provides pictorial representation of the element's function.
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> y origin of the box
+<parameter name="callback">
+<parameter_description> the function to be executed when the button is pressed.
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> the width of the box
+<parameter name="user_data">
+<parameter_description> any data you wish to pass to the callback.
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> the height of the box
+<parameter name="position">
+<parameter_description> the number of widgets to insert this element after.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the new toolbar element as a #GtkWidget.
+
+</return>
</function>
-<function name="gtk_container_set_focus_vadjustment">
+<function name="gtk_toolbar_insert_item">
<description>
-Hooks up an adjustment to focus handling in a container, so when a
-child of the container is focused, the adjustment is scrolled to
-show that widget. This function sets the vertical alignment. See
-gtk_scrolled_window_get_vadjustment() for a typical way of obtaining
-the adjustment and gtk_container_set_focus_hadjustment() for setting
-the horizontal adjustment.
+Inserts a new item into the toolbar. You must specify the position in the
+toolbar where it will be inserted.
-The adjustments have to be in pixel units and in the same coordinate
-system as the allocation for immediate children of the container.
+ callback must be a pointer to a function taking a #GtkWidget and a gpointer as
+arguments. Use G_CALLBACK() to cast the function to #GCallback.
+
+Deprecated: 2.4: Use gtk_toolbar_insert() instead.
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar.
</parameter_description>
</parameter>
-<parameter name="adjustment">
-<parameter_description> an adjustment which should be adjusted when the focus
-is moved among the descendents of @container
+<parameter name="text">
+<parameter_description> give your toolbar button a label.
+</parameter_description>
+</parameter>
+<parameter name="tooltip_text">
+<parameter_description> a string that appears when the user holds the mouse over this item.
+</parameter_description>
+</parameter>
+<parameter name="tooltip_private_text">
+<parameter_description> use with #GtkTipsQuery.
+</parameter_description>
+</parameter>
+<parameter name="icon">
+<parameter_description> a #GtkWidget that should be used as the button's icon.
+</parameter_description>
+</parameter>
+<parameter name="callback">
+<parameter_description> the function to be executed when the button is pressed.
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> a pointer to any data you wish to be passed to the callback.
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> the number of widgets to insert this item after.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the new toolbar item as a #GtkWidget.
+
+</return>
</function>
-<function name="gtk_text_view_set_indent">
+<function name="gtk_toolbar_insert_space">
<description>
-Sets the default indentation for paragraphs in @text_view.
-Tags in the buffer may override the default.
+Inserts a new space in the toolbar at the specified position.
+
+Deprecated: 2.4: Use gtk_toolbar_insert() instead.
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar
</parameter_description>
</parameter>
-<parameter name="indent">
-<parameter_description> indentation in pixels
+<parameter name="position">
+<parameter_description> the number of widgets after which a space should be inserted.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_notebook_set_group">
+<function name="gtk_toolbar_insert_stock">
<description>
-Sets a group identificator pointer for @notebook, notebooks sharing
-the same group identificator pointer will be able to exchange tabs
-via drag and drop. A notebook with a %NULL group identificator will
-not be able to exchange tabs with any other notebook.
+Inserts a stock item at the specified position of the toolbar. If
+ stock_id is not a known stock item ID, it's inserted verbatim,
+except that underscores used to mark mnemonics are removed.
-Since: 2.12
+ callback must be a pointer to a function taking a #GtkWidget and a gpointer as
+arguments. Use G_CALLBACK() to cast the function to #GCallback.
+
+Deprecated: 2.4: Use gtk_toolbar_insert() instead.
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="toolbar">
+<parameter_description> A #GtkToolbar
</parameter_description>
</parameter>
-<parameter name="group">
-<parameter_description> a pointer to identify the notebook group, or %NULL to unset it
+<parameter name="stock_id">
+<parameter_description> The id of the stock item you want to insert
+</parameter_description>
+</parameter>
+<parameter name="tooltip_text">
+<parameter_description> The text in the tooltip of the toolbar button
+</parameter_description>
+</parameter>
+<parameter name="tooltip_private_text">
+<parameter_description> The private text of the tooltip
+</parameter_description>
+</parameter>
+<parameter name="callback">
+<parameter_description> The callback called when the toolbar button is clicked.
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> user data passed to callback
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> The position the button shall be inserted at.
+-1 means at the end.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the inserted widget
+
+</return>
</function>
-<function name="gtk_toggle_button_get_inconsistent">
+<function name="gtk_toolbar_insert_widget">
<description>
-Gets the value set by gtk_toggle_button_set_inconsistent().
+Inserts a widget in the toolbar at the given position.
+Deprecated: 2.4: Use gtk_toolbar_insert() instead.
</description>
<parameters>
-<parameter name="toggle_button">
-<parameter_description> a #GtkToggleButton
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar.
+</parameter_description>
+</parameter>
+<parameter name="widget">
+<parameter_description> a #GtkWidget to add to the toolbar.
+</parameter_description>
+</parameter>
+<parameter name="tooltip_text">
+<parameter_description> the element's tooltip.
+</parameter_description>
+</parameter>
+<parameter name="tooltip_private_text">
+<parameter_description> used for context-sensitive help about this toolbar element.
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> the number of widgets to insert this widget after.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the button is displayed as inconsistent, %FALSE otherwise
-</return>
+<return></return>
</function>
-<function name="gtk_handle_box_get_snap_edge">
+<function name="gtk_toolbar_new">
<description>
-Gets the edge used for determining reattachment of the handle box. See
-gtk_handle_box_set_snap_edge().
-
+Creates a new toolbar.
+
</description>
<parameters>
-<parameter name="handle_box">
-<parameter_description> a #GtkHandleBox
-</parameter_description>
-</parameter>
</parameters>
-<return> the edge used for determining reattachment, or (GtkPositionType)-1 if this
-is determined (as per default) from the handle position.
+<return> the newly-created toolbar.
</return>
</function>
-<function name="gtk_label_set_text_with_mnemonic">
+<function name="gtk_toolbar_prepend_element">
<description>
-Sets the label's text from the string @str.
-If characters in @str are preceded by an underscore, they are underlined
-indicating that they represent a keyboard accelerator called a mnemonic.
-The mnemonic key can be used to activate another widget, chosen
-automatically, or explicitly using gtk_label_set_mnemonic_widget().
+Adds a new element to the beginning of a toolbar.
+
+If @type == %GTK_TOOLBAR_CHILD_WIDGET, @widget is used as the new element.
+If @type == %GTK_TOOLBAR_CHILD_RADIOBUTTON, @widget is used to determine
+the radio group for the new element. In all other cases, @widget must
+be %NULL.
+
+ callback must be a pointer to a function taking a #GtkWidget and a gpointer as
+arguments. Use G_CALLBACK() to cast the function to #GCallback.
+
+Deprecated: 2.4: Use gtk_toolbar_insert() instead.
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar.
</parameter_description>
</parameter>
-<parameter name="str">
-<parameter_description> a string
+<parameter name="type">
+<parameter_description> a value of type #GtkToolbarChildType that determines what @widget will be.
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_text_layout_get_cursor_locations">
-<description>
-Given an iterator within a text layout, determine the positions of the
-strong and weak cursors if the insertion point is at that
-iterator. The position of each cursor is stored as a zero-width
-rectangle. The strong cursor location is the location where
-characters of the directionality equal to the base direction of the
-paragraph are inserted. The weak cursor location is the location
-where characters of the directionality opposite to the base
-direction of the paragraph are inserted.
-
-</description>
-<parameters>
-<parameter name="layout">
-<parameter_description> a #GtkTextLayout
+<parameter name="widget">
+<parameter_description> a #GtkWidget, or %NULL
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="text">
+<parameter_description> the element's label.
</parameter_description>
</parameter>
-<parameter name="strong_pos">
-<parameter_description> location to store the strong cursor position (may be %NULL)
+<parameter name="tooltip_text">
+<parameter_description> the element's tooltip.
</parameter_description>
</parameter>
-<parameter name="weak_pos">
-<parameter_description> location to store the weak cursor position (may be %NULL)
+<parameter name="tooltip_private_text">
+<parameter_description> used for context-sensitive help about this toolbar element.
+</parameter_description>
+</parameter>
+<parameter name="icon">
+<parameter_description> a #GtkWidget that provides pictorial representation of the element's function.
+</parameter_description>
+</parameter>
+<parameter name="callback">
+<parameter_description> the function to be executed when the button is pressed.
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> any data you wish to pass to the callback.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the new toolbar element as a #GtkWidget.
+
+</return>
</function>
-<function name="gtk_print_unix_dialog_set_page_setup">
+<function name="gtk_toolbar_prepend_item">
<description>
-Sets the page setup of the #GtkPrintUnixDialog.
+Adds a new button to the beginning (top or left edges) of the given toolbar.
-Since: 2.10
+ callback must be a pointer to a function taking a #GtkWidget and a gpointer as
+arguments. Use G_CALLBACK() to cast the function to #GCallback.
+
+Deprecated: 2.4: Use gtk_toolbar_insert() instead.
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar.
</parameter_description>
</parameter>
-<parameter name="page_setup">
-<parameter_description> a #GtkPageSetup
+<parameter name="text">
+<parameter_description> give your toolbar button a label.
+</parameter_description>
+</parameter>
+<parameter name="tooltip_text">
+<parameter_description> a string that appears when the user holds the mouse over this item.
+</parameter_description>
+</parameter>
+<parameter name="tooltip_private_text">
+<parameter_description> use with #GtkTipsQuery.
+</parameter_description>
+</parameter>
+<parameter name="icon">
+<parameter_description> a #GtkWidget that should be used as the button's icon.
+</parameter_description>
+</parameter>
+<parameter name="callback">
+<parameter_description> the function to be executed when the button is pressed.
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> a pointer to any data you wish to be passed to the callback.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the new toolbar item as a #GtkWidget.
+
+</return>
</function>
-<function name="gtk_window_present_with_time">
+<function name="gtk_toolbar_prepend_space">
<description>
-Presents a window to the user in response to a user interaction.
-If you need to present a window without a timestamp, use
-gtk_window_present(). See gtk_window_present() for details.
+Adds a new space to the beginning of the toolbar.
-Since: 2.8
+Deprecated: 2.4: Use gtk_toolbar_insert() instead.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
-</parameter_description>
-</parameter>
-<parameter name="timestamp">
-<parameter_description> the timestamp of the user interaction (typically a
-button or key press event) which triggered this call
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_list_store_reorder">
+<function name="gtk_toolbar_prepend_widget">
<description>
-Reorders @store to follow the order indicated by @new_order. Note that
-this function only works with unsorted stores.
+Adds a widget to the beginning of the given toolbar.
-Since: 2.2
+Deprecated: 2.4: Use gtk_toolbar_insert() instead.
</description>
<parameters>
-<parameter name="store">
-<parameter_description> A #GtkListStore.
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar.
</parameter_description>
</parameter>
-<parameter name="new_order">
-<parameter_description> an array of integers mapping the new position of each child
-to its old position before the re-ordering,
-i.e. @new_order<literal>[newpos] = oldpos</literal>.
+<parameter name="widget">
+<parameter_description> a #GtkWidget to add to the toolbar.
+</parameter_description>
+</parameter>
+<parameter name="tooltip_text">
+<parameter_description> the element's tooltip.
+</parameter_description>
+</parameter>
+<parameter name="tooltip_private_text">
+<parameter_description> used for context-sensitive help about this toolbar element.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_get_serialize_formats">
+<function name="gtk_toolbar_remove_space">
<description>
-This function returns the rich text serialize formats registered
-with @buffer using gtk_text_buffer_register_serialize_format() or
-gtk_text_buffer_register_serialize_tagset()
+Removes a space from the specified position.
-Since: 2.10
+Deprecated: 2.4: Use gtk_toolbar_insert() instead.
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar.
</parameter_description>
</parameter>
-<parameter name="n_formats">
-<parameter_description> return location for the number of formats
+<parameter name="position">
+<parameter_description> the index of the space to remove.
</parameter_description>
</parameter>
</parameters>
-<return> an array of #GdkAtom<!-- -->s representing the registered
-formats.
-
-</return>
+<return></return>
</function>
-<function name="gtk_text_buffer_get_iter_at_line">
+<function name="gtk_toolbar_set_drop_highlight_item">
<description>
-Initializes @iter to the start of the given line.
+Highlights @toolbar to give an idea of what it would look like
+if @item was added to @toolbar at the position indicated by @index_.
+If @item is %NULL, highlighting is turned off. In that case @index_
+is ignored.
+
+The @tool_item passed to this function must not be part of any widget
+hierarchy. When an item is set as drop highlight item it can not
+added to any widget hierarchy or used as highlight item for another
+toolbar.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> iterator to initialize
+<parameter name="tool_item">
+<parameter_description> a #GtkToolItem, or %NULL to turn of highlighting
</parameter_description>
</parameter>
-<parameter name="line_number">
-<parameter_description> line number counting from 0
+<parameter name="index_">
+<parameter_description> a position on @toolbar
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_get_visible">
+<function name="gtk_toolbar_set_icon_size">
<description>
-Determines whether the widget is visible. Note that this doesn't
-take into account whether the widget's parent is also visible
-or the widget is obscured in any way.
-
-See gtk_widget_set_visible().
+This function sets the size of stock icons in the toolbar. You
+can call it both before you add the icons and after they've been
+added. The size you set will override user preferences for the default
+icon size.
-Since: 2.18
+This should only be used for special-purpose toolbars, normal
+application toolbars should respect the user preferences for the
+size of icons.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="toolbar">
+<parameter_description> A #GtkToolbar
+</parameter_description>
+</parameter>
+<parameter name="icon_size">
+<parameter_description> The #GtkIconSize that stock icons in the
+toolbar shall have.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the widget is visible
-
-</return>
+<return></return>
</function>
-<function name="gtk_color_selection_palette_to_string">
+<function name="gtk_toolbar_set_orientation">
<description>
-Encodes a palette as a string, useful for persistent storage.
+Sets whether a toolbar should appear horizontally or vertically.
+Deprecated: 2.16: Use gtk_orientable_set_orientation() instead.
</description>
<parameters>
-<parameter name="colors">
-<parameter_description> an array of colors.
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar.
</parameter_description>
</parameter>
-<parameter name="n_colors">
-<parameter_description> length of the array.
+<parameter name="orientation">
+<parameter_description> a new #GtkOrientation.
</parameter_description>
</parameter>
</parameters>
-<return> allocated string encoding the palette.
-</return>
+<return></return>
</function>
-<function name="gtk_selection_clear_targets">
+<function name="gtk_toolbar_set_show_arrow">
<description>
-Remove all targets registered for the given selection for the
-widget.
+Sets whether to show an overflow menu when
+ toolbar doesn't have room for all items on it. If %TRUE,
+items that there are not room are available through an
+overflow menu.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar
</parameter_description>
</parameter>
-<parameter name="selection">
-<parameter_description> an atom representing a selection
+<parameter name="show_arrow">
+<parameter_description> Whether to show an overflow menu
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_font_selection_dialog_set_preview_text">
+<function name="gtk_toolbar_set_style">
<description>
-Sets the text displayed in the preview area.
+Alters the view of @toolbar to display either icons only, text only, or both.
</description>
<parameters>
-<parameter name="fsd">
-<parameter_description> a #GtkFontSelectionDialog
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar.
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> the text to display in the preview area
+<parameter name="style">
+<parameter_description> the new style for @toolbar.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_reset_rc_styles">
+<function name="gtk_toolbar_set_tooltips">
<description>
-Reset the styles of @widget and all descendents, so when
-they are looked up again, they get the correct values
-for the currently loaded RC file settings.
+Sets if the tooltips of a toolbar should be active or not.
-This function is not useful for applications.
+Deprecated: 2.14: The toolkit-wide #GtkSettings:gtk-enable-tooltips property
+is now used instead.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget.
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar.
+</parameter_description>
+</parameter>
+<parameter name="enable">
+<parameter_description> set to %FALSE to disable the tooltips, or %TRUE to enable them.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_file_chooser_button_set_width_chars">
+<function name="gtk_toolbar_unset_icon_size">
<description>
-Sets the width (in characters) that @button will use to @n_chars.
-
-Since: 2.6
+Unsets toolbar icon size set with gtk_toolbar_set_icon_size(), so that
+user preferences will be used to determine the icon size.
</description>
<parameters>
-<parameter name="button">
-<parameter_description> the button widget to examine.
-</parameter_description>
-</parameter>
-<parameter name="n_chars">
-<parameter_description> the new width, in characters.
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_orientable_set_orientation">
+<function name="gtk_toolbar_unset_style">
<description>
-Sets the orientation of the @orientable.
-
-Since: 2.16
+Unsets a toolbar style set with gtk_toolbar_set_style(), so that
+user preferences will be used to determine the toolbar style.
</description>
<parameters>
-<parameter name="orientable">
-<parameter_description> a #GtkOrientable
-</parameter_description>
-</parameter>
-<parameter name="orientation">
-<parameter_description> the orientable's new orientation.
+<parameter name="toolbar">
+<parameter_description> a #GtkToolbar
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_iter_forward_cursor_positions">
+<function name="gtk_tooltip_set_custom">
<description>
-Moves up to @count cursor positions. See
-gtk_text_iter_forward_cursor_position() for details.
+Replaces the widget packed into the tooltip with
+ custom_widget @custom_widget does not get destroyed when the tooltip goes
+away.
+By default a box with a #GtkImage and #GtkLabel is embedded in
+the tooltip, which can be configured using gtk_tooltip_set_markup()
+and gtk_tooltip_set_icon().
+Since: 2.12
+
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="tooltip">
+<parameter_description> a #GtkTooltip
</parameter_description>
</parameter>
-<parameter name="count">
-<parameter_description> number of positions to move
+<parameter name="custom_widget">
+<parameter_description> a #GtkWidget, or %NULL to unset the old custom widget.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if we moved and the new position is dereferenceable
-</return>
+<return></return>
</function>
-<function name="gtk_ui_manager_set_add_tearoffs">
+<function name="gtk_tooltip_set_icon">
<description>
-Sets the "add_tearoffs" property, which controls whether menus
-generated by this #GtkUIManager will have tearoff menu items.
-
-Note that this only affects regular menus. Generated popup
-menus never have tearoff menu items.
+Sets the icon of the tooltip (which is in front of the text) to be
+ pixbuf If @pixbuf is %NULL, the image will be hidden.
-Since: 2.4
+Since: 2.12
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #GtkUIManager
+<parameter name="tooltip">
+<parameter_description> a #GtkTooltip
</parameter_description>
</parameter>
-<parameter name="add_tearoffs">
-<parameter_description> whether tearoff menu items are added
+<parameter name="pixbuf">
+<parameter_description> a #GdkPixbuf, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_size_get_name">
+<function name="gtk_tooltip_set_icon_from_gicon">
<description>
-Gets the canonical name of the given icon size. The returned string
-is statically allocated and should not be freed.
+Sets the icon of the tooltip (which is in front of the text)
+to be the icon indicated by @gicon with the size indicated
+by @size. If @gicon is %NULL, the image will be hidden.
+
+Since: 2.20
</description>
<parameters>
+<parameter name="tooltip">
+<parameter_description> a #GtkTooltip
+</parameter_description>
+</parameter>
+<parameter name="gicon">
+<parameter_description> a #GIcon representing the icon, or %NULL
+</parameter_description>
+</parameter>
<parameter name="size">
-<parameter_description> a #GtkIconSize.
+<parameter_description> a stock icon size
</parameter_description>
</parameter>
</parameters>
-<return> the name of the given icon size.
-</return>
+<return></return>
</function>
-<function name="gtk_entry_set_progress_fraction">
+<function name="gtk_tooltip_set_icon_from_icon_name">
<description>
-Causes the entry's progress indicator to "fill in" the given
-fraction of the bar. The fraction should be between 0.0 and 1.0,
-inclusive.
+Sets the icon of the tooltip (which is in front of the text) to be
+the icon indicated by @icon_name with the size indicated
+by @size. If @icon_name is %NULL, the image will be hidden.
-Since: 2.16
+Since: 2.14
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="tooltip">
+<parameter_description> a #GtkTooltip
</parameter_description>
</parameter>
-<parameter name="fraction">
-<parameter_description> fraction of the task that's been completed
+<parameter name="icon_name">
+<parameter_description> an icon name, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="size">
+<parameter_description> a stock icon size
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_button_get_label">
+<function name="gtk_tooltip_set_icon_from_stock">
<description>
-Fetches the text from the label of the button, as set by
-gtk_button_set_label(). If the label text has not
-been set the return value will be %NULL. This will be the
-case if you create an empty button with gtk_button_new() to
-use as a container.
+Sets the icon of the tooltip (which is in front of the text) to be
+the stock item indicated by @stock_id with the size indicated
+by @size. If @stock_id is %NULL, the image will be hidden.
+Since: 2.12
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkButton
+<parameter name="tooltip">
+<parameter_description> a #GtkTooltip
+</parameter_description>
+</parameter>
+<parameter name="stock_id">
+<parameter_description> a stock id, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="size">
+<parameter_description> a stock icon size
</parameter_description>
</parameter>
</parameters>
-<return> The text of the label widget. This string is owned
-by the widget and must not be modified or freed.
-</return>
+<return></return>
</function>
-<function name="gtk_editable_get_chars">
+<function name="gtk_tooltip_set_markup">
<description>
-Retrieves a sequence of characters. The characters that are retrieved
-are those characters at positions from @start_pos up to, but not
-including @end_pos. If @end_pos is negative, then the the characters
-retrieved are those characters from @start_pos to the end of the text.
-
-Note that positions are specified in characters, not bytes.
+Sets the text of the tooltip to be @markup, which is marked up
+with the <link
+linkend="PangoMarkupFormat">Pango text markup language</link>.
+If @markup is %NULL, the label will be hidden.
+Since: 2.12
</description>
<parameters>
-<parameter name="editable">
-<parameter_description> a #GtkEditable
-</parameter_description>
-</parameter>
-<parameter name="start_pos">
-<parameter_description> start of text
+<parameter name="tooltip">
+<parameter_description> a #GtkTooltip
</parameter_description>
</parameter>
-<parameter name="end_pos">
-<parameter_description> end of text
+<parameter name="markup">
+<parameter_description> a markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>) or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the contents of the widget as a
-string. This string is allocated by the #GtkEditable
-implementation and should be freed by the caller.
-</return>
+<return></return>
</function>
-<function name="gtk_statusbar_remove_all">
+<function name="gtk_tooltip_set_text">
<description>
-Forces the removal of all messages from a statusbar's
-stack with the exact @context_id.
+Sets the text of the tooltip to be @text. If @text is %NULL, the label
+will be hidden. See also gtk_tooltip_set_markup().
-Since: 2.22
+Since: 2.12
</description>
<parameters>
-<parameter name="statusbar">
-<parameter_description> a #GtkStatusBar
+<parameter name="tooltip">
+<parameter_description> a #GtkTooltip
</parameter_description>
</parameter>
-<parameter name="context_id">
-<parameter_description> a context identifier
+<parameter name="text">
+<parameter_description> a text string or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_mark_get_left_gravity">
+<function name="gtk_tooltip_set_tip_area">
<description>
-Determines whether the mark has left gravity.
+Sets the area of the widget, where the contents of this tooltip apply,
+to be @rect (in widget coordinates). This is especially useful for
+properly setting tooltips on #GtkTreeView rows and cells, #GtkIconViews,
+etc.
+For setting tooltips on #GtkTreeView, please refer to the convenience
+functions for this: gtk_tree_view_set_tooltip_row() and
+gtk_tree_view_set_tooltip_cell().
+
+Since: 2.12
</description>
<parameters>
-<parameter name="mark">
-<parameter_description> a #GtkTextMark
+<parameter name="tooltip">
+<parameter_description> a #GtkTooltip
+</parameter_description>
+</parameter>
+<parameter name="rect">
+<parameter_description> a #GdkRectangle
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the mark has left gravity, %FALSE otherwise
-</return>
+<return></return>
</function>
-<function name="gtk_tool_palette_set_expand">
+<function name="gtk_tooltip_trigger_tooltip_query">
<description>
-Sets whether the group should be given extra space.
+Triggers a new tooltip query on @display, in order to update the current
+visible tooltip, or to show/hide the current tooltip. This function is
+useful to call when, for example, the state of the widget changed by a
+key press.
-Since: 2.20
+Since: 2.12
</description>
<parameters>
-<parameter name="palette">
-<parameter_description> a #GtkToolPalette
-</parameter_description>
-</parameter>
-<parameter name="group">
-<parameter_description> a #GtkToolItemGroup which is a child of palette
-</parameter_description>
-</parameter>
-<parameter name="expand">
-<parameter_description> whether the group should be given extra space
+<parameter name="display">
+<parameter_description> a #GdkDisplay
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_accelerator_name">
+<function name="gtk_tooltips_get_info_from_tip_window">
<description>
-Converts an accelerator keyval and modifier mask
-into a string parseable by gtk_accelerator_parse().
-For example, if you pass in #GDK_q and #GDK_CONTROL_MASK,
-this function returns "<Control>q".
+Determines the tooltips and the widget they belong to from the window in
+which they are displayed.
-If you need to display accelerators in the user interface,
-see gtk_accelerator_get_label().
+This function is mostly intended for use by accessibility technologies;
+applications should have little use for it.
+Since: 2.4
+
+Deprecated: 2.12:
</description>
<parameters>
-<parameter name="accelerator_key">
-<parameter_description> accelerator keyval
+<parameter name="tip_window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="accelerator_mods">
-<parameter_description> accelerator modifier mask
+<parameter name="tooltips">
+<parameter_description> the return location for the tooltips which are displayed
+in @tip_window, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="current_widget">
+<parameter_description> the return location for the widget whose tooltips
+are displayed, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated accelerator name
+<return> %TRUE if @tip_window is displaying tooltips, otherwise %FALSE.
+
</return>
</function>
-<function name="gtk_widget_set_colormap">
+<function name="gtk_tooltips_set_tip">
<description>
-Sets the colormap for the widget to the given value. Widget must not
-have been previously realized. This probably should only be used
-from an <function>init()</function> function (i.e. from the constructor
-for the widget).
+Adds a tooltip containing the message @tip_text to the specified #GtkWidget.
+Deprecated: 2.12:
</description>
<parameters>
+<parameter name="tooltips">
+<parameter_description> a #GtkTooltips.
+</parameter_description>
+</parameter>
<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter_description> the #GtkWidget you wish to associate the tip with.
</parameter_description>
</parameter>
-<parameter name="colormap">
-<parameter_description> a colormap
+<parameter name="tip_text">
+<parameter_description> a string containing the tip itself.
+</parameter_description>
+</parameter>
+<parameter name="tip_private">
+<parameter_description> a string of any further information that may be useful if the user gets stuck.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_set_urgency_hint">
+<function name="gtk_tree_drag_dest_drag_data_received">
<description>
-Windows may set a hint asking the desktop environment to draw
-the users attention to the window. This function sets this hint.
+Asks the #GtkTreeDragDest to insert a row before the path @dest,
+deriving the contents of the row from @selection_data. If @dest is
+outside the tree so that inserting before it is impossible, %FALSE
+will be returned. Also, %FALSE may be returned if the new row is
+not created for some model-specific reason. Should robustly handle
+a @dest no longer found in the model!
-Since: 2.8
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="drag_dest">
+<parameter_description> a #GtkTreeDragDest
</parameter_description>
</parameter>
-<parameter name="setting">
-<parameter_description> %TRUE to mark this window as urgent
+<parameter name="dest">
+<parameter_description> row to drop in front of
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_image_menu_item_new_with_label">
-<description>
-Creates a new #GtkImageMenuItem containing a label.
-
-</description>
-<parameters>
-<parameter name="label">
-<parameter_description> the text of the menu item.
+<parameter name="selection_data">
+<parameter_description> data to drop
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkImageMenuItem.
+<return> whether a new row was created before position @dest
</return>
</function>
-<function name="gtk_action_set_icon_name">
+<function name="gtk_tree_drag_dest_row_drop_possible">
<description>
-Sets the icon name on @action
+Determines whether a drop is possible before the given @dest_path,
+at the same depth as @dest_path. i.e., can we drop the data in
+ selection_data at that location. @dest_path does not have to
+exist; the return value will almost certainly be %FALSE if the
+parent of @dest_path doesn't exist, though.
-Since: 2.16
</description>
<parameters>
-<parameter name="action">
-<parameter_description> a #GtkAction
+<parameter name="drag_dest">
+<parameter_description> a #GtkTreeDragDest
</parameter_description>
</parameter>
-<parameter name="icon_name">
-<parameter_description> the icon name to set
+<parameter name="dest_path">
+<parameter_description> destination row
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_expander_get_spacing">
-<description>
-Gets the value set by gtk_expander_set_spacing().
-
-Since: 2.4
-
-</description>
-<parameters>
-<parameter name="expander">
-<parameter_description> a #GtkExpander
+<parameter name="selection_data">
+<parameter_description> the data being dragged
</parameter_description>
</parameter>
</parameters>
-<return> spacing between the expander and child.
-
+<return> %TRUE if a drop is possible before @dest_path
</return>
</function>
-<function name="gtk_list_store_move_before">
+<function name="gtk_tree_drag_source_drag_data_delete">
<description>
-Moves @iter in @store to the position before @position. Note that this
-function only works with unsorted stores. If @position is %NULL, @iter
-will be moved to the end of the list.
+Asks the #GtkTreeDragSource to delete the row at @path, because
+it was moved somewhere else via drag-and-drop. Returns %FALSE
+if the deletion fails because @path no longer exists, or for
+some model-specific reason. Should robustly handle a @path no
+longer found in the model!
-Since: 2.2
</description>
<parameters>
-<parameter name="store">
-<parameter_description> A #GtkListStore.
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> A #GtkTreeIter.
+<parameter name="drag_source">
+<parameter_description> a #GtkTreeDragSource
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> A #GtkTreeIter, or %NULL.
+<parameter name="path">
+<parameter_description> row that was being dragged
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the row was successfully deleted
+</return>
</function>
-<function name="gtk_widget_path">
+<function name="gtk_tree_drag_source_drag_data_get">
<description>
-Obtains the full path to @widget. The path is simply the name of a
-widget and all its parents in the container hierarchy, separated by
-periods. The name of a widget comes from
-gtk_widget_get_name(). Paths are used to apply styles to a widget
-in gtkrc configuration files. Widget names are the type of the
-widget by default (e.g. "GtkButton") or can be set to an
-application-specific value with gtk_widget_set_name(). By setting
-the name of a widget, you allow users or theme authors to apply
-styles to that specific widget in their gtkrc
-file. @path_reversed_p fills in the path in reverse order,
-i.e. starting with @widget's name instead of starting with the name
-of @widget's outermost ancestor.
+Asks the #GtkTreeDragSource to fill in @selection_data with a
+representation of the row at @path. @selection_data->target gives
+the required type of the data. Should robustly handle a @path no
+longer found in the model!
+
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="path_length">
-<parameter_description> location to store length of the path, or %NULL
+<parameter name="drag_source">
+<parameter_description> a #GtkTreeDragSource
</parameter_description>
</parameter>
<parameter name="path">
-<parameter_description> location to store allocated path string, or %NULL
+<parameter_description> row that was dragged
</parameter_description>
</parameter>
-<parameter name="path_reversed">
-<parameter_description> location to store allocated reverse path string, or %NULL
+<parameter name="selection_data">
+<parameter_description> a #GtkSelectionData to fill with data from the dragged row
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if data of the required type was provided
+</return>
</function>
-<function name="gtk_status_icon_new_from_pixbuf">
+<function name="gtk_tree_drag_source_row_draggable">
<description>
-Creates a status icon displaying @pixbuf.
-
-The image will be scaled down to fit in the available
-space in the notification area, if necessary.
+Asks the #GtkTreeDragSource whether a particular row can be used as
+the source of a DND operation. If the source doesn't implement
+this interface, the row is assumed draggable.
-Since: 2.10
</description>
<parameters>
-<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf
+<parameter name="drag_source">
+<parameter_description> a #GtkTreeDragSource
+</parameter_description>
+</parameter>
+<parameter name="path">
+<parameter_description> row on which user is initiating a drag
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkStatusIcon
-
+<return> %TRUE if the row can be dragged
</return>
</function>
-<function name="gtk_drag_set_icon_pixmap">
+<function name="gtk_tree_get_row_drag_data">
<description>
-Sets @pixmap as the icon for a given drag. GTK+ retains
-references for the arguments, and will release them when
-they are no longer needed. In general, gtk_drag_set_icon_pixbuf()
-will be more convenient to use.
+Obtains a @tree_model and @path from selection data of target type
+%GTK_TREE_MODEL_ROW. Normally called from a drag_data_received handler.
+This function can only be used if @selection_data originates from the same
+process that's calling this function, because a pointer to the tree model
+is being passed around. If you aren't in the same process, then you'll
+get memory corruption. In the #GtkTreeDragDest drag_data_received handler,
+you can assume that selection data of type %GTK_TREE_MODEL_ROW is
+in from the current process. The returned path must be freed with
+gtk_tree_path_free().
+
</description>
<parameters>
-<parameter name="context">
-<parameter_description> the context for a drag. (This must be called
-with a context for the source side of a drag)
-</parameter_description>
-</parameter>
-<parameter name="colormap">
-<parameter_description> the colormap of the icon
-</parameter_description>
-</parameter>
-<parameter name="pixmap">
-<parameter_description> the image data for the icon
-</parameter_description>
-</parameter>
-<parameter name="mask">
-<parameter_description> the transparency mask for the icon
+<parameter name="selection_data">
+<parameter_description> a #GtkSelectionData
</parameter_description>
</parameter>
-<parameter name="hot_x">
-<parameter_description> the X offset within @pixmap of the hotspot.
+<parameter name="tree_model">
+<parameter_description> a #GtkTreeModel
</parameter_description>
</parameter>
-<parameter name="hot_y">
-<parameter_description> the Y offset within @pixmap of the hotspot.
+<parameter name="path">
+<parameter_description> row in @tree_model
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @selection_data had target type %GTK_TREE_MODEL_ROW and
+is otherwise valid
+</return>
</function>
-<function name="gtk_combo_box_set_button_sensitivity">
+<function name="gtk_tree_iter_copy">
<description>
-Sets whether the dropdown button of the combo box should be
-always sensitive (%GTK_SENSITIVITY_ON), never sensitive (%GTK_SENSITIVITY_OFF)
-or only if there is at least one item to display (%GTK_SENSITIVITY_AUTO).
+Creates a dynamically allocated tree iterator as a copy of @iter.
+This function is not intended for use in applications, because you
+can just copy the structs by value
+(<literal>GtkTreeIter new_iter = iter;</literal>).
+You must free this iter with gtk_tree_iter_free().
-Since: 2.14
</description>
<parameters>
-<parameter name="combo_box">
-<parameter_description> a #GtkComboBox
-</parameter_description>
-</parameter>
-<parameter name="sensitivity">
-<parameter_description> specify the sensitivity of the dropdown button
+<parameter name="iter">
+<parameter_description> A #GtkTreeIter.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a newly-allocated copy of @iter.
+</return>
</function>
-<function name="gtk_list_store_move_after">
+<function name="gtk_tree_iter_free">
<description>
-Moves @iter in @store to the position after @position. Note that this
-function only works with unsorted stores. If @position is %NULL, @iter
-will be moved to the start of the list.
-
-Since: 2.2
+Frees an iterator that has been allocated by gtk_tree_iter_copy().
+This function is mainly used for language bindings.
</description>
<parameters>
-<parameter name="store">
-<parameter_description> A #GtkListStore.
-</parameter_description>
-</parameter>
<parameter name="iter">
-<parameter_description> A #GtkTreeIter.
-</parameter_description>
-</parameter>
-<parameter name="position">
-<parameter_description> A #GtkTreeIter or %NULL.
+<parameter_description> A dynamically allocated tree iterator.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_get_modified">
+<function name="gtk_tree_model_filter_clear_cache">
<description>
-Indicates whether the buffer has been modified since the last call
-to gtk_text_buffer_set_modified() set the modification flag to
-%FALSE. Used for example to enable a "save" function in a text
-editor.
+This function should almost never be called. It clears the @filter
+of any cached iterators that haven't been reffed with
+gtk_tree_model_ref_node(). This might be useful if the child model
+being filtered is static (and doesn't change often) and there has been
+a lot of unreffed access to nodes. As a side effect of this function,
+all unreffed iters will be invalid.
+Since: 2.4
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="filter">
+<parameter_description> A #GtkTreeModelFilter.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the buffer has been modified
-</return>
+<return></return>
</function>
-<function name="gtk_text_buffer_remove_all_tags">
+<function name="gtk_tree_model_filter_convert_child_iter_to_iter">
<description>
-Removes all tags in the range between @start and @end. Be careful
-with this function; it could remove tags added in code unrelated to
-the code you're currently writing. That is, using this function is
-probably a bad idea if you have two or more unrelated code sections
-that add tags.
+Sets @filter_iter to point to the row in @filter that corresponds to the
+row pointed at by @child_iter. If @filter_iter was not set, %FALSE is
+returned.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="filter">
+<parameter_description> A #GtkTreeModelFilter.
</parameter_description>
</parameter>
-<parameter name="start">
-<parameter_description> one bound of range to be untagged
+<parameter name="filter_iter">
+<parameter_description> An uninitialized #GtkTreeIter.
</parameter_description>
</parameter>
-<parameter name="end">
-<parameter_description> other bound of range to be untagged
+<parameter name="child_iter">
+<parameter_description> A valid #GtkTreeIter pointing to a row on the child model.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE, if @filter_iter was set, i.e. if @child_iter is a
+valid iterator pointing to a visible row in child model.
+
+</return>
</function>
-<function name="gtk_toolbar_get_orientation">
+<function name="gtk_tree_model_filter_convert_child_path_to_path">
<description>
-Retrieves the current orientation of the toolbar. See
-gtk_toolbar_set_orientation().
+Converts @child_path to a path relative to @filter. That is, @child_path
+points to a path in the child model. The rerturned path will point to the
+same row in the filtered model. If @child_path isn't a valid path on the
+child model or points to a row which is not visible in @filter, then %NULL
+is returned.
-Deprecated: 2.16: Use gtk_orientable_get_orientation() instead.
+Since: 2.4
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar
+<parameter name="filter">
+<parameter_description> A #GtkTreeModelFilter.
+</parameter_description>
+</parameter>
+<parameter name="child_path">
+<parameter_description> A #GtkTreePath to convert.
</parameter_description>
</parameter>
</parameters>
-<return> the orientation
+<return> A newly allocated #GtkTreePath, or %NULL.
</return>
</function>
-<function name="gtk_entry_get_layout_offsets">
+<function name="gtk_tree_model_filter_convert_iter_to_child_iter">
<description>
-Obtains the position of the #PangoLayout used to render text
-in the entry, in widget coordinates. Useful if you want to line
-up the text in an entry with some other text, e.g. when using the
-entry to implement editable cells in a sheet widget.
-
-Also useful to convert mouse events into coordinates inside the
-#PangoLayout, e.g. to take some action if some part of the entry text
-is clicked.
-
-Note that as the user scrolls around in the entry the offsets will
-change; you'll need to connect to the "notify::scroll-offset"
-signal to track this. Remember when using the #PangoLayout
-functions you need to convert to and from pixels using
-PANGO_PIXELS() or #PANGO_SCALE.
+Sets @child_iter to point to the row pointed to by @filter_iter.
-Keep in mind that the layout text may contain a preedit string, so
-gtk_entry_layout_index_to_text_index() and
-gtk_entry_text_index_to_layout_index() are needed to convert byte
-indices in the layout to byte indices in the entry contents.
+Since: 2.4
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="filter">
+<parameter_description> A #GtkTreeModelFilter.
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> location to store X offset of layout, or %NULL
+<parameter name="child_iter">
+<parameter_description> An uninitialized #GtkTreeIter.
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> location to store Y offset of layout, or %NULL
+<parameter name="filter_iter">
+<parameter_description> A valid #GtkTreeIter pointing to a row on @filter.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_action_set_sensitive">
+<function name="gtk_tree_model_filter_convert_path_to_child_path">
<description>
-Sets the ::sensitive property of the action to @sensitive. Note that
-this doesn't necessarily mean effective sensitivity. See
-gtk_action_is_sensitive()
-for that.
+Converts @filter_path to a path on the child model of @filter. That is,
+ filter_path points to a location in @filter. The returned path will
+point to the same location in the model not being filtered. If @filter_path
+does not point to a location in the child model, %NULL is returned.
-Since: 2.6
+Since: 2.4
</description>
<parameters>
-<parameter name="action">
-<parameter_description> the action object
+<parameter name="filter">
+<parameter_description> A #GtkTreeModelFilter.
</parameter_description>
</parameter>
-<parameter name="sensitive">
-<parameter_description> %TRUE to make the action sensitive
+<parameter name="filter_path">
+<parameter_description> A #GtkTreePath to convert.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A newly allocated #GtkTreePath, or %NULL.
+
+</return>
</function>
-<function name="gtk_text_buffer_register_deserialize_tagset">
+<function name="gtk_tree_model_filter_get_model">
<description>
-This function registers GTK+'s internal rich text serialization
-format with the passed @buffer. See
-gtk_text_buffer_register_serialize_tagset() for details.
+Returns a pointer to the child model of @filter.
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="tagset_name">
-<parameter_description> an optional tagset name, on %NULL
+<parameter name="filter">
+<parameter_description> A #GtkTreeModelFilter.
</parameter_description>
</parameter>
</parameters>
-<return> the #GdkAtom that corresponds to the newly registered
-format's mime-type.
+<return> A pointer to a #GtkTreeModel.
</return>
</function>
-<function name="gtk_color_button_new_with_color">
+<function name="gtk_tree_model_filter_new">
<description>
-Creates a new color button.
+Creates a new #GtkTreeModel, with @child_model as the child_model
+and @root as the virtual root.
Since: 2.4
</description>
<parameters>
-<parameter name="color">
-<parameter_description> A #GdkColor to set the current color with.
+<parameter name="child_model">
+<parameter_description> A #GtkTreeModel.
+</parameter_description>
+</parameter>
+<parameter name="root">
+<parameter_description> A #GtkTreePath or %NULL.
</parameter_description>
</parameter>
</parameters>
-<return> a new color button.
+<return> A new #GtkTreeModel.
</return>
</function>
-<function name="gtk_widget_class_install_style_property_parser">
+<function name="gtk_tree_model_filter_refilter">
<description>
-Installs a style property on a widget class.
+Emits ::row_changed for each row in the child model, which causes
+the filter to re-evaluate whether a row is visible or not.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="klass">
-<parameter_description> a #GtkWidgetClass
-</parameter_description>
-</parameter>
-<parameter name="pspec">
-<parameter_description> the #GParamSpec for the style property
-</parameter_description>
-</parameter>
-<parameter name="parser">
-<parameter_description> the parser for the style property
+<parameter name="filter">
+<parameter_description> A #GtkTreeModelFilter.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_file_chooser_get_use_preview_label">
+<function name="gtk_tree_model_filter_set_modify_func">
<description>
-Gets whether a stock label should be drawn with the name of the previewed
-file. See gtk_file_chooser_set_use_preview_label().
+With the @n_columns and @types parameters, you give an array of column
+types for this model (which will be exposed to the parent model/view).
+The @func, @data and @destroy parameters are for specifying the modify
+function. The modify function will get called for <emphasis>each</emphasis>
+data access, the goal of the modify function is to return the data which
+should be displayed at the location specified using the parameters of the
+modify function.
+Since: 2.4
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="filter">
+<parameter_description> A #GtkTreeModelFilter.
+</parameter_description>
+</parameter>
+<parameter name="n_columns">
+<parameter_description> The number of columns in the filter model.
+</parameter_description>
+</parameter>
+<parameter name="types">
+<parameter_description> The #GType<!-- -->s of the columns.
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> A #GtkTreeModelFilterModifyFunc
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> User data to pass to the modify function, or %NULL.
+</parameter_description>
+</parameter>
+<parameter name="destroy">
+<parameter_description> Destroy notifier of @data, or %NULL.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the file chooser is set to display a label with the
-name of the previewed file, %FALSE otherwise.
-</return>
+<return></return>
</function>
-<function name="gtk_icon_source_get_filename">
+<function name="gtk_tree_model_filter_set_visible_column">
<description>
-Retrieves the source filename, or %NULL if none is set. The
-filename is not a copy, and should not be modified or expected to
-persist beyond the lifetime of the icon source.
+Sets @column of the child_model to be the column where @filter should
+look for visibility information. @columns should be a column of type
+%G_TYPE_BOOLEAN, where %TRUE means that a row is visible, and %FALSE
+if not.
+Since: 2.4
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GtkIconSource
+<parameter name="filter">
+<parameter_description> A #GtkTreeModelFilter.
+</parameter_description>
+</parameter>
+<parameter name="column">
+<parameter_description> A #gint which is the column containing the visible information.
</parameter_description>
</parameter>
</parameters>
-<return> image filename. This string must not be modified
-or freed.
-</return>
+<return></return>
</function>
-<function name="gtk_menu_get_tearoff_state">
+<function name="gtk_tree_model_filter_set_visible_func">
<description>
-Returns whether the menu is torn off. See
-gtk_menu_set_tearoff_state ().
+Sets the visible function used when filtering the @filter to be @func. The
+function should return %TRUE if the given row should be visible and
+%FALSE otherwise.
+If the condition calculated by the function changes over time (e.g. because
+it depends on some global parameters), you must call
+gtk_tree_model_filter_refilter() to keep the visibility information of
+the model uptodate.
-</description>
-<parameters>
-<parameter name="menu">
-<parameter_description> a #GtkMenu
-</parameter_description>
-</parameter>
-</parameters>
-<return> %TRUE if the menu is currently torn off.
-</return>
-</function>
+Note that @func is called whenever a row is inserted, when it may still be
+empty. The visible function should therefore take special care of empty
+rows, like in the example below.
-<function name="gtk_text_iter_backward_find_char">
-<description>
-Same as gtk_text_iter_forward_find_char(), but goes backward from @iter.
+<informalexample><programlisting>
+static gboolean
+visible_func (GtkTreeModel *model,
+GtkTreeIter *iter,
+gpointer data)
+{
+/ * Visible if row is non-empty and first column is "HI" * /
+gchar *str;
+gboolean visible = FALSE;
+gtk_tree_model_get (model, iter, 0, &str, -1);
+if (str && strcmp (str, "HI") == 0)
+visible = TRUE;
+g_free (str);
+
+return visible;
+}
+</programlisting></informalexample>
+
+Since: 2.4
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="filter">
+<parameter_description> A #GtkTreeModelFilter.
</parameter_description>
</parameter>
-<parameter name="pred">
-<parameter_description> function to be called on each character
+<parameter name="func">
+<parameter_description> A #GtkTreeModelFilterVisibleFunc, the visible function.
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> user data for @pred
+<parameter name="data">
+<parameter_description> User data to pass to the visible function, or %NULL.
</parameter_description>
</parameter>
-<parameter name="limit">
-<parameter_description> search limit, or %NULL for none
+<parameter name="destroy">
+<parameter_description> Destroy notifier of @data, or %NULL.
</parameter_description>
</parameter>
</parameters>
-<return> whether a match was found
-</return>
+<return></return>
</function>
-<function name="gtk_widget_get_colormap">
+<function name="gtk_tree_model_foreach">
<description>
-Gets the colormap that will be used to render @widget. No reference will
-be added to the returned colormap; it should not be unreferenced.
-
+Calls func on each node in model in a depth-first fashion.
+If @func returns %TRUE, then the tree ceases to be walked, and
+gtk_tree_model_foreach() returns.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="model">
+<parameter_description> A #GtkTreeModel
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> A function to be called on each row
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> User data to passed to func.
</parameter_description>
</parameter>
</parameters>
-<return> the colormap used by @widget
-</return>
+<return></return>
</function>
<function name="gtk_tree_model_get">
@@ -56081,4879 +56918,4351 @@ passed by value.
<return></return>
</function>
-<function name="gtk_page_setup_get_orientation">
+<function name="gtk_tree_model_get_column_type">
<description>
-Gets the page orientation of the #GtkPageSetup.
+Returns the type of the column.
-Since: 2.10
</description>
<parameters>
-<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter name="tree_model">
+<parameter_description> A #GtkTreeModel.
+</parameter_description>
+</parameter>
+<parameter name="index_">
+<parameter_description> The column index.
</parameter_description>
</parameter>
</parameters>
-<return> the page orientation
-
+<return> The type of the column.
</return>
</function>
-<function name="gtk_viewport_set_vadjustment">
+<function name="gtk_tree_model_get_flags">
<description>
-Sets the vertical adjustment of the viewport.
+Returns a set of flags supported by this interface. The flags are a bitwise
+combination of #GtkTreeModelFlags. The flags supported should not change
+during the lifecycle of the @tree_model.
+
</description>
<parameters>
-<parameter name="viewport">
-<parameter_description> a #GtkViewport.
-</parameter_description>
-</parameter>
-<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment.
+<parameter name="tree_model">
+<parameter_description> A #GtkTreeModel.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The flags supported by this interface.
+</return>
</function>
-<function name="gtk_action_connect_proxy">
+<function name="gtk_tree_model_get_iter">
<description>
-Connects a widget to an action object as a proxy. Synchronises
-various properties of the action with the widget (such as label
-text, icon, tooltip, etc), and attaches a callback so that the
-action gets activated when the proxy widget does.
-
-If the widget is already connected to an action, it is disconnected
-first.
+Sets @iter to a valid iterator pointing to @path.
-Since: 2.4
-
-Deprecated: 2.16: Use gtk_activatable_set_related_action() instead.
</description>
<parameters>
-<parameter name="action">
-<parameter_description> the action object
+<parameter name="tree_model">
+<parameter_description> A #GtkTreeModel.
</parameter_description>
</parameter>
-<parameter name="proxy">
-<parameter_description> the proxy widget
+<parameter name="iter">
+<parameter_description> The uninitialized #GtkTreeIter.
+</parameter_description>
+</parameter>
+<parameter name="path">
+<parameter_description> The #GtkTreePath.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE, if @iter was set.
+</return>
</function>
-<function name="gtk_ctree_move">
+<function name="gtk_tree_model_get_iter_first">
<description>
+Initializes @iter with the first iterator in the tree (the one at the path
+"0") and returns %TRUE. Returns %FALSE if the tree is empty.
+
</description>
<parameters>
-<parameter name="new_parent">
-<parameter_description>
+<parameter name="tree_model">
+<parameter_description> A #GtkTreeModel.
</parameter_description>
</parameter>
-<parameter name="new_sibling">
-<parameter_description>
+<parameter name="iter">
+<parameter_description> The uninitialized #GtkTreeIter.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE, if @iter was set.
+</return>
</function>
-<function name="gtk_info_bar_set_default_response">
+<function name="gtk_tree_model_get_iter_from_string">
<description>
-Sets the last widget in the info bar's action area with
-the given response_id as the default widget for the dialog.
-Pressing "Enter" normally activates the default widget.
-
-Note that this function currently requires @info_bar to
-be added to a widget hierarchy.
+Sets @iter to a valid iterator pointing to @path_string, if it
+exists. Otherwise, @iter is left invalid and %FALSE is returned.
-Since: 2.18
</description>
<parameters>
-<parameter name="info_bar">
-<parameter_description> a #GtkInfoBar
+<parameter name="tree_model">
+<parameter_description> A #GtkTreeModel.
</parameter_description>
</parameter>
-<parameter name="response_id">
-<parameter_description> a response ID
+<parameter name="iter">
+<parameter_description> An uninitialized #GtkTreeIter.
+</parameter_description>
+</parameter>
+<parameter name="path_string">
+<parameter_description> A string representation of a #GtkTreePath.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE, if @iter was set.
+</return>
</function>
-<function name="gtk_file_filter_add_pattern">
+<function name="gtk_tree_model_get_n_columns">
<description>
-Adds a rule allowing a shell style glob to a filter.
+Returns the number of columns supported by @tree_model.
-Since: 2.4
</description>
<parameters>
-<parameter name="filter">
-<parameter_description> a #GtkFileFilter
-</parameter_description>
-</parameter>
-<parameter name="pattern">
-<parameter_description> a shell style glob
+<parameter name="tree_model">
+<parameter_description> A #GtkTreeModel.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The number of columns.
+</return>
</function>
-<function name="gtk_text_view_set_border_window_size">
+<function name="gtk_tree_model_get_path">
<description>
-Sets the width of %GTK_TEXT_WINDOW_LEFT or %GTK_TEXT_WINDOW_RIGHT,
-or the height of %GTK_TEXT_WINDOW_TOP or %GTK_TEXT_WINDOW_BOTTOM.
-Automatically destroys the corresponding window if the size is set
-to 0, and creates the window if the size is set to non-zero. This
-function can only be used for the "border windows," it doesn't work
-with #GTK_TEXT_WINDOW_WIDGET, #GTK_TEXT_WINDOW_TEXT, or
-#GTK_TEXT_WINDOW_PRIVATE.
+Returns a newly-created #GtkTreePath referenced by @iter. This path should
+be freed with gtk_tree_path_free().
+
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
-</parameter_description>
-</parameter>
-<parameter name="type">
-<parameter_description> window to affect
+<parameter name="tree_model">
+<parameter_description> A #GtkTreeModel.
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> width or height of the window
+<parameter name="iter">
+<parameter_description> The #GtkTreeIter.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a newly-created #GtkTreePath.
+</return>
</function>
-<function name="gtk_print_settings_new_from_file">
+<function name="gtk_tree_model_get_string_from_iter">
<description>
-Reads the print settings from @file_name. Returns a new #GtkPrintSettings
-object with the restored settings, or %NULL if an error occurred. If the
-file could not be loaded then error is set to either a #GFileError or
-#GKeyFileError. See gtk_print_settings_to_file().
+Generates a string representation of the iter. This string is a ':'
+separated list of numbers. For example, "4:10:0:3" would be an
+acceptable return value for this string.
-Since: 2.12
+Since: 2.2
</description>
<parameters>
-<parameter name="file_name">
-<parameter_description> the filename to read the settings from
+<parameter name="tree_model">
+<parameter_description> A #GtkTreeModel.
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for errors, or %NULL
+<parameter name="iter">
+<parameter_description> An #GtkTreeIter.
</parameter_description>
</parameter>
</parameters>
-<return> the restored #GtkPrintSettings
+<return> A newly-allocated string. Must be freed with g_free().
</return>
</function>
-<function name="gtk_text_layout_move_iter_to_x">
+<function name="gtk_tree_model_get_valist">
<description>
-Keeping the iterator on the same line of the layout, move it to the
-specified X coordinate. The lines of a wrapped paragraph are
-treated as distinct for this operation.
+See gtk_tree_model_get(), this version takes a <type>va_list</type>
+for language bindings to use.
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #GtkTextLayout
+<parameter name="tree_model">
+<parameter_description> a #GtkTreeModel
</parameter_description>
</parameter>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> a row in @tree_model
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> X coordinate
+<parameter name="var_args">
+<parameter_description> <type>va_list</type> of column/return location pairs
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_column_queue_resize">
+<function name="gtk_tree_model_get_value">
<description>
-Flags the column, and the cell renderers added to this column, to have
-their sizes renegotiated.
-
-Since: 2.8
+Initializes and sets @value to that at @column.
+When done with @value, g_value_unset() needs to be called
+to free any allocated memory.
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn
+<parameter name="tree_model">
+<parameter_description> A #GtkTreeModel.
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> The #GtkTreeIter.
+</parameter_description>
+</parameter>
+<parameter name="column">
+<parameter_description> The column to lookup the value at.
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> An empty #GValue to set.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_draw_layout">
+<function name="gtk_tree_model_iter_children">
<description>
-Draws a layout on @window using the given parameters.
+Sets @iter to point to the first child of @parent. If @parent has no
+children, %FALSE is returned and @iter is set to be invalid. @parent
+will remain a valid node after this function has been called.
+
+If @parent is %NULL returns the first node, equivalent to
+<literal>gtk_tree_model_get_iter_first (tree_model, iter);</literal>
+
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
-</parameter_description>
-</parameter>
-<parameter name="use_text">
-<parameter_description> whether to use the text or foreground
-graphics context of @style
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> x origin
+<parameter name="tree_model">
+<parameter_description> A #GtkTreeModel.
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> y origin
+<parameter name="iter">
+<parameter_description> The new #GtkTreeIter to be set to the child.
</parameter_description>
</parameter>
-<parameter name="layout">
-<parameter_description> the layout to draw
+<parameter name="parent">
+<parameter_description> The #GtkTreeIter, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE, if @child has been set to the first child.
+</return>
</function>
-<function name="gtk_scrolled_window_new">
+<function name="gtk_tree_model_iter_has_child">
<description>
-Creates a new scrolled window.
-
-The two arguments are the scrolled window's adjustments; these will be
-shared with the scrollbars and the child widget to keep the bars in sync
-with the child. Usually you want to pass %NULL for the adjustments, which
-will cause the scrolled window to create them for you.
+Returns %TRUE if @iter has children, %FALSE otherwise.
</description>
<parameters>
-<parameter name="hadjustment">
-<parameter_description> horizontal adjustment
+<parameter name="tree_model">
+<parameter_description> A #GtkTreeModel.
</parameter_description>
</parameter>
-<parameter name="vadjustment">
-<parameter_description> vertical adjustment
+<parameter name="iter">
+<parameter_description> The #GtkTreeIter to test for children.
</parameter_description>
</parameter>
</parameters>
-<return> a new scrolled window
+<return> %TRUE if @iter has children.
</return>
</function>
-<function name="gtk_arrow_new">
+<function name="gtk_tree_model_iter_n_children">
<description>
-Creates a new #GtkArrow widget.
+Returns the number of children that @iter has. As a special case, if @iter
+is %NULL, then the number of toplevel nodes is returned.
</description>
<parameters>
-<parameter name="arrow_type">
-<parameter_description> a valid #GtkArrowType.
+<parameter name="tree_model">
+<parameter_description> A #GtkTreeModel.
</parameter_description>
</parameter>
-<parameter name="shadow_type">
-<parameter_description> a valid #GtkShadowType.
+<parameter name="iter">
+<parameter_description> The #GtkTreeIter, or %NULL.
</parameter_description>
</parameter>
</parameters>
-<return> the new #GtkArrow widget.
+<return> The number of children of @iter.
</return>
</function>
-<function name="gtk_widget_add_accelerator">
+<function name="gtk_tree_model_iter_next">
<description>
-Installs an accelerator for this @widget in @accel_group that causes
- accel_signal to be emitted if the accelerator is activated.
-The @accel_group needs to be added to the widget's toplevel via
-gtk_window_add_accel_group(), and the signal must be of type %G_RUN_ACTION.
-Accelerators added through this function are not user changeable during
-runtime. If you want to support accelerators that can be changed by the
-user, use gtk_accel_map_add_entry() and gtk_widget_set_accel_path() or
-gtk_menu_item_set_accel_path() instead.
+Sets @iter to point to the node following it at the current level. If there
+is no next @iter, %FALSE is returned and @iter is set to be invalid.
+
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> widget to install an accelerator on
+<parameter name="tree_model">
+<parameter_description> A #GtkTreeModel.
</parameter_description>
</parameter>
-<parameter name="accel_signal">
-<parameter_description> widget signal to emit on accelerator activation
+<parameter name="iter">
+<parameter_description> The #GtkTreeIter.
</parameter_description>
</parameter>
-<parameter name="accel_group">
-<parameter_description> accel group for this widget, added to its toplevel
+</parameters>
+<return> %TRUE if @iter has been changed to the next node.
+</return>
+</function>
+
+<function name="gtk_tree_model_iter_nth_child">
+<description>
+Sets @iter to be the child of @parent, using the given index. The first
+index is 0. If @n is too big, or @parent has no children, @iter is set
+to an invalid iterator and %FALSE is returned. @parent will remain a valid
+node after this function has been called. As a special case, if @parent is
+%NULL, then the @n<!-- -->th root node is set.
+
+
+</description>
+<parameters>
+<parameter name="tree_model">
+<parameter_description> A #GtkTreeModel.
</parameter_description>
</parameter>
-<parameter name="accel_key">
-<parameter_description> GDK keyval of the accelerator
+<parameter name="iter">
+<parameter_description> The #GtkTreeIter to set to the nth child.
</parameter_description>
</parameter>
-<parameter name="accel_mods">
-<parameter_description> modifier key combination of the accelerator
+<parameter name="parent">
+<parameter_description> The #GtkTreeIter to get the child from, or %NULL.
</parameter_description>
</parameter>
-<parameter name="accel_flags">
-<parameter_description> flag accelerators, e.g. %GTK_ACCEL_VISIBLE
+<parameter name="n">
+<parameter_description> Then index of the desired child.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE, if @parent has an @n<!-- -->th child.
+</return>
</function>
-<function name="gtk_text_layout_clamp_iter_to_vrange">
+<function name="gtk_tree_model_iter_parent">
<description>
-If the iterator is not fully in the range @top <= y < @bottom,
-then, if possible, move it the minimum distance so that the
-iterator in this range.
+Sets @iter to be the parent of @child. If @child is at the toplevel, and
+doesn't have a parent, then @iter is set to an invalid iterator and %FALSE
+is returned. @child will remain a valid node after this function has been
+called.
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #GtkTextLayout
+<parameter name="tree_model">
+<parameter_description> A #GtkTreeModel
</parameter_description>
</parameter>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
-</parameter_description>
-</parameter>
-<parameter name="top">
-<parameter_description> the top of the range
+<parameter_description> The new #GtkTreeIter to set to the parent.
</parameter_description>
</parameter>
-<parameter name="bottom">
-<parameter_description> the bottom the range
+<parameter name="child">
+<parameter_description> The #GtkTreeIter.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the iterator was moved, otherwise %FALSE.
+<return> %TRUE, if @iter is set to the parent of @child.
</return>
</function>
-<function name="gtk_builder_value_from_string_type">
+<function name="gtk_tree_model_ref_node">
<description>
-Like gtk_builder_value_from_string(), this function demarshals
-a value from a string, but takes a #GType instead of #GParamSpec.
-This function calls g_value_init() on the @value argument, so it
-need not be initialised beforehand.
+Lets the tree ref the node. This is an optional method for models to
+implement. To be more specific, models may ignore this call as it exists
+primarily for performance reasons.
-Upon errors %FALSE will be returned and @error will be assigned a
-#GError from the #GTK_BUILDER_ERROR domain.
+This function is primarily meant as a way for views to let caching model
+know when nodes are being displayed (and hence, whether or not to cache that
+node.) For example, a file-system based model would not want to keep the
+entire file-hierarchy in memory, just the sections that are currently being
+displayed by every current view.
-Since: 2.12
+A model should be expected to be able to get an iter independent of its
+reffed state.
</description>
<parameters>
-<parameter name="builder">
-<parameter_description> a #GtkBuilder
-</parameter_description>
-</parameter>
-<parameter name="type">
-<parameter_description> the #GType of the value
-</parameter_description>
-</parameter>
-<parameter name="string">
-<parameter_description> the string representation of the value
-</parameter_description>
-</parameter>
-<parameter name="value">
-<parameter_description> the #GValue to store the result in
+<parameter name="tree_model">
+<parameter_description> A #GtkTreeModel.
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> return location for an error, or %NULL
+<parameter name="iter">
+<parameter_description> The #GtkTreeIter.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success
-
-</return>
+<return></return>
</function>
-<function name="gtk_widget_get_allocation">
+<function name="gtk_tree_model_row_changed">
<description>
-Retrieves the widget's allocation.
-
-Since: 2.18
+Emits the "row-changed" signal on @tree_model.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="tree_model">
+<parameter_description> A #GtkTreeModel
</parameter_description>
</parameter>
-<parameter name="allocation">
-<parameter_description> a pointer to a #GtkAllocation to copy to
+<parameter name="path">
+<parameter_description> A #GtkTreePath pointing to the changed row
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> A valid #GtkTreeIter pointing to the changed row
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_image_get_pixbuf">
+<function name="gtk_tree_model_row_deleted">
<description>
-Gets the #GdkPixbuf being displayed by the #GtkImage.
-The storage type of the image must be %GTK_IMAGE_EMPTY or
-%GTK_IMAGE_PIXBUF (see gtk_image_get_storage_type()).
-The caller of this function does not own a reference to the
-returned pixbuf.
-
+Emits the "row-deleted" signal on @tree_model. This should be called by
+models after a row has been removed. The location pointed to by @path
+should be the location that the row previously was at. It may not be a
+valid location anymore.
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GtkImage
+<parameter name="tree_model">
+<parameter_description> A #GtkTreeModel
+</parameter_description>
+</parameter>
+<parameter name="path">
+<parameter_description> A #GtkTreePath pointing to the previous location of the deleted row.
</parameter_description>
</parameter>
</parameters>
-<return> the displayed pixbuf, or %NULL if
-the image is empty
-</return>
+<return></return>
</function>
-<function name="gtk_icon_view_set_spacing">
+<function name="gtk_tree_model_row_has_child_toggled">
<description>
-Sets the ::spacing property which specifies the space
-which is inserted between the cells (i.e. the icon and
-the text) of an item.
-
-Since: 2.6
+Emits the "row-has-child-toggled" signal on @tree_model. This should be
+called by models after the child state of a node changes.
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
+<parameter name="tree_model">
+<parameter_description> A #GtkTreeModel
</parameter_description>
</parameter>
-<parameter name="spacing">
-<parameter_description> the spacing
+<parameter name="path">
+<parameter_description> A #GtkTreePath pointing to the changed row
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> A valid #GtkTreeIter pointing to the changed row
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_binding_entry_clear">
+<function name="gtk_tree_model_row_inserted">
<description>
-Clears a binding entry.
-
-Deprecated: 2.12: Use gtk_binding_entry_remove() instead.
+Emits the "row-inserted" signal on @tree_model
</description>
<parameters>
-<parameter name="binding_set">
-<parameter_description> binding set to clear an entry of
+<parameter name="tree_model">
+<parameter_description> A #GtkTreeModel
</parameter_description>
</parameter>
-<parameter name="keyval">
-<parameter_description> key value of binding to clear
+<parameter name="path">
+<parameter_description> A #GtkTreePath pointing to the inserted row
</parameter_description>
</parameter>
-<parameter name="modifiers">
-<parameter_description> key modifier of binding to clear
+<parameter name="iter">
+<parameter_description> A valid #GtkTreeIter pointing to the inserted row
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_about_dialog_set_translator_credits">
+<function name="gtk_tree_model_rows_reordered">
<description>
-Sets the translator credits string which is displayed in
-the translators tab of the secondary credits dialog.
-
-The intended use for this string is to display the translator
-of the language which is currently used in the user interface.
-Using gettext(), a simple way to achieve that is to mark the
-string for translation:
-|[
-gtk_about_dialog_set_translator_credits (about, _("translator-credits"));
-]|
-It is a good idea to use the customary msgid "translator-credits" for this
-purpose, since translators will already know the purpose of that msgid, and
-since #GtkAboutDialog will detect if "translator-credits" is untranslated
-and hide the tab.
-
-Since: 2.6
+Emits the "rows-reordered" signal on @tree_model. This should be called by
+models when their rows have been reordered.
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter name="tree_model">
+<parameter_description> A #GtkTreeModel
</parameter_description>
</parameter>
-<parameter name="translator_credits">
-<parameter_description> the translator credits
+<parameter name="path">
+<parameter_description> A #GtkTreePath pointing to the tree node whose children have been
+reordered
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> A valid #GtkTreeIter pointing to the node whose children have been
+reordered, or %NULL if the depth of @path is 0.
+</parameter_description>
+</parameter>
+<parameter name="new_order">
+<parameter_description> an array of integers mapping the current position of each child
+to its old position before the re-ordering,
+i.e. @new_order<literal>[newpos] = oldpos</literal>.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_column_get_fixed_width">
+<function name="gtk_tree_model_sort_clear_cache">
<description>
-Gets the fixed width of the column. This value is only meaning may not be
-the actual width of the column on the screen, just what is requested.
-
+This function should almost never be called. It clears the @tree_model_sort
+of any cached iterators that haven't been reffed with
+gtk_tree_model_ref_node(). This might be useful if the child model being
+sorted is static (and doesn't change often) and there has been a lot of
+unreffed access to nodes. As a side effect of this function, all unreffed
+iters will be invalid.
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> a #GtkTreeViewColumn
+<parameter name="tree_model_sort">
+<parameter_description> A #GtkTreeModelSort
</parameter_description>
</parameter>
</parameters>
-<return> the fixed width of the column
-</return>
+<return></return>
</function>
-<function name="gtk_recent_manager_purge_items">
+<function name="gtk_tree_model_sort_convert_child_iter_to_iter">
<description>
-Purges every item from the recently used resources list.
+Sets @sort_iter to point to the row in @tree_model_sort that corresponds to
+the row pointed at by @child_iter. If @sort_iter was not set, %FALSE
+is returned. Note: a boolean is only returned since 2.14.
-Since: 2.10
</description>
<parameters>
-<parameter name="manager">
-<parameter_description> a #GtkRecentManager
+<parameter name="tree_model_sort">
+<parameter_description> A #GtkTreeModelSort
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> a return location for a #GError, or %NULL
+<parameter name="sort_iter">
+<parameter_description> An uninitialized #GtkTreeIter.
+</parameter_description>
+</parameter>
+<parameter name="child_iter">
+<parameter_description> A valid #GtkTreeIter pointing to a row on the child model
</parameter_description>
</parameter>
</parameters>
-<return> the number of items that have been removed from the
-recently used resources list.
-
+<return> %TRUE, if @sort_iter was set, i.e. if @sort_iter is a
+valid iterator pointer to a visible row in the child model.
</return>
</function>
-<function name="gtk_text_iter_forward_word_ends">
+<function name="gtk_tree_model_sort_convert_child_path_to_path">
<description>
-Calls gtk_text_iter_forward_word_end() up to @count times.
+Converts @child_path to a path relative to @tree_model_sort. That is,
+ child_path points to a path in the child model. The returned path will
+point to the same row in the sorted model. If @child_path isn't a valid
+path on the child model, then %NULL is returned.
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="tree_model_sort">
+<parameter_description> A #GtkTreeModelSort
</parameter_description>
</parameter>
-<parameter name="count">
-<parameter_description> number of times to move
+<parameter name="child_path">
+<parameter_description> A #GtkTreePath to convert
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter moved and is not the end iterator
+<return> A newly allocated #GtkTreePath, or %NULL
</return>
</function>
-<function name="gtk_printer_has_details">
+<function name="gtk_tree_model_sort_convert_iter_to_child_iter">
<description>
-Returns whether the printer details are available.
-
-Since: 2.12
+Sets @child_iter to point to the row pointed to by @sorted_iter.
</description>
<parameters>
-<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter name="tree_model_sort">
+<parameter_description> A #GtkTreeModelSort
+</parameter_description>
+</parameter>
+<parameter name="child_iter">
+<parameter_description> An uninitialized #GtkTreeIter
+</parameter_description>
+</parameter>
+<parameter name="sorted_iter">
+<parameter_description> A valid #GtkTreeIter pointing to a row on @tree_model_sort.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @printer details are available
-
-</return>
+<return></return>
</function>
-<function name="gtk_color_selection_is_adjusting">
+<function name="gtk_tree_model_sort_convert_path_to_child_path">
<description>
-Gets the current state of the @colorsel.
+Converts @sorted_path to a path on the child model of @tree_model_sort.
+That is, @sorted_path points to a location in @tree_model_sort. The
+returned path will point to the same location in the model not being
+sorted. If @sorted_path does not point to a location in the child model,
+%NULL is returned.
</description>
<parameters>
-<parameter name="colorsel">
-<parameter_description> a #GtkColorSelection.
+<parameter name="tree_model_sort">
+<parameter_description> A #GtkTreeModelSort
+</parameter_description>
+</parameter>
+<parameter name="sorted_path">
+<parameter_description> A #GtkTreePath to convert
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the user is currently dragging a color around, and %FALSE
-if the selection has stopped.
+<return> A newly allocated #GtkTreePath, or %NULL
</return>
</function>
-<function name="gtk_scale_get_digits">
+<function name="gtk_tree_model_sort_get_model">
<description>
-Gets the number of decimal places that are displayed in the value.
+Returns the model the #GtkTreeModelSort is sorting.
</description>
<parameters>
-<parameter name="scale">
-<parameter_description> a #GtkScale
+<parameter name="tree_model">
+<parameter_description> a #GtkTreeModelSort
</parameter_description>
</parameter>
</parameters>
-<return> the number of decimal places that are displayed
+<return> the "child model" being sorted
</return>
</function>
-<function name="gtk_entry_reset_im_context">
+<function name="gtk_tree_model_sort_iter_is_valid">
<description>
-Reset the input method context of the entry if needed.
+<warning><para>
+This function is slow. Only use it for debugging and/or testing purposes.
+</para></warning>
-This can be necessary in the case where modifying the buffer
-would confuse on-going input method behavior.
+Checks if the given iter is a valid iter for this #GtkTreeModelSort.
-Since: 2.22
+Since: 2.2
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="tree_model_sort">
+<parameter_description> A #GtkTreeModelSort.
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> A #GtkTreeIter.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the iter is valid, %FALSE if the iter is invalid.
+
+</return>
</function>
-<function name="gtk_about_dialog_get_wrap_license">
+<function name="gtk_tree_model_sort_new_with_model">
<description>
-Returns whether the license text in @about is
-automatically wrapped.
+Creates a new #GtkTreeModel, with @child_model as the child model.
-Since: 2.8
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter name="child_model">
+<parameter_description> A #GtkTreeModel
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the license text is wrapped
-
+<return> A new #GtkTreeModel.
</return>
</function>
-<function name="gtk_builder_get_type_from_name">
+<function name="gtk_tree_model_sort_reset_default_sort_func">
<description>
-Looks up a type by name, using the virtual function that
-#GtkBuilder has for that purpose. This is mainly used when
-implementing the #GtkBuildable interface on a type.
-
-Since: 2.12
+This resets the default sort function to be in the 'unsorted' state. That
+is, it is in the same order as the child model. It will re-sort the model
+to be in the same order as the child model only if the #GtkTreeModelSort
+is in 'unsorted' state.
</description>
<parameters>
-<parameter name="builder">
-<parameter_description> a #GtkBuilder
-</parameter_description>
-</parameter>
-<parameter name="type_name">
-<parameter_description> type name to lookup
+<parameter name="tree_model_sort">
+<parameter_description> A #GtkTreeModelSort
</parameter_description>
</parameter>
</parameters>
-<return> the #GType found for @type_name or #G_TYPE_INVALID
-if no type was found
-
-</return>
+<return></return>
</function>
-<function name="gtk_text_view_scroll_to_mark">
+<function name="gtk_tree_model_sort_set_model">
<description>
-Scrolls @text_view so that @mark is on the screen in the position
-indicated by @xalign and @yalign. An alignment of 0.0 indicates
-left or top, 1.0 indicates right or bottom, 0.5 means center.
-If @use_align is %FALSE, the text scrolls the minimal distance to
-get the mark onscreen, possibly not scrolling at all. The effective
-screen for purposes of this function is reduced by a margin of size
- within_margin
+Sets the model of @tree_model_sort to be @model. If @model is %NULL,
+then the old model is unset. The sort function is unset as a result
+of this call. The model will be in an unsorted state until a sort
+function is set.
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
-</parameter_description>
-</parameter>
-<parameter name="mark">
-<parameter_description> a #GtkTextMark
-</parameter_description>
-</parameter>
-<parameter name="within_margin">
-<parameter_description> margin as a [0.0,0.5) fraction of screen size
-</parameter_description>
-</parameter>
-<parameter name="use_align">
-<parameter_description> whether to use alignment arguments (if %FALSE, just
-get the mark onscreen)
-</parameter_description>
-</parameter>
-<parameter name="xalign">
-<parameter_description> horizontal alignment of mark within visible area
+<parameter name="tree_model_sort">
+<parameter_description> The #GtkTreeModelSort.
</parameter_description>
</parameter>
-<parameter name="yalign">
-<parameter_description> vertical alignment of mark within visible area
+<parameter name="child_model">
+<parameter_description> A #GtkTreeModel, or %NULL.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_settings_set_paper_width">
+<function name="gtk_tree_model_unref_node">
<description>
-Sets the value of %GTK_PRINT_SETTINGS_PAPER_WIDTH.
+Lets the tree unref the node. This is an optional method for models to
+implement. To be more specific, models may ignore this call as it exists
+primarily for performance reasons.
-Since: 2.10
+For more information on what this means, see gtk_tree_model_ref_node().
+Please note that nodes that are deleted are not unreffed.
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> the paper width
+<parameter name="tree_model">
+<parameter_description> A #GtkTreeModel.
</parameter_description>
</parameter>
-<parameter name="unit">
-<parameter_description> the units of @width
+<parameter name="iter">
+<parameter_description> The #GtkTreeIter.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_move_column_after">
+<function name="gtk_tree_path_append_index">
<description>
-Moves @column to be after to @base_column. If @base_column is %NULL, then
- column is placed in the first position.
+Appends a new index to a path. As a result, the depth of the path is
+increased.
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView
-</parameter_description>
-</parameter>
-<parameter name="column">
-<parameter_description> The #GtkTreeViewColumn to be moved.
+<parameter name="path">
+<parameter_description> A #GtkTreePath.
</parameter_description>
</parameter>
-<parameter name="base_column">
-<parameter_description> The #GtkTreeViewColumn to be moved relative to, or %NULL.
+<parameter name="index_">
+<parameter_description> The index.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_range_get_value">
+<function name="gtk_tree_path_compare">
<description>
-Gets the current value of the range.
+Compares two paths. If @a appears before @b in a tree, then -1 is returned.
+If @b appears before @a, then 1 is returned. If the two nodes are equal,
+then 0 is returned.
</description>
<parameters>
-<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter name="a">
+<parameter_description> A #GtkTreePath.
+</parameter_description>
+</parameter>
+<parameter name="b">
+<parameter_description> A #GtkTreePath to compare with.
</parameter_description>
</parameter>
</parameters>
-<return> current value of the range.
+<return> The relative positions of @a and @b
</return>
</function>
-<function name="gtk_image_set_from_icon_name">
+<function name="gtk_tree_path_copy">
<description>
-See gtk_image_new_from_icon_name() for details.
+Creates a new #GtkTreePath as a copy of @path.
-Since: 2.6
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GtkImage
-</parameter_description>
-</parameter>
-<parameter name="icon_name">
-<parameter_description> an icon name
-</parameter_description>
-</parameter>
-<parameter name="size">
-<parameter_description> an icon size
+<parameter name="path">
+<parameter_description> A #GtkTreePath.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A new #GtkTreePath.
+</return>
</function>
-<function name="gtk_paper_size_get_ppd_name">
+<function name="gtk_tree_path_down">
<description>
-Gets the PPD name of the #GtkPaperSize, which
-may be %NULL.
-
-Since: 2.10
+Moves @path to point to the first child of the current path.
</description>
<parameters>
-<parameter name="size">
-<parameter_description> a #GtkPaperSize object
+<parameter name="path">
+<parameter_description> A #GtkTreePath.
</parameter_description>
</parameter>
</parameters>
-<return> the PPD name of @size
-
-</return>
+<return></return>
</function>
-<function name="gtk_widget_trigger_tooltip_query">
+<function name="gtk_tree_path_free">
<description>
-Triggers a tooltip query on the display where the toplevel of @widget
-is located. See gtk_tooltip_trigger_tooltip_query() for more
-information.
-
-Since: 2.12
+Frees @path.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="path">
+<parameter_description> A #GtkTreePath.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_drag_set_icon_name">
+<function name="gtk_tree_path_get_depth">
<description>
-Sets the icon for a given drag from a named themed icon. See
-the docs for #GtkIconTheme for more details. Note that the
-size of the icon depends on the icon theme (the icon is
-loaded at the symbolic size #GTK_ICON_SIZE_DND), thus
- hot_x and @hot_y have to be used with care.
+Returns the current depth of @path.
-Since: 2.8
</description>
<parameters>
-<parameter name="context">
-<parameter_description> the context for a drag. (This must be called
-with a context for the source side of a drag)
-</parameter_description>
-</parameter>
-<parameter name="icon_name">
-<parameter_description> name of icon to use
-</parameter_description>
-</parameter>
-<parameter name="hot_x">
-<parameter_description> the X offset of the hotspot within the icon
-</parameter_description>
-</parameter>
-<parameter name="hot_y">
-<parameter_description> the Y offset of the hotspot within the icon
+<parameter name="path">
+<parameter_description> A #GtkTreePath.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The depth of @path
+</return>
</function>
-<function name="gtk_tool_item_group_new">
+<function name="gtk_tree_path_get_indices">
<description>
-Creates a new tool item group with label @label.
+Returns the current indices of @path. This is an array of integers, each
+representing a node in a tree. This value should not be freed.
-Since: 2.20
</description>
<parameters>
-<parameter name="label">
-<parameter_description> the label of the new group
+<parameter name="path">
+<parameter_description> A #GtkTreePath.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkToolItemGroup.
-
+<return> The current indices, or %NULL.
</return>
</function>
-<function name="gtk_widget_keynav_failed">
+<function name="gtk_tree_path_get_indices_with_depth">
<description>
-This function should be called whenever keyboard navigation within
-a single widget hits a boundary. The function emits the
-#GtkWidget::keynav-failed signal on the widget and its return
-value should be interpreted in a way similar to the return value of
-gtk_widget_child_focus():
-
-When %TRUE is returned, stay in the widget, the failed keyboard
-navigation is Ok and/or there is nowhere we can/should move the
-focus to.
-
-When %FALSE is returned, the caller should continue with keyboard
-navigation outside the widget, e.g. by calling
-gtk_widget_child_focus() on the widget's toplevel.
-
-The default ::keynav-failed handler returns %TRUE for
-%GTK_DIR_TAB_FORWARD and %GTK_DIR_TAB_BACKWARD. For the other
-values of #GtkDirectionType, it looks at the
-#GtkSettings:gtk-keynav-cursor-only setting and returns %FALSE
-if the setting is %TRUE. This way the entire user interface
-becomes cursor-navigatable on input devices such as mobile phones
-which only have cursor keys but no tab key.
-
-Whenever the default handler returns %TRUE, it also calls
-gtk_widget_error_bell() to notify the user of the failed keyboard
-navigation.
-
-A use case for providing an own implementation of ::keynav-failed
-(either by connecting to it or by overriding it) would be a row of
-#GtkEntry widgets where the user should be able to navigate the
-entire row with the cursor keys, as e.g. known from user interfaces
-that require entering license keys.
+Returns the current indices of @path.
+This is an array of integers, each representing a node in a tree.
+It also returns the number of elements in the array.
+The array should not be freed.
-Since: 2.12
+Since: 2.22
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="path">
+<parameter_description> A #GtkTreePath.
</parameter_description>
</parameter>
-<parameter name="direction">
-<parameter_description> direction of focus movement
+<parameter name="depth">
+<parameter_description> Number of elements returned in the integer array
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if stopping keyboard navigation is fine, %FALSE
-if the emitting widget should try to handle the keyboard
-navigation attempt in its parent container(s).
+<return> The current indices, or %NULL.
</return>
</function>
-<function name="gtk_window_set_deletable">
+<function name="gtk_tree_path_is_ancestor">
<description>
-By default, windows have a close button in the window frame. Some
-<link linkend="gtk-X11-arch">window managers</link> allow GTK+ to
-disable this button. If you set the deletable property to %FALSE
-using this function, GTK+ will do its best to convince the window
-manager not to show a close button. Depending on the system, this
-function may not have any effect when called on a window that is
-already visible, so you should call it before calling gtk_window_show().
-
-On Windows, this function always works, since there's no window manager
-policy involved.
+Returns %TRUE if @descendant is a descendant of @path.
-Since: 2.10
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="path">
+<parameter_description> a #GtkTreePath
</parameter_description>
</parameter>
-<parameter name="setting">
-<parameter_description> %TRUE to decorate the window as deletable
+<parameter name="descendant">
+<parameter_description> another #GtkTreePath
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @descendant is contained inside @path
+</return>
</function>
-<function name="gtk_assistant_set_forward_page_func">
+<function name="gtk_tree_path_is_descendant">
<description>
-Sets the page forwarding function to be @page_func, this function will
-be used to determine what will be the next page when the user presses
-the forward button. Setting @page_func to %NULL will make the assistant
-to use the default forward function, which just goes to the next visible
-page.
+Returns %TRUE if @path is a descendant of @ancestor.
-Since: 2.10
</description>
<parameters>
-<parameter name="assistant">
-<parameter_description> a #GtkAssistant
-</parameter_description>
-</parameter>
-<parameter name="page_func">
-<parameter_description> the #GtkAssistantPageFunc, or %NULL to use the default one
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> user data for @page_func
+<parameter name="path">
+<parameter_description> a #GtkTreePath
</parameter_description>
</parameter>
-<parameter name="destroy">
-<parameter_description> destroy notifier for @data
+<parameter name="ancestor">
+<parameter_description> another #GtkTreePath
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @ancestor contains @path somewhere below it
+</return>
</function>
-<function name="gtk_file_chooser_set_uri">
+<function name="gtk_tree_path_new">
<description>
-Sets the file referred to by @uri as the current file for the file chooser,
-by changing to the URI's parent folder and actually selecting the URI in the
-list. If the @chooser is %GTK_FILE_CHOOSER_ACTION_SAVE mode, the URI's base
-name will also appear in the dialog's file name entry.
-
-If the URI isn't in the current folder of @chooser, then the current folder
-of @chooser will be changed to the folder containing @uri. This is equivalent
-to a sequence of gtk_file_chooser_unselect_all() followed by
-gtk_file_chooser_select_uri().
-
-Note that the URI must exist, or nothing will be done except for the
-directory change.
-If you are implementing a <guimenuitem>File/Save As...</guimenuitem> dialog,
-you should use this function if you already have a file name to which the
-user may save; for example, when the user opens an existing file and then
-does <guimenuitem>File/Save As...</guimenuitem> on it. If you don't have
-a file name already — for example, if the user just created a new
-file and is saving it for the first time, do not call this function.
-Instead, use something similar to this:
-|[
-if (document_is_new)
-{
-/ * the user just created a new document * /
-gtk_file_chooser_set_current_folder_uri (chooser, default_folder_for_saving);
-gtk_file_chooser_set_current_name (chooser, "Untitled document");
-}
-else
-{
-/ * the user edited an existing document * /
-gtk_file_chooser_set_uri (chooser, existing_uri);
-}
-]|
+Creates a new #GtkTreePath. This structure refers to a row.
-Since: 2.4
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
-</parameter_description>
-</parameter>
-<parameter name="uri">
-<parameter_description> the URI to set as current
-</parameter_description>
-</parameter>
</parameters>
-<return> %TRUE if both the folder could be changed and the URI was
-selected successfully, %FALSE otherwise.
-
+<return> A newly created #GtkTreePath.
</return>
</function>
-<function name="gtk_action_get_short_label">
+<function name="gtk_tree_path_new_first">
<description>
-Gets the short label text of @action.
+Creates a new #GtkTreePath. The string representation of this path is "0"
-Since: 2.16
</description>
<parameters>
-<parameter name="action">
-<parameter_description> a #GtkAction
-</parameter_description>
-</parameter>
</parameters>
-<return> the short label text.
-
+<return> A new #GtkTreePath.
</return>
</function>
-<function name="gtk_page_setup_set_orientation">
+<function name="gtk_tree_path_new_from_indices">
<description>
-Sets the page orientation of the #GtkPageSetup.
+Creates a new path with @first_index and @varargs as indices.
-Since: 2.10
+Since: 2.2
</description>
<parameters>
-<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter name="first_index">
+<parameter_description> first integer
</parameter_description>
</parameter>
-<parameter name="orientation">
-<parameter_description> a #GtkPageOrientation value
+<parameter name="varargs">
+<parameter_description> list of integers terminated by -1
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A newly created #GtkTreePath.
+
+</return>
</function>
-<function name="gtk_invisible_new">
+<function name="gtk_tree_path_new_from_string">
<description>
-Creates a new #GtkInvisible.
+Creates a new #GtkTreePath initialized to @path. @path is expected to be a
+colon separated list of numbers. For example, the string "10:4:0" would
+create a path of depth 3 pointing to the 11th child of the root node, the 5th
+child of that 11th child, and the 1st child of that 5th child. If an invalid
+path string is passed in, %NULL is returned.
</description>
<parameters>
+<parameter name="path">
+<parameter_description> The string representation of a path.
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GtkInvisible.
+<return> A newly-created #GtkTreePath, or %NULL
</return>
</function>
-<function name="gtk_test_slider_set_perc">
+<function name="gtk_tree_path_next">
<description>
-This function will adjust the slider position of all GtkRange
-based widgets, such as scrollbars or scales, it'll also adjust
-spin buttons. The adjustment value of these widgets is set to
-a value between the lower and upper limits, according to the
- percentage argument.
-
-Since: 2.14
+Moves the @path to point to the next node at the current depth.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> valid widget pointer.
-</parameter_description>
-</parameter>
-<parameter name="percentage">
-<parameter_description> value between 0 and 100.
+<parameter name="path">
+<parameter_description> A #GtkTreePath.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_iter_set_visible_line_index">
+<function name="gtk_tree_path_prepend_index">
<description>
-Like gtk_text_iter_set_line_index(), but the index is in visible
-bytes, i.e. text with a tag making it invisible is not counted
-in the index.
+Prepends a new index to a path. As a result, the depth of the path is
+increased.
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="path">
+<parameter_description> A #GtkTreePath.
</parameter_description>
</parameter>
-<parameter name="byte_on_line">
-<parameter_description> a byte index
+<parameter name="index_">
+<parameter_description> The index.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_container_child_get_valist">
+<function name="gtk_tree_path_prev">
<description>
-Gets the values of one or more child properties for @child and @container.
+Moves the @path to point to the previous node at the current depth,
+if it exists.
+
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
-</parameter_description>
-</parameter>
-<parameter name="child">
-<parameter_description> a widget which is a child of @container
-</parameter_description>
-</parameter>
-<parameter name="first_property_name">
-<parameter_description> the name of the first property to get
-</parameter_description>
-</parameter>
-<parameter name="var_args">
-<parameter_description> return location for the first property, followed
-optionally by more name/return location pairs, followed by %NULL
+<parameter name="path">
+<parameter_description> A #GtkTreePath.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @path has a previous node, and the move was made.
+</return>
</function>
-<function name="gtk_icon_view_set_cursor">
+<function name="gtk_tree_path_to_string">
<description>
-Sets the current keyboard focus to be at @path, and selects it. This is
-useful when you want to focus the user's attention on a particular item.
-If @cell is not %NULL, then focus is given to the cell specified by
-it. Additionally, if @start_editing is %TRUE, then editing should be
-started in the specified cell.
-
-This function is often followed by <literal>gtk_widget_grab_focus
-(icon_view)</literal> in order to give keyboard focus to the widget.
-Please note that editing can only happen when the widget is realized.
+Generates a string representation of the path. This string is a ':'
+separated list of numbers. For example, "4:10:0:3" would be an acceptable return value for this string.
-Since: 2.8
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> A #GtkIconView
-</parameter_description>
-</parameter>
<parameter name="path">
<parameter_description> A #GtkTreePath
</parameter_description>
</parameter>
-<parameter name="cell">
-<parameter_description> One of the cell renderers of @icon_view, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="start_editing">
-<parameter_description> %TRUE if the specified cell should start being edited.
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> A newly-allocated string. Must be freed with g_free().
+</return>
</function>
-<function name="gtk_range_get_lower_stepper_sensitivity">
+<function name="gtk_tree_path_up">
<description>
-Gets the sensitivity policy for the stepper that points to the
-'lower' end of the GtkRange's adjustment.
+Moves the @path to point to its parent node, if it has a parent.
-Since: 2.10
</description>
<parameters>
-<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter name="path">
+<parameter_description> A #GtkTreePath.
</parameter_description>
</parameter>
</parameters>
-<return> The lower stepper's sensitivity policy.
-
+<return> %TRUE if @path has a parent, and the move was made.
</return>
</function>
-<function name="gtk_plug_new">
+<function name="gtk_tree_row_reference_copy">
<description>
-Creates a new plug widget inside the #GtkSocket identified
-by @socket_id. If @socket_id is 0, the plug is left "unplugged" and
-can later be plugged into a #GtkSocket by gtk_socket_add_id().
+Copies a #GtkTreeRowReference.
+Since: 2.2
</description>
<parameters>
-<parameter name="socket_id">
-<parameter_description> the window ID of the socket, or 0.
+<parameter name="reference">
+<parameter_description> a #GtkTreeRowReference
</parameter_description>
</parameter>
</parameters>
-<return> the new #GtkPlug widget.
+<return> a copy of @reference.
+
</return>
</function>
-<function name="gtk_alignment_set">
+<function name="gtk_tree_row_reference_deleted">
<description>
-Sets the #GtkAlignment values.
+Lets a set of row reference created by gtk_tree_row_reference_new_proxy()
+know that the model emitted the "row_deleted" signal.
</description>
<parameters>
-<parameter name="alignment">
-<parameter_description> a #GtkAlignment.
-</parameter_description>
-</parameter>
-<parameter name="xalign">
-<parameter_description> the horizontal alignment of the child widget, from 0 (left) to 1
-(right).
-</parameter_description>
-</parameter>
-<parameter name="yalign">
-<parameter_description> the vertical alignment of the child widget, from 0 (top) to 1
-(bottom).
-</parameter_description>
-</parameter>
-<parameter name="xscale">
-<parameter_description> the amount that the child widget expands horizontally to fill up
-unused space, from 0 to 1.
-A value of 0 indicates that the child widget should never expand.
-A value of 1 indicates that the child widget will expand to fill all of the
-space allocated for the #GtkAlignment.
+<parameter name="proxy">
+<parameter_description> A #GObject
</parameter_description>
</parameter>
-<parameter name="yscale">
-<parameter_description> the amount that the child widget expands vertically to fill up
-unused space, from 0 to 1. The values are similar to @xscale.
+<parameter name="path">
+<parameter_description> The path position that was deleted
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_recent_chooser_get_show_numbers">
+<function name="gtk_tree_row_reference_free">
<description>
-Returns whether @chooser should display recently used resources
-prepended by a unique number.
-
-Deprecated: 2.12: use gtk_recent_chooser_menu_get_show_numbers() instead.
-
-Since: 2.10
+Free's @reference. @reference may be %NULL.
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
+<parameter name="reference">
+<parameter_description> A #GtkTreeRowReference, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the recent chooser should show display numbers,
-%FALSE otherwise.
-
-</return>
+<return></return>
</function>
-<function name="gtk_file_filter_get_needed">
+<function name="gtk_tree_row_reference_get_model">
<description>
-Gets the fields that need to be filled in for the structure
-passed to gtk_file_filter_filter()
-
-This function will not typically be used by applications; it
-is intended principally for use in the implementation of
-#GtkFileChooser.
+Returns the model that the row reference is monitoring.
-Since: 2.4
+Since: 2.8
</description>
<parameters>
-<parameter name="filter">
-<parameter_description> a #GtkFileFilter
+<parameter name="reference">
+<parameter_description> A #GtkTreeRowReference
</parameter_description>
</parameter>
</parameters>
-<return> bitfield of flags indicating needed fields when
-calling gtk_file_filter_filter()
+<return> the model
</return>
</function>
-<function name="gtk_text_buffer_get_deserialize_formats">
+<function name="gtk_tree_row_reference_get_path">
<description>
-This function returns the rich text deserialize formats registered
-with @buffer using gtk_text_buffer_register_deserialize_format() or
-gtk_text_buffer_register_deserialize_tagset()
+Returns a path that the row reference currently points to, or %NULL if the
+path pointed to is no longer valid.
-Since: 2.10
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="n_formats">
-<parameter_description> return location for the number of formats
+<parameter name="reference">
+<parameter_description> A #GtkTreeRowReference
</parameter_description>
</parameter>
</parameters>
-<return> an array of #GdkAtom<!-- -->s representing the registered
-formats.
-
+<return> A current path, or %NULL.
</return>
</function>
-<function name="gtk_menu_attach">
+<function name="gtk_tree_row_reference_inserted">
<description>
-Adds a new #GtkMenuItem to a (table) menu. The number of 'cells' that
-an item will occupy is specified by @left_attach, @right_attach,
- top_attach and @bottom_attach. These each represent the leftmost,
-rightmost, uppermost and lower column and row numbers of the table.
-(Columns and rows are indexed from zero).
-
-Note that this function is not related to gtk_menu_detach().
-
-Since: 2.4
+Lets a set of row reference created by gtk_tree_row_reference_new_proxy()
+know that the model emitted the "row_inserted" signal.
</description>
<parameters>
-<parameter name="menu">
-<parameter_description> a #GtkMenu.
-</parameter_description>
-</parameter>
-<parameter name="child">
-<parameter_description> a #GtkMenuItem.
-</parameter_description>
-</parameter>
-<parameter name="left_attach">
-<parameter_description> The column number to attach the left side of the item to.
-</parameter_description>
-</parameter>
-<parameter name="right_attach">
-<parameter_description> The column number to attach the right side of the item to.
-</parameter_description>
-</parameter>
-<parameter name="top_attach">
-<parameter_description> The row number to attach the top of the item to.
+<parameter name="proxy">
+<parameter_description> A #GObject
</parameter_description>
</parameter>
-<parameter name="bottom_attach">
-<parameter_description> The row number to attach the bottom of the item to.
+<parameter name="path">
+<parameter_description> The row position that was inserted
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_list_store_insert_after">
+<function name="gtk_tree_row_reference_new">
<description>
-Inserts a new row after @sibling. If @sibling is %NULL, then the row will be
-prepended to the beginning of the list. @iter will be changed to point to
-this new row. The row will be empty after this function is called. To fill
-in values, you need to call gtk_list_store_set() or gtk_list_store_set_value().
+Creates a row reference based on @path. This reference will keep pointing
+to the node pointed to by @path, so long as it exists. It listens to all
+signals emitted by @model, and updates its path appropriately. If @path
+isn't a valid path in @model, then %NULL is returned.
</description>
<parameters>
-<parameter name="list_store">
-<parameter_description> A #GtkListStore
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> An unset #GtkTreeIter to set to the new row
+<parameter name="model">
+<parameter_description> A #GtkTreeModel
</parameter_description>
</parameter>
-<parameter name="sibling">
-<parameter_description> A valid #GtkTreeIter, or %NULL
+<parameter name="path">
+<parameter_description> A valid #GtkTreePath to monitor
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A newly allocated #GtkTreeRowReference, or %NULL
+</return>
</function>
-<function name="gtk_scale_button_get_value">
+<function name="gtk_tree_row_reference_new_proxy">
<description>
-Gets the current value of the scale button.
-
-Since: 2.12
-
-</description>
-<parameters>
-<parameter name="button">
-<parameter_description> a #GtkScaleButton
-</parameter_description>
-</parameter>
-</parameters>
-<return> current value of the scale button
+You do not need to use this function. Creates a row reference based on
+ path This reference will keep pointing to the node pointed to by @path,
+so long as it exists. If @path isn't a valid path in @model, then %NULL is
+returned. However, unlike references created with
+gtk_tree_row_reference_new(), it does not listen to the model for changes.
+The creator of the row reference must do this explicitly using
+gtk_tree_row_reference_inserted(), gtk_tree_row_reference_deleted(),
+gtk_tree_row_reference_reordered().
-</return>
-</function>
+These functions must be called exactly once per proxy when the
+corresponding signal on the model is emitted. This single call
+updates all row references for that proxy. Since built-in GTK+
+objects like #GtkTreeView already use this mechanism internally,
+using them as the proxy object will produce unpredictable results.
+Further more, passing the same object as @model and @proxy
+doesn't work for reasons of internal implementation.
-<function name="gtk_tree_store_set_valuesv">
-<description>
-A variant of gtk_tree_store_set_valist() which takes
-the columns and values as two arrays, instead of varargs. This
-function is mainly intended for language bindings or in case
-the number of columns to change is not known until run-time.
+This type of row reference is primarily meant by structures that need to
+carefully monitor exactly when a row reference updates itself, and is not
+generally needed by most applications.
-Since: 2.12
</description>
<parameters>
-<parameter name="tree_store">
-<parameter_description> A #GtkTreeStore
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> A valid #GtkTreeIter for the row being modified
-</parameter_description>
-</parameter>
-<parameter name="columns">
-<parameter_description> an array of column numbers
+<parameter name="proxy">
+<parameter_description> A proxy #GObject
</parameter_description>
</parameter>
-<parameter name="values">
-<parameter_description> an array of GValues
+<parameter name="model">
+<parameter_description> A #GtkTreeModel
</parameter_description>
</parameter>
-<parameter name="n_values">
-<parameter_description> the length of the @columns and @values arrays
+<parameter name="path">
+<parameter_description> A valid #GtkTreePath to monitor
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A newly allocated #GtkTreeRowReference, or %NULL
+</return>
</function>
-<function name="gtk_event_box_set_visible_window">
+<function name="gtk_tree_row_reference_reordered">
<description>
-Set whether the event box uses a visible or invisible child
-window. The default is to use visible windows.
-
-In an invisible window event box, the window that the
-event box creates is a %GDK_INPUT_ONLY window, which
-means that it is invisible and only serves to receive
-events.
-
-A visible window event box creates a visible (%GDK_INPUT_OUTPUT)
-window that acts as the parent window for all the widgets
-contained in the event box.
-
-You should generally make your event box invisible if
-you just want to trap events. Creating a visible window
-may cause artifacts that are visible to the user, especially
-if the user is using a theme with gradients or pixmaps.
-
-The main reason to create a non input-only event box is if
-you want to set the background to a different color or
-draw on it.
-
-<note><para>
-There is one unexpected issue for an invisible event box that has its
-window below the child. (See gtk_event_box_set_above_child().)
-Since the input-only window is not an ancestor window of any windows
-that descendent widgets of the event box create, events on these
-windows aren't propagated up by the windowing system, but only by GTK+.
-The practical effect of this is if an event isn't in the event
-mask for the descendant window (see gtk_widget_add_events()),
-it won't be received by the event box.
-</para><para>
-This problem doesn't occur for visible event boxes, because in
-that case, the event box window is actually the ancestor of the
-descendant windows, not just at the same place on the screen.
-</para></note>
-
-Since: 2.4
+Lets a set of row reference created by gtk_tree_row_reference_new_proxy()
+know that the model emitted the "rows_reordered" signal.
</description>
<parameters>
-<parameter name="event_box">
-<parameter_description> a #GtkEventBox
+<parameter name="proxy">
+<parameter_description> A #GObject
</parameter_description>
</parameter>
-<parameter name="visible_window">
-<parameter_description> boolean value
+<parameter name="path">
+<parameter_description> The parent path of the reordered signal
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> The iter pointing to the parent of the reordered
+</parameter_description>
+</parameter>
+<parameter name="new_order">
+<parameter_description> The new order of rows
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_tag_table_lookup">
+<function name="gtk_tree_row_reference_valid">
<description>
-Look up a named tag.
+Returns %TRUE if the @reference is non-%NULL and refers to a current valid
+path.
</description>
<parameters>
-<parameter name="table">
-<parameter_description> a #GtkTextTagTable
-</parameter_description>
-</parameter>
-<parameter name="name">
-<parameter_description> name of a tag
+<parameter name="reference">
+<parameter_description> A #GtkTreeRowReference, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> The tag, or %NULL if none by that name is in the table.
+<return> %TRUE if @reference points to a valid path.
</return>
</function>
-<function name="gtk_spinner_new">
+<function name="gtk_tree_selection_count_selected_rows">
<description>
-Returns a new spinner widget. Not yet started.
+Returns the number of rows that have been selected in @tree.
-Since: 2.20
+Since: 2.2
</description>
<parameters>
+<parameter name="selection">
+<parameter_description> A #GtkTreeSelection.
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GtkSpinner
+<return> The number of rows selected.
</return>
</function>
-<function name="gtk_font_button_get_title">
+<function name="gtk_tree_selection_get_mode">
<description>
-Retrieves the title of the font selection dialog.
+Gets the selection mode for @selection. See
+gtk_tree_selection_set_mode().
-Since: 2.4
</description>
<parameters>
-<parameter name="font_button">
-<parameter_description> a #GtkFontButton
+<parameter name="selection">
+<parameter_description> a #GtkTreeSelection
</parameter_description>
</parameter>
</parameters>
-<return> an internal copy of the title string which must not be freed.
-
+<return> the current selection mode
</return>
</function>
-<function name="gtk_tool_item_get_use_drag_window">
+<function name="gtk_tree_selection_get_select_function">
<description>
-Returns whether @tool_item has a drag window. See
-gtk_tool_item_set_use_drag_window().
+Returns the current selection function.
-Since: 2.4
+Since: 2.14
</description>
<parameters>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem
+<parameter name="selection">
+<parameter_description> A #GtkTreeSelection.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @tool_item uses a drag window.
+<return> The function.
</return>
</function>
-<function name="gtk_targets_include_uri">
+<function name="gtk_tree_selection_get_selected">
<description>
-Determines if any of the targets in @targets can be used to
-provide an uri list.
+Sets @iter to the currently selected node if @selection is set to
+#GTK_SELECTION_SINGLE or #GTK_SELECTION_BROWSE. @iter may be NULL if you
+just want to test if @selection has any selected nodes. @model is filled
+with the current model as a convenience. This function will not work if you
+use @selection is #GTK_SELECTION_MULTIPLE.
-Since: 2.10
</description>
<parameters>
-<parameter name="targets">
-<parameter_description> an array of #GdkAtom<!-- -->s
+<parameter name="selection">
+<parameter_description> A #GtkTreeSelection.
</parameter_description>
</parameter>
-<parameter name="n_targets">
-<parameter_description> the length of @targets
+<parameter name="model">
+<parameter_description> A pointer to set to the #GtkTreeModel, or NULL.
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> The #GtkTreeIter, or NULL.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @targets include a suitable target for uri lists,
-otherwise %FALSE.
-
+<return> TRUE, if there is a selected node.
</return>
</function>
-<function name="gtk_rc_property_parse_color">
+<function name="gtk_tree_selection_get_selected_rows">
<description>
-A #GtkRcPropertyParser for use with gtk_settings_install_property_parser()
-or gtk_widget_class_install_style_property_parser() which parses a
-color given either by its name or in the form
-<literal>{ red, green, blue }</literal> where %red, %green and
-%blue are integers between 0 and 65535 or floating-point numbers
-between 0 and 1.
+Creates a list of path of all selected rows. Additionally, if you are
+planning on modifying the model after calling this function, you may
+want to convert the returned list into a list of #GtkTreeRowReference<!-- -->s.
+To do this, you can use gtk_tree_row_reference_new().
+To free the return value, use:
+|[
+g_list_foreach (list, (GFunc) gtk_tree_path_free, NULL);
+g_list_free (list);
+]|
+
+Since: 2.2
</description>
<parameters>
-<parameter name="pspec">
-<parameter_description> a #GParamSpec
-</parameter_description>
-</parameter>
-<parameter name="gstring">
-<parameter_description> the #GString to be parsed
+<parameter name="selection">
+<parameter_description> A #GtkTreeSelection.
</parameter_description>
</parameter>
-<parameter name="property_value">
-<parameter_description> a #GValue which must hold #GdkColor values.
+<parameter name="model">
+<parameter_description> A pointer to set to the #GtkTreeModel, or %NULL.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @gstring could be parsed and @property_value
-has been set to the resulting #GdkColor.
+<return> A #GList containing a #GtkTreePath for each selected row.
+
</return>
</function>
-<function name="gtk_file_chooser_get_current_folder_file">
+<function name="gtk_tree_selection_get_tree_view">
<description>
-Gets the current folder of @chooser as #GFile.
-See gtk_file_chooser_get_current_folder_uri().
+Returns the tree view associated with @selection.
-Since: 2.14
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="selection">
+<parameter_description> A #GtkTreeSelection
</parameter_description>
</parameter>
</parameters>
-<return> the #GFile for the current folder.
-
+<return> A #GtkTreeView
</return>
</function>
-<function name="gtk_recent_manager_get_default">
+<function name="gtk_tree_selection_get_user_data">
<description>
-Gets a unique instance of #GtkRecentManager, that you can share
-in your application without caring about memory management. The
-returned instance will be freed when you application terminates.
+Returns the user data for the selection function.
-Since: 2.10
</description>
<parameters>
+<parameter name="selection">
+<parameter_description> A #GtkTreeSelection.
+</parameter_description>
+</parameter>
</parameters>
-<return> A unique #GtkRecentManager. Do not ref or unref it.
-
+<return> The user data.
</return>
</function>
-<function name="gtk_dialog_response">
+<function name="gtk_tree_selection_iter_is_selected">
<description>
-Emits the #GtkDialog::response signal with the given response ID.
-Used to indicate that the user has responded to the dialog in some way;
-typically either you or gtk_dialog_run() will be monitoring the
-::response signal and take appropriate action.
+Returns %TRUE if the row at @iter is currently selected.
+
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkDialog
+<parameter name="selection">
+<parameter_description> A #GtkTreeSelection
</parameter_description>
</parameter>
-<parameter name="response_id">
-<parameter_description> response ID
+<parameter name="iter">
+<parameter_description> A valid #GtkTreeIter
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE, if @iter is selected
+</return>
</function>
-<function name="gtk_text_buffer_delete_mark">
+<function name="gtk_tree_selection_path_is_selected">
<description>
-Deletes @mark, so that it's no longer located anywhere in the
-buffer. Removes the reference the buffer holds to the mark, so if
-you haven't called g_object_ref() on the mark, it will be freed. Even
-if the mark isn't freed, most operations on @mark become
-invalid, until it gets added to a buffer again with
-gtk_text_buffer_add_mark(). Use gtk_text_mark_get_deleted() to
-find out if a mark has been removed from its buffer.
-The "mark-deleted" signal will be emitted as notification after
-the mark is deleted.
+Returns %TRUE if the row pointed to by @path is currently selected. If @path
+does not point to a valid location, %FALSE is returned
+
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="selection">
+<parameter_description> A #GtkTreeSelection.
</parameter_description>
</parameter>
-<parameter name="mark">
-<parameter_description> a #GtkTextMark in @buffer
+<parameter name="path">
+<parameter_description> A #GtkTreePath to check selection on.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @path is selected.
+</return>
</function>
-<function name="gtk_text_buffer_get_tag_table">
+<function name="gtk_tree_selection_select_all">
<description>
-Get the #GtkTextTagTable associated with this buffer.
-
+Selects all the nodes. @selection must be set to #GTK_SELECTION_MULTIPLE
+mode.
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="selection">
+<parameter_description> A #GtkTreeSelection.
</parameter_description>
</parameter>
</parameters>
-<return> the buffer's tag table
-</return>
+<return></return>
</function>
-<function name="gtk_text_buffer_remove_tag_by_name">
+<function name="gtk_tree_selection_select_iter">
<description>
-Calls gtk_text_tag_table_lookup() on the buffer's tag table to
-get a #GtkTextTag, then calls gtk_text_buffer_remove_tag().
+Selects the specified iterator.
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="name">
-<parameter_description> name of a #GtkTextTag
-</parameter_description>
-</parameter>
-<parameter name="start">
-<parameter_description> one bound of range to be untagged
+<parameter name="selection">
+<parameter_description> A #GtkTreeSelection.
</parameter_description>
</parameter>
-<parameter name="end">
-<parameter_description> other bound of range to be untagged
+<parameter name="iter">
+<parameter_description> The #GtkTreeIter to be selected.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_entry_completion_get_entry">
+<function name="gtk_tree_selection_select_path">
<description>
-Gets the entry @completion has been attached to.
-
-Since: 2.4
+Select the row at @path.
</description>
<parameters>
-<parameter name="completion">
-<parameter_description> A #GtkEntryCompletion.
+<parameter name="selection">
+<parameter_description> A #GtkTreeSelection.
</parameter_description>
</parameter>
-</parameters>
-<return> The entry @completion has been attached to.
-
-</return>
-</function>
-
-<function name="gtk_tree_view_get_search_column">
-<description>
-Gets the column searched on by the interactive search code.
-
-
-</description>
-<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView
+<parameter name="path">
+<parameter_description> The #GtkTreePath to be selected.
</parameter_description>
</parameter>
</parameters>
-<return> the column the interactive search code searches in.
-</return>
+<return></return>
</function>
-<function name="gtk_calendar_get_detail_height_rows">
+<function name="gtk_tree_selection_select_range">
<description>
-Queries the height of detail cells, in rows.
-See #GtkCalendar:detail-width-chars.
-
-Since: 2.14
-
+Selects a range of nodes, determined by @start_path and @end_path inclusive.
+ selection must be set to #GTK_SELECTION_MULTIPLE mode.
</description>
<parameters>
-<parameter name="calendar">
-<parameter_description> a #GtkCalendar.
+<parameter name="selection">
+<parameter_description> A #GtkTreeSelection.
+</parameter_description>
+</parameter>
+<parameter name="start_path">
+<parameter_description> The initial node of the range.
+</parameter_description>
+</parameter>
+<parameter name="end_path">
+<parameter_description> The final node of the range.
</parameter_description>
</parameter>
</parameters>
-<return> The height of detail cells, in rows.
-</return>
+<return></return>
</function>
-<function name="gtk_recent_chooser_set_show_private">
+<function name="gtk_tree_selection_selected_foreach">
<description>
-Whether to show recently used resources marked registered as private.
-
-Since: 2.10
+Calls a function for each selected node. Note that you cannot modify
+the tree or selection from within this function. As a result,
+gtk_tree_selection_get_selected_rows() might be more useful.
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
+<parameter name="selection">
+<parameter_description> A #GtkTreeSelection.
</parameter_description>
</parameter>
-<parameter name="show_private">
-<parameter_description> %TRUE to show private items, %FALSE otherwise
+<parameter name="func">
+<parameter_description> The function to call for each selected node.
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> user data to pass to the function.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_settings_get_paper_width">
+<function name="gtk_tree_selection_set_mode">
<description>
-Gets the value of %GTK_PRINT_SETTINGS_PAPER_WIDTH,
-converted to @unit.
-
-Since: 2.10
+Sets the selection mode of the @selection. If the previous type was
+#GTK_SELECTION_MULTIPLE, then the anchor is kept selected, if it was
+previously selected.
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="selection">
+<parameter_description> A #GtkTreeSelection.
</parameter_description>
</parameter>
-<parameter name="unit">
-<parameter_description> the unit for the return value
+<parameter name="type">
+<parameter_description> The selection mode
</parameter_description>
</parameter>
</parameters>
-<return> the paper width, in units of @unit
-
-</return>
+<return></return>
</function>
-<function name="gtk_toggle_action_new">
+<function name="gtk_tree_selection_set_select_function">
<description>
-Creates a new #GtkToggleAction object. To add the action to
-a #GtkActionGroup and set the accelerator for the action,
-call gtk_action_group_add_action_with_accel().
-
-Since: 2.4
+Sets the selection function. If set, this function is called before any node
+is selected or unselected, giving some control over which nodes are selected.
+The select function should return %TRUE if the state of the node may be toggled,
+and %FALSE if the state of the node should be left unchanged.
</description>
<parameters>
-<parameter name="name">
-<parameter_description> A unique name for the action
+<parameter name="selection">
+<parameter_description> A #GtkTreeSelection.
</parameter_description>
</parameter>
-<parameter name="label">
-<parameter_description> The label displayed in menu items and on buttons, or %NULL
+<parameter name="func">
+<parameter_description> The selection function.
</parameter_description>
</parameter>
-<parameter name="tooltip">
-<parameter_description> A tooltip for the action, or %NULL
+<parameter name="data">
+<parameter_description> The selection function's data.
</parameter_description>
</parameter>
-<parameter name="stock_id">
-<parameter_description> The stock icon to display in widgets representing the
-action, or %NULL
+<parameter name="destroy">
+<parameter_description> The destroy function for user data. May be NULL.
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkToggleAction
-
-</return>
+<return></return>
</function>
-<function name="gtk_combo_box_get_add_tearoffs">
+<function name="gtk_tree_selection_unselect_all">
<description>
-Gets the current value of the :add-tearoffs property.
-
+Unselects all the nodes.
</description>
<parameters>
-<parameter name="combo_box">
-<parameter_description> a #GtkComboBox
+<parameter name="selection">
+<parameter_description> A #GtkTreeSelection.
</parameter_description>
</parameter>
</parameters>
-<return> the current value of the :add-tearoffs property.
-</return>
+<return></return>
</function>
-<function name="gtk_target_list_remove">
+<function name="gtk_tree_selection_unselect_iter">
<description>
-Removes a target from a target list.
+Unselects the specified iterator.
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GtkTargetList
+<parameter name="selection">
+<parameter_description> A #GtkTreeSelection.
</parameter_description>
</parameter>
-<parameter name="target">
-<parameter_description> the interned atom representing the target
+<parameter name="iter">
+<parameter_description> The #GtkTreeIter to be unselected.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_action_group_set_sensitive">
+<function name="gtk_tree_selection_unselect_path">
<description>
-Changes the sensitivity of @action_group
-
-Since: 2.4
+Unselects the row at @path.
</description>
<parameters>
-<parameter name="action_group">
-<parameter_description> the action group
+<parameter name="selection">
+<parameter_description> A #GtkTreeSelection.
</parameter_description>
</parameter>
-<parameter name="sensitive">
-<parameter_description> new sensitivity
+<parameter name="path">
+<parameter_description> The #GtkTreePath to be unselected.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_set_focus_on_map">
+<function name="gtk_tree_selection_unselect_range">
<description>
-Windows may set a hint asking the desktop environment not to receive
-the input focus when the window is mapped. This function sets this
-hint.
+Unselects a range of nodes, determined by @start_path and @end_path
+inclusive.
-Since: 2.6
+Since: 2.2
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="selection">
+<parameter_description> A #GtkTreeSelection.
</parameter_description>
</parameter>
-<parameter name="setting">
-<parameter_description> %TRUE to let this window receive input focus on map
+<parameter name="start_path">
+<parameter_description> The initial node of the range.
+</parameter_description>
+</parameter>
+<parameter name="end_path">
+<parameter_description> The initial node of the range.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_recent_chooser_get_show_not_found">
+<function name="gtk_tree_set_row_drag_data">
<description>
-Retrieves whether @chooser should show the recently used resources that
-were not found.
+Sets selection data of target type %GTK_TREE_MODEL_ROW. Normally used
+in a drag_data_get handler.
-Since: 2.10
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
+<parameter name="selection_data">
+<parameter_description> some #GtkSelectionData
+</parameter_description>
+</parameter>
+<parameter name="tree_model">
+<parameter_description> a #GtkTreeModel
+</parameter_description>
+</parameter>
+<parameter name="path">
+<parameter_description> a row in @tree_model
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the resources not found should be displayed, and
-%FALSE otheriwse.
-
+<return> %TRUE if the #GtkSelectionData had the proper target type to allow us to set a tree row
</return>
</function>
-<function name="gtk_window_set_position">
+<function name="gtk_tree_sortable_get_sort_column_id">
<description>
-Sets a position constraint for this window. If the old or new
-constraint is %GTK_WIN_POS_CENTER_ALWAYS, this will also cause
-the window to be repositioned to satisfy the new constraint.
+Fills in @sort_column_id and @order with the current sort column and the
+order. It returns %TRUE unless the @sort_column_id is
+%GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID or
+%GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID.
+
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow.
+<parameter name="sortable">
+<parameter_description> A #GtkTreeSortable
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> a position constraint.
+<parameter name="sort_column_id">
+<parameter_description> The sort column id to be filled in
+</parameter_description>
+</parameter>
+<parameter name="order">
+<parameter_description> The #GtkSortType to be filled in
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the sort column is not one of the special sort
+column ids.
+</return>
</function>
-<function name="gtk_alternative_dialog_button_order">
+<function name="gtk_tree_sortable_has_default_sort_func">
<description>
-Returns %TRUE if dialogs are expected to use an alternative
-button order on the screen @screen. See
-gtk_dialog_set_alternative_button_order() for more details
-about alternative button order.
+Returns %TRUE if the model has a default sort function. This is used
+primarily by GtkTreeViewColumns in order to determine if a model can
+go back to the default state, or not.
-If you need to use this function, you should probably connect
-to the ::notify:gtk-alternative-button-order signal on the
-#GtkSettings object associated to @screen, in order to be
-notified if the button order setting changes.
-
-Since: 2.6
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen, or %NULL to use the default screen
+<parameter name="sortable">
+<parameter_description> A #GtkTreeSortable
</parameter_description>
</parameter>
</parameters>
-<return> Whether the alternative button order should be used
-
+<return> %TRUE, if the model has a default sort function
</return>
</function>
-<function name="gtk_scrolled_window_set_vadjustment">
+<function name="gtk_tree_sortable_set_default_sort_func">
<description>
-Sets the #GtkAdjustment for the vertical scrollbar.
+Sets the default comparison function used when sorting to be @sort_func.
+If the current sort column id of @sortable is
+%GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, then the model will sort using
+this function.
+
+If @sort_func is %NULL, then there will be no default comparison function.
+This means that once the model has been sorted, it can't go back to the
+default state. In this case, when the current sort column id of @sortable
+is %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, the model will be unsorted.
</description>
<parameters>
-<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter name="sortable">
+<parameter_description> A #GtkTreeSortable
</parameter_description>
</parameter>
-<parameter name="vadjustment">
-<parameter_description> vertical scroll adjustment
+<parameter name="sort_func">
+<parameter_description> The comparison function
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> User data to pass to @sort_func, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="destroy">
+<parameter_description> Destroy notifier of @user_data, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_store_clear">
+<function name="gtk_tree_sortable_set_sort_column_id">
<description>
-Removes all rows from @tree_store
+Sets the current sort column to be @sort_column_id. The @sortable will
+resort itself to reflect this change, after emitting a
+#GtkTreeSortable::sort-column-changed signal. @sort_column_id may either be
+a regular column id, or one of the following special values:
+<variablelist>
+<varlistentry>
+<term>%GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID</term>
+<listitem>the default sort function will be used, if it is set</listitem>
+</varlistentry>
+<varlistentry>
+<term>%GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID</term>
+<listitem>no sorting will occur</listitem>
+</varlistentry>
+</variablelist>
</description>
<parameters>
-<parameter name="tree_store">
-<parameter_description> a #GtkTreeStore
+<parameter name="sortable">
+<parameter_description> A #GtkTreeSortable
+</parameter_description>
+</parameter>
+<parameter name="sort_column_id">
+<parameter_description> the sort column id to set
+</parameter_description>
+</parameter>
+<parameter name="order">
+<parameter_description> The sort order of the column
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_job_get_track_print_status">
+<function name="gtk_tree_sortable_set_sort_func">
<description>
-Returns wheter jobs will be tracked after printing.
-For details, see gtk_print_job_set_track_print_status().
-
-Since: 2.10
+Sets the comparison function used when sorting to be @sort_func. If the
+current sort column id of @sortable is the same as @sort_column_id, then
+the model will sort using this function.
</description>
<parameters>
-<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter name="sortable">
+<parameter_description> A #GtkTreeSortable
</parameter_description>
</parameter>
-</parameters>
-<return> %TRUE if print job status will be reported after printing
-
-</return>
-</function>
-
-<function name="gtk_accel_map_lookup_entry">
-<description>
-Looks up the accelerator entry for @accel_path and fills in @key.
-
-</description>
-<parameters>
-<parameter name="accel_path">
-<parameter_description> a valid accelerator path
+<parameter name="sort_column_id">
+<parameter_description> the sort column id to set the function for
</parameter_description>
</parameter>
-<parameter name="key">
-<parameter_description> the accelerator key to be filled in (optional)
+<parameter name="sort_func">
+<parameter_description> The comparison function
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> User data to pass to @sort_func, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="destroy">
+<parameter_description> Destroy notifier of @user_data, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @accel_path is known, %FALSE otherwise
-</return>
+<return></return>
</function>
-<function name="gtk_print_context_get_page_setup">
+<function name="gtk_tree_sortable_sort_column_changed">
<description>
-Obtains the #GtkPageSetup that determines the page
-dimensions of the #GtkPrintContext.
-
-Since: 2.10
+Emits a #GtkTreeSortable::sort-column-changed signal on @sortable.
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GtkPrintContext
+<parameter name="sortable">
+<parameter_description> A #GtkTreeSortable
</parameter_description>
</parameter>
</parameters>
-<return> the page setup of @context
-
-</return>
+<return></return>
</function>
-<function name="gtk_tree_view_map_expanded_rows">
+<function name="gtk_tree_store_append">
<description>
-Calls @func on all expanded rows.
+Appends a new row to @tree_store. If @parent is non-%NULL, then it will append the
+new row after the last child of @parent, otherwise it will append a row to
+the top level. @iter will be changed to point to this new row. The row will
+be empty after this function is called. To fill in values, you need to call
+gtk_tree_store_set() or gtk_tree_store_set_value().
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView
+<parameter name="tree_store">
+<parameter_description> A #GtkTreeStore
</parameter_description>
</parameter>
-<parameter name="func">
-<parameter_description> A function to be called
+<parameter name="iter">
+<parameter_description> An unset #GtkTreeIter to set to the appended row
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> User data to be passed to the function.
+<parameter name="parent">
+<parameter_description> A valid #GtkTreeIter, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_file_selection_get_filename">
+<function name="gtk_tree_store_clear">
<description>
-This function returns the selected filename in the GLib file name
-encoding. To convert to UTF-8, call g_filename_to_utf8(). The
-returned string points to a statically allocated buffer and should
-be copied if you plan to keep it around.
-
-If no file is selected then the selected directory path is returned.
-
+Removes all rows from @tree_store
</description>
<parameters>
-<parameter name="filesel">
-<parameter_description> a #GtkFileSelection
+<parameter name="tree_store">
+<parameter_description> a #GtkTreeStore
</parameter_description>
</parameter>
</parameters>
-<return> currently-selected filename in the on-disk encoding.
-</return>
+<return></return>
</function>
-<function name="gtk_info_bar_get_action_area">
+<function name="gtk_tree_store_insert">
<description>
-Returns the action area of @info_bar.
+Creates a new row at @position. If parent is non-%NULL, then the row will be
+made a child of @parent. Otherwise, the row will be created at the toplevel.
+If @position is larger than the number of rows at that level, then the new
+row will be inserted to the end of the list. @iter will be changed to point
+to this new row. The row will be empty after this function is called. To
+fill in values, you need to call gtk_tree_store_set() or
+gtk_tree_store_set_value().
-Since: 2.18
</description>
<parameters>
-<parameter name="info_bar">
-<parameter_description> a #GtkInfoBar
+<parameter name="tree_store">
+<parameter_description> A #GtkTreeStore
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> An unset #GtkTreeIter to set to the new row
+</parameter_description>
+</parameter>
+<parameter name="parent">
+<parameter_description> A valid #GtkTreeIter, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> position to insert the new row
</parameter_description>
</parameter>
</parameters>
-<return> the action area.
-
-</return>
+<return></return>
</function>
-<function name="gtk_label_select_region">
+<function name="gtk_tree_store_insert_after">
<description>
-Selects a range of characters in the label, if the label is selectable.
-See gtk_label_set_selectable(). If the label is not selectable,
-this function has no effect. If @start_offset or
- end_offset are -1, then the end of the label will be substituted.
+Inserts a new row after @sibling. If @sibling is %NULL, then the row will be
+prepended to @parent 's children. If @parent and @sibling are %NULL, then
+the row will be prepended to the toplevel. If both @sibling and @parent are
+set, then @parent must be the parent of @sibling. When @sibling is set,
+ parent is optional.
+
+ iter will be changed to point to this new row. The row will be empty after
+this function is called. To fill in values, you need to call
+gtk_tree_store_set() or gtk_tree_store_set_value().
+
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="tree_store">
+<parameter_description> A #GtkTreeStore
</parameter_description>
</parameter>
-<parameter name="start_offset">
-<parameter_description> start offset (in characters not bytes)
+<parameter name="iter">
+<parameter_description> An unset #GtkTreeIter to set to the new row
</parameter_description>
</parameter>
-<parameter name="end_offset">
-<parameter_description> end offset (in characters not bytes)
+<parameter name="parent">
+<parameter_description> A valid #GtkTreeIter, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="sibling">
+<parameter_description> A valid #GtkTreeIter, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_insert_interactive_at_cursor">
+<function name="gtk_tree_store_insert_before">
<description>
-Calls gtk_text_buffer_insert_interactive() at the cursor
-position.
+Inserts a new row before @sibling. If @sibling is %NULL, then the row will
+be appended to @parent 's children. If @parent and @sibling are %NULL, then
+the row will be appended to the toplevel. If both @sibling and @parent are
+set, then @parent must be the parent of @sibling. When @sibling is set,
+ parent is optional.
- default_editable indicates the editability of text that doesn't
-have a tag affecting editability applied to it. Typically the
-result of gtk_text_view_get_editable() is appropriate here.
+ iter will be changed to point to this new row. The row will be empty after
+this function is called. To fill in values, you need to call
+gtk_tree_store_set() or gtk_tree_store_set_value().
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="tree_store">
+<parameter_description> A #GtkTreeStore
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> text in UTF-8 format
+<parameter name="iter">
+<parameter_description> An unset #GtkTreeIter to set to the new row
</parameter_description>
</parameter>
-<parameter name="len">
-<parameter_description> length of text in bytes, or -1
+<parameter name="parent">
+<parameter_description> A valid #GtkTreeIter, or %NULL
</parameter_description>
</parameter>
-<parameter name="default_editable">
-<parameter_description> default editability of buffer
+<parameter name="sibling">
+<parameter_description> A valid #GtkTreeIter, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> whether text was actually inserted
-</return>
+<return></return>
</function>
-<function name="gtk_toolbar_insert_element">
+<function name="gtk_tree_store_insert_with_values">
<description>
-Inserts a new element in the toolbar at the given position.
-
-If @type == %GTK_TOOLBAR_CHILD_WIDGET, @widget is used as the new element.
-If @type == %GTK_TOOLBAR_CHILD_RADIOBUTTON, @widget is used to determine
-the radio group for the new element. In all other cases, @widget must
-be %NULL.
+Creates a new row at @position. @iter will be changed to point to this
+new row. If @position is larger than the number of rows on the list, then
+the new row will be appended to the list. The row will be filled with
+the values given to this function.
- callback must be a pointer to a function taking a #GtkWidget and a gpointer as
-arguments. Use G_CALLBACK() to cast the function to #GCallback.
+Calling
+<literal>gtk_tree_store_insert_with_values (tree_store, iter, position, ...)</literal>
+has the same effect as calling
+|[
+gtk_tree_store_insert (tree_store, iter, position);
+gtk_tree_store_set (tree_store, iter, ...);
+]|
+with the different that the former will only emit a row_inserted signal,
+while the latter will emit row_inserted, row_changed and if the tree store
+is sorted, rows_reordered. Since emitting the rows_reordered signal
+repeatedly can affect the performance of the program,
+gtk_tree_store_insert_with_values() should generally be preferred when
+inserting rows in a sorted tree store.
-Deprecated: 2.4: Use gtk_toolbar_insert() instead.
+Since: 2.10
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar.
+<parameter name="tree_store">
+<parameter_description> A #GtkTreeStore
</parameter_description>
</parameter>
-<parameter name="type">
-<parameter_description> a value of type #GtkToolbarChildType that determines what @widget
-will be.
+<parameter name="iter">
+<parameter_description> An unset #GtkTreeIter to set the new row, or %NULL.
</parameter_description>
</parameter>
-<parameter name="widget">
-<parameter_description> a #GtkWidget, or %NULL.
+<parameter name="parent">
+<parameter_description> A valid #GtkTreeIter, or %NULL
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> the element's label.
+<parameter name="position">
+<parameter_description> position to insert the new row
</parameter_description>
</parameter>
-<parameter name="tooltip_text">
-<parameter_description> the element's tooltip.
+<parameter name="Varargs">
+<parameter_description> pairs of column number and value, terminated with -1
</parameter_description>
</parameter>
-<parameter name="tooltip_private_text">
-<parameter_description> used for context-sensitive help about this toolbar element.
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_tree_store_insert_with_valuesv">
+<description>
+A variant of gtk_tree_store_insert_with_values() which takes
+the columns and values as two arrays, instead of varargs. This
+function is mainly intended for language bindings.
+
+Since: 2.10
+
+</description>
+<parameters>
+<parameter name="tree_store">
+<parameter_description> A #GtkTreeStore
</parameter_description>
</parameter>
-<parameter name="icon">
-<parameter_description> a #GtkWidget that provides pictorial representation of the element's function.
+<parameter name="iter">
+<parameter_description> An unset #GtkTreeIter to set the new row, or %NULL.
</parameter_description>
</parameter>
-<parameter name="callback">
-<parameter_description> the function to be executed when the button is pressed.
+<parameter name="parent">
+<parameter_description> A valid #GtkTreeIter, or %NULL
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> any data you wish to pass to the callback.
+<parameter name="position">
+<parameter_description> position to insert the new row
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> the number of widgets to insert this element after.
+<parameter name="columns">
+<parameter_description> an array of column numbers
+</parameter_description>
+</parameter>
+<parameter name="values">
+<parameter_description> an array of GValues
+</parameter_description>
+</parameter>
+<parameter name="n_values">
+<parameter_description> the length of the @columns and @values arrays
</parameter_description>
</parameter>
</parameters>
-<return> the new toolbar element as a #GtkWidget.
-
-</return>
+<return></return>
</function>
-<function name="gtk_text_iter_set_line_offset">
+<function name="gtk_tree_store_is_ancestor">
<description>
-Moves @iter within a line, to a new <emphasis>character</emphasis>
-(not byte) offset. The given character offset must be less than or
-equal to the number of characters in the line; if equal, @iter
-moves to the start of the next line. See
-gtk_text_iter_set_line_index() if you have a byte index rather than
-a character offset.
+Returns %TRUE if @iter is an ancestor of @descendant. That is, @iter is the
+parent (or grandparent or great-grandparent) of @descendant.
</description>
<parameters>
+<parameter name="tree_store">
+<parameter_description> A #GtkTreeStore
+</parameter_description>
+</parameter>
<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter_description> A valid #GtkTreeIter
</parameter_description>
</parameter>
-<parameter name="char_on_line">
-<parameter_description> a character offset relative to the start of @iter's current line
+<parameter name="descendant">
+<parameter_description> A valid #GtkTreeIter
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE, if @iter is an ancestor of @descendant
+</return>
</function>
-<function name="gtk_combo_box_entry_new_with_model">
+<function name="gtk_tree_store_iter_depth">
<description>
-Creates a new #GtkComboBoxEntry which has a #GtkEntry as child and a list
-of strings as popup. You can get the #GtkEntry from a #GtkComboBoxEntry
-using GTK_ENTRY (GTK_BIN (combo_box_entry)->child). To add and remove
-strings from the list, just modify @model using its data manipulation
-API.
+Returns the depth of @iter. This will be 0 for anything on the root level, 1
+for anything down a level, etc.
-Since: 2.4
</description>
<parameters>
-<parameter name="model">
-<parameter_description> A #GtkTreeModel.
+<parameter name="tree_store">
+<parameter_description> A #GtkTreeStore
</parameter_description>
</parameter>
-<parameter name="text_column">
-<parameter_description> A column in @model to get the strings from.
+<parameter name="iter">
+<parameter_description> A valid #GtkTreeIter
</parameter_description>
</parameter>
</parameters>
-<return> A new #GtkComboBoxEntry.
-
+<return> The depth of @iter
</return>
</function>
-<function name="gtk_progress_bar_set_fraction">
+<function name="gtk_tree_store_iter_is_valid">
<description>
-Causes the progress bar to "fill in" the given fraction
-of the bar. The fraction should be between 0.0 and 1.0,
-inclusive.
+WARNING: This function is slow. Only use it for debugging and/or testing
+purposes.
+Checks if the given iter is a valid iter for this #GtkTreeStore.
+
+Since: 2.2
</description>
<parameters>
-<parameter name="pbar">
-<parameter_description> a #GtkProgressBar
+<parameter name="tree_store">
+<parameter_description> A #GtkTreeStore.
</parameter_description>
</parameter>
-<parameter name="fraction">
-<parameter_description> fraction of the task that's been completed
+<parameter name="iter">
+<parameter_description> A #GtkTreeIter.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the iter is valid, %FALSE if the iter is invalid.
+
+</return>
</function>
-<function name="gtk_scale_button_get_minus_button">
+<function name="gtk_tree_store_move_after">
<description>
-Retrieves the minus button of the #GtkScaleButton.
+Moves @iter in @tree_store to the position after @position. @iter and
+ position should be in the same level. Note that this function only
+works with unsorted stores. If @position is %NULL, @iter will be moved
+to the start of the level.
-Since: 2.14
+Since: 2.2
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkScaleButton
+<parameter name="tree_store">
+<parameter_description> A #GtkTreeStore.
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> A #GtkTreeIter.
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> A #GtkTreeIter.
</parameter_description>
</parameter>
</parameters>
-<return> the minus button of the #GtkScaleButton.
-
-</return>
+<return></return>
</function>
-<function name="gtk_icon_view_select_all">
+<function name="gtk_tree_store_move_before">
<description>
-Selects all the icons. @icon_view must has its selection mode set
-to #GTK_SELECTION_MULTIPLE.
+Moves @iter in @tree_store to the position before @position. @iter and
+ position should be in the same level. Note that this function only
+works with unsorted stores. If @position is %NULL, @iter will be
+moved to the end of the level.
-Since: 2.6
+Since: 2.2
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> A #GtkIconView.
+<parameter name="tree_store">
+<parameter_description> A #GtkTreeStore.
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> A #GtkTreeIter.
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> A #GtkTreeIter or %NULL.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_item_factory_new">
+<function name="gtk_tree_store_new">
<description>
-Creates a new #GtkItemFactory.
+Creates a new tree store as with @n_columns columns each of the types passed
+in. Note that only types derived from standard GObject fundamental types
+are supported.
-Beware that the returned object does not have a floating reference.
+As an example, <literal>gtk_tree_store_new (3, G_TYPE_INT, G_TYPE_STRING,
+GDK_TYPE_PIXBUF);</literal> will create a new #GtkTreeStore with three columns, of type
+<type>int</type>, <type>string</type> and #GdkPixbuf respectively.
-Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="container_type">
-<parameter_description> the kind of menu to create; can be
-#GTK_TYPE_MENU_BAR, #GTK_TYPE_MENU or #GTK_TYPE_OPTION_MENU
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> the factory path of the new item factory, a string of the form
-<literal>"<name>"</literal>
+<parameter name="n_columns">
+<parameter_description> number of columns in the tree store
</parameter_description>
</parameter>
-<parameter name="accel_group">
-<parameter_description> a #GtkAccelGroup to which the accelerators for the
-menu items will be added, or %NULL to create a new one
+<parameter name="Varargs">
+<parameter_description> all #GType types for the columns, from first to last
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkItemFactory
+<return> a new #GtkTreeStore
</return>
</function>
-<function name="gtk_action_get_visible">
+<function name="gtk_tree_store_newv">
<description>
-Returns whether the action itself is visible. Note that this doesn't
-necessarily mean effective visibility. See gtk_action_is_sensitive()
-for that.
+Non vararg creation function. Used primarily by language bindings.
-Since: 2.4
</description>
<parameters>
-<parameter name="action">
-<parameter_description> the action object
+<parameter name="n_columns">
+<parameter_description> number of columns in the tree store
+</parameter_description>
+</parameter>
+<parameter name="types">
+<parameter_description> an array of #GType types for the columns, from first to last
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the action itself is visible.
-
+<return> a new #GtkTreeStore
</return>
</function>
-<function name="gtk_print_operation_set_show_progress">
+<function name="gtk_tree_store_prepend">
<description>
-If @show_progress is %TRUE, the print operation will show a
-progress dialog during the print operation.
-
-Since: 2.10
+Prepends a new row to @tree_store. If @parent is non-%NULL, then it will prepend
+the new row before the first child of @parent, otherwise it will prepend a row
+to the top level. @iter will be changed to point to this new row. The row
+will be empty after this function is called. To fill in values, you need to
+call gtk_tree_store_set() or gtk_tree_store_set_value().
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter name="tree_store">
+<parameter_description> A #GtkTreeStore
</parameter_description>
</parameter>
-<parameter name="show_progress">
-<parameter_description> %TRUE to show a progress dialog
+<parameter name="iter">
+<parameter_description> An unset #GtkTreeIter to set to the prepended row
+</parameter_description>
+</parameter>
+<parameter name="parent">
+<parameter_description> A valid #GtkTreeIter, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_path_copy">
+<function name="gtk_tree_store_remove">
<description>
-Creates a new #GtkTreePath as a copy of @path.
+Removes @iter from @tree_store. After being removed, @iter is set to the
+next valid row at that level, or invalidated if it previously pointed to the
+last one.
</description>
<parameters>
-<parameter name="path">
-<parameter_description> A #GtkTreePath.
+<parameter name="tree_store">
+<parameter_description> A #GtkTreeStore
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> A valid #GtkTreeIter
</parameter_description>
</parameter>
</parameters>
-<return> A new #GtkTreePath.
+<return> %TRUE if @iter is still valid, %FALSE if not.
</return>
</function>
-<function name="gtk_text_view_set_tabs">
+<function name="gtk_tree_store_reorder">
<description>
-Sets the default tab stops for paragraphs in @text_view.
-Tags in the buffer may override the default.
+Reorders the children of @parent in @tree_store to follow the order
+indicated by @new_order. Note that this function only works with
+unsorted stores.
+
+Since: 2.2
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="tree_store">
+<parameter_description> A #GtkTreeStore.
</parameter_description>
</parameter>
-<parameter name="tabs">
-<parameter_description> tabs as a #PangoTabArray
+<parameter name="parent">
+<parameter_description> A #GtkTreeIter.
+</parameter_description>
+</parameter>
+<parameter name="new_order">
+<parameter_description> an array of integers mapping the new position of each child
+to its old position before the re-ordering,
+i.e. @new_order<literal>[newpos] = oldpos</literal>.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_paint_string">
+<function name="gtk_tree_store_set">
<description>
-Draws a text string on @window with the given parameters.
+Sets the value of one or more cells in the row referenced by @iter.
+The variable argument list should contain integer column numbers,
+each column number followed by the value to be set.
+The list is terminated by a -1. For example, to set column 0 with type
+%G_TYPE_STRING to "Foo", you would write
+<literal>gtk_tree_store_set (store, iter, 0, "Foo", -1)</literal>.
-Deprecated: 2.0: Use gtk_paint_layout() instead.
+The value will be referenced by the store if it is a %G_TYPE_OBJECT, and it
+will be copied if it is a %G_TYPE_STRING or %G_TYPE_BOXED.
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
+<parameter name="tree_store">
+<parameter_description> A #GtkTreeStore
</parameter_description>
</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="iter">
+<parameter_description> A valid #GtkTreeIter for the row being modified
</parameter_description>
</parameter>
-<parameter name="state_type">
-<parameter_description> a state
+<parameter name="Varargs">
+<parameter_description> pairs of column number and value, terminated with -1
</parameter_description>
</parameter>
-<parameter name="area">
-<parameter_description> clip rectangle, or %NULL if the
-output should not be clipped
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_tree_store_set_column_type">
+<description>
+Supported types include: %G_TYPE_UINT, %G_TYPE_INT, %G_TYPE_UCHAR,
+%G_TYPE_CHAR, %G_TYPE_BOOLEAN, %G_TYPE_POINTER, %G_TYPE_FLOAT,
+%G_TYPE_DOUBLE, %G_TYPE_STRING, %G_TYPE_OBJECT, and %G_TYPE_BOXED, along with
+subclasses of those types such as %GDK_TYPE_PIXBUF.
+
+
+</description>
+<parameters>
+<parameter name="tree_store">
+<parameter_description> a #GtkTreeStore
</parameter_description>
</parameter>
-<parameter name="widget">
-<parameter_description> the widget
+<parameter name="column">
+<parameter_description> column number
</parameter_description>
</parameter>
-<parameter name="detail">
-<parameter_description> a style detail
+<parameter name="type">
+<parameter_description> type of the data to be stored in @column
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> x origin
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_tree_store_set_column_types">
+<description>
+This function is meant primarily for #GObjects that inherit from
+#GtkTreeStore, and should only be used when constructing a new
+#GtkTreeStore. It will not function after a row has been added,
+or a method on the #GtkTreeModel interface is called.
+
+</description>
+<parameters>
+<parameter name="tree_store">
+<parameter_description> A #GtkTreeStore
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> y origin
+<parameter name="n_columns">
+<parameter_description> Number of columns for the tree store
</parameter_description>
</parameter>
-<parameter name="string">
-<parameter_description> the string to draw
+<parameter name="types">
+<parameter_description> An array of #GType types, one for each column
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_insert_column_with_data_func">
+<function name="gtk_tree_store_set_valist">
<description>
-Convenience function that inserts a new column into the #GtkTreeView
-with the given cell renderer and a #GtkCellDataFunc to set cell renderer
-attributes (normally using data from the model). See also
-gtk_tree_view_column_set_cell_data_func(), gtk_tree_view_column_pack_start().
-If @tree_view has "fixed_height" mode enabled, then the new column will have its
-"sizing" property set to be GTK_TREE_VIEW_COLUMN_FIXED.
+See gtk_tree_store_set(); this version takes a <type>va_list</type> for
+use by language bindings.
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
-</parameter_description>
-</parameter>
-<parameter name="position">
-<parameter_description> Position to insert, -1 for append
-</parameter_description>
-</parameter>
-<parameter name="title">
-<parameter_description> column title
-</parameter_description>
-</parameter>
-<parameter name="cell">
-<parameter_description> cell renderer for column
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> function to set attributes of cell renderer
+<parameter name="tree_store">
+<parameter_description> A #GtkTreeStore
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data for @func
+<parameter name="iter">
+<parameter_description> A valid #GtkTreeIter for the row being modified
</parameter_description>
</parameter>
-<parameter name="dnotify">
-<parameter_description> destroy notifier for @data
+<parameter name="var_args">
+<parameter_description> <type>va_list</type> of column/value pairs
</parameter_description>
</parameter>
</parameters>
-<return> number of columns in the tree view post-insert
-</return>
+<return></return>
</function>
-<function name="gtk_paned_get_position">
+<function name="gtk_tree_store_set_value">
<description>
-Obtains the position of the divider between the two panes.
+Sets the data in the cell specified by @iter and @column.
+The type of @value must be convertible to the type of the
+column.
</description>
<parameters>
-<parameter name="paned">
-<parameter_description> a #GtkPaned widget
+<parameter name="tree_store">
+<parameter_description> a #GtkTreeStore
+</parameter_description>
+</parameter>
+<parameter name="iter">
+<parameter_description> A valid #GtkTreeIter for the row being modified
+</parameter_description>
+</parameter>
+<parameter name="column">
+<parameter_description> column number to modify
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> new value for the cell
</parameter_description>
</parameter>
</parameters>
-<return> position of the divider
-</return>
+<return></return>
</function>
-<function name="gtk_action_group_add_toggle_actions_full">
+<function name="gtk_tree_store_set_valuesv">
<description>
-This variant of gtk_action_group_add_toggle_actions() adds a
-#GDestroyNotify callback for @user_data.
+A variant of gtk_tree_store_set_valist() which takes
+the columns and values as two arrays, instead of varargs. This
+function is mainly intended for language bindings or in case
+the number of columns to change is not known until run-time.
-Since: 2.4
+Since: 2.12
</description>
<parameters>
-<parameter name="action_group">
-<parameter_description> the action group
+<parameter name="tree_store">
+<parameter_description> A #GtkTreeStore
</parameter_description>
</parameter>
-<parameter name="entries">
-<parameter_description> an array of toggle action descriptions
+<parameter name="iter">
+<parameter_description> A valid #GtkTreeIter for the row being modified
</parameter_description>
</parameter>
-<parameter name="n_entries">
-<parameter_description> the number of entries
+<parameter name="columns">
+<parameter_description> an array of column numbers
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> data to pass to the action callbacks
+<parameter name="values">
+<parameter_description> an array of GValues
</parameter_description>
</parameter>
-<parameter name="destroy">
-<parameter_description> destroy notification callback for @user_data
+<parameter name="n_values">
+<parameter_description> the length of the @columns and @values arrays
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_toolbar_prepend_widget">
+<function name="gtk_tree_store_swap">
<description>
-Adds a widget to the beginning of the given toolbar.
+Swaps @a and @b in the same level of @tree_store. Note that this function
+only works with unsorted stores.
-Deprecated: 2.4: Use gtk_toolbar_insert() instead.
+Since: 2.2
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar.
-</parameter_description>
-</parameter>
-<parameter name="widget">
-<parameter_description> a #GtkWidget to add to the toolbar.
+<parameter name="tree_store">
+<parameter_description> A #GtkTreeStore.
</parameter_description>
</parameter>
-<parameter name="tooltip_text">
-<parameter_description> the element's tooltip.
+<parameter name="a">
+<parameter_description> A #GtkTreeIter.
</parameter_description>
</parameter>
-<parameter name="tooltip_private_text">
-<parameter_description> used for context-sensitive help about this toolbar element.
+<parameter name="b">
+<parameter_description> Another #GtkTreeIter.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_vpaned_new">
+<function name="gtk_tree_view_append_column">
<description>
-Create a new #GtkVPaned
+Appends @column to the list of columns. If @tree_view has "fixed_height"
+mode enabled, then @column must have its "sizing" property set to be
+GTK_TREE_VIEW_COLUMN_FIXED.
</description>
<parameters>
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView.
+</parameter_description>
+</parameter>
+<parameter name="column">
+<parameter_description> The #GtkTreeViewColumn to add.
+</parameter_description>
+</parameter>
</parameters>
-<return> the new #GtkVPaned
+<return> The number of columns in @tree_view after appending.
</return>
</function>
-<function name="gtk_editable_delete_selection">
+<function name="gtk_tree_view_collapse_all">
<description>
-Deletes the currently selected text of the editable.
-This call doesn't do anything if there is no selected text.
+Recursively collapses all visible, expanded nodes in @tree_view.
</description>
<parameters>
-<parameter name="editable">
-<parameter_description> a #GtkEditable
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_iter_backward_visible_word_starts">
+<function name="gtk_tree_view_collapse_row">
<description>
-Calls gtk_text_iter_backward_visible_word_start() up to @count times.
+Collapses a row (hides its child rows, if they exist).
-Since: 2.4
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="count">
-<parameter_description> number of times to move
+<parameter name="path">
+<parameter_description> path to a row in the @tree_view
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter moved and is not the end iterator
-
+<return> %TRUE if the row was collapsed.
</return>
</function>
-<function name="gtk_calendar_mark_day">
+<function name="gtk_tree_view_column_add_attribute">
<description>
-Places a visual marker on a particular day.
-
-Note that this function always returns %TRUE, and you should
-ignore the return value. In GTK+ 3, this function will not
-return a value.
-
+Adds an attribute mapping to the list in @tree_column. The @column is the
+column of the model to get a value from, and the @attribute is the
+parameter on @cell_renderer to be set from the value. So for example
+if column 2 of the model contains strings, you could have the
+"text" attribute of a #GtkCellRendererText get its values from
+column 2.
</description>
<parameters>
-<parameter name="calendar">
-<parameter_description> a #GtkCalendar
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn.
</parameter_description>
</parameter>
-<parameter name="day">
-<parameter_description> the day number to mark between 1 and 31.
+<parameter name="cell_renderer">
+<parameter_description> the #GtkCellRenderer to set attributes on
</parameter_description>
</parameter>
-</parameters>
-<return> %TRUE, always
-</return>
-</function>
-
-<function name="gtk_item_factory_get_widget_by_action">
-<description>
-Obtains the widget which was constructed from the #GtkItemFactoryEntry
-with the given @action.
-
-If there are multiple items with the same action, the result is
-undefined.
-
-Deprecated: 2.4: Use #GtkUIManager instead.
-
-</description>
-<parameters>
-<parameter name="ifactory">
-<parameter_description> a #GtkItemFactory
+<parameter name="attribute">
+<parameter_description> An attribute on the renderer
</parameter_description>
</parameter>
-<parameter name="action">
-<parameter_description> an action as specified in the @callback_action field
-of #GtkItemFactoryEntry
+<parameter name="column">
+<parameter_description> The column position on the model to get the attribute from.
</parameter_description>
</parameter>
</parameters>
-<return> the widget which corresponds to the given action, or %NULL
-if no widget was found
-</return>
+<return></return>
</function>
-<function name="gtk_separator_new">
+<function name="gtk_tree_view_column_cell_get_position">
<description>
-Creates a new #GtkSeparator with the given orientation.
+Obtains the horizontal position and size of a cell in a column. If the
+cell is not found in the column, @start_pos and @width are not changed and
+%FALSE is returned.
-Since: 2.16
</description>
<parameters>
-<parameter name="orientation">
-<parameter_description> the separator's orientation.
+<parameter name="tree_column">
+<parameter_description> a #GtkTreeViewColumn
+</parameter_description>
+</parameter>
+<parameter name="cell_renderer">
+<parameter_description> a #GtkCellRenderer
+</parameter_description>
+</parameter>
+<parameter name="start_pos">
+<parameter_description> return location for the horizontal position of @cell within
+ tree_column, may be %NULL
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> return location for the width of @cell, may be %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkSeparator.
-
+<return> %TRUE if @cell belongs to @tree_column.
</return>
</function>
-<function name="gtk_widget_set_visible">
+<function name="gtk_tree_view_column_cell_get_size">
<description>
-Sets the visibility state of @widget. Note that setting this to
-%TRUE doesn't mean the widget is actually viewable, see
-gtk_widget_get_visible().
-
-This function simply calls gtk_widget_show() or gtk_widget_hide()
-but is nicer to use when the visibility of the widget depends on
-some condition.
-
-Since: 2.18
+Obtains the width and height needed to render the column. This is used
+primarily by the #GtkTreeView.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn.
</parameter_description>
</parameter>
-<parameter name="visible">
-<parameter_description> whether the widget should be shown or not
+<parameter name="cell_area">
+<parameter_description> The area a cell in the column will be allocated, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="x_offset">
+<parameter_description> location to return x offset of a cell relative to @cell_area, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="y_offset">
+<parameter_description> location to return y offset of a cell relative to @cell_area, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> location to return width needed to render a cell, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> location to return height needed to render a cell, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_settings_get_number_up">
+<function name="gtk_tree_view_column_cell_is_visible">
<description>
-Gets the value of %GTK_PRINT_SETTINGS_NUMBER_UP.
+Returns %TRUE if any of the cells packed into the @tree_column are visible.
+For this to be meaningful, you must first initialize the cells with
+gtk_tree_view_column_cell_set_cell_data()
-Since: 2.10
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn
</parameter_description>
</parameter>
</parameters>
-<return> the number of pages per sheet
-
+<return> %TRUE, if any of the cells packed into the @tree_column are currently visible
</return>
</function>
-<function name="gtk_text_iter_get_visible_line_index">
+<function name="gtk_tree_view_column_cell_render">
<description>
-Returns the number of bytes from the start of the
-line to the given @iter, not counting bytes that
-are invisible due to tags with the "invisible" flag
-toggled on.
-
+Renders the cell contained by #tree_column. This is used primarily by the
+#GtkTreeView.
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn.
+</parameter_description>
+</parameter>
+<parameter name="window">
+<parameter_description> a #GdkDrawable to draw to
+</parameter_description>
+</parameter>
+<parameter name="background_area">
+<parameter_description> entire cell area (including tree expanders and maybe padding on the sides)
+</parameter_description>
+</parameter>
+<parameter name="cell_area">
+<parameter_description> area normally rendered by a cell renderer
+</parameter_description>
+</parameter>
+<parameter name="expose_area">
+<parameter_description> area that actually needs updating
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> flags that affect rendering
</parameter_description>
</parameter>
</parameters>
-<return> byte index of @iter with respect to the start of the line
-</return>
+<return></return>
</function>
-<function name="gtk_toolbar_get_drop_index">
+<function name="gtk_tree_view_column_cell_set_cell_data">
<description>
-Returns the position corresponding to the indicated point on
- toolbar This is useful when dragging items to the toolbar:
-this function returns the position a new item should be
-inserted.
-
- x and @y are in @toolbar coordinates.
-
-Since: 2.4
+Sets the cell renderer based on the @tree_model and @iter. That is, for
+every attribute mapping in @tree_column, it will get a value from the set
+column on the @iter, and use that value to set the attribute on the cell
+renderer. This is used primarily by the #GtkTreeView.
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn.
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> x coordinate of a point on the toolbar
+<parameter name="tree_model">
+<parameter_description> The #GtkTreeModel to to get the cell renderers attributes from.
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> y coordinate of a point on the toolbar
+<parameter name="iter">
+<parameter_description> The #GtkTreeIter to to get the cell renderer's attributes from.
+</parameter_description>
+</parameter>
+<parameter name="is_expander">
+<parameter_description> %TRUE, if the row has children
+</parameter_description>
+</parameter>
+<parameter name="is_expanded">
+<parameter_description> %TRUE, if the row has visible children
</parameter_description>
</parameter>
</parameters>
-<return> The position corresponding to the point (@x, @y) on the toolbar.
-
-</return>
+<return></return>
</function>
-<function name="gtk_print_job_get_status">
+<function name="gtk_tree_view_column_clear">
<description>
-Gets the status of the print job.
-
-Since: 2.10
+Unsets all the mappings on all renderers on the @tree_column.
</description>
<parameters>
-<parameter name="job">
-<parameter_description> a #GtkPrintJob
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn
</parameter_description>
</parameter>
</parameters>
-<return> the status of @job
-
-</return>
+<return></return>
</function>
-<function name="gtk_tree_view_get_cell_area">
+<function name="gtk_tree_view_column_clear_attributes">
<description>
-Fills the bounding rectangle in bin_window coordinates for the cell at the
-row specified by @path and the column specified by @column. If @path is
-%NULL, or points to a path not currently displayed, the @y and @height fields
-of the rectangle will be filled with 0. If @column is %NULL, the @x and @width
-fields will be filled with 0. The sum of all cell rects does not cover the
-entire tree; there are extra pixels in between rows, for example. The
-returned rectangle is equivalent to the @cell_area passed to
-gtk_cell_renderer_render(). This function is only valid if @tree_view is
-realized.
+Clears all existing attributes previously set with
+gtk_tree_view_column_set_attributes().
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> a #GtkTreePath for the row, or %NULL to get only horizontal coordinates
-</parameter_description>
-</parameter>
-<parameter name="column">
-<parameter_description> a #GtkTreeViewColumn for the column, or %NULL to get only vertical coordinates
+<parameter name="tree_column">
+<parameter_description> a #GtkTreeViewColumn
</parameter_description>
</parameter>
-<parameter name="rect">
-<parameter_description> rectangle to fill with cell rect
+<parameter name="cell_renderer">
+<parameter_description> a #GtkCellRenderer to clear the attribute mapping on.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_menu_set_accel_group">
+<function name="gtk_tree_view_column_clicked">
<description>
+Emits the "clicked" signal on the column. This function will only work if
+ tree_column is clickable.
</description>
<parameters>
-<parameter name="accel_group">
-<parameter_description>
+<parameter name="tree_column">
+<parameter_description> a #GtkTreeViewColumn
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_create_child_anchor">
+<function name="gtk_tree_view_column_focus_cell">
<description>
-This is a convenience function which simply creates a child anchor
-with gtk_text_child_anchor_new() and inserts it into the buffer
-with gtk_text_buffer_insert_child_anchor(). The new anchor is
-owned by the buffer; no reference count is returned to
-the caller of gtk_text_buffer_create_child_anchor().
+Sets the current keyboard focus to be at @cell, if the column contains
+2 or more editable and activatable cells.
+Since: 2.2
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> location in the buffer
+<parameter name="cell">
+<parameter_description> A #GtkCellRenderer
</parameter_description>
</parameter>
</parameters>
-<return> the created child anchor
-</return>
+<return></return>
</function>
-<function name="gtk_accelerator_set_default_mod_mask">
+<function name="gtk_tree_view_column_get_alignment">
<description>
-Sets the modifiers that will be considered significant for keyboard
-accelerators. The default mod mask is #GDK_CONTROL_MASK |
-#GDK_SHIFT_MASK | #GDK_MOD1_MASK | #GDK_SUPER_MASK |
-#GDK_HYPER_MASK | #GDK_META_MASK, that is, Control, Shift, Alt,
-Super, Hyper and Meta. Other modifiers will by default be ignored
-by #GtkAccelGroup.
-You must include at least the three modifiers Control, Shift
-and Alt in any value you pass to this function.
+Returns the current x alignment of @tree_column. This value can range
+between 0.0 and 1.0.
-The default mod mask should be changed on application startup,
-before using any accelerator groups.
</description>
<parameters>
-<parameter name="default_mod_mask">
-<parameter_description> accelerator modifier mask
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The current alignent of @tree_column.
+</return>
</function>
-<function name="gtk_recent_chooser_menu_new_for_manager">
+<function name="gtk_tree_view_column_get_cell_renderers">
<description>
-Creates a new #GtkRecentChooserMenu widget using @manager as
-the underlying recently used resources manager.
-
-This is useful if you have implemented your own recent manager,
-or if you have a customized instance of a #GtkRecentManager
-object or if you wish to share a common #GtkRecentManager object
-among multiple #GtkRecentChooser widgets.
+Returns a newly-allocated #GList of all the cell renderers in the column,
+in no particular order. The list must be freed with g_list_free().
-Since: 2.10
+Deprecated: 2.18: use gtk_cell_layout_get_cells() instead.
</description>
<parameters>
-<parameter name="manager">
-<parameter_description> a #GtkRecentManager
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkRecentChooserMenu, bound to @manager.
+<return> A list of #GtkCellRenderers
</return>
</function>
-<function name="gtk_cell_view_new">
+<function name="gtk_tree_view_column_get_clickable">
<description>
-Creates a new #GtkCellView widget.
+Returns %TRUE if the user can click on the header for the column.
-Since: 2.6
</description>
<parameters>
+<parameter name="tree_column">
+<parameter_description> a #GtkTreeViewColumn
+</parameter_description>
+</parameter>
</parameters>
-<return> A newly created #GtkCellView widget.
-
+<return> %TRUE if user can click the column header.
</return>
</function>
-<function name="gtk_tree_view_get_drag_dest_row">
+<function name="gtk_tree_view_column_get_expand">
<description>
-Gets information about the row that is highlighted for feedback.
+Return %TRUE if the column expands to take any available space.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> Return location for the path of the highlighted row, or %NULL.
-</parameter_description>
-</parameter>
-<parameter name="pos">
-<parameter_description> Return location for the drop position, or %NULL
+<parameter name="tree_column">
+<parameter_description> a #GtkTreeViewColumn
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE, if the column expands
+
+</return>
</function>
-<function name="gtk_action_block_activate_from">
+<function name="gtk_tree_view_column_get_fixed_width">
<description>
-Disables calls to the gtk_action_activate()
-function by signals on the given proxy widget. This is used to
-break notification loops for things like check or radio actions.
-
-This function is intended for use by action implementations.
-
-Since: 2.4
+Gets the fixed width of the column. This value is only meaning may not be
+the actual width of the column on the screen, just what is requested.
-Deprecated: 2.16: activatables are now responsible for activating the
-action directly so this doesnt apply anymore.
</description>
<parameters>
-<parameter name="action">
-<parameter_description> the action object
-</parameter_description>
-</parameter>
-<parameter name="proxy">
-<parameter_description> a proxy widget
+<parameter name="tree_column">
+<parameter_description> a #GtkTreeViewColumn
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the fixed width of the column
+</return>
</function>
-<function name="gtk_toolbar_unset_style">
+<function name="gtk_tree_view_column_get_max_width">
<description>
-Unsets a toolbar style set with gtk_toolbar_set_style(), so that
-user preferences will be used to determine the toolbar style.
+Returns the maximum width in pixels of the @tree_column, or -1 if no maximum
+width is set.
+
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The maximum width of the @tree_column.
+</return>
</function>
-<function name="gtk_widget_get_size_request">
+<function name="gtk_tree_view_column_get_min_width">
<description>
-Gets the size request that was explicitly set for the widget using
-gtk_widget_set_size_request(). A value of -1 stored in @width or
- height indicates that that dimension has not been set explicitly
-and the natural requisition of the widget will be used intead. See
-gtk_widget_set_size_request(). To get the size a widget will
-actually use, call gtk_widget_size_request() instead of
-this function.
+Returns the minimum width in pixels of the @tree_column, or -1 if no minimum
+width is set.
+
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> return location for width, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> return location for height, or %NULL
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The minimum width of the @tree_column.
+</return>
</function>
-<function name="gtk_draw_diamond">
+<function name="gtk_tree_view_column_get_reorderable">
<description>
-Draws a diamond in the given rectangle on @window using the given
-parameters.
+Returns %TRUE if the @tree_column can be reordered by the user.
-Deprecated: 2.0: Use gtk_paint_diamond() instead.
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
-</parameter_description>
-</parameter>
-<parameter name="shadow_type">
-<parameter_description> the type of shadow to draw
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> x origin of the rectangle to draw the diamond in
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> y origin of the rectangle to draw the diamond in
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> width of the rectangle to draw the diamond in
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> height of the rectangle to draw the diamond in
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the @tree_column can be reordered by the user.
+</return>
</function>
-<function name="gtk_ui_manager_get_action">
+<function name="gtk_tree_view_column_get_resizable">
<description>
-Looks up an action by following a path. See gtk_ui_manager_get_widget()
-for more information about paths.
+Returns %TRUE if the @tree_column can be resized by the end user.
-Since: 2.4
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #GtkUIManager
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> a path
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn
</parameter_description>
</parameter>
</parameters>
-<return> the action whose proxy widget is found by following the path,
-or %NULL if no widget was found.
-
+<return> %TRUE, if the @tree_column can be resized.
</return>
</function>
-<function name="gtk_icon_theme_prepend_search_path">
+<function name="gtk_tree_view_column_get_sizing">
<description>
-Prepends a directory to the search path.
-See gtk_icon_theme_set_search_path().
+Returns the current type of @tree_column.
-Since: 2.4
</description>
<parameters>
-<parameter name="icon_theme">
-<parameter_description> a #GtkIconTheme
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> directory name to prepend to the icon path
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The type of @tree_column.
+</return>
</function>
-<function name="gtk_clipboard_wait_is_text_available">
+<function name="gtk_tree_view_column_get_sort_column_id">
<description>
-Test to see if there is text available to be pasted
-This is done by requesting the TARGETS atom and checking
-if it contains any of the supported text targets. This function
-waits for the data to be received using the main loop, so events,
-timeouts, etc, may be dispatched during the wait.
-
-This function is a little faster than calling
-gtk_clipboard_wait_for_text() since it doesn't need to retrieve
-the actual text.
+Gets the logical @sort_column_id that the model sorts on when this
+column is selected for sorting.
+See gtk_tree_view_column_set_sort_column_id().
</description>
<parameters>
-<parameter name="clipboard">
-<parameter_description> a #GtkClipboard
+<parameter name="tree_column">
+<parameter_description> a #GtkTreeViewColumn
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE is there is text available, %FALSE otherwise.
+<return> the current @sort_column_id for this column, or -1 if
+this column can't be used for sorting.
</return>
</function>
-<function name="gtk_icon_view_selected_foreach">
+<function name="gtk_tree_view_column_get_sort_indicator">
<description>
-Calls a function for each selected icon. Note that the model or
-selection cannot be modified from within this function.
+Gets the value set by gtk_tree_view_column_set_sort_indicator().
-Since: 2.6
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> A #GtkIconView.
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> The funcion to call for each selected icon.
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> User data to pass to the function.
+<parameter name="tree_column">
+<parameter_description> a #GtkTreeViewColumn
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether the sort indicator arrow is displayed
+</return>
</function>
-<function name="gtk_recent_action_get_show_numbers">
+<function name="gtk_tree_view_column_get_sort_order">
<description>
-Returns the value set by gtk_recent_chooser_menu_set_show_numbers().
+Gets the value set by gtk_tree_view_column_set_sort_order().
-Since: 2.12
</description>
<parameters>
-<parameter name="action">
-<parameter_description> a #GtkRecentAction
+<parameter name="tree_column">
+<parameter_description> a #GtkTreeViewColumn
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if numbers should be shown.
-
+<return> the sort order the sort indicator is indicating
</return>
</function>
-<function name="gtk_print_settings_set_page_ranges">
+<function name="gtk_tree_view_column_get_spacing">
<description>
-Sets the value of %GTK_PRINT_SETTINGS_PAGE_RANGES.
+Returns the spacing of @tree_column.
-Since: 2.10
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
-</parameter_description>
-</parameter>
-<parameter name="page_ranges">
-<parameter_description> an array of #GtkPageRange<!-- -->s
-</parameter_description>
-</parameter>
-<parameter name="num_ranges">
-<parameter_description> the length of @page_ranges
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the spacing of @tree_column.
+</return>
</function>
-<function name="gtk_tool_button_set_icon_name">
+<function name="gtk_tree_view_column_get_title">
<description>
-Sets the icon for the tool button from a named themed icon.
-See the docs for #GtkIconTheme for more details.
-The "icon_name" property only has an effect if not
-overridden by non-%NULL "label", "icon_widget" and "stock_id"
-properties.
+Returns the title of the widget.
-Since: 2.8
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkToolButton
-</parameter_description>
-</parameter>
-<parameter name="icon_name">
-<parameter_description> the name of the themed icon
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the title of the column. This string should not be
+modified or freed.
+</return>
</function>
-<function name="gtk_notebook_prepend_page_menu">
+<function name="gtk_tree_view_column_get_tree_view">
<description>
-Prepends a page to @notebook, specifying the widget to use as the
-label in the popup menu.
+Returns the #GtkTreeView wherein @tree_column has been inserted.
+If @column is currently not inserted in any tree view, %NULL is
+returned.
+Since: 2.12
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
-</parameter_description>
-</parameter>
-<parameter name="child">
-<parameter_description> the #GtkWidget to use as the contents of the page.
-</parameter_description>
-</parameter>
-<parameter name="tab_label">
-<parameter_description> the #GtkWidget to be used as the label for the page,
-or %NULL to use the default label, 'page N'.
-</parameter_description>
-</parameter>
-<parameter name="menu_label">
-<parameter_description> the widget to use as a label for the page-switch
-menu, if that is enabled. If %NULL, and @tab_label
-is a #GtkLabel or %NULL, then the menu label will be
-a newly created label with the same text as @tab_label;
-If @tab_label is not a #GtkLabel, @menu_label must be
-specified if the page-switch menu is to be used.
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn
</parameter_description>
</parameter>
</parameters>
-<return> the index (starting from 0) of the prepended
-page in the notebook, or -1 if function fails
+<return> The tree view wherein @column has
+been inserted if any, %NULL otherwise.
+
</return>
</function>
-<function name="gtk_window_fullscreen">
+<function name="gtk_tree_view_column_get_visible">
<description>
-Asks to place @window in the fullscreen state. Note that you
-shouldn't assume the window is definitely full screen afterward,
-because other entities (e.g. the user or <link
-linkend="gtk-X11-arch">window manager</link>) could unfullscreen it
-again, and not all window managers honor requests to fullscreen
-windows. But normally the window will end up fullscreen. Just
-don't write code that crashes if not.
-
-You can track the fullscreen state via the "window-state-event" signal
-on #GtkWidget.
+Returns %TRUE if @tree_column is visible.
-Since: 2.2
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether the column is visible or not. If it is visible, then
+the tree will show the column.
+</return>
</function>
-<function name="gtk_file_chooser_select_file">
+<function name="gtk_tree_view_column_get_widget">
<description>
-Selects the file referred to by @file. An internal function. See
-_gtk_file_chooser_select_uri().
+Returns the #GtkWidget in the button on the column header.
+If a custom widget has not been set then %NULL is returned.
-Since: 2.14
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
-</parameter_description>
-</parameter>
-<parameter name="file">
-<parameter_description> the file to select
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> location to store error, or %NULL
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if both the folder could be changed and the path was
-selected successfully, %FALSE otherwise.
-
+<return> The #GtkWidget in the column
+header, or %NULL
</return>
</function>
-<function name="gtk_text_iter_order">
+<function name="gtk_tree_view_column_get_width">
<description>
-Swaps the value of @first and @second if @second comes before
- first in the buffer. That is, ensures that @first and @second are
-in sequence. Most text buffer functions that take a range call this
-automatically on your behalf, so there's no real reason to call it yourself
-in those cases. There are some exceptions, such as gtk_text_iter_in_range(),
-that expect a pre-sorted range.
+Returns the current size of @tree_column in pixels.
</description>
<parameters>
-<parameter name="first">
-<parameter_description> a #GtkTextIter
-</parameter_description>
-</parameter>
-<parameter name="second">
-<parameter_description> another #GtkTextIter
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The current width of @tree_column.
+</return>
</function>
-<function name="gtk_selection_clear">
+<function name="gtk_tree_view_column_new">
<description>
-The default handler for the #GtkWidget::selection-clear-event
-signal.
-
-Since: 2.2
+Creates a new #GtkTreeViewColumn.
-Deprecated: 2.4: Instead of calling this function, chain up from
-your selection-clear-event handler. Calling this function
-from any other context is illegal.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="event">
-<parameter_description> the event
-</parameter_description>
-</parameter>
</parameters>
-<return> %TRUE if the event was handled, otherwise false
-
+<return> A newly created #GtkTreeViewColumn.
</return>
</function>
-<function name="gtk_notebook_prepend_page">
+<function name="gtk_tree_view_column_new_with_attributes">
<description>
-Prepends a page to @notebook.
+Creates a new #GtkTreeViewColumn with a number of default values. This is
+equivalent to calling gtk_tree_view_column_set_title(),
+gtk_tree_view_column_pack_start(), and
+gtk_tree_view_column_set_attributes() on the newly created #GtkTreeViewColumn.
+
+Here's a simple example:
+|[
+enum { TEXT_COLUMN, COLOR_COLUMN, N_COLUMNS };
+...
+{
+GtkTreeViewColumn *column;
+GtkCellRenderer *renderer = gtk_cell_renderer_text_new ();
+
+column = gtk_tree_view_column_new_with_attributes ("Title",
+renderer,
+"text", TEXT_COLUMN,
+"foreground", COLOR_COLUMN,
+NULL);
+}
+]|
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="title">
+<parameter_description> The title to set the header to.
</parameter_description>
</parameter>
-<parameter name="child">
-<parameter_description> the #GtkWidget to use as the contents of the page.
+<parameter name="cell">
+<parameter_description> The #GtkCellRenderer.
</parameter_description>
</parameter>
-<parameter name="tab_label">
-<parameter_description> the #GtkWidget to be used as the label for the page,
-or %NULL to use the default label, 'page N'.
+<parameter name="Varargs">
+<parameter_description> A %NULL-terminated list of attributes.
</parameter_description>
</parameter>
</parameters>
-<return> the index (starting from 0) of the prepended
-page in the notebook, or -1 if function fails
+<return> A newly created #GtkTreeViewColumn.
</return>
</function>
-<function name="gtk_buildable_parser_finished">
+<function name="gtk_tree_view_column_pack_end">
<description>
-Called when the builder finishes the parsing of a
-<link linkend="BUILDER-UI">GtkBuilder UI definition</link>.
-Note that this will be called once for each time
-gtk_builder_add_from_file() or gtk_builder_add_from_string()
-is called on a builder.
-
-Since: 2.12
+Adds the @cell to end of the column. If @expand is %FALSE, then the @cell
+is allocated no more space than it needs. Any unused space is divided
+evenly between cells for which @expand is %TRUE.
</description>
<parameters>
-<parameter name="buildable">
-<parameter_description> a #GtkBuildable
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn.
</parameter_description>
</parameter>
-<parameter name="builder">
-<parameter_description> a #GtkBuilder
+<parameter name="cell">
+<parameter_description> The #GtkCellRenderer.
+</parameter_description>
+</parameter>
+<parameter name="expand">
+<parameter_description> %TRUE if @cell is to be given extra space allocated to @tree_column.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_view_set_markup_column">
+<function name="gtk_tree_view_column_pack_start">
<description>
-Sets the column with markup information for @icon_view to be
- column The markup column must be of type #G_TYPE_STRING.
-If the markup column is set to something, it overrides
-the text column set by gtk_icon_view_set_text_column().
-
-Since: 2.6
+Packs the @cell into the beginning of the column. If @expand is %FALSE, then
+the @cell is allocated no more space than it needs. Any unused space is divided
+evenly between cells for which @expand is %TRUE.
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> A #GtkIconView.
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn.
</parameter_description>
</parameter>
-<parameter name="column">
-<parameter_description> A column in the currently used model, or -1 to display no text
+<parameter name="cell">
+<parameter_description> The #GtkCellRenderer.
+</parameter_description>
+</parameter>
+<parameter name="expand">
+<parameter_description> %TRUE if @cell is to be given extra space allocated to @tree_column.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_toolbar_append_widget">
+<function name="gtk_tree_view_column_queue_resize">
<description>
-Adds a widget to the end of the given toolbar.
+Flags the column, and the cell renderers added to this column, to have
+their sizes renegotiated.
-Deprecated: 2.4: Use gtk_toolbar_insert() instead.
+Since: 2.8
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar.
-</parameter_description>
-</parameter>
-<parameter name="widget">
-<parameter_description> a #GtkWidget to add to the toolbar.
-</parameter_description>
-</parameter>
-<parameter name="tooltip_text">
-<parameter_description> the element's tooltip.
-</parameter_description>
-</parameter>
-<parameter name="tooltip_private_text">
-<parameter_description> used for context-sensitive help about this toolbar element.
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_separator_tool_item_set_draw">
+<function name="gtk_tree_view_column_set_alignment">
<description>
-Whether @item is drawn as a vertical line, or just blank.
-Setting this to %FALSE along with gtk_tool_item_set_expand() is useful
-to create an item that forces following items to the end of the toolbar.
-
-Since: 2.4
+Sets the alignment of the title or custom widget inside the column header.
+The alignment determines its location inside the button -- 0.0 for left, 0.5
+for center, 1.0 for right.
</description>
<parameters>
-<parameter name="item">
-<parameter_description> a #GtkSeparatorToolItem
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn.
</parameter_description>
</parameter>
-<parameter name="draw">
-<parameter_description> whether @item is drawn as a vertical line
+<parameter name="xalign">
+<parameter_description> The alignment, which is between [0.0 and 1.0] inclusive.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_box_query_child_packing">
+<function name="gtk_tree_view_column_set_attributes">
<description>
-Obtains information about how @child is packed into @box.
+Sets the attributes in the list as the attributes of @tree_column.
+The attributes should be in attribute/column order, as in
+gtk_tree_view_column_add_attribute(). All existing attributes
+are removed, and replaced with the new attributes.
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #GtkBox
-</parameter_description>
-</parameter>
-<parameter name="child">
-<parameter_description> the #GtkWidget of the child to query
-</parameter_description>
-</parameter>
-<parameter name="expand">
-<parameter_description> pointer to return location for #GtkBox:expand child property
-</parameter_description>
-</parameter>
-<parameter name="fill">
-<parameter_description> pointer to return location for #GtkBox:fill child property
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn.
</parameter_description>
</parameter>
-<parameter name="padding">
-<parameter_description> pointer to return location for #GtkBox:padding child property
+<parameter name="cell_renderer">
+<parameter_description> the #GtkCellRenderer we're setting the attributes of
</parameter_description>
</parameter>
-<parameter name="pack_type">
-<parameter_description> pointer to return location for #GtkBox:pack-type child property
+<parameter name="Varargs">
+<parameter_description> A %NULL-terminated list of attributes.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_paste_clipboard">
+<function name="gtk_tree_view_column_set_cell_data_func">
<description>
-Pastes the contents of a clipboard at the insertion point, or at
- override_location (Note: pasting is asynchronous, that is, we'll
-ask for the paste data and return, and at some point later after
-the main loop runs, the paste data will be inserted.)
+Sets the #GtkTreeViewColumnFunc to use for the column. This
+function is used instead of the standard attributes mapping for
+setting the column value, and should set the value of @tree_column's
+cell renderer as appropriate. @func may be %NULL to remove an
+older one.
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn
</parameter_description>
</parameter>
-<parameter name="clipboard">
-<parameter_description> the #GtkClipboard to paste from
+<parameter name="cell_renderer">
+<parameter_description> A #GtkCellRenderer
</parameter_description>
</parameter>
-<parameter name="override_location">
-<parameter_description> location to insert pasted text, or %NULL for
-at the cursor
+<parameter name="func">
+<parameter_description> The #GtkTreeViewColumnFunc to use.
</parameter_description>
</parameter>
-<parameter name="default_editable">
-<parameter_description> whether the buffer is editable by default
+<parameter name="func_data">
+<parameter_description> The user data for @func.
+</parameter_description>
+</parameter>
+<parameter name="destroy">
+<parameter_description> The destroy notification for @func_data
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_image_new">
+<function name="gtk_tree_view_column_set_clickable">
<description>
-Creates a new empty #GtkImage widget.
-
+Sets the header to be active if @active is %TRUE. When the header is active,
+then it can take keyboard focus, and can be clicked.
</description>
<parameters>
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn.
+</parameter_description>
+</parameter>
+<parameter name="clickable">
+<parameter_description> %TRUE if the header is active.
+</parameter_description>
+</parameter>
</parameters>
-<return> a newly created #GtkImage widget.
-</return>
+<return></return>
</function>
-<function name="gtk_tool_item_group_get_label_widget">
+<function name="gtk_tree_view_column_set_expand">
<description>
-Gets the label widget of @group.
-See gtk_tool_item_group_set_label_widget().
+Sets the column to take available extra space. This space is shared equally
+amongst all columns that have the expand set to %TRUE. If no column has this
+option set, then the last column gets all extra space. By default, every
+column is created with this %FALSE.
-Since: 2.20
+Since: 2.4
</description>
<parameters>
-<parameter name="group">
-<parameter_description> a #GtkToolItemGroup
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn
+</parameter_description>
+</parameter>
+<parameter name="expand">
+<parameter_description> %TRUE if the column should take available extra space, %FALSE if not
</parameter_description>
</parameter>
</parameters>
-<return> the label widget of @group
-
-</return>
+<return></return>
</function>
-<function name="gtk_print_context_create_pango_context">
+<function name="gtk_tree_view_column_set_fixed_width">
<description>
-Creates a new #PangoContext that can be used with the
-#GtkPrintContext.
-
-Since: 2.10
+Sets the size of the column in pixels. This is meaningful only if the sizing
+type is #GTK_TREE_VIEW_COLUMN_FIXED. The size of the column is clamped to
+the min/max width for the column. Please note that the min/max width of the
+column doesn't actually affect the "fixed_width" property of the widget, just
+the actual size when displayed.
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GtkPrintContext
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn.
+</parameter_description>
+</parameter>
+<parameter name="fixed_width">
+<parameter_description> The size to set @tree_column to. Must be greater than 0.
</parameter_description>
</parameter>
</parameters>
-<return> a new Pango context for @context
-
-</return>
+<return></return>
</function>
-<function name="gtk_ui_manager_remove_ui">
+<function name="gtk_tree_view_column_set_max_width">
<description>
-Unmerges the part of @self<!-- -->s content identified by @merge_id.
-
-Since: 2.4
+Sets the maximum width of the @tree_column. If @max_width is -1, then the
+maximum width is unset. Note, the column can actually be wider than max
+width if it's the last column in a view. In this case, the column expands to
+fill any extra space.
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #GtkUIManager object
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn.
</parameter_description>
</parameter>
-<parameter name="merge_id">
-<parameter_description> a merge id as returned by gtk_ui_manager_add_ui_from_string()
+<parameter name="max_width">
+<parameter_description> The maximum width of the column in pixels, or -1.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_factory_remove_default">
+<function name="gtk_tree_view_column_set_min_width">
<description>
-Removes an icon factory from the list of default icon
-factories. Not normally used; you might use it for a library that
-can be unloaded or shut down.
+Sets the minimum width of the @tree_column. If @min_width is -1, then the
+minimum width is unset.
</description>
<parameters>
-<parameter name="factory">
-<parameter_description> a #GtkIconFactory previously added with gtk_icon_factory_add_default()
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn.
+</parameter_description>
+</parameter>
+<parameter name="min_width">
+<parameter_description> The minimum width of the column in pixels, or -1.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_combo_box_set_focus_on_click">
+<function name="gtk_tree_view_column_set_reorderable">
<description>
-Sets whether the combo box will grab focus when it is clicked with
-the mouse. Making mouse clicks not grab focus is useful in places
-like toolbars where you don't want the keyboard focus removed from
-the main area of the application.
-
-Since: 2.6
+If @reorderable is %TRUE, then the column can be reordered by the end user
+dragging the header.
</description>
<parameters>
-<parameter name="combo">
-<parameter_description> a #GtkComboBox
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn
</parameter_description>
</parameter>
-<parameter name="focus_on_click">
-<parameter_description> whether the combo box grabs focus when clicked
-with the mouse
+<parameter name="reorderable">
+<parameter_description> %TRUE, if the column can be reordered.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_container_set_focus_hadjustment">
+<function name="gtk_tree_view_column_set_resizable">
<description>
-Hooks up an adjustment to focus handling in a container, so when a child
-of the container is focused, the adjustment is scrolled to show that
-widget. This function sets the horizontal alignment.
-See gtk_scrolled_window_get_hadjustment() for a typical way of obtaining
-the adjustment and gtk_container_set_focus_vadjustment() for setting
-the vertical adjustment.
-
-The adjustments have to be in pixel units and in the same coordinate
-system as the allocation for immediate children of the container.
+If @resizable is %TRUE, then the user can explicitly resize the column by
+grabbing the outer edge of the column button. If resizable is %TRUE and
+sizing mode of the column is #GTK_TREE_VIEW_COLUMN_AUTOSIZE, then the sizing
+mode is changed to #GTK_TREE_VIEW_COLUMN_GROW_ONLY.
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn
</parameter_description>
</parameter>
-<parameter name="adjustment">
-<parameter_description> an adjustment which should be adjusted when the focus is
-moved among the descendents of @container
+<parameter name="resizable">
+<parameter_description> %TRUE, if the column can be resized
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_mark_get_visible">
+<function name="gtk_tree_view_column_set_sizing">
<description>
-Returns %TRUE if the mark is visible (i.e. a cursor is displayed
-for it).
-
+Sets the growth behavior of @tree_column to @type.
</description>
<parameters>
-<parameter name="mark">
-<parameter_description> a #GtkTextMark
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn.
+</parameter_description>
+</parameter>
+<parameter name="type">
+<parameter_description> The #GtkTreeViewColumnSizing.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if visible
-</return>
+<return></return>
</function>
-<function name="gtk_label_get_track_visited_links">
+<function name="gtk_tree_view_column_set_sort_column_id">
<description>
-Returns whether the label is currently keeping track
-of clicked links.
-
-Since: 2.18
+Sets the logical @sort_column_id that this column sorts on when this column
+is selected for sorting. Doing so makes the column header clickable.
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="tree_column">
+<parameter_description> a #GtkTreeViewColumn
+</parameter_description>
+</parameter>
+<parameter name="sort_column_id">
+<parameter_description> The @sort_column_id of the model to sort on.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if clicked links are remembered
-
-</return>
+<return></return>
</function>
-<function name="gtk_status_icon_set_name">
+<function name="gtk_tree_view_column_set_sort_indicator">
<description>
-Sets the name of this tray icon.
-This should be a string identifying this icon. It is may be
-used for sorting the icons in the tray and will not be shown to
-the user.
+Call this function with a @setting of %TRUE to display an arrow in
+the header button indicating the column is sorted. Call
+gtk_tree_view_column_set_sort_order() to change the direction of
+the arrow.
-Since: 2.20
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
+<parameter name="tree_column">
+<parameter_description> a #GtkTreeViewColumn
</parameter_description>
</parameter>
-<parameter name="name">
-<parameter_description> the name
+<parameter name="setting">
+<parameter_description> %TRUE to display an indicator that the column is sorted
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_get_modifier_style">
+<function name="gtk_tree_view_column_set_sort_order">
<description>
-Returns the current modifier style for the widget. (As set by
-gtk_widget_modify_style().) If no style has previously set, a new
-#GtkRcStyle will be created with all values unset, and set as the
-modifier style for the widget. If you make changes to this rc
-style, you must call gtk_widget_modify_style(), passing in the
-returned rc style, to make sure that your changes take effect.
+Changes the appearance of the sort indicator.
-Caution: passing the style back to gtk_widget_modify_style() will
-normally end up destroying it, because gtk_widget_modify_style() copies
-the passed-in style and sets the copy as the new modifier style,
-thus dropping any reference to the old modifier style. Add a reference
-to the modifier style if you want to keep it alive.
+This <emphasis>does not</emphasis> actually sort the model. Use
+gtk_tree_view_column_set_sort_column_id() if you want automatic sorting
+support. This function is primarily for custom sorting behavior, and should
+be used in conjunction with gtk_tree_sortable_set_sort_column() to do
+that. For custom models, the mechanism will vary.
+The sort indicator changes direction to indicate normal sort or reverse sort.
+Note that you must have the sort indicator enabled to see anything when
+calling this function; see gtk_tree_view_column_set_sort_indicator().
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="tree_column">
+<parameter_description> a #GtkTreeViewColumn
+</parameter_description>
+</parameter>
+<parameter name="order">
+<parameter_description> sort order that the sort indicator should indicate
</parameter_description>
</parameter>
</parameters>
-<return> the modifier style for the widget. This rc style is
-owned by the widget. If you want to keep a pointer to value this
-around, you must add a refcount using g_object_ref().
-</return>
+<return></return>
</function>
-<function name="gtk_window_get_frame_dimensions">
+<function name="gtk_tree_view_column_set_spacing">
<description>
-(Note: this is a special-purpose function intended for the
-framebuffer port; see gtk_window_set_has_frame(). It will not
-return the size of the window border drawn by the <link
-linkend="gtk-X11-arch">window manager</link>, which is the normal
-case when using a windowing system. See
-gdk_window_get_frame_extents() to get the standard window border
-extents.)
-
-Retrieves the dimensions of the frame window for this toplevel.
-See gtk_window_set_has_frame(), gtk_window_set_frame_dimensions().
+Sets the spacing field of @tree_column, which is the number of pixels to
+place between cell renderers packed into it.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
-</parameter_description>
-</parameter>
-<parameter name="left">
-<parameter_description> location to store the width of the frame at the left, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="top">
-<parameter_description> location to store the height of the frame at the top, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="right">
-<parameter_description> location to store the width of the frame at the returns, or %NULL
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn.
</parameter_description>
</parameter>
-<parameter name="bottom">
-<parameter_description> location to store the height of the frame at the bottom, or %NULL
+<parameter name="spacing">
+<parameter_description> distance between cell renderers in pixels.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_file_chooser_set_select_multiple">
+<function name="gtk_tree_view_column_set_title">
<description>
-Sets whether multiple files can be selected in the file selector. This is
-only relevant if the action is set to be %GTK_FILE_CHOOSER_ACTION_OPEN or
-%GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER.
-
-Since: 2.4
+Sets the title of the @tree_column. If a custom widget has been set, then
+this value is ignored.
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn.
</parameter_description>
</parameter>
-<parameter name="select_multiple">
-<parameter_description> %TRUE if multiple files can be selected.
+<parameter name="title">
+<parameter_description> The title of the @tree_column.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_status_icon_new">
-<description>
-Creates an empty status icon object.
-
-Since: 2.10
-
-</description>
-<parameters>
-</parameters>
-<return> a new #GtkStatusIcon
-
-</return>
-</function>
-
-<function name="gtk_show_uri">
+<function name="gtk_tree_view_column_set_visible">
<description>
-This is a convenience function for launching the default application
-to show the uri. The uri must be of a form understood by GIO. Typical
-examples are
-<simplelist>
-<member><filename>file:///home/gnome/pict.jpg</filename></member>
-<member><filename>http://www.gnome.org</filename></member>
-<member><filename>mailto:me gnome org</filename></member>
-</simplelist>
-Ideally the timestamp is taken from the event triggering
-the gtk_show_uri() call. If timestamp is not known you can take
-%GDK_CURRENT_TIME.
-
-This function can be used as a replacement for gnome_vfs_url_show()
-and gnome_url_show().
-
-Since: 2.14
+Sets the visibility of @tree_column.
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> screen to show the uri on or %NULL for the default screen
-</parameter_description>
-</parameter>
-<parameter name="uri">
-<parameter_description> the uri to show
-</parameter_description>
-</parameter>
-<parameter name="timestamp">
-<parameter_description> a timestamp to prevent focus stealing.
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn.
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> a #GError that is returned in case of errors
+<parameter name="visible">
+<parameter_description> %TRUE if the @tree_column is visible.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE on success, %FALSE on error.
-
-</return>
+<return></return>
</function>
-<function name="gtk_entry_get_icon_sensitive">
+<function name="gtk_tree_view_column_set_widget">
<description>
-Returns whether the icon appears sensitive or insensitive.
-
-Since: 2.16
+Sets the widget in the header to be @widget. If widget is %NULL, then the
+header button is set with a #GtkLabel set to the title of @tree_column.
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="tree_column">
+<parameter_description> A #GtkTreeViewColumn.
</parameter_description>
</parameter>
-<parameter name="icon_pos">
-<parameter_description> Icon position
+<parameter name="widget">
+<parameter_description> A child #GtkWidget, or %NULL.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the icon is sensitive.
-
-</return>
+<return></return>
</function>
-<function name="gtk_widget_queue_resize">
+<function name="gtk_tree_view_columns_autosize">
<description>
-This function is only for use in widget implementations.
-Flags a widget to have its size renegotiated; should
-be called when a widget for some reason has a new size request.
-For example, when you change the text in a #GtkLabel, #GtkLabel
-queues a resize to ensure there's enough space for the new text.
+Resizes all columns to their optimal width. Only works after the
+treeview has been realized.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_store_move_before">
+<function name="gtk_tree_view_convert_bin_window_to_tree_coords">
<description>
-Moves @iter in @tree_store to the position before @position. @iter and
- position should be in the same level. Note that this function only
-works with unsorted stores. If @position is %NULL, @iter will be
-moved to the end of the level.
+Converts bin_window coordinates to coordinates for the
+tree (the full scrollable area of the tree).
-Since: 2.2
+Since: 2.12
</description>
<parameters>
-<parameter name="tree_store">
-<parameter_description> A #GtkTreeStore.
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> A #GtkTreeIter.
+<parameter name="bx">
+<parameter_description> X coordinate relative to bin_window
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> A #GtkTreeIter or %NULL.
+<parameter name="by">
+<parameter_description> Y coordinate relative to bin_window
+</parameter_description>
+</parameter>
+<parameter name="tx">
+<parameter_description> return location for tree X coordinate
+</parameter_description>
+</parameter>
+<parameter name="ty">
+<parameter_description> return location for tree Y coordinate
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_image_get_storage_type">
+<function name="gtk_tree_view_convert_bin_window_to_widget_coords">
<description>
-Gets the type of representation being used by the #GtkImage
-to store image data. If the #GtkImage has no image data,
-the return value will be %GTK_IMAGE_EMPTY.
+Converts bin_window coordinates (see gtk_tree_view_get_bin_window())
+to widget relative coordinates.
+Since: 2.12
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GtkImage
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
-</parameters>
-<return> image representation being used
-</return>
-</function>
-
-<function name="gtk_tree_view_column_get_max_width">
-<description>
-Returns the maximum width in pixels of the @tree_column, or -1 if no maximum
-width is set.
-
-
-</description>
-<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn.
+<parameter name="bx">
+<parameter_description> bin_window X coordinate
</parameter_description>
</parameter>
-</parameters>
-<return> The maximum width of the @tree_column.
-</return>
-</function>
-
-<function name="gtk_tool_item_group_get_item_position">
-<description>
-Gets the position of @item in @group as index.
-
-Since: 2.20
-
-</description>
-<parameters>
-<parameter name="group">
-<parameter_description> a #GtkToolItemGroup
+<parameter name="by">
+<parameter_description> bin_window Y coordinate
</parameter_description>
</parameter>
-<parameter name="item">
-<parameter_description> a #GtkToolItem
+<parameter name="wx">
+<parameter_description> return location for widget X coordinate
+</parameter_description>
+</parameter>
+<parameter name="wy">
+<parameter_description> return location for widget Y coordinate
</parameter_description>
</parameter>
</parameters>
-<return> the index of @item in @group or -1 if @item is no child of @group
-
-</return>
+<return></return>
</function>
-<function name="gtk_list_store_newv">
+<function name="gtk_tree_view_convert_tree_to_bin_window_coords">
<description>
-Non-vararg creation function. Used primarily by language bindings.
+Converts tree coordinates (coordinates in full scrollable area of the tree)
+to bin_window coordinates.
+Since: 2.12
</description>
<parameters>
-<parameter name="n_columns">
-<parameter_description> number of columns in the list store
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="types">
-<parameter_description> an array of #GType types for the columns, from first to last
+<parameter name="tx">
+<parameter_description> tree X coordinate
+</parameter_description>
+</parameter>
+<parameter name="ty">
+<parameter_description> tree Y coordinate
+</parameter_description>
+</parameter>
+<parameter name="bx">
+<parameter_description> return location for X coordinate relative to bin_window
+</parameter_description>
+</parameter>
+<parameter name="by">
+<parameter_description> return location for Y coordinate relative to bin_window
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkListStore
-</return>
+<return></return>
</function>
-<function name="gtk_print_operation_run">
+<function name="gtk_tree_view_convert_tree_to_widget_coords">
<description>
-Runs the print operation, by first letting the user modify
-print settings in the print dialog, and then print the document.
-
-Normally that this function does not return until the rendering of all
-pages is complete. You can connect to the
-#GtkPrintOperation::status-changed signal on @op to obtain some
-information about the progress of the print operation.
-Furthermore, it may use a recursive mainloop to show the print dialog.
-
-If you call gtk_print_operation_set_allow_async() or set the
-#GtkPrintOperation:allow-async property the operation will run
-asynchronously if this is supported on the platform. The
-#GtkPrintOperation::done signal will be emitted with the result of the
-operation when the it is done (i.e. when the dialog is canceled, or when
-the print succeeds or fails).
-|[
-if (settings != NULL)
-gtk_print_operation_set_print_settings (print, settings);
-
-if (page_setup != NULL)
-gtk_print_operation_set_default_page_setup (print, page_setup);
-
-g_signal_connect (print, "begin-print",
-G_CALLBACK (begin_print), &data);
-g_signal_connect (print, "draw-page",
-G_CALLBACK (draw_page), &data);
-
-res = gtk_print_operation_run (print,
-GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG,
-parent,
-&error);
-
-if (res == GTK_PRINT_OPERATION_RESULT_ERROR)
-{
-error_dialog = gtk_message_dialog_new (GTK_WINDOW (parent),
-GTK_DIALOG_DESTROY_WITH_PARENT,
-GTK_MESSAGE_ERROR,
-GTK_BUTTONS_CLOSE,
-"Error printing file:\n%s",
-error->message);
-g_signal_connect (error_dialog, "response",
-G_CALLBACK (gtk_widget_destroy), NULL);
-gtk_widget_show (error_dialog);
-g_error_free (error);
-}
-else if (res == GTK_PRINT_OPERATION_RESULT_APPLY)
-{
-if (settings != NULL)
-g_object_unref (settings);
-settings = g_object_ref (gtk_print_operation_get_print_settings (print));
-}
-]|
-
-Note that gtk_print_operation_run() can only be called once on a
-given #GtkPrintOperation.
+Converts tree coordinates (coordinates in full scrollable area of the tree)
+to widget coordinates.
-Since: 2.10
+Since: 2.12
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="action">
-<parameter_description> the action to start
+<parameter name="tx">
+<parameter_description> X coordinate relative to the tree
</parameter_description>
</parameter>
-<parameter name="parent">
-<parameter_description> Transient parent of the dialog
+<parameter name="ty">
+<parameter_description> Y coordinate relative to the tree
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> Return location for errors, or %NULL
+<parameter name="wx">
+<parameter_description> return location for widget X coordinate
</parameter_description>
</parameter>
-</parameters>
-<return> the result of the print operation. A return value of
-%GTK_PRINT_OPERATION_RESULT_APPLY indicates that the printing was
-completed successfully. In this case, it is a good idea to obtain
-the used print settings with gtk_print_operation_get_print_settings()
-and store them for reuse with the next print operation. A value of
-%GTK_PRINT_OPERATION_RESULT_IN_PROGRESS means the operation is running
-asynchronously, and will emit the #GtkPrintOperation::done signal when
-done.
-
-</return>
-</function>
-
-<function name="gtk_notebook_popup_enable">
-<description>
-Enables the popup menu: if the user clicks with the right mouse button on
-the tab labels, a menu with all the pages will be popped up.
-
-</description>
-<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="wy">
+<parameter_description> return location for widget Y coordinate
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_entry_set_icon_drag_source">
+<function name="gtk_tree_view_convert_widget_to_bin_window_coords">
<description>
-Sets up the icon at the given position so that GTK+ will start a drag
-operation when the user clicks and drags the icon.
-
-To handle the drag operation, you need to connect to the usual
-#GtkWidget::drag-data-get (or possibly #GtkWidget::drag-data-delete)
-signal, and use gtk_entry_get_current_icon_drag_source() in
-your signal handler to find out if the drag was started from
-an icon.
-
-By default, GTK+ uses the icon as the drag icon. You can use the
-#GtkWidget::drag-begin signal to set a different icon. Note that you
-have to use g_signal_connect_after() to ensure that your signal handler
-gets executed after the default handler.
+Converts widget coordinates to coordinates for the bin_window
+(see gtk_tree_view_get_bin_window()).
-Since: 2.16
+Since: 2.12
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkIconEntry
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="icon_pos">
-<parameter_description> icon position
+<parameter name="wx">
+<parameter_description> X coordinate relative to the widget
</parameter_description>
</parameter>
-<parameter name="target_list">
-<parameter_description> the targets (data formats) in which the data can be provided
+<parameter name="wy">
+<parameter_description> Y coordinate relative to the widget
</parameter_description>
</parameter>
-<parameter name="actions">
-<parameter_description> a bitmask of the allowed drag actions
+<parameter name="bx">
+<parameter_description> return location for bin_window X coordinate
+</parameter_description>
+</parameter>
+<parameter name="by">
+<parameter_description> return location for bin_window Y coordinate
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_hscale_new_with_range">
+<function name="gtk_tree_view_convert_widget_to_tree_coords">
<description>
-Creates a new horizontal scale widget that lets the user input a
-number between @min and @max (including @min and @max) with the
-increment @step. @step must be nonzero; it's the distance the
-slider moves when using the arrow keys to adjust the scale value.
-
-Note that the way in which the precision is derived works best if @step
-is a power of ten. If the resulting precision is not suitable for your
-needs, use gtk_scale_set_digits() to correct it.
+Converts widget coordinates to coordinates for the
+tree (the full scrollable area of the tree).
+Since: 2.12
</description>
<parameters>
-<parameter name="min">
-<parameter_description> minimum value
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="max">
-<parameter_description> maximum value
+<parameter name="wx">
+<parameter_description> X coordinate relative to the widget
</parameter_description>
</parameter>
-<parameter name="step">
-<parameter_description> step increment (tick size) used with keyboard shortcuts
+<parameter name="wy">
+<parameter_description> Y coordinate relative to the widget
</parameter_description>
</parameter>
-</parameters>
-<return> a new #GtkHScale
-</return>
-</function>
-
-<function name="gtk_recent_chooser_add_filter">
-<description>
-Adds @filter to the list of #GtkRecentFilter objects held by @chooser.
-
-If no previous filter objects were defined, this function will call
-gtk_recent_chooser_set_filter().
-
-Since: 2.10
-
-</description>
-<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
+<parameter name="tx">
+<parameter_description> return location for tree X coordinate
</parameter_description>
</parameter>
-<parameter name="filter">
-<parameter_description> a #GtkRecentFilter
+<parameter name="ty">
+<parameter_description> return location for tree Y coordinate
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_model_get_column_type">
+<function name="gtk_tree_view_create_row_drag_icon">
<description>
-Returns the type of the column.
+Creates a #GdkPixmap representation of the row at @path.
+This image is used for a drag icon.
</description>
<parameters>
-<parameter name="tree_model">
-<parameter_description> A #GtkTreeModel.
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="index_">
-<parameter_description> The column index.
+<parameter name="path">
+<parameter_description> a #GtkTreePath in @tree_view
</parameter_description>
</parameter>
</parameters>
-<return> The type of the column.
+<return> a newly-allocated pixmap of the drag icon.
</return>
</function>
-<function name="gtk_toolbar_insert_space">
+<function name="gtk_tree_view_enable_model_drag_dest">
<description>
-Inserts a new space in the toolbar at the specified position.
-
-Deprecated: 2.4: Use gtk_toolbar_insert() instead.
+Turns @tree_view into a drop destination for automatic DND. Calling
+this method sets #GtkTreeView:reorderable to %FALSE.
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> the number of widgets after which a space should be inserted.
+<parameter name="targets">
+<parameter_description> the table of targets that the drag will support
+</parameter_description>
+</parameter>
+<parameter name="n_targets">
+<parameter_description> the number of items in @targets
+</parameter_description>
+</parameter>
+<parameter name="actions">
+<parameter_description> the bitmask of possible actions for a drag from this
+widget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_theme_list_icons">
+<function name="gtk_tree_view_enable_model_drag_source">
<description>
-Lists the icons in the current icon theme. Only a subset
-of the icons can be listed by providing a context string.
-The set of values for the context string is system dependent,
-but will typically include such values as "Applications" and
-"MimeTypes".
-
-Since: 2.4
+Turns @tree_view into a drag source for automatic DND. Calling this
+method sets #GtkTreeView:reorderable to %FALSE.
</description>
<parameters>
-<parameter name="icon_theme">
-<parameter_description> a #GtkIconTheme
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="context">
-<parameter_description> a string identifying a particular type of icon,
-or %NULL to list all icons.
+<parameter name="start_button_mask">
+<parameter_description> Mask of allowed buttons to start drag
</parameter_description>
</parameter>
-</parameters>
-<return> a #GList list holding the names of all the
-icons in the theme. You must first free each element
-in the list with g_free(), then free the list itself
-with g_list_free().
-
-</return>
-</function>
-
-<function name="gtk_icon_view_create_drag_icon">
-<description>
-Creates a #GdkPixmap representation of the item at @path.
-This image is used for a drag icon.
-
-Since: 2.8
-
-</description>
-<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
+<parameter name="targets">
+<parameter_description> the table of targets that the drag will support
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> a #GtkTreePath in @icon_view
+<parameter name="n_targets">
+<parameter_description> the number of items in @targets
+</parameter_description>
+</parameter>
+<parameter name="actions">
+<parameter_description> the bitmask of possible actions for a drag from this
+widget
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated pixmap of the drag icon.
-
-</return>
+<return></return>
</function>
-<function name="gtk_selection_data_get_pixbuf">
+<function name="gtk_tree_view_expand_all">
<description>
-Gets the contents of the selection data as a #GdkPixbuf.
-
-Since: 2.6
+Recursively expands all nodes in the @tree_view.
</description>
<parameters>
-<parameter name="selection_data">
-<parameter_description> a #GtkSelectionData
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView.
</parameter_description>
</parameter>
</parameters>
-<return> if the selection data contained a recognized
-image type and it could be converted to a #GdkPixbuf, a
-newly allocated pixbuf is returned, otherwise %NULL.
-If the result is non-%NULL it must be freed with g_object_unref().
-
-</return>
+<return></return>
</function>
-<function name="gtk_entry_get_icon_activatable">
+<function name="gtk_tree_view_expand_row">
<description>
-Returns whether the icon is activatable.
+Opens the row so its children are visible.
-Since: 2.16
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="icon_pos">
-<parameter_description> Icon position
+<parameter name="path">
+<parameter_description> path to a row
+</parameter_description>
+</parameter>
+<parameter name="open_all">
+<parameter_description> whether to recursively expand, or just expand immediate children
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the icon is activatable.
-
+<return> %TRUE if the row existed and had children
</return>
</function>
-<function name="gtk_status_icon_get_tooltip_markup">
+<function name="gtk_tree_view_expand_to_path">
<description>
-Gets the contents of the tooltip for @status_icon.
+Expands the row at @path. This will also expand all parent rows of
+ path as necessary.
-Since: 2.16
+Since: 2.2
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView.
+</parameter_description>
+</parameter>
+<parameter name="path">
+<parameter_description> path to a row.
</parameter_description>
</parameter>
</parameters>
-<return> the tooltip text, or %NULL. You should free the
-returned string with g_free() when done.
-
-</return>
+<return></return>
</function>
-<function name="gtk_accel_groups_activate">
+<function name="gtk_tree_view_get_background_area">
<description>
-Finds the first accelerator in any #GtkAccelGroup attached
-to @object that matches @accel_key and @accel_mods, and
-activates that accelerator.
+Fills the bounding rectangle in bin_window coordinates for the cell at the
+row specified by @path and the column specified by @column. If @path is
+%NULL, or points to a node not found in the tree, the @y and @height fields of
+the rectangle will be filled with 0. If @column is %NULL, the @x and @width
+fields will be filled with 0. The returned rectangle is equivalent to the
+ background_area passed to gtk_cell_renderer_render(). These background
+areas tile to cover the entire bin window. Contrast with the @cell_area,
+returned by gtk_tree_view_get_cell_area(), which returns only the cell
+itself, excluding surrounding borders and the tree expander area.
</description>
<parameters>
-<parameter name="object">
-<parameter_description> the #GObject, usually a #GtkWindow, on which
-to activate the accelerator.
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="accel_key">
-<parameter_description> accelerator keyval from a key event
+<parameter name="path">
+<parameter_description> a #GtkTreePath for the row, or %NULL to get only horizontal coordinates
</parameter_description>
</parameter>
-<parameter name="accel_mods">
-<parameter_description> keyboard state mask from a key event
+<parameter name="column">
+<parameter_description> a #GtkTreeViewColumn for the column, or %NULL to get only vertical coordiantes
+</parameter_description>
+</parameter>
+<parameter name="rect">
+<parameter_description> rectangle to fill with cell background rect
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if an accelerator was activated and handled this keypress
-</return>
+<return></return>
</function>
-<function name="gtk_ui_manager_get_action_groups">
+<function name="gtk_tree_view_get_bin_window">
<description>
-Returns the list of action groups associated with @self.
+Returns the window that @tree_view renders to.
+This is used primarily to compare to <literal>event->window</literal>
+to confirm that the event on @tree_view is on the right window.
-Since: 2.4
</description>
<parameters>
-<parameter name="self">
-<parameter_description> a #GtkUIManager object
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView
</parameter_description>
</parameter>
</parameters>
-<return> a #GList of
-action groups. The list is owned by GTK+
-and should not be modified.
-
+<return> A #GdkWindow, or %NULL when @tree_view
+hasn't been realized yet
</return>
</function>
-<function name="gtk_selection_data_set">
+<function name="gtk_tree_view_get_cell_area">
<description>
-Stores new data into a #GtkSelectionData object. Should
-<emphasis>only</emphasis> be called from a selection handler callback.
-Zero-terminates the stored data.
+Fills the bounding rectangle in bin_window coordinates for the cell at the
+row specified by @path and the column specified by @column. If @path is
+%NULL, or points to a path not currently displayed, the @y and @height fields
+of the rectangle will be filled with 0. If @column is %NULL, the @x and @width
+fields will be filled with 0. The sum of all cell rects does not cover the
+entire tree; there are extra pixels in between rows, for example. The
+returned rectangle is equivalent to the @cell_area passed to
+gtk_cell_renderer_render(). This function is only valid if @tree_view is
+realized.
</description>
<parameters>
-<parameter name="selection_data">
-<parameter_description> a pointer to a #GtkSelectionData structure.
-</parameter_description>
-</parameter>
-<parameter name="type">
-<parameter_description> the type of selection data
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="format">
-<parameter_description> format (number of bits in a unit)
+<parameter name="path">
+<parameter_description> a #GtkTreePath for the row, or %NULL to get only horizontal coordinates
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> pointer to the data (will be copied)
+<parameter name="column">
+<parameter_description> a #GtkTreeViewColumn for the column, or %NULL to get only vertical coordinates
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> length of the data
+<parameter name="rect">
+<parameter_description> rectangle to fill with cell rect
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_builder_connect_signals">
+<function name="gtk_tree_view_get_column">
<description>
-This method is a simpler variation of gtk_builder_connect_signals_full().
-It uses #GModule's introspective features (by opening the module %NULL)
-to look at the application's symbol table. From here it tries to match
-the signal handler names given in the interface description with
-symbols in the application and connects the signals.
-
-Note that this function will not work correctly if #GModule is not
-supported on the platform.
-
-When compiling applications for Windows, you must declare signal callbacks
-with #G_MODULE_EXPORT, or they will not be put in the symbol table.
-On Linux and Unices, this is not necessary; applications should instead
-be compiled with the -Wl,--export-dynamic CFLAGS, and linked against
-gmodule-export-2.0.
+Gets the #GtkTreeViewColumn at the given position in the #tree_view.
-Since: 2.12
</description>
<parameters>
-<parameter name="builder">
-<parameter_description> a #GtkBuilder
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView.
</parameter_description>
</parameter>
-<parameter name="user_data">
-<parameter_description> a pointer to a structure sent in as user data to all signals
+<parameter name="n">
+<parameter_description> The position of the column, counting from 0.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The #GtkTreeViewColumn, or %NULL if the
+position is outside the range of columns.
+</return>
</function>
-<function name="gtk_button_set_use_stock">
+<function name="gtk_tree_view_get_columns">
<description>
-If %TRUE, the label set on the button is used as a
-stock id to select the stock item for the button.
+Returns a #GList of all the #GtkTreeViewColumn s currently in @tree_view.
+The returned list must be freed with g_list_free ().
+
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkButton
-</parameter_description>
-</parameter>
-<parameter name="use_stock">
-<parameter_description> %TRUE if the button should use a stock item
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A list of #GtkTreeViewColumn s
+</return>
</function>
-<function name="gtk_notebook_get_menu_label_text">
+<function name="gtk_tree_view_get_cursor">
<description>
-Retrieves the text of the menu label for the page containing
- child
+Fills in @path and @focus_column with the current path and focus column. If
+the cursor isn't currently set, then * path will be %NULL. If no column
+currently has focus, then * focus_column will be %NULL.
+The returned #GtkTreePath must be freed with gtk_tree_path_free() when
+you are done with it.
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="child">
-<parameter_description> the child widget of a page of the notebook.
+<parameter name="path">
+<parameter_description> A pointer to be filled with the current cursor path, or %NULL
</parameter_description>
</parameter>
-</parameters>
-<return> the text of the tab label, or %NULL if the
-widget does not have a menu label other than
-the default menu label, or the menu label widget
-is not a #GtkLabel. The string is owned by
-the widget and must not be freed.
-</return>
-</function>
-
-<function name="gtk_tool_item_get_expand">
-<description>
-Returns whether @tool_item is allocated extra space.
-See gtk_tool_item_set_expand().
-
-Since: 2.4
-
-</description>
-<parameters>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem
+<parameter name="focus_column">
+<parameter_description> A pointer to be filled with the current focus column, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @tool_item is allocated extra space.
-
-</return>
+<return></return>
</function>
-<function name="gtk_radio_tool_button_get_group">
+<function name="gtk_tree_view_get_dest_row_at_pos">
<description>
-Returns the radio button group @button belongs to.
+Determines the destination row for a given position. @drag_x and
+ drag_y are expected to be in widget coordinates. This function is only
+meaningful if @tree_view is realized. Therefore this function will always
+return %FALSE if @tree_view is not realized or does not have a model.
-Since: 2.4
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkRadioToolButton
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
+</parameter_description>
+</parameter>
+<parameter name="drag_x">
+<parameter_description> the position to determine the destination row for
+</parameter_description>
+</parameter>
+<parameter name="drag_y">
+<parameter_description> the position to determine the destination row for
+</parameter_description>
+</parameter>
+<parameter name="path">
+<parameter_description> Return location for the path of the highlighted row, or %NULL.
+</parameter_description>
+</parameter>
+<parameter name="pos">
+<parameter_description> Return location for the drop position, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> The group @button belongs to.
-
+<return> whether there is a row at the given position, %TRUE if this
+is indeed the case.
</return>
</function>
-<function name="gtk_about_dialog_set_logo">
+<function name="gtk_tree_view_get_drag_dest_row">
<description>
-Sets the pixbuf to be displayed as logo in the about dialog.
-If it is %NULL, the default window icon set with
-gtk_window_set_default_icon() will be used.
-
-Since: 2.6
+Gets information about the row that is highlighted for feedback.
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="logo">
-<parameter_description> a #GdkPixbuf, or %NULL
+<parameter name="path">
+<parameter_description> Return location for the path of the highlighted row, or %NULL.
+</parameter_description>
+</parameter>
+<parameter name="pos">
+<parameter_description> Return location for the drop position, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_page_setup_copy">
+<function name="gtk_tree_view_get_enable_search">
<description>
-Copies a #GtkPageSetup.
+Returns whether or not the tree allows to start interactive searching
+by typing in text.
-Since: 2.10
</description>
<parameters>
-<parameter name="other">
-<parameter_description> the #GtkPageSetup to copy
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView
</parameter_description>
</parameter>
</parameters>
-<return> a copy of @other
-
+<return> whether or not to let the user search interactively
</return>
</function>
-<function name="gtk_custom_paper_unix_dialog_new">
+<function name="gtk_tree_view_get_enable_tree_lines">
<description>
-Creates a new custom paper dialog.
+Returns whether or not tree lines are drawn in @tree_view.
-Since: 2.18
+Since: 2.10
</description>
<parameters>
-<parameter name="title">
-<parameter_description> the title of the dialog, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="parent">
-<parameter_description> transient parent of the dialog, or %NULL
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView.
</parameter_description>
</parameter>
</parameters>
-<return> the new #GtkCustomPaperUnixDialog
+<return> %TRUE if tree lines are drawn in @tree_view, %FALSE
+otherwise.
</return>
</function>
-<function name="gtk_size_group_get_mode">
+<function name="gtk_tree_view_get_expander_column">
<description>
-Gets the current mode of the size group. See gtk_size_group_set_mode().
+Returns the column that is the current expander column.
+This column has the expander arrow drawn next to it.
</description>
<parameters>
-<parameter name="size_group">
-<parameter_description> a #GtkSizeGroup
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView
</parameter_description>
</parameter>
</parameters>
-<return> the current mode of the size group.
+<return> The expander column.
</return>
</function>
-<function name="gtk_widget_get_sensitive">
+<function name="gtk_tree_view_get_fixed_height_mode">
<description>
-Returns the widget's sensitivity (in the sense of returning
-the value that has been set using gtk_widget_set_sensitive()).
-
-The effective sensitivity of a widget is however determined by both its
-own and its parent widget's sensitivity. See gtk_widget_is_sensitive().
+Returns whether fixed height mode is turned on for @tree_view.
-Since: 2.18
+Since: 2.6
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the widget is sensitive
+<return> %TRUE if @tree_view is in fixed height mode
</return>
</function>
-<function name="gtk_tree_view_get_model">
+<function name="gtk_tree_view_get_grid_lines">
<description>
-Returns the model the #GtkTreeView is based on. Returns %NULL if the
-model is unset.
+Returns which grid lines are enabled in @tree_view.
+Since: 2.10
</description>
<parameters>
@@ -60962,1190 +61271,916 @@ model is unset.
</parameter_description>
</parameter>
</parameters>
-<return> A #GtkTreeModel, or %NULL if none is currently being used.
+<return> a #GtkTreeViewGridLines value indicating which grid lines
+are enabled.
+
</return>
</function>
-<function name="gtk_label_get_max_width_chars">
+<function name="gtk_tree_view_get_hadjustment">
<description>
-Retrieves the desired maximum width of @label, in characters. See
-gtk_label_set_width_chars().
+Gets the #GtkAdjustment currently being used for the horizontal aspect.
-Since: 2.6
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView
</parameter_description>
</parameter>
</parameters>
-<return> the maximum width of the label in characters.
-
+<return> A #GtkAdjustment object, or %NULL
+if none is currently being used.
</return>
</function>
-<function name="gtk_paint_shadow">
+<function name="gtk_tree_view_get_headers_clickable">
<description>
-Draws a shadow around the given rectangle in @window
-using the given style and state and shadow type.
+Returns whether all header columns are clickable.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
-</parameter_description>
-</parameter>
-<parameter name="shadow_type">
-<parameter_description> type of shadow to draw
-</parameter_description>
-</parameter>
-<parameter name="area">
-<parameter_description> clip rectangle or %NULL if the
-output should not be clipped
-</parameter_description>
-</parameter>
-<parameter name="widget">
-<parameter_description> the widget
-</parameter_description>
-</parameter>
-<parameter name="detail">
-<parameter_description> a style detail
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> x origin of the rectangle
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> y origin of the rectangle
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> width of the rectangle
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> width of the rectangle
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if all header columns are clickable, otherwise %FALSE
+
+</return>
</function>
-<function name="gtk_accel_label_refetch">
+<function name="gtk_tree_view_get_headers_visible">
<description>
-Recreates the string representing the accelerator keys.
-This should not be needed since the string is automatically updated whenever
-accelerators are added or removed from the associated widget.
+Returns %TRUE if the headers on the @tree_view are visible.
</description>
<parameters>
-<parameter name="accel_label">
-<parameter_description> a #GtkAccelLabel.
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView.
</parameter_description>
</parameter>
</parameters>
-<return> always returns %FALSE.
+<return> Whether the headers are visible or not.
</return>
</function>
-<function name="gtk_button_get_focus_on_click">
+<function name="gtk_tree_view_get_hover_expand">
<description>
-Returns whether the button grabs focus when it is clicked with the mouse.
-See gtk_button_set_focus_on_click().
+Returns whether hover expansion mode is turned on for @tree_view.
-Since: 2.4
+Since: 2.6
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkButton
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the button grabs focus when it is clicked with
-the mouse.
+<return> %TRUE if @tree_view is in hover expansion mode
</return>
</function>
-<function name="gtk_entry_completion_get_popup_single_match">
+<function name="gtk_tree_view_get_hover_selection">
<description>
-Returns whether the completion popup window will appear even if there is
-only a single match.
+Returns whether hover selection mode is turned on for @tree_view.
-Since: 2.8
+Since: 2.6
</description>
<parameters>
-<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the popup window will appear regardless of the
-number of matches.
+<return> %TRUE if @tree_view is in hover selection mode
</return>
</function>
-<function name="gtk_tool_shell_get_text_size_group">
+<function name="gtk_tree_view_get_level_indentation">
<description>
-Retrieves the current text size group for the tool shell. Tool items must not
-call this function directly, but rely on gtk_tool_item_get_text_size_group()
-instead.
+Returns the amount, in pixels, of extra indentation for child levels
+in @tree_view.
-Since: 2.20
+Since: 2.12
</description>
<parameters>
-<parameter name="shell">
-<parameter_description> a #GtkToolShell
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView.
</parameter_description>
</parameter>
</parameters>
-<return> the current text size group of @shell
+<return> the amount of extra indentation for child levels in
+ tree_view A return value of 0 means that this feature is disabled.
</return>
</function>
-<function name="gtk_tool_item_set_tooltip">
+<function name="gtk_tree_view_get_model">
<description>
-Sets the #GtkTooltips object to be used for @tool_item, the
-text to be displayed as tooltip on the item and the private text
-to be used. See gtk_tooltips_set_tip().
-
-Since: 2.4
+Returns the model the #GtkTreeView is based on. Returns %NULL if the
+model is unset.
-Deprecated: 2.12: Use gtk_tool_item_set_tooltip_text() instead.
</description>
<parameters>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem
-</parameter_description>
-</parameter>
-<parameter name="tooltips">
-<parameter_description> The #GtkTooltips object to be used
-</parameter_description>
-</parameter>
-<parameter name="tip_text">
-<parameter_description> text to be used as tooltip text for @tool_item
-</parameter_description>
-</parameter>
-<parameter name="tip_private">
-<parameter_description> text to be used as private tooltip text
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A #GtkTreeModel, or %NULL if none is currently being used.
+</return>
</function>
-<function name="gtk_icon_theme_load_icon">
+<function name="gtk_tree_view_get_path_at_pos">
<description>
-Looks up an icon in an icon theme, scales it to the given size
-and renders it into a pixbuf. This is a convenience function;
-if more details about the icon are needed, use
-gtk_icon_theme_lookup_icon() followed by gtk_icon_info_load_icon().
+Finds the path at the point (@x, @y), relative to bin_window coordinates
+(please see gtk_tree_view_get_bin_window()).
+That is, @x and @y are relative to an events coordinates. @x and @y must
+come from an event on the @tree_view only where <literal>event->window ==
+gtk_tree_view_get_bin_window (<!-- -->)</literal>. It is primarily for
+things like popup menus. If @path is non-%NULL, then it will be filled
+with the #GtkTreePath at that point. This path should be freed with
+gtk_tree_path_free(). If @column is non-%NULL, then it will be filled
+with the column at that point. @cell_x and @cell_y return the coordinates
+relative to the cell background (i.e. the @background_area passed to
+gtk_cell_renderer_render()). This function is only meaningful if
+ tree_view is realized. Therefore this function will always return %FALSE
+if @tree_view is not realized or does not have a model.
-Note that you probably want to listen for icon theme changes and
-update the icon. This is usually done by connecting to the
-GtkWidget::style-set signal. If for some reason you do not want to
-update the icon when the icon theme changes, you should consider
-using gdk_pixbuf_copy() to make a private copy of the pixbuf
-returned by this function. Otherwise GTK+ may need to keep the old
-icon theme loaded, which would be a waste of memory.
+For converting widget coordinates (eg. the ones you get from
+GtkWidget::query-tooltip), please see
+gtk_tree_view_convert_widget_to_bin_window_coords().
-Since: 2.4
</description>
<parameters>
-<parameter name="icon_theme">
-<parameter_description> a #GtkIconTheme
-</parameter_description>
-</parameter>
-<parameter name="icon_name">
-<parameter_description> the name of the icon to lookup
-</parameter_description>
-</parameter>
-<parameter name="size">
-<parameter_description> the desired icon size. The resulting icon may not be
-exactly this size; see gtk_icon_info_load_icon().
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView.
</parameter_description>
</parameter>
-<parameter name="flags">
-<parameter_description> flags modifying the behavior of the icon lookup
+<parameter name="x">
+<parameter_description> The x position to be identified (relative to bin_window).
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> Location to store error information on failure, or %NULL.
+<parameter name="y">
+<parameter_description> The y position to be identified (relative to bin_window).
</parameter_description>
</parameter>
-</parameters>
-<return> the rendered icon; this may be a newly created icon
-or a new reference to an internal icon, so you must not modify
-the icon. Use g_object_unref() to release your reference to the
-icon. %NULL if the icon isn't found.
-
-</return>
-</function>
-
-<function name="gtk_text_buffer_get_text">
-<description>
-Returns the text in the range [ start,@end). Excludes undisplayed
-text (text marked with tags that set the invisibility attribute) if
- include_hidden_chars is %FALSE. Does not include characters
-representing embedded images, so byte and character indexes into
-the returned string do <emphasis>not</emphasis> correspond to byte
-and character indexes into the buffer. Contrast with
-gtk_text_buffer_get_slice().
-
-
-</description>
-<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="path">
+<parameter_description> A pointer to a #GtkTreePath pointer to be filled in, or %NULL
</parameter_description>
</parameter>
-<parameter name="start">
-<parameter_description> start of a range
+<parameter name="column">
+<parameter_description> A pointer to a #GtkTreeViewColumn pointer to be filled in, or %NULL
</parameter_description>
</parameter>
-<parameter name="end">
-<parameter_description> end of a range
+<parameter name="cell_x">
+<parameter_description> A pointer where the X coordinate relative to the cell can be placed, or %NULL
</parameter_description>
</parameter>
-<parameter name="include_hidden_chars">
-<parameter_description> whether to include invisible text
+<parameter name="cell_y">
+<parameter_description> A pointer where the Y coordinate relative to the cell can be placed, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> an allocated UTF-8 string
+<return> %TRUE if a row exists at that coordinate.
</return>
</function>
-<function name="gtk_accel_group_get_is_locked">
+<function name="gtk_tree_view_get_reorderable">
<description>
-Locks are added and removed using gtk_accel_group_lock() and
-gtk_accel_group_unlock().
+Retrieves whether the user can reorder the tree via drag-and-drop. See
+gtk_tree_view_set_reorderable().
-Since: 2.14
</description>
<parameters>
-<parameter name="accel_group">
-<parameter_description> a #GtkAccelGroup
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if there are 1 or more locks on the @accel_group,
-%FALSE otherwise.
-
+<return> %TRUE if the tree can be reordered.
</return>
</function>
-<function name="gtk_color_selection_get_has_opacity_control">
+<function name="gtk_tree_view_get_row_separator_func">
<description>
-Determines whether the colorsel has an opacity control.
+Returns the current row separator function.
+Since: 2.6
</description>
<parameters>
-<parameter name="colorsel">
-<parameter_description> a #GtkColorSelection.
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the @colorsel has an opacity control. %FALSE if it does't.
+<return> the current row separator function.
+
</return>
</function>
-<function name="gtk_drag_begin">
+<function name="gtk_tree_view_get_rubber_banding">
<description>
-Initiates a drag on the source side. The function
-only needs to be used when the application is
-starting drags itself, and is not needed when
-gtk_drag_source_set() is used.
-
-The @event is used to retrieve the timestamp that will be used internally to
-grab the pointer. If @event is #NULL, then GDK_CURRENT_TIME will be used.
-However, you should try to pass a real event in all cases, since that can be
-used by GTK+ to get information about the start position of the drag, for
-example if the @event is a GDK_MOTION_NOTIFY.
-
-Generally there are three cases when you want to start a drag by hand by calling
-this function:
-
-1. During a button-press-event handler, if you want to start a drag immediately
-when the user presses the mouse button. Pass the @event that you have in your
-button-press-event handler.
-
-2. During a motion-notify-event handler, if you want to start a drag when the mouse
-moves past a certain threshold distance after a button-press. Pass the @event that you
-have in your motion-notify-event handler.
-
-3. During a timeout handler, if you want to start a drag after the mouse
-button is held down for some time. Try to save the last event that you got
-from the mouse, using gdk_event_copy(), and pass it to this function
-(remember to free the event with gdk_event_free() when you are done). If you
-can really not pass a real event, pass #NULL instead.
+Returns whether rubber banding is turned on for @tree_view. If the
+selection mode is #GTK_SELECTION_MULTIPLE, rubber banding will allow the
+user to select multiple rows by dragging the mouse.
+Since: 2.10
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> the source widget.
-</parameter_description>
-</parameter>
-<parameter name="targets">
-<parameter_description> The targets (data formats) in which the
-source can provide the data.
-</parameter_description>
-</parameter>
-<parameter name="actions">
-<parameter_description> A bitmask of the allowed drag actions for this drag.
-</parameter_description>
-</parameter>
-<parameter name="button">
-<parameter_description> The button the user clicked to start the drag.
-</parameter_description>
-</parameter>
-<parameter name="event">
-<parameter_description> The event that triggered the start of the drag.
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
</parameters>
-<return> the context for this drag.
+<return> %TRUE if rubber banding in @tree_view is enabled.
+
</return>
</function>
-<function name="gtk_scrolled_window_set_hadjustment">
+<function name="gtk_tree_view_get_rules_hint">
<description>
-Sets the #GtkAdjustment for the horizontal scrollbar.
+Gets the setting set by gtk_tree_view_set_rules_hint().
+
</description>
<parameters>
-<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
-</parameter_description>
-</parameter>
-<parameter name="hadjustment">
-<parameter_description> horizontal scroll adjustment
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if rules are useful for the user of this tree
+</return>
</function>
-<function name="gtk_window_set_accept_focus">
+<function name="gtk_tree_view_get_search_column">
<description>
-Windows may set a hint asking the desktop environment not to receive
-the input focus. This function sets this hint.
+Gets the column searched on by the interactive search code.
-Since: 2.4
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
-</parameter_description>
-</parameter>
-<parameter name="setting">
-<parameter_description> %TRUE to let this window receive input focus
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the column the interactive search code searches in.
+</return>
</function>
-<function name="gtk_recent_chooser_widget_new">
+<function name="gtk_tree_view_get_search_entry">
<description>
-Creates a new #GtkRecentChooserWidget object. This is an embeddable widget
-used to access the recently used resources list.
+Returns the #GtkEntry which is currently in use as interactive search
+entry for @tree_view. In case the built-in entry is being used, %NULL
+will be returned.
Since: 2.10
</description>
<parameters>
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GtkRecentChooserWidget
+<return> the entry currently in use as search entry.
</return>
</function>
-<function name="gtk_tool_item_set_proxy_menu_item">
+<function name="gtk_tree_view_get_search_equal_func">
<description>
-Sets the #GtkMenuItem used in the toolbar overflow menu. The
- menu_item_id is used to identify the caller of this function and
-should also be used with gtk_tool_item_get_proxy_menu_item().
+Returns the compare function currently in use.
-Since: 2.4
</description>
<parameters>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem
-</parameter_description>
-</parameter>
-<parameter name="menu_item_id">
-<parameter_description> a string used to identify @menu_item
-</parameter_description>
-</parameter>
-<parameter name="menu_item">
-<parameter_description> a #GtkMenuItem to be used in the overflow menu
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the currently used compare function for the search code.
+</return>
</function>
-<function name="gtk_assistant_get_nth_page">
+<function name="gtk_tree_view_get_search_position_func">
<description>
-Returns the child widget contained in page number @page_num.
+Returns the positioning function currently in use.
Since: 2.10
</description>
<parameters>
-<parameter name="assistant">
-<parameter_description> a #GtkAssistant
-</parameter_description>
-</parameter>
-<parameter name="page_num">
-<parameter_description> The index of a page in the @assistant, or -1 to get the last page;
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView
</parameter_description>
</parameter>
</parameters>
-<return> The child widget, or %NULL if @page_num is out of bounds.
+<return> the currently used function for positioning the search dialog.
</return>
</function>
-<function name="gtk_editable_cut_clipboard">
+<function name="gtk_tree_view_get_selection">
<description>
-Removes the contents of the currently selected content in the editable and
-puts it on the clipboard.
-
-</description>
-<parameters>
-<parameter name="editable">
-<parameter_description> a #GtkEditable
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
-</function>
+Gets the #GtkTreeSelection associated with @tree_view.
-<function name="gtk_im_context_set_use_preedit">
-<description>
-Sets whether the IM context should use the preedit string
-to display feedback. If @use_preedit is FALSE (default
-is TRUE), then the IM context may use some other method to display
-feedback, such as displaying it in a child of the root window.
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GtkIMContext
-</parameter_description>
-</parameter>
-<parameter name="use_preedit">
-<parameter_description> whether the IM context should use the preedit string.
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A #GtkTreeSelection object.
+</return>
</function>
-<function name="gtk_tree_model_filter_get_model">
+<function name="gtk_tree_view_get_show_expanders">
<description>
-Returns a pointer to the child model of @filter.
+Returns whether or not expanders are drawn in @tree_view.
-Since: 2.4
+Since: 2.12
</description>
<parameters>
-<parameter name="filter">
-<parameter_description> A #GtkTreeModelFilter.
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView.
</parameter_description>
</parameter>
</parameters>
-<return> A pointer to a #GtkTreeModel.
+<return> %TRUE if expanders are drawn in @tree_view, %FALSE
+otherwise.
</return>
</function>
-<function name="gtk_color_selection_set_previous_color">
+<function name="gtk_tree_view_get_tooltip_column">
<description>
-Sets the 'previous' color to be @color. This function should be called with
-some hesitations, as it might seem confusing to have that color change.
-Calling gtk_color_selection_set_current_color() will also set this color the first
-time it is called.
+Returns the column of @tree_view's model which is being used for
+displaying tooltips on @tree_view's rows.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="colorsel">
-<parameter_description> a #GtkColorSelection.
-</parameter_description>
-</parameter>
-<parameter name="color">
-<parameter_description> a #GdkColor to set the previous color with.
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the index of the tooltip column that is currently being
+used, or -1 if this is disabled.
+
+</return>
</function>
-<function name="gtk_recent_chooser_set_local_only">
+<function name="gtk_tree_view_get_tooltip_context">
<description>
-Sets whether only local resources, that is resources using the file:// URI
-scheme, should be shown in the recently used resources selector. If
- local_only is %TRUE (the default) then the shown resources are guaranteed
-to be accessible through the operating system native file system.
+This function is supposed to be used in a #GtkWidget::query-tooltip
+signal handler for #GtkTreeView. The @x, @y and @keyboard_tip values
+which are received in the signal handler, should be passed to this
+function without modification.
-Since: 2.10
+The return value indicates whether there is a tree view row at the given
+coordinates (%TRUE) or not (%FALSE) for mouse tooltips. For keyboard
+tooltips the row returned will be the cursor row. When %TRUE, then any of
+ model, @path and @iter which have been provided will be set to point to
+that row and the corresponding model. @x and @y will always be converted
+to be relative to @tree_view's bin_window if @keyboard_tooltip is %FALSE.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="local_only">
-<parameter_description> %TRUE if only local files can be shown
+<parameter name="x">
+<parameter_description> the x coordinate (relative to widget coordinates)
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_text_layout_set_cursor_direction">
-<description>
-Sets which text directions (left-to-right and/or right-to-left) for
-which cursors will be drawn for the insertion point. The visual
-point at which new text is inserted depends on whether the new
-text is right-to-left or left-to-right, so it may be desired to
-make the drawn position of the cursor depend on the keyboard state.
-
-</description>
-<parameters>
-<parameter name="direction">
-<parameter_description> the new direction(s) for which to draw cursors.
-%GTK_TEXT_DIR_NONE means draw cursors for both
-left-to-right insertion and right-to-left insertion.
-(The two cursors will be visually distinguished.)
+<parameter name="y">
+<parameter_description> the y coordinate (relative to widget coordinates)
</parameter_description>
</parameter>
-</parameters>
-<return></return>
-</function>
-
-<function name="gtk_rc_get_style_by_paths">
-<description>
-Creates up a #GtkStyle from styles defined in a RC file by providing
-the raw components used in matching. This function may be useful
-when creating pseudo-widgets that should be themed like widgets but
-don't actually have corresponding GTK+ widgets. An example of this
-would be items inside a GNOME canvas widget.
-
-The action of gtk_rc_get_style() is similar to:
-|[
-gtk_widget_path (widget, NULL, &path, NULL);
-gtk_widget_class_path (widget, NULL, &class_path, NULL);
-gtk_rc_get_style_by_paths (gtk_widget_get_settings (widget),
-path, class_path,
-G_OBJECT_TYPE (widget));
-]|
-
-
-</description>
-<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkSettings object
+<parameter name="keyboard_tip">
+<parameter_description> whether this is a keyboard tooltip or not
</parameter_description>
</parameter>
-<parameter name="widget_path">
-<parameter_description> the widget path to use when looking up the style, or %NULL
-if no matching against the widget path should be done
+<parameter name="model">
+<parameter_description> a pointer to receive a #GtkTreeModel or %NULL
</parameter_description>
</parameter>
-<parameter name="class_path">
-<parameter_description> the class path to use when looking up the style, or %NULL
-if no matching against the class path should be done.
+<parameter name="path">
+<parameter_description> a pointer to receive a #GtkTreePath or %NULL
</parameter_description>
</parameter>
-<parameter name="type">
-<parameter_description> a type that will be used along with parent types of this type
-when matching against class styles, or #G_TYPE_NONE
+<parameter name="iter">
+<parameter_description> a pointer to receive a #GtkTreeIter or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> A style created by matching with the supplied paths,
-or %NULL if nothing matching was specified and the default style should
-be used. The returned value is owned by GTK+ as part of an internal cache,
-so you must call g_object_ref() on the returned value if you want to
-keep a reference to it.
+<return> whether or not the given tooltip context points to a row.
+
</return>
</function>
-<function name="gtk_action_get_accel_closure">
+<function name="gtk_tree_view_get_vadjustment">
<description>
-Returns the accel closure for this action.
-
-Since: 2.8
+Gets the #GtkAdjustment currently being used for the vertical aspect.
</description>
<parameters>
-<parameter name="action">
-<parameter_description> the action object
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView
</parameter_description>
</parameter>
</parameters>
-<return> the accel closure for this action. The returned closure is
-owned by GTK+ and must not be unreffed or modified.
+<return> A #GtkAdjustment object, or %NULL
+if none is currently being used.
</return>
</function>
-<function name="gtk_calendar_select_month">
+<function name="gtk_tree_view_get_visible_range">
<description>
-Shifts the calendar to a different month.
+Sets @start_path and @end_path to be the first and last visible path.
+Note that there may be invisible paths in between.
-Note that this function always returns %TRUE, and you should
-ignore the return value. In GTK+ 3, this function will not
-return a value.
+The paths should be freed with gtk_tree_path_free() after use.
+Since: 2.8
</description>
<parameters>
-<parameter name="calendar">
-<parameter_description> a #GtkCalendar
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="month">
-<parameter_description> a month number between 0 and 11.
+<parameter name="start_path">
+<parameter_description> Return location for start of region, or %NULL.
</parameter_description>
</parameter>
-<parameter name="year">
-<parameter_description> the year the month is in.
+<parameter name="end_path">
+<parameter_description> Return location for end of region, or %NULL.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE, always
+<return> %TRUE, if valid paths were placed in @start_path and @end_path.
+
</return>
</function>
-<function name="gtk_widget_get_has_tooltip">
+<function name="gtk_tree_view_get_visible_rect">
<description>
-Returns the current value of the has-tooltip property. See
-GtkWidget:has-tooltip for more information.
-
-Since: 2.12
+Fills @visible_rect with the currently-visible region of the
+buffer, in tree coordinates. Convert to bin_window coordinates with
+gtk_tree_view_convert_tree_to_bin_window_coords().
+Tree coordinates start at 0,0 for row 0 of the tree, and cover the entire
+scrollable area of the tree.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
+</parameter_description>
+</parameter>
+<parameter name="visible_rect">
+<parameter_description> rectangle to fill
</parameter_description>
</parameter>
</parameters>
-<return> current value of has-tooltip on @widget.
-
-</return>
-</function>
-
-<function name="gtk_vbutton_box_get_spacing_default">
-<description>
-Retrieves the current default spacing for vertical button boxes. This is the number of pixels
-to be placed between the buttons when they are arranged.
-
-Deprecated: 2.0: Use gtk_box_get_spacing() instead.
-
-</description>
-<parameters>
-</parameters>
-<return> the default number of pixels between buttons.
-
-</return>
+<return></return>
</function>
-<function name="gtk_radio_tool_button_new_from_stock">
+<function name="gtk_tree_view_insert_column">
<description>
-Creates a new #GtkRadioToolButton, adding it to @group.
-The new #GtkRadioToolButton will contain an icon and label from the
-stock item indicated by @stock_id.
+This inserts the @column into the @tree_view at @position. If @position is
+-1, then the column is inserted at the end. If @tree_view has
+"fixed_height" mode enabled, then @column must have its "sizing" property
+set to be GTK_TREE_VIEW_COLUMN_FIXED.
-Since: 2.4
</description>
<parameters>
-<parameter name="group">
-<parameter_description> an existing radio button group, or %NULL if you are creating a new group
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView.
</parameter_description>
</parameter>
-<parameter name="stock_id">
-<parameter_description> the name of a stock item
+<parameter name="column">
+<parameter_description> The #GtkTreeViewColumn to be inserted.
+</parameter_description>
+</parameter>
+<parameter name="position">
+<parameter_description> The position to insert @column in.
</parameter_description>
</parameter>
</parameters>
-<return> The new #GtkRadioToolItem
-
+<return> The number of columns in @tree_view after insertion.
</return>
</function>
-<function name="gtk_icon_view_get_dest_item_at_pos">
+<function name="gtk_tree_view_insert_column_with_attributes">
<description>
-Determines the destination item for a given position.
+Creates a new #GtkTreeViewColumn and inserts it into the @tree_view at
+ position If @position is -1, then the newly created column is inserted at
+the end. The column is initialized with the attributes given. If @tree_view
+has "fixed_height" mode enabled, then the new column will have its sizing
+property set to be GTK_TREE_VIEW_COLUMN_FIXED.
-Since: 2.8
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="drag_x">
-<parameter_description> the position to determine the destination item for
+<parameter name="position">
+<parameter_description> The position to insert the new column in.
</parameter_description>
</parameter>
-<parameter name="drag_y">
-<parameter_description> the position to determine the destination item for
+<parameter name="title">
+<parameter_description> The title to set the header to.
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> Return location for the path of the item, or %NULL.
+<parameter name="cell">
+<parameter_description> The #GtkCellRenderer.
</parameter_description>
</parameter>
-<parameter name="pos">
-<parameter_description> Return location for the drop position, or %NULL
+<parameter name="Varargs">
+<parameter_description> A %NULL-terminated list of attributes.
</parameter_description>
</parameter>
</parameters>
-<return> whether there is an item at the given position.
-
+<return> The number of columns in @tree_view after insertion.
</return>
</function>
-<function name="gtk_combo_box_get_active_text">
+<function name="gtk_tree_view_insert_column_with_data_func">
<description>
-Returns the currently active string in @combo_box or %NULL if none
-is selected. Note that you can only use this function with combo
-boxes constructed with gtk_combo_box_new_text() and with
-#GtkComboBoxEntry<!-- -->s.
+Convenience function that inserts a new column into the #GtkTreeView
+with the given cell renderer and a #GtkCellDataFunc to set cell renderer
+attributes (normally using data from the model). See also
+gtk_tree_view_column_set_cell_data_func(), gtk_tree_view_column_pack_start().
+If @tree_view has "fixed_height" mode enabled, then the new column will have its
+"sizing" property set to be GTK_TREE_VIEW_COLUMN_FIXED.
-Since: 2.6
</description>
<parameters>
-<parameter name="combo_box">
-<parameter_description> A #GtkComboBox constructed with gtk_combo_box_new_text()
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
-</parameters>
-<return> a newly allocated string containing the currently active text.
-Must be freed with g_free().
-
-</return>
-</function>
-
-<function name="gtk_tree_view_column_cell_get_size">
-<description>
-Obtains the width and height needed to render the column. This is used
-primarily by the #GtkTreeView.
-
-</description>
-<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn.
+<parameter name="position">
+<parameter_description> Position to insert, -1 for append
</parameter_description>
</parameter>
-<parameter name="cell_area">
-<parameter_description> The area a cell in the column will be allocated, or %NULL
+<parameter name="title">
+<parameter_description> column title
</parameter_description>
</parameter>
-<parameter name="x_offset">
-<parameter_description> location to return x offset of a cell relative to @cell_area, or %NULL
+<parameter name="cell">
+<parameter_description> cell renderer for column
</parameter_description>
</parameter>
-<parameter name="y_offset">
-<parameter_description> location to return y offset of a cell relative to @cell_area, or %NULL
+<parameter name="func">
+<parameter_description> function to set attributes of cell renderer
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> location to return width needed to render a cell, or %NULL
+<parameter name="data">
+<parameter_description> data for @func
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> location to return height needed to render a cell, or %NULL
+<parameter name="dnotify">
+<parameter_description> destroy notifier for @data
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> number of columns in the tree view post-insert
+</return>
</function>
-<function name="gtk_font_button_set_use_font">
+<function name="gtk_tree_view_is_rubber_banding_active">
<description>
-If @use_font is %TRUE, the font name will be written using the selected font.
+Returns whether a rubber banding operation is currently being done
+in @tree_view.
-Since: 2.4
+Since: 2.12
</description>
<parameters>
-<parameter name="font_button">
-<parameter_description> a #GtkFontButton
-</parameter_description>
-</parameter>
-<parameter name="use_font">
-<parameter_description> If %TRUE, font name will be written using font chosen.
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if a rubber banding operation is currently being
+done in @tree_view.
+
+</return>
</function>
-<function name="gtk_rc_property_parse_enum">
+<function name="gtk_tree_view_map_expanded_rows">
<description>
-A #GtkRcPropertyParser for use with gtk_settings_install_property_parser()
-or gtk_widget_class_install_style_property_parser() which parses a single
-enumeration value.
-
-The enumeration value can be specified by its name, its nickname or
-its numeric value. For consistency with flags parsing, the value
-may be surrounded by parentheses.
-
+Calls @func on all expanded rows.
</description>
<parameters>
-<parameter name="pspec">
-<parameter_description> a #GParamSpec
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="gstring">
-<parameter_description> the #GString to be parsed
+<parameter name="func">
+<parameter_description> A function to be called
</parameter_description>
</parameter>
-<parameter name="property_value">
-<parameter_description> a #GValue which must hold enum values.
+<parameter name="data">
+<parameter_description> User data to be passed to the function.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @gstring could be parsed and @property_value
-has been set to the resulting #GEnumValue.
-</return>
+<return></return>
</function>
-<function name="gtk_paper_size_free">
+<function name="gtk_tree_view_move_column_after">
<description>
-Free the given #GtkPaperSize object.
-
-Since: 2.10
+Moves @column to be after to @base_column. If @base_column is %NULL, then
+ column is placed in the first position.
</description>
<parameters>
-<parameter name="size">
-<parameter_description> a #GtkPaperSize
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView
+</parameter_description>
+</parameter>
+<parameter name="column">
+<parameter_description> The #GtkTreeViewColumn to be moved.
+</parameter_description>
+</parameter>
+<parameter name="base_column">
+<parameter_description> The #GtkTreeViewColumn to be moved relative to, or %NULL.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_window_get_skip_pager_hint">
+<function name="gtk_tree_view_new">
<description>
-Gets the value set by gtk_window_set_skip_pager_hint().
+Creates a new #GtkTreeView widget.
-Since: 2.2
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
-</parameter_description>
-</parameter>
</parameters>
-<return> %TRUE if window shouldn't be in pager
-
+<return> A newly created #GtkTreeView widget.
</return>
</function>
-<function name="gtk_image_get">
+<function name="gtk_tree_view_new_with_model">
<description>
-Gets the #GtkImage.
+Creates a new #GtkTreeView widget with the model initialized to @model.
-Deprecated: 2.0: Use gtk_image_get_image() instead.
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GtkImage
-</parameter_description>
-</parameter>
-<parameter name="val">
-<parameter_description> return location for a #GdkImage
-</parameter_description>
-</parameter>
-<parameter name="mask">
-<parameter_description> a #GdkBitmap that indicates which parts of the image should be transparent.
+<parameter name="model">
+<parameter_description> the model.
</parameter_description>
</parameter>
</parameters>
-<return></return>
-</function>
-
-<function name="gtk_icon_source_new">
-<description>
-Creates a new #GtkIconSource. A #GtkIconSource contains a #GdkPixbuf (or
-image filename) that serves as the base image for one or more of the
-icons in a #GtkIconSet, along with a specification for which icons in the
-icon set will be based on that pixbuf or image file. An icon set contains
-a set of icons that represent "the same" logical concept in different states,
-different global text directions, and different sizes.
-
-So for example a web browser's "Back to Previous Page" icon might
-point in a different direction in Hebrew and in English; it might
-look different when insensitive; and it might change size depending
-on toolbar mode (small/large icons). So a single icon set would
-contain all those variants of the icon. #GtkIconSet contains a list
-of #GtkIconSource from which it can derive specific icon variants in
-the set.
-
-In the simplest case, #GtkIconSet contains one source pixbuf from
-which it derives all variants. The convenience function
-gtk_icon_set_new_from_pixbuf() handles this case; if you only have
-one source pixbuf, just use that function.
-
-If you want to use a different base pixbuf for different icon
-variants, you create multiple icon sources, mark which variants
-they'll be used to create, and add them to the icon set with
-gtk_icon_set_add_source().
-
-By default, the icon source has all parameters wildcarded. That is,
-the icon source will be used as the base icon for any desired text
-direction, widget state, or icon size.
-
-
-</description>
-<parameters>
-</parameters>
-<return> a new #GtkIconSource
+<return> A newly created #GtkTreeView widget.
</return>
</function>
-<function name="gtk_tool_palette_set_style">
+<function name="gtk_tree_view_remove_column">
<description>
-Sets the style (text, icons or both) of items in the tool palette.
+Removes @column from @tree_view.
-Since: 2.20
</description>
<parameters>
-<parameter name="palette">
-<parameter_description> a #GtkToolPalette
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView.
</parameter_description>
</parameter>
-<parameter name="style">
-<parameter_description> the #GtkToolbarStyle that items in the tool palette shall have
+<parameter name="column">
+<parameter_description> The #GtkTreeViewColumn to remove.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The number of columns in @tree_view after removing.
+</return>
</function>
-<function name="gtk_adjustment_set_upper">
+<function name="gtk_tree_view_row_activated">
<description>
-Sets the maximum value of the adjustment.
-
-Note that values will be restricted by
-<literal>upper - page-size</literal> if the page-size
-property is nonzero.
-
-See gtk_adjustment_set_lower() about how to compress multiple
-emissions of the "changed" signal when setting multiple adjustment
-properties.
-
-Since: 2.14
+Activates the cell determined by @path and @column.
</description>
<parameters>
-<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="upper">
-<parameter_description> the new maximum value
+<parameter name="path">
+<parameter_description> The #GtkTreePath to be activated.
+</parameter_description>
+</parameter>
+<parameter name="column">
+<parameter_description> The #GtkTreeViewColumn to be activated.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_view_get_justification">
+<function name="gtk_tree_view_row_expanded">
<description>
-Gets the default justification of paragraphs in @text_view.
-Tags in the buffer may override the default.
+Returns %TRUE if the node pointed to by @path is expanded in @tree_view.
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView.
</parameter_description>
</parameter>
-</parameters>
-<return> default justification
-</return>
-</function>
-
-<function name="gtk_file_chooser_get_uris">
-<description>
-Lists all the selected files and subfolders in the current folder of
- chooser The returned names are full absolute URIs.
-
-Since: 2.4
-
-</description>
-<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="path">
+<parameter_description> A #GtkTreePath to test expansion state.
</parameter_description>
</parameter>
</parameters>
-<return> a #GSList containing the URIs of all selected
-files and subfolders in the current folder. Free the returned list
-with g_slist_free(), and the filenames with g_free().
-
+<return> %TRUE if #path is expanded.
</return>
</function>
-<function name="gtk_entry_buffer_get_length">
+<function name="gtk_tree_view_scroll_to_cell">
<description>
-Retrieves the length in characters of the buffer.
+Moves the alignments of @tree_view to the position specified by @column and
+ path If @column is %NULL, then no horizontal scrolling occurs. Likewise,
+if @path is %NULL no vertical scrolling occurs. At a minimum, one of @column
+or @path need to be non-%NULL. @row_align determines where the row is
+placed, and @col_align determines where @column is placed. Both are expected
+to be between 0.0 and 1.0. 0.0 means left/top alignment, 1.0 means
+right/bottom alignment, 0.5 means center.
-Since: 2.18
+If @use_align is %FALSE, then the alignment arguments are ignored, and the
+tree does the minimum amount of work to scroll the cell onto the screen.
+This means that the cell will be scrolled to the edge closest to its current
+position. If the cell is currently visible on the screen, nothing is done.
+
+This function only works if the model is set, and @path is a valid row on the
+model. If the model changes before the @tree_view is realized, the centered
+path will be modified to reflect this change.
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkEntryBuffer
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView.
</parameter_description>
</parameter>
-</parameters>
-<return> The number of characters in the buffer.
-
-</return>
-</function>
-
-<function name="gtk_alignment_new">
-<description>
-Creates a new #GtkAlignment.
-
-
-</description>
-<parameters>
-<parameter name="xalign">
-<parameter_description> the horizontal alignment of the child widget, from 0 (left) to 1
-(right).
+<parameter name="path">
+<parameter_description> The path of the row to move to, or %NULL.
</parameter_description>
</parameter>
-<parameter name="yalign">
-<parameter_description> the vertical alignment of the child widget, from 0 (top) to 1
-(bottom).
+<parameter name="column">
+<parameter_description> The #GtkTreeViewColumn to move horizontally to, or %NULL.
</parameter_description>
</parameter>
-<parameter name="xscale">
-<parameter_description> the amount that the child widget expands horizontally to fill up
-unused space, from 0 to 1.
-A value of 0 indicates that the child widget should never expand.
-A value of 1 indicates that the child widget will expand to fill all of the
-space allocated for the #GtkAlignment.
+<parameter name="use_align">
+<parameter_description> whether to use alignment arguments, or %FALSE.
</parameter_description>
</parameter>
-<parameter name="yscale">
-<parameter_description> the amount that the child widget expands vertically to fill up
-unused space, from 0 to 1. The values are similar to @xscale.
+<parameter name="row_align">
+<parameter_description> The vertical alignment of the row specified by @path.
+</parameter_description>
+</parameter>
+<parameter name="col_align">
+<parameter_description> The horizontal alignment of the column specified by @column.
</parameter_description>
</parameter>
</parameters>
-<return> the new #GtkAlignment.
-</return>
+<return></return>
</function>
-<function name="gtk_drag_source_get_target_list">
+<function name="gtk_tree_view_scroll_to_point">
<description>
-Gets the list of targets this widget can provide for
-drag-and-drop.
+Scrolls the tree view such that the top-left corner of the visible
+area is @tree_x, @tree_y, where @tree_x and @tree_y are specified
+in tree coordinates. The @tree_view must be realized before
+this function is called. If it isn't, you probably want to be
+using gtk_tree_view_scroll_to_cell().
-Since: 2.4
+If either @tree_x or @tree_y are -1, then that direction isn't scrolled.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
+</parameter_description>
+</parameter>
+<parameter name="tree_x">
+<parameter_description> X coordinate of new top-left pixel of visible area, or -1
+</parameter_description>
+</parameter>
+<parameter name="tree_y">
+<parameter_description> Y coordinate of new top-left pixel of visible area, or -1
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkTargetList, or %NULL if none
-
-</return>
+<return></return>
</function>
-<function name="gtk_widget_get_mapped">
+<function name="gtk_tree_view_set_column_drag_function">
<description>
-Whether the widget is mapped.
-
-Since: 2.20
+Sets a user function for determining where a column may be dropped when
+dragged. This function is called on every column pair in turn at the
+beginning of a column drag to determine where a drop can take place. The
+arguments passed to @func are: the @tree_view, the #GtkTreeViewColumn being
+dragged, the two #GtkTreeViewColumn s determining the drop spot, and
+ user_data If either of the #GtkTreeViewColumn arguments for the drop spot
+are %NULL, then they indicate an edge. If @func is set to be %NULL, then
+ tree_view reverts to the default behavior of allowing all columns to be
+dropped everywhere.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView.
+</parameter_description>
+</parameter>
+<parameter name="func">
+<parameter_description> A function to determine which columns are reorderable, or %NULL.
+</parameter_description>
+</parameter>
+<parameter name="user_data">
+<parameter_description> User data to be passed to @func, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="destroy">
+<parameter_description> Destroy notifier for @user_data, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the widget is mapped, %FALSE otherwise.
-
-</return>
+<return></return>
</function>
-<function name="gtk_style_lookup_color">
+<function name="gtk_tree_view_set_cursor">
<description>
-Looks up @color_name in the style's logical color mappings,
-filling in @color and returning %TRUE if found, otherwise
-returning %FALSE. Do not cache the found mapping, because
-it depends on the #GtkStyle and might change when a theme
-switch occurs.
+Sets the current keyboard focus to be at @path, and selects it. This is
+useful when you want to focus the user's attention on a particular row. If
+ focus_column is not %NULL, then focus is given to the column specified by
+it. Additionally, if @focus_column is specified, and @start_editing is
+%TRUE, then editing should be started in the specified cell.
+This function is often followed by @gtk_widget_grab_focus (@tree_view)
+in order to give keyboard focus to the widget. Please note that editing
+can only happen when the widget is realized.
-Since: 2.10
+If @path is invalid for @model, the current cursor (if any) will be unset
+and the function will return without failing.
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="color_name">
-<parameter_description> the name of the logical color to look up
+<parameter name="path">
+<parameter_description> A #GtkTreePath
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> the #GdkColor to fill in
+<parameter name="focus_column">
+<parameter_description> A #GtkTreeViewColumn, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="start_editing">
+<parameter_description> %TRUE if the specified cell should start being edited.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the mapping was found.
-
-</return>
+<return></return>
</function>
<function name="gtk_tree_view_set_cursor_on_cell">
@@ -62193,735 +62228,749 @@ Since: 2.2
<return></return>
</function>
-<function name="gtk_activatable_set_related_action">
+<function name="gtk_tree_view_set_destroy_count_func">
<description>
-Sets the related action on the @activatable object.
-
-<note><para>#GtkActivatable implementors need to handle the #GtkActivatable:related-action
-property and call gtk_activatable_do_set_related_action() when it changes.</para></note>
-
-Since: 2.16
+This function should almost never be used. It is meant for private use by
+ATK for determining the number of visible children that are removed when the
+user collapses a row, or a row is deleted.
</description>
<parameters>
-<parameter name="activatable">
-<parameter_description> a #GtkActivatable
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="action">
-<parameter_description> the #GtkAction to set
+<parameter name="func">
+<parameter_description> Function to be called when a view row is destroyed, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> User data to be passed to @func, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="destroy">
+<parameter_description> Destroy notifier for @data, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_view_starts_display_line">
+<function name="gtk_tree_view_set_drag_dest_row">
<description>
-Determines whether @iter is at the start of a display line.
-See gtk_text_view_forward_display_line() for an explanation of
-display lines vs. paragraphs.
-
+Sets the row that is highlighted for feedback.
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="path">
+<parameter_description> The path of the row to highlight, or %NULL.
+</parameter_description>
+</parameter>
+<parameter name="pos">
+<parameter_description> Specifies whether to drop before, after or into the row
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter begins a wrapped line
-</return>
-</function>
-
-<function name="gtk_get_default_language">
-<description>
-Returns the #PangoLanguage for the default language currently in
-effect. (Note that this can change over the life of an
-application.) The default language is derived from the current
-locale. It determines, for example, whether GTK+ uses the
-right-to-left or left-to-right text direction.
-
-This function is equivalent to pango_language_get_default(). See
-that function for details.
-
-
-</description>
-<parameters>
-</parameters>
-<return> the default language as a #PangoLanguage, must not be
-freed
-</return>
+<return></return>
</function>
-<function name="gtk_label_new">
+<function name="gtk_tree_view_set_enable_search">
<description>
-Creates a new label with the given text inside it. You can
-pass %NULL to get an empty label widget.
+If @enable_search is set, then the user can type in text to search through
+the tree interactively (this is sometimes called "typeahead find").
+Note that even if this is %FALSE, the user can still initiate a search
+using the "start-interactive-search" key binding.
</description>
<parameters>
-<parameter name="str">
-<parameter_description> The text of the label
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView
+</parameter_description>
+</parameter>
+<parameter name="enable_search">
+<parameter_description> %TRUE, if the user can search interactively
</parameter_description>
</parameter>
</parameters>
-<return> the new #GtkLabel
-</return>
+<return></return>
</function>
-<function name="gtk_size_group_remove_widget">
+<function name="gtk_tree_view_set_enable_tree_lines">
<description>
-Removes a widget from a #GtkSizeGroup.
+Sets whether to draw lines interconnecting the expanders in @tree_view.
+This does not have any visible effects for lists.
+
+Since: 2.10
</description>
<parameters>
-<parameter name="size_group">
-<parameter_description> a #GtkSizeGrup
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="widget">
-<parameter_description> the #GtkWidget to remove
+<parameter name="enabled">
+<parameter_description> %TRUE to enable tree line drawing, %FALSE otherwise.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_spin_button_update">
+<function name="gtk_tree_view_set_expander_column">
<description>
-Manually force an update of the spin button.
+Sets the column to draw the expander arrow at. It must be in @tree_view.
+If @column is %NULL, then the expander arrow is always at the first
+visible column.
+
+If you do not want expander arrow to appear in your tree, set the
+expander column to a hidden column.
</description>
<parameters>
-<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView
+</parameter_description>
+</parameter>
+<parameter name="column">
+<parameter_description> %NULL, or the column to draw the expander arrow at.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tool_item_get_orientation">
+<function name="gtk_tree_view_set_fixed_height_mode">
<description>
-Returns the orientation used for @tool_item. Custom subclasses of
-#GtkToolItem should call this function to find out what size icons
-they should use.
+Enables or disables the fixed height mode of @tree_view.
+Fixed height mode speeds up #GtkTreeView by assuming that all
+rows have the same height.
+Only enable this option if all rows are the same height and all
+columns are of type %GTK_TREE_VIEW_COLUMN_FIXED.
-Since: 2.4
+Since: 2.6
</description>
<parameters>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
+</parameter_description>
+</parameter>
+<parameter name="enable">
+<parameter_description> %TRUE to enable fixed height mode
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkOrientation indicating the orientation
-used for @tool_item
-
-</return>
+<return></return>
</function>
-<function name="gtk_menu_tool_button_set_menu">
+<function name="gtk_tree_view_set_grid_lines">
<description>
-Sets the #GtkMenu that is popped up when the user clicks on the arrow.
-If @menu is NULL, the arrow button becomes insensitive.
+Sets which grid lines to draw in @tree_view.
-Since: 2.6
+Since: 2.10
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkMenuToolButton
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="menu">
-<parameter_description> the #GtkMenu associated with #GtkMenuToolButton
+<parameter name="grid_lines">
+<parameter_description> a #GtkTreeViewGridLines value indicating which grid lines to
+enable.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tool_item_group_get_collapsed">
+<function name="gtk_tree_view_set_hadjustment">
<description>
-Gets whether @group is collapsed or expanded.
-
-Since: 2.20
+Sets the #GtkAdjustment for the current horizontal aspect.
</description>
<parameters>
-<parameter name="group">
-<parameter_description> a GtkToolItemGroup
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView
+</parameter_description>
+</parameter>
+<parameter name="adjustment">
+<parameter_description> The #GtkAdjustment to set, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @group is collapsed, %FALSE if it is expanded
-
-</return>
+<return></return>
</function>
-<function name="gtk_print_unix_dialog_get_current_page">
+<function name="gtk_tree_view_set_headers_clickable">
<description>
-Gets the current page of the #GtkPrintDialog.
-
-Since: 2.10
+Allow the column title buttons to be clicked.
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView.
+</parameter_description>
+</parameter>
+<parameter name="setting">
+<parameter_description> %TRUE if the columns are clickable.
</parameter_description>
</parameter>
</parameters>
-<return> the current page of @dialog
-
-</return>
+<return></return>
</function>
-<function name="gtk_table_get_col_spacing">
+<function name="gtk_tree_view_set_headers_visible">
<description>
-Gets the amount of space between column @col, and
-column @col + 1. See gtk_table_set_col_spacing().
-
+Sets the visibility state of the headers.
</description>
<parameters>
-<parameter name="table">
-<parameter_description> a #GtkTable
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView.
</parameter_description>
</parameter>
-<parameter name="column">
-<parameter_description> a column in the table, 0 indicates the first column
+<parameter name="headers_visible">
+<parameter_description> %TRUE if the headers are visible
</parameter_description>
</parameter>
</parameters>
-<return> the column spacing
-</return>
+<return></return>
</function>
-<function name="gtk_vbutton_box_set_layout_default">
+<function name="gtk_tree_view_set_hover_expand">
<description>
-Sets a new layout mode that will be used by all button boxes.
+Enables of disables the hover expansion mode of @tree_view.
+Hover expansion makes rows expand or collapse if the pointer
+moves over them.
-Deprecated: 2.0: Use gtk_button_box_set_layout() instead.
+Since: 2.6
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a new #GtkButtonBoxStyle.
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
+</parameter_description>
+</parameter>
+<parameter name="expand">
+<parameter_description> %TRUE to enable hover selection mode
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_entry_get_activates_default">
+<function name="gtk_tree_view_set_hover_selection">
<description>
-Retrieves the value set by gtk_entry_set_activates_default().
+Enables of disables the hover selection mode of @tree_view.
+Hover selection makes the selected row follow the pointer.
+Currently, this works only for the selection modes
+%GTK_SELECTION_SINGLE and %GTK_SELECTION_BROWSE.
+Since: 2.6
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
+</parameter_description>
+</parameter>
+<parameter name="hover">
+<parameter_description> %TRUE to enable hover selection mode
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the entry will activate the default widget
-</return>
+<return></return>
</function>
-<function name="gtk_widget_style_get_valist">
+<function name="gtk_tree_view_set_level_indentation">
<description>
-Non-vararg variant of gtk_widget_style_get(). Used primarily by language
-bindings.
+Sets the amount of extra indentation for child levels to use in @tree_view
+in addition to the default indentation. The value should be specified in
+pixels, a value of 0 disables this feature and in this case only the default
+indentation will be used.
+This does not have any visible effects for lists.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="first_property_name">
-<parameter_description> the name of the first property to get
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="var_args">
-<parameter_description> a <type>va_list</type> of pairs of property names and
-locations to return the property values, starting with the location
-for @first_property_name.
+<parameter name="indentation">
+<parameter_description> the amount, in pixels, of extra indentation in @tree_view.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_model_ref_node">
+<function name="gtk_tree_view_set_model">
<description>
-Lets the tree ref the node. This is an optional method for models to
-implement. To be more specific, models may ignore this call as it exists
-primarily for performance reasons.
-
-This function is primarily meant as a way for views to let caching model
-know when nodes are being displayed (and hence, whether or not to cache that
-node.) For example, a file-system based model would not want to keep the
-entire file-hierarchy in memory, just the sections that are currently being
-displayed by every current view.
-
-A model should be expected to be able to get an iter independent of its
-reffed state.
+Sets the model for a #GtkTreeView. If the @tree_view already has a model
+set, it will remove it before setting the new model. If @model is %NULL,
+then it will unset the old model.
</description>
<parameters>
-<parameter name="tree_model">
-<parameter_description> A #GtkTreeModel.
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeNode.
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> The #GtkTreeIter.
+<parameter name="model">
+<parameter_description> The model.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_show_now">
+<function name="gtk_tree_view_set_reorderable">
<description>
-Shows a widget. If the widget is an unmapped toplevel widget
-(i.e. a #GtkWindow that has not yet been shown), enter the main
-loop and wait for the window to actually be mapped. Be careful;
-because the main loop is running, anything can happen during
-this function.
+This function is a convenience function to allow you to reorder
+models that support the #GtkDragSourceIface and the
+#GtkDragDestIface. Both #GtkTreeStore and #GtkListStore support
+these. If @reorderable is %TRUE, then the user can reorder the
+model by dragging and dropping rows. The developer can listen to
+these changes by connecting to the model's row_inserted and
+row_deleted signals. The reordering is implemented by setting up
+the tree view as a drag source and destination. Therefore, drag and
+drop can not be used in a reorderable view for any other purpose.
+
+This function does not give you any degree of control over the order -- any
+reordering is allowed. If more control is needed, you should probably
+handle drag and drop manually.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView.
+</parameter_description>
+</parameter>
+<parameter name="reorderable">
+<parameter_description> %TRUE, if the tree can be reordered.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_notebook_append_page">
+<function name="gtk_tree_view_set_row_separator_func">
<description>
-Appends a page to @notebook.
+Sets the row separator function, which is used to determine
+whether a row should be drawn as a separator. If the row separator
+function is %NULL, no separators are drawn. This is the default value.
+Since: 2.6
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="child">
-<parameter_description> the #GtkWidget to use as the contents of the page.
+<parameter name="func">
+<parameter_description> a #GtkTreeViewRowSeparatorFunc
</parameter_description>
</parameter>
-<parameter name="tab_label">
-<parameter_description> the #GtkWidget to be used as the label for the page,
-or %NULL to use the default label, 'page N'.
+<parameter name="data">
+<parameter_description> user data to pass to @func, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="destroy">
+<parameter_description> destroy notifier for @data, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the index (starting from 0) of the appended
-page in the notebook, or -1 if function fails
-</return>
+<return></return>
</function>
-<function name="gtk_recent_filter_add_mime_type">
+<function name="gtk_tree_view_set_rubber_banding">
<description>
-Adds a rule that allows resources based on their registered MIME type.
+Enables or disables rubber banding in @tree_view. If the selection mode
+is #GTK_SELECTION_MULTIPLE, rubber banding will allow the user to select
+multiple rows by dragging the mouse.
Since: 2.10
</description>
<parameters>
-<parameter name="filter">
-<parameter_description> a #GtkRecentFilter
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="mime_type">
-<parameter_description> a MIME type
+<parameter name="enable">
+<parameter_description> %TRUE to enable rubber banding
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_get_bin_window">
+<function name="gtk_tree_view_set_rules_hint">
<description>
-Returns the window that @tree_view renders to. This is used primarily to
-compare to <literal>event->window</literal> to confirm that the event on
- tree_view is on the right window.
+This function tells GTK+ that the user interface for your
+application requires users to read across tree rows and associate
+cells with one another. By default, GTK+ will then render the tree
+with alternating row colors. Do <emphasis>not</emphasis> use it
+just because you prefer the appearance of the ruled tree; that's a
+question for the theme. Some themes will draw tree rows in
+alternating colors even when rules are turned off, and users who
+prefer that appearance all the time can choose those themes. You
+should call this function only as a <emphasis>semantic</emphasis>
+hint to the theme engine that your tree makes alternating colors
+useful from a functional standpoint (since it has lots of columns,
+generally).
</description>
<parameters>
<parameter name="tree_view">
-<parameter_description> A #GtkTreeView
+<parameter_description> a #GtkTreeView
+</parameter_description>
+</parameter>
+<parameter name="setting">
+<parameter_description> %TRUE if the tree requires reading across rows
</parameter_description>
</parameter>
</parameters>
-<return> A #GdkWindow, or %NULL when @tree_view hasn't been realized yet
-</return>
+<return></return>
</function>
-<function name="gtk_message_dialog_format_secondary_text">
+<function name="gtk_tree_view_set_search_column">
<description>
-Sets the secondary text of the message dialog to be @message_format
-(with printf()-style).
+Sets @column as the column where the interactive search code should
+search in for the current model.
-Note that setting a secondary text makes the primary text become
-bold, unless you have provided explicit markup.
+If the search column is set, users can use the "start-interactive-search"
+key binding to bring up search popup. The enable-search property controls
+whether simply typing text will also start an interactive search.
-Since: 2.6
+Note that @column refers to a column of the current model. The search
+column is reset to -1 when the model is changed.
</description>
<parameters>
-<parameter name="message_dialog">
-<parameter_description> a #GtkMessageDialog
-</parameter_description>
-</parameter>
-<parameter name="message_format">
-<parameter_description> printf()-style format string, or %NULL
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> arguments for @message_format
+<parameter name="column">
+<parameter_description> the column of the model to search in, or -1 to disable searching
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_toolbar_get_nth_item">
+<function name="gtk_tree_view_set_search_entry">
<description>
-Returns the @n<!-- -->'th item on @toolbar, or %NULL if the
-toolbar does not contain an @n<!-- -->'th item.
+Sets the entry which the interactive search code will use for this
+ tree_view This is useful when you want to provide a search entry
+in our interface at all time at a fixed position. Passing %NULL for
+ entry will make the interactive search code use the built-in popup
+entry again.
-Since: 2.4
+Since: 2.10
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="n">
-<parameter_description> A position on the toolbar
+<parameter name="entry">
+<parameter_description> the entry the interactive search code of @tree_view should use or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> The @n<!-- -->'th #GtkToolItem on @toolbar, or %NULL if there
-isn't an @n<!-- -->'th item.
-
-</return>
+<return></return>
</function>
-<function name="gtk_font_selection_dialog_get_apply_button">
+<function name="gtk_tree_view_set_search_equal_func">
<description>
-Obtains a button. The button doesn't have any function.
-
-Since: 2.14
-
-Deprecated: 2.16: Don't use this function.
+Sets the compare function for the interactive search capabilities; note
+that somewhat like strcmp() returning 0 for equality
+#GtkTreeViewSearchEqualFunc returns %FALSE on matches.
</description>
<parameters>
-<parameter name="fsd">
-<parameter_description> a #GtkFontSelectionDialog
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView
+</parameter_description>
+</parameter>
+<parameter name="search_equal_func">
+<parameter_description> the compare function to use during the search
+</parameter_description>
+</parameter>
+<parameter name="search_user_data">
+<parameter_description> user data to pass to @search_equal_func, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="search_destroy">
+<parameter_description> Destroy notifier for @search_user_data, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkWidget
-
-</return>
+<return></return>
</function>
-<function name="gtk_layout_set_vadjustment">
+<function name="gtk_tree_view_set_search_position_func">
<description>
-Sets the vertical scroll adjustment for the layout.
-
-See #GtkScrolledWindow, #GtkScrollbar, #GtkAdjustment for details.
+Sets the function to use when positioning the search dialog.
+Since: 2.10
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #GtkLayout
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="adjustment">
-<parameter_description> new scroll adjustment
+<parameter name="func">
+<parameter_description> the function to use to position the search dialog, or %NULL
+to use the default search position function
+</parameter_description>
+</parameter>
+<parameter name="data">
+<parameter_description> user data to pass to @func, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="destroy">
+<parameter_description> Destroy notifier for @data, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_view_set_item_width">
+<function name="gtk_tree_view_set_show_expanders">
<description>
-Sets the ::item-width property which specifies the width
-to use for each item. If it is set to -1, the icon view will
-automatically determine a suitable item size.
+Sets whether to draw and enable expanders and indent child rows in
+ tree_view When disabled there will be no expanders visible in trees
+and there will be no way to expand and collapse rows by default. Also
+note that hiding the expanders will disable the default indentation. You
+can set a custom indentation in this case using
+gtk_tree_view_set_level_indentation().
+This does not have any visible effects for lists.
-Since: 2.6
+Since: 2.12
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="item_width">
-<parameter_description> the width for each item
+<parameter name="enabled">
+<parameter_description> %TRUE to enable expander drawing, %FALSE otherwise.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_alignment_get_padding">
+<function name="gtk_tree_view_set_tooltip_cell">
<description>
-Gets the padding on the different sides of the widget.
-See gtk_alignment_set_padding ().
+Sets the tip area of @tooltip to the area @path, @column and @cell have
+in common. For example if @path is %NULL and @column is set, the tip
+area will be set to the full area covered by @column. See also
+gtk_tooltip_set_tip_area().
-Since: 2.4
+Note that if @path is not specified and @cell is set and part of a column
+containing the expander, the tooltip might not show and hide at the correct
+position. In such cases @path must be set to the current node under the
+mouse cursor for this function to operate correctly.
+
+See also gtk_tree_view_set_tooltip_column() for a simpler alternative.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="alignment">
-<parameter_description> a #GtkAlignment
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="padding_top">
-<parameter_description> location to store the padding for the top of the widget, or %NULL
+<parameter name="tooltip">
+<parameter_description> a #GtkTooltip
</parameter_description>
</parameter>
-<parameter name="padding_bottom">
-<parameter_description> location to store the padding for the bottom of the widget, or %NULL
+<parameter name="path">
+<parameter_description> a #GtkTreePath or %NULL
</parameter_description>
</parameter>
-<parameter name="padding_left">
-<parameter_description> location to store the padding for the left of the widget, or %NULL
+<parameter name="column">
+<parameter_description> a #GtkTreeViewColumn or %NULL
</parameter_description>
</parameter>
-<parameter name="padding_right">
-<parameter_description> location to store the padding for the right of the widget, or %NULL
+<parameter name="cell">
+<parameter_description> a #GtkCellRenderer or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_entry_completion_get_completion_prefix">
+<function name="gtk_tree_view_set_tooltip_column">
<description>
-Get the original text entered by the user that triggered
-the completion or %NULL if there's no completion ongoing.
-
-Since: 2.12
-
-</description>
-<parameters>
-<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
-</parameter_description>
-</parameter>
-</parameters>
-<return> the prefix for the current completion
+If you only plan to have simple (text-only) tooltips on full rows, you
+can use this function to have #GtkTreeView handle these automatically
+for you. @column should be set to the column in @tree_view's model
+containing the tooltip texts, or -1 to disable this feature.
-</return>
-</function>
+When enabled, #GtkWidget::has-tooltip will be set to %TRUE and
+ tree_view will connect a #GtkWidget::query-tooltip signal handler.
-<function name="gtk_calendar_set_display_options">
-<description>
-Sets display options (whether to display the heading and the month
-headings).
+Note that the signal handler sets the text with gtk_tooltip_set_markup(),
+so &, <, etc have to be escaped in the text.
-Since: 2.4
+Since: 2.12
</description>
<parameters>
-<parameter name="calendar">
-<parameter_description> a #GtkCalendar
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="flags">
-<parameter_description> the display options to set
+<parameter name="column">
+<parameter_description> an integer, which is a valid column number for @tree_view's model
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_recent_filter_add_custom">
+<function name="gtk_tree_view_set_tooltip_row">
<description>
-Adds a rule to a filter that allows resources based on a custom callback
-function. The bitfield @needed which is passed in provides information
-about what sorts of information that the filter function needs;
-this allows GTK+ to avoid retrieving expensive information when
-it isn't needed by the filter.
+Sets the tip area of @tooltip to be the area covered by the row at @path.
+See also gtk_tree_view_set_tooltip_column() for a simpler alternative.
+See also gtk_tooltip_set_tip_area().
-Since: 2.10
+Since: 2.12
</description>
<parameters>
-<parameter name="filter">
-<parameter_description> a #GtkRecentFilter
-</parameter_description>
-</parameter>
-<parameter name="needed">
-<parameter_description> bitfield of flags indicating the information that the custom
-filter function needs.
-</parameter_description>
-</parameter>
-<parameter name="func">
-<parameter_description> callback function; if the function returns %TRUE, then
-the file will be displayed.
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> data to pass to @func
+<parameter name="tooltip">
+<parameter_description> a #GtkTooltip
</parameter_description>
</parameter>
-<parameter name="data_destroy">
-<parameter_description> function to call to free @data when it is no longer needed.
+<parameter name="path">
+<parameter_description> a #GtkTreePath
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_get_has_selection">
+<function name="gtk_tree_view_set_vadjustment">
<description>
-Indicates whether the buffer has some text currently selected.
-
-Since: 2.10
+Sets the #GtkAdjustment for the current vertical aspect.
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="tree_view">
+<parameter_description> A #GtkTreeView
+</parameter_description>
+</parameter>
+<parameter name="adjustment">
+<parameter_description> The #GtkAdjustment to set, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the there is text selected
-
-</return>
+<return></return>
</function>
-<function name="gtk_text_iter_forward_visible_lines">
+<function name="gtk_tree_view_tree_to_widget_coords">
<description>
-Moves @count visible lines forward, if possible (if @count would move
-past the start or end of the buffer, moves to the start or end of
-the buffer). The return value indicates whether the iterator moved
-onto a dereferenceable position; if the iterator didn't move, or
-moved onto the end iterator, then %FALSE is returned. If @count is 0,
-the function does nothing and returns %FALSE. If @count is negative,
-moves backward by 0 - @count lines.
+Converts tree coordinates (coordinates in full scrollable area of the tree)
+to bin_window coordinates.
+
+Deprecated: 2.12: Due to historial reasons the name of this function is
+incorrect. For converting bin_window coordinates to coordinates relative
+to bin_window, please see
+gtk_tree_view_convert_bin_window_to_widget_coords().
-Since: 2.8
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="count">
-<parameter_description> number of lines to move forward
+<parameter name="tx">
+<parameter_description> tree X coordinate
</parameter_description>
</parameter>
-</parameters>
-<return> whether @iter moved and is dereferenceable
-
-</return>
-</function>
-
-<function name="gtk_tool_item_group_get_label">
-<description>
-Gets the label of @group.
-
-Since: 2.20
-
-</description>
-<parameters>
-<parameter name="group">
-<parameter_description> a #GtkToolItemGroup
+<parameter name="ty">
+<parameter_description> tree Y coordinate
+</parameter_description>
+</parameter>
+<parameter name="wx">
+<parameter_description> return location for X coordinate relative to bin_window
+</parameter_description>
+</parameter>
+<parameter name="wy">
+<parameter_description> return location for Y coordinate relative to bin_window
</parameter_description>
</parameter>
</parameters>
-<return> the label of @group. The label is an internal string of @group
-and must not be modified. Note that %NULL is returned if a custom
-label has been set with gtk_tool_item_group_set_label_widget()
-
-</return>
+<return></return>
</function>
-<function name="gtk_font_button_new">
+<function name="gtk_tree_view_unset_rows_drag_dest">
<description>
-Creates a new font picker widget.
-
-Since: 2.4
+Undoes the effect of
+gtk_tree_view_enable_model_drag_dest(). Calling this method sets
+#GtkTreeView:reorderable to %FALSE.
</description>
<parameters>
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
+</parameter_description>
+</parameter>
</parameters>
-<return> a new font picker widget.
-
-</return>
+<return></return>
</function>
-<function name="gtk_container_focus_sort">
+<function name="gtk_tree_view_unset_rows_drag_source">
<description>
-Sorts @children in the correct order for focusing with
-direction type @direction.
-
+Undoes the effect of
+gtk_tree_view_enable_model_drag_source(). Calling this method sets
+#GtkTreeView:reorderable to %FALSE.
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
-</parameter_description>
-</parameter>
-<parameter name="children">
-<parameter_description> a list of descendents of @container (they don't
-have to be direct children)
-</parameter_description>
-</parameter>
-<parameter name="direction">
-<parameter_description> focus direction
-</parameter_description>
-</parameter>
-<parameter name="old_focus">
-<parameter_description> widget to use for the starting position, or %NULL
-to determine this automatically.
-(Note, this argument isn't used for GTK_DIR_TAB_*,
-which is the only @direction we use currently,
-so perhaps this argument should be removed)
+<parameter name="tree_view">
+<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
</parameters>
-<return> a copy of @children, sorted in correct focusing order,
-with children that aren't suitable for focusing in this direction
-removed.
-</return>
+<return></return>
</function>
-<function name="gtk_tree_view_convert_bin_window_to_tree_coords">
+<function name="gtk_tree_view_widget_to_tree_coords">
<description>
Converts bin_window coordinates to coordinates for the
tree (the full scrollable area of the tree).
-Since: 2.12
+Deprecated: 2.12: Due to historial reasons the name of this function is
+incorrect. For converting coordinates relative to the widget to
+bin_window coordinates, please see
+gtk_tree_view_convert_widget_to_bin_window_coords().
+
</description>
<parameters>
@@ -62929,11 +62978,11 @@ Since: 2.12
<parameter_description> a #GtkTreeView
</parameter_description>
</parameter>
-<parameter name="bx">
+<parameter name="wx">
<parameter_description> X coordinate relative to bin_window
</parameter_description>
</parameter>
-<parameter name="by">
+<parameter name="wy">
<parameter_description> Y coordinate relative to bin_window
</parameter_description>
</parameter>
@@ -62949,911 +62998,887 @@ Since: 2.12
<return></return>
</function>
-<function name="gtk_tree_store_set_valist">
+<function name="gtk_type_class">
<description>
-See gtk_tree_store_set(); this version takes a <type>va_list</type> for
-use by language bindings.
+Returns a pointer pointing to the class of @type or %NULL if there
+was any trouble identifying @type. Initializes the class if
+necessary.
+Deprecated: 2.14: Use g_type_class_peek() or g_type_class_ref() instead.
</description>
<parameters>
-<parameter name="tree_store">
-<parameter_description> A #GtkTreeStore
+<parameter name="type">
+<parameter_description> a #GtkType.
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> A valid #GtkTreeIter for the row being modified
+</parameters>
+<return> pointer to the class.
+
+</return>
+</function>
+
+<function name="gtk_ui_manager_add_ui">
+<description>
+Adds a UI element to the current contents of @self.
+
+If @type is %GTK_UI_MANAGER_AUTO, GTK+ inserts a menuitem, toolitem or
+separator if such an element can be inserted at the place determined by
+ path Otherwise @type must indicate an element that can be inserted at
+the place determined by @path.
+
+If @path points to a menuitem or toolitem, the new element will be inserted
+before or after this item, depending on @top.
+
+Since: 2.4
+
+</description>
+<parameters>
+<parameter name="self">
+<parameter_description> a #GtkUIManager
</parameter_description>
</parameter>
-<parameter name="var_args">
-<parameter_description> <type>va_list</type> of column/value pairs
+<parameter name="merge_id">
+<parameter_description> the merge id for the merged UI, see gtk_ui_manager_new_merge_id()
+</parameter_description>
+</parameter>
+<parameter name="path">
+<parameter_description> a path
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> the name for the added UI element
+</parameter_description>
+</parameter>
+<parameter name="action">
+<parameter_description> the name of the action to be proxied, or %NULL to add a separator
+</parameter_description>
+</parameter>
+<parameter name="type">
+<parameter_description> the type of UI element to add.
+</parameter_description>
+</parameter>
+<parameter name="top">
+<parameter_description> if %TRUE, the UI element is added before its siblings, otherwise it
+is added after its siblings.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_font_selection_dialog_get_font_selection">
+<function name="gtk_ui_manager_add_ui_from_file">
<description>
-Retrieves the #GtkFontSelection widget embedded in the dialog.
+Parses a file containing a <link linkend="XML-UI">UI definition</link> and
+merges it with the current contents of @self.
-Since: 2.22
+Since: 2.4
</description>
<parameters>
-<parameter name="colorsel">
-<parameter_description> a #GtkFontSelectionDialog
+<parameter name="self">
+<parameter_description> a #GtkUIManager object
+</parameter_description>
+</parameter>
+<parameter name="filename">
+<parameter_description> the name of the file to parse
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> return location for an error
</parameter_description>
</parameter>
</parameters>
-<return> the embedded #GtkFontSelection
+<return> The merge id for the merged UI. The merge id can be used
+to unmerge the UI with gtk_ui_manager_remove_ui(). If an error occurred,
+the return value is 0.
</return>
</function>
-<function name="gtk_enumerate_printers">
+<function name="gtk_ui_manager_add_ui_from_string">
<description>
-Calls a function for all #GtkPrinter<!-- -->s.
-If @func returns %TRUE, the enumeration is stopped.
+Parses a string containing a <link linkend="XML-UI">UI definition</link> and
+merges it with the current contents of @self. An enclosing <ui>
+element is added if it is missing.
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="func">
-<parameter_description> a function to call for each printer
+<parameter name="self">
+<parameter_description> a #GtkUIManager object
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> user data to pass to @func
+<parameter name="buffer">
+<parameter_description> the string to parse
</parameter_description>
</parameter>
-<parameter name="destroy">
-<parameter_description> function to call if @data is no longer needed
+<parameter name="length">
+<parameter_description> the length of @buffer (may be -1 if @buffer is nul-terminated)
</parameter_description>
</parameter>
-<parameter name="wait">
-<parameter_description> if %TRUE, wait in a recursive mainloop until
-all printers are enumerated; otherwise return early
+<parameter name="error">
+<parameter_description> return location for an error
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> The merge id for the merged UI. The merge id can be used
+to unmerge the UI with gtk_ui_manager_remove_ui(). If an error occurred,
+the return value is 0.
+
+</return>
</function>
-<function name="gtk_check_button_new_with_mnemonic">
+<function name="gtk_ui_manager_ensure_update">
<description>
-Creates a new #GtkCheckButton containing a label. The label
-will be created using gtk_label_new_with_mnemonic(), so underscores
-in @label indicate the mnemonic for the check button.
+Makes sure that all pending updates to the UI have been completed.
+
+This may occasionally be necessary, since #GtkUIManager updates the
+UI in an idle function. A typical example where this function is
+useful is to enforce that the menubar and toolbar have been added to
+the main window before showing it:
+|[
+gtk_container_add (GTK_CONTAINER (window), vbox);
+g_signal_connect (merge, "add-widget",
+G_CALLBACK (add_widget), vbox);
+gtk_ui_manager_add_ui_from_file (merge, "my-menus");
+gtk_ui_manager_add_ui_from_file (merge, "my-toolbars");
+gtk_ui_manager_ensure_update (merge);
+gtk_widget_show (window);
+]|
+
+Since: 2.4
</description>
<parameters>
-<parameter name="label">
-<parameter_description> The text of the button, with an underscore in front of the
-mnemonic character
+<parameter name="self">
+<parameter_description> a #GtkUIManager
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkCheckButton
-</return>
+<return></return>
</function>
-<function name="gtk_about_dialog_get_authors">
+<function name="gtk_ui_manager_get_accel_group">
<description>
-Returns the string which are displayed in the authors tab
-of the secondary credits dialog.
+Returns the #GtkAccelGroup associated with @self.
-Since: 2.6
+Since: 2.4
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
+<parameter name="self">
+<parameter_description> a #GtkUIManager object
</parameter_description>
</parameter>
</parameters>
-<return> A %NULL-terminated string array containing
-the authors. The array is owned by the about dialog
-and must not be modified.
+<return> the #GtkAccelGroup.
</return>
</function>
-<function name="gtk_combo_box_insert_text">
+<function name="gtk_ui_manager_get_action">
<description>
-Inserts @string at @position in the list of strings stored in @combo_box.
-Note that you can only use this function with combo boxes constructed
-with gtk_combo_box_new_text().
+Looks up an action by following a path. See gtk_ui_manager_get_widget()
+for more information about paths.
Since: 2.4
</description>
<parameters>
-<parameter name="combo_box">
-<parameter_description> A #GtkComboBox constructed using gtk_combo_box_new_text()
-</parameter_description>
-</parameter>
-<parameter name="position">
-<parameter_description> An index to insert @text
+<parameter name="self">
+<parameter_description> a #GtkUIManager
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> A string
+<parameter name="path">
+<parameter_description> a path
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the action whose proxy widget is found by following the path,
+or %NULL if no widget was found.
+
+</return>
</function>
-<function name="gtk_mount_operation_get_parent">
+<function name="gtk_ui_manager_get_action_groups">
<description>
-Gets the transient parent used by the #GtkMountOperation
+Returns the list of action groups associated with @self.
-Since: 2.14
+Since: 2.4
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkMountOperation
+<parameter name="self">
+<parameter_description> a #GtkUIManager object
</parameter_description>
</parameter>
</parameters>
-<return> the transient parent for windows shown by @op
+<return> a #GList of
+action groups. The list is owned by GTK+
+and should not be modified.
</return>
</function>
-<function name="gtk_printer_is_accepting_jobs">
+<function name="gtk_ui_manager_get_add_tearoffs">
<description>
-Returns whether the printer is accepting jobs
+Returns whether menus generated by this #GtkUIManager
+will have tearoff menu items.
-Since: 2.14
+Since: 2.4
</description>
<parameters>
-<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter name="self">
+<parameter_description> a #GtkUIManager
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @printer is accepting jobs
+<return> whether tearoff menu items are added
</return>
</function>
-<function name="gtk_tool_shell_rebuild_menu">
+<function name="gtk_ui_manager_get_toplevels">
<description>
-Calling this function signals the tool shell that the overflow menu item for
-tool items have changed. If there is an overflow menu and if it is visible
-when this function it called, the menu will be rebuilt.
-
-Tool items must not call this function directly, but rely on
-gtk_tool_item_rebuild_menu() instead.
+Obtains a list of all toplevel widgets of the requested types.
-Since: 2.14
+Since: 2.4
</description>
<parameters>
-<parameter name="shell">
-<parameter_description> a #GtkToolShell
+<parameter name="self">
+<parameter_description> a #GtkUIManager
+</parameter_description>
+</parameter>
+<parameter name="types">
+<parameter_description> specifies the types of toplevel widgets to include. Allowed
+types are #GTK_UI_MANAGER_MENUBAR, #GTK_UI_MANAGER_TOOLBAR and
+#GTK_UI_MANAGER_POPUP.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a newly-allocated #GSList of
+all toplevel widgets of the requested types. Free the returned list with g_slist_free().
+
+</return>
</function>
-<function name="gtk_file_chooser_unselect_uri">
+<function name="gtk_ui_manager_get_ui">
<description>
-Unselects the file referred to by @uri. If the file
-is not in the current directory, does not exist, or
-is otherwise not currently selected, does nothing.
+Creates a <link linkend="XML-UI">UI definition</link> of the merged UI.
Since: 2.4
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
-</parameter_description>
-</parameter>
-<parameter name="uri">
-<parameter_description> the URI to unselect
+<parameter name="self">
+<parameter_description> a #GtkUIManager
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A newly allocated string containing an XML representation of
+the merged UI.
+
+</return>
</function>
-<function name="gtk_image_new_from_gicon">
+<function name="gtk_ui_manager_get_widget">
<description>
-Creates a #GtkImage displaying an icon from the current icon theme.
-If the icon name isn't known, a "broken image" icon will be
-displayed instead. If the current icon theme is changed, the icon
-will be updated appropriately.
+Looks up a widget by following a path.
+The path consists of the names specified in the XML description of the UI.
+separated by '/'. Elements which don't have a name or action attribute in
+the XML (e.g. <popup>) can be addressed by their XML element name
+(e.g. "popup"). The root element ("/ui") can be omitted in the path.
-Since: 2.14
+Note that the widget found by following a path that ends in a <menu>
+element is the menuitem to which the menu is attached, not the menu itself.
+
+Also note that the widgets constructed by a ui manager are not tied to
+the lifecycle of the ui manager. If you add the widgets returned by this
+function to some container or explicitly ref them, they will survive the
+destruction of the ui manager.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="icon">
-<parameter_description> an icon
+<parameter name="self">
+<parameter_description> a #GtkUIManager
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> a stock icon size
+<parameter name="path">
+<parameter_description> a path
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkImage displaying the themed icon
+<return> the widget found by following the path, or %NULL if no widget
+was found.
</return>
</function>
-<function name="gtk_item_factory_delete_entry">
+<function name="gtk_ui_manager_insert_action_group">
<description>
-Deletes the menu item which was created from @entry by the given
-item factory.
+Inserts an action group into the list of action groups associated
+with @self. Actions in earlier groups hide actions with the same
+name in later groups.
-Deprecated: 2.4: Use #GtkUIManager instead.
+Since: 2.4
</description>
<parameters>
-<parameter name="ifactory">
-<parameter_description> a #GtkItemFactory
+<parameter name="self">
+<parameter_description> a #GtkUIManager object
</parameter_description>
</parameter>
-<parameter name="entry">
-<parameter_description> a #GtkItemFactoryEntry
+<parameter name="action_group">
+<parameter_description> the action group to be inserted
+</parameter_description>
+</parameter>
+<parameter name="pos">
+<parameter_description> the position at which the group will be inserted.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tool_palette_get_drag_target_item">
+<function name="gtk_ui_manager_new">
<description>
-Gets the target entry for a dragged #GtkToolItem.
+Creates a new ui manager object.
-Since: 2.20
+Since: 2.4
</description>
<parameters>
</parameters>
-<return> the #GtkTargetEntry for a dragged item.
+<return> a new ui manager object.
</return>
</function>
-<function name="gtk_widget_child_notify">
+<function name="gtk_ui_manager_new_merge_id">
<description>
-Emits a #GtkWidget::child-notify signal for the
-<link linkend="child-properties">child property</link> @child_property
-on @widget.
+Returns an unused merge id, suitable for use with
+gtk_ui_manager_add_ui().
-This is the analogue of g_object_notify() for child properties.
+Since: 2.4
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="child_property">
-<parameter_description> the name of a child property installed on the
-class of @widget<!-- -->'s parent
+<parameter name="self">
+<parameter_description> a #GtkUIManager
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> an unused merge id.
+
+</return>
</function>
-<function name="gtk_window_resize">
+<function name="gtk_ui_manager_remove_action_group">
<description>
-Resizes the window as if the user had done so, obeying geometry
-constraints. The default geometry constraint is that windows may
-not be smaller than their size request; to override this
-constraint, call gtk_widget_set_size_request() to set the window's
-request to a smaller value.
-
-If gtk_window_resize() is called before showing a window for the
-first time, it overrides any default size set with
-gtk_window_set_default_size().
-
-Windows may not be resized smaller than 1 by 1 pixels.
+Removes an action group from the list of action groups associated
+with @self.
+Since: 2.4
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> width in pixels to resize the window to
+<parameter name="self">
+<parameter_description> a #GtkUIManager object
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> height in pixels to resize the window to
+<parameter name="action_group">
+<parameter_description> the action group to be removed
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_paper_size_get_display_name">
+<function name="gtk_ui_manager_remove_ui">
<description>
-Gets the human-readable name of the #GtkPaperSize.
+Unmerges the part of @self<!-- -->s content identified by @merge_id.
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="size">
-<parameter_description> a #GtkPaperSize object
+<parameter name="self">
+<parameter_description> a #GtkUIManager object
+</parameter_description>
+</parameter>
+<parameter name="merge_id">
+<parameter_description> a merge id as returned by gtk_ui_manager_add_ui_from_string()
</parameter_description>
</parameter>
</parameters>
-<return> the human-readable name of @size
-
-</return>
+<return></return>
</function>
-<function name="gtk_widget_grab_focus">
+<function name="gtk_ui_manager_set_add_tearoffs">
<description>
-Causes @widget to have the keyboard focus for the #GtkWindow it's
-inside. @widget must be a focusable widget, such as a #GtkEntry;
-something like #GtkFrame won't work.
+Sets the "add_tearoffs" property, which controls whether menus
+generated by this #GtkUIManager will have tearoff menu items.
-More precisely, it must have the %GTK_CAN_FOCUS flag set. Use
-gtk_widget_set_can_focus() to modify that flag.
+Note that this only affects regular menus. Generated popup
+menus never have tearoff menu items.
-The widget also needs to be realized and mapped. This is indicated by the
-related signals. Grabbing the focus immediately after creating the widget
-will likely fail and cause critical warnings.
+Since: 2.4
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="self">
+<parameter_description> a #GtkUIManager
+</parameter_description>
+</parameter>
+<parameter name="add_tearoffs">
+<parameter_description> whether tearoff menu items are added
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_label_set_line_wrap">
+<function name="gtk_vbox_new">
<description>
-Toggles line wrapping within the #GtkLabel widget. %TRUE makes it break
-lines if text exceeds the widget's size. %FALSE lets the text get cut off
-by the edge of the widget if it exceeds the widget size.
+Creates a new #GtkVBox.
-Note that setting line wrapping to %TRUE does not make the label
-wrap at its parent container's width, because GTK+ widgets
-conceptually can't make their requisition depend on the parent
-container's size. For a label that wraps at a specific position,
-set the label's width using gtk_widget_set_size_request().
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="homogeneous">
+<parameter_description> %TRUE if all children are to be given equal space allotments.
</parameter_description>
</parameter>
-<parameter name="wrap">
-<parameter_description> the setting
+<parameter name="spacing">
+<parameter_description> the number of pixels to place by default between children.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GtkVBox.
+</return>
</function>
-<function name="gtk_check_menu_item_new_with_mnemonic">
+<function name="gtk_vbutton_box_get_layout_default">
<description>
-Creates a new #GtkCheckMenuItem containing a label. The label
-will be created using gtk_label_new_with_mnemonic(), so underscores
-in @label indicate the mnemonic for the menu item.
+Retrieves the current layout used to arrange buttons in button box widgets.
+
+Deprecated: 2.0: Use gtk_button_box_get_layout() instead.
</description>
<parameters>
-<parameter name="label">
-<parameter_description> The text of the button, with an underscore in front of the
-mnemonic character
-</parameter_description>
-</parameter>
</parameters>
-<return> a new #GtkCheckMenuItem
+<return> the current #GtkButtonBoxStyle.
+
</return>
</function>
-<function name="gtk_text_tag_table_remove">
+<function name="gtk_vbutton_box_get_spacing_default">
<description>
-Remove a tag from the table. This will remove the table's
-reference to the tag, so be careful - the tag will end
-up destroyed if you don't have a reference to it.
+Retrieves the current default spacing for vertical button boxes. This is the number of pixels
+to be placed between the buttons when they are arranged.
+
+Deprecated: 2.0: Use gtk_box_get_spacing() instead.
</description>
<parameters>
-<parameter name="table">
-<parameter_description> a #GtkTextTagTable
-</parameter_description>
-</parameter>
-<parameter name="tag">
-<parameter_description> a #GtkTextTag
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> the default number of pixels between buttons.
+
+</return>
</function>
-<function name="gtk_icon_theme_set_custom_theme">
+<function name="gtk_vbutton_box_new">
<description>
-Sets the name of the icon theme that the #GtkIconTheme object uses
-overriding system configuration. This function cannot be called
-on the icon theme objects returned from gtk_icon_theme_get_default()
-and gtk_icon_theme_get_for_screen().
+Creates a new vertical button box.
-Since: 2.4
</description>
<parameters>
-<parameter name="icon_theme">
-<parameter_description> a #GtkIconTheme
-</parameter_description>
-</parameter>
-<parameter name="theme_name">
-<parameter_description> name of icon theme to use instead of configured theme,
-or %NULL to unset a previously set custom theme
-</parameter_description>
-</parameter>
</parameters>
-<return></return>
+<return> a new button box #GtkWidget.
+</return>
</function>
-<function name="gtk_tool_item_rebuild_menu">
+<function name="gtk_vbutton_box_set_layout_default">
<description>
-Calling this function signals to the toolbar that the
-overflow menu item for @tool_item has changed. If the
-overflow menu is visible when this function it called,
-the menu will be rebuilt.
-
-The function must be called when the tool item changes what it
-will do in response to the #GtkToolItem::create-menu-proxy signal.
+Sets a new layout mode that will be used by all button boxes.
-Since: 2.6
+Deprecated: 2.0: Use gtk_button_box_set_layout() instead.
</description>
<parameters>
-<parameter name="tool_item">
-<parameter_description> a #GtkToolItem
+<parameter name="layout">
+<parameter_description> a new #GtkButtonBoxStyle.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_paper_size_get_default_right_margin">
+<function name="gtk_vbutton_box_set_spacing_default">
<description>
-Gets the default right margin for the #GtkPaperSize.
+Changes the default spacing that is placed between widgets in an
+vertical button box.
-Since: 2.10
+Deprecated: 2.0: Use gtk_box_set_spacing() instead.
</description>
<parameters>
-<parameter name="size">
-<parameter_description> a #GtkPaperSize object
-</parameter_description>
-</parameter>
-<parameter name="unit">
-<parameter_description> the unit for the return value
+<parameter name="spacing">
+<parameter_description> an integer value.
</parameter_description>
</parameter>
</parameters>
-<return> the default right margin
-
-</return>
+<return></return>
</function>
-<function name="gtk_text_iter_set_line_index">
+<function name="gtk_viewport_get_bin_window">
<description>
-Same as gtk_text_iter_set_line_offset(), but works with a
-<emphasis>byte</emphasis> index. The given byte index must be at
-the start of a character, it can't be in the middle of a UTF-8
-encoded character.
+Gets the bin window of the #GtkViewport.
+Since: 2.20
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
-</parameter_description>
-</parameter>
-<parameter name="byte_on_line">
-<parameter_description> a byte index relative to the start of @iter's current line
+<parameter name="viewport">
+<parameter_description> a #GtkViewport
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #GdkWindow
+
+</return>
</function>
-<function name="gtk_tree_get_row_drag_data">
+<function name="gtk_viewport_get_hadjustment">
<description>
-Obtains a @tree_model and @path from selection data of target type
-%GTK_TREE_MODEL_ROW. Normally called from a drag_data_received handler.
-This function can only be used if @selection_data originates from the same
-process that's calling this function, because a pointer to the tree model
-is being passed around. If you aren't in the same process, then you'll
-get memory corruption. In the #GtkTreeDragDest drag_data_received handler,
-you can assume that selection data of type %GTK_TREE_MODEL_ROW is
-in from the current process. The returned path must be freed with
-gtk_tree_path_free().
+Returns the horizontal adjustment of the viewport.
</description>
<parameters>
-<parameter name="selection_data">
-<parameter_description> a #GtkSelectionData
-</parameter_description>
-</parameter>
-<parameter name="tree_model">
-<parameter_description> a #GtkTreeModel
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> row in @tree_model
+<parameter name="viewport">
+<parameter_description> a #GtkViewport.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @selection_data had target type %GTK_TREE_MODEL_ROW and
-is otherwise valid
+<return> the horizontal adjustment of @viewport.
</return>
</function>
-<function name="gtk_scrolled_window_get_hscrollbar">
+<function name="gtk_viewport_get_shadow_type">
<description>
-Returns the horizontal scrollbar of @scrolled_window.
-
-Since: 2.8
+Gets the shadow type of the #GtkViewport. See
+gtk_viewport_set_shadow_type().
+
</description>
<parameters>
-<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
+<parameter name="viewport">
+<parameter_description> a #GtkViewport
</parameter_description>
</parameter>
</parameters>
-<return> the horizontal scrollbar of the scrolled window, or
-%NULL if it does not have one.
-
+<return> the shadow type
</return>
</function>
-<function name="gtk_range_get_adjustment">
+<function name="gtk_viewport_get_vadjustment">
<description>
-Get the #GtkAdjustment which is the "model" object for #GtkRange.
-See gtk_range_set_adjustment() for details.
-The return value does not have a reference added, so should not
-be unreferenced.
+Returns the vertical adjustment of the viewport.
</description>
<parameters>
-<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter name="viewport">
+<parameter_description> a #GtkViewport.
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkAdjustment
+<return> the vertical adjustment of @viewport.
</return>
</function>
-<function name="gtk_window_set_skip_taskbar_hint">
+<function name="gtk_viewport_get_view_window">
<description>
-Windows may set a hint asking the desktop environment not to display
-the window in the task bar. This function sets this hint.
+Gets the view window of the #GtkViewport.
-Since: 2.2
+Since: 2.22
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
-</parameter_description>
-</parameter>
-<parameter name="setting">
-<parameter_description> %TRUE to keep this window from appearing in the task bar
+<parameter name="viewport">
+<parameter_description> a #GtkViewport
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #GdkWindow
+
+</return>
</function>
-<function name="gtk_item_factory_popup_data">
+<function name="gtk_viewport_new">
<description>
-Obtains the @popup_data which was passed to
-gtk_item_factory_popup_with_data(). This data is available until the menu
-is popped down again.
+Creates a new #GtkViewport with the given adjustments.
-Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="ifactory">
-<parameter_description> a #GtkItemFactory
+<parameter name="hadjustment">
+<parameter_description> horizontal adjustment.
+</parameter_description>
+</parameter>
+<parameter name="vadjustment">
+<parameter_description> vertical adjustment.
</parameter_description>
</parameter>
</parameters>
-<return> @popup_data associated with @ifactory
+<return> a new #GtkViewport.
</return>
</function>
-<function name="gtk_icon_view_get_text_column">
+<function name="gtk_viewport_set_hadjustment">
<description>
-Returns the column with text for @icon_view.
-
-Since: 2.6
+Sets the horizontal adjustment of the viewport.
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> A #GtkIconView.
+<parameter name="viewport">
+<parameter_description> a #GtkViewport.
+</parameter_description>
+</parameter>
+<parameter name="adjustment">
+<parameter_description> a #GtkAdjustment.
</parameter_description>
</parameter>
</parameters>
-<return> the text column, or -1 if it's unset.
-
-</return>
+<return></return>
</function>
-<function name="gtk_tool_button_set_icon_widget">
+<function name="gtk_viewport_set_shadow_type">
<description>
-Sets @icon as the widget used as icon on @button. If @icon_widget is
-%NULL the icon is determined by the "stock_id" property. If the
-"stock_id" property is also %NULL, @button will not have an icon.
-
-Since: 2.4
+Sets the shadow type of the viewport.
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkToolButton
+<parameter name="viewport">
+<parameter_description> a #GtkViewport.
</parameter_description>
</parameter>
-<parameter name="icon_widget">
-<parameter_description> the widget used as icon, or %NULL
+<parameter name="type">
+<parameter_description> the new shadow type.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_copy_clipboard">
+<function name="gtk_viewport_set_vadjustment">
<description>
-Copies the currently-selected text to a clipboard.
+Sets the vertical adjustment of the viewport.
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="viewport">
+<parameter_description> a #GtkViewport.
</parameter_description>
</parameter>
-<parameter name="clipboard">
-<parameter_description> the #GtkClipboard object to copy to
+<parameter name="adjustment">
+<parameter_description> a #GtkAdjustment.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_recent_info_get_modified">
+<function name="gtk_volume_button_new">
<description>
-Gets the timestamp (seconds from system's Epoch) when the resource
-was last modified.
+Creates a #GtkVolumeButton, with a range between 0.0 and 1.0, with
+a stepping of 0.02. Volume values can be obtained and modified using
+the functions from #GtkScaleButton.
-Since: 2.10
+Since: 2.12
</description>
<parameters>
-<parameter name="info">
-<parameter_description> a #GtkRecentInfo
-</parameter_description>
-</parameter>
</parameters>
-<return> the number of seconds elapsed from system's Epoch when
-the resource was last modified, or -1 on failure.
+<return> a new #GtkVolumeButton
</return>
</function>
-<function name="gtk_toggle_action_get_draw_as_radio">
+<function name="gtk_vpaned_new">
<description>
-Returns whether the action should have proxies like a radio action.
+Create a new #GtkVPaned
-Since: 2.4
</description>
<parameters>
-<parameter name="action">
-<parameter_description> the action object
-</parameter_description>
-</parameter>
</parameters>
-<return> whether the action should have proxies like a radio action.
-
+<return> the new #GtkVPaned
</return>
</function>
-<function name="gtk_text_iter_get_buffer">
+<function name="gtk_vruler_new">
<description>
-Returns the #GtkTextBuffer this iterator is associated with.
+Creates a new vertical ruler
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
-</parameter_description>
-</parameter>
</parameters>
-<return> the buffer
+<return> a new #GtkVRuler.
+
+ Deprecated: 2.24: #GtkRuler has been removed from GTK 3 for being
+unmaintained and too specialized. There is no replacement.
</return>
</function>
-<function name="gtk_widget_set_redraw_on_allocate">
+<function name="gtk_vscale_new">
<description>
-Sets whether the entire widget is queued for drawing when its size
-allocation changes. By default, this setting is %TRUE and
-the entire widget is redrawn on every size change. If your widget
-leaves the upper left unchanged when made bigger, turning this
-setting off will improve performance.
+Creates a new #GtkVScale.
-Note that for %NO_WINDOW widgets setting this flag to %FALSE turns
-off all allocation on resizing: the widget will not even redraw if
-its position changes; this is to allow containers that don't draw
-anything to avoid excess invalidations. If you set this flag on a
-%NO_WINDOW widget that <emphasis>does</emphasis> draw on @widget->window,
-you are responsible for invalidating both the old and new allocation
-of the widget when the widget is moved and responsible for invalidating
-regions newly when the widget increases size.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="redraw_on_allocate">
-<parameter_description> if %TRUE, the entire widget will be redrawn
-when it is allocated to a new size. Otherwise, only the
-new portion of the widget will be redrawn.
+<parameter name="adjustment">
+<parameter_description> the #GtkAdjustment which sets the range of the scale.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a new #GtkVScale.
+</return>
</function>
-<function name="gtk_link_button_new">
+<function name="gtk_vscale_new_with_range">
<description>
-Creates a new #GtkLinkButton with the URI as its text.
+Creates a new vertical scale widget that lets the user input a
+number between @min and @max (including @min and @max) with the
+increment @step. @step must be nonzero; it's the distance the
+slider moves when using the arrow keys to adjust the scale value.
+
+Note that the way in which the precision is derived works best if @step
+is a power of ten. If the resulting precision is not suitable for your
+needs, use gtk_scale_set_digits() to correct it.
-Since: 2.10
</description>
<parameters>
-<parameter name="uri">
-<parameter_description> a valid URI
+<parameter name="min">
+<parameter_description> minimum value
+</parameter_description>
+</parameter>
+<parameter name="max">
+<parameter_description> maximum value
+</parameter_description>
+</parameter>
+<parameter name="step">
+<parameter_description> step increment (tick size) used with keyboard shortcuts
</parameter_description>
</parameter>
</parameters>
-<return> a new link button widget.
-
+<return> a new #GtkVScale
</return>
</function>
-<function name="gtk_rc_property_parse_border">
+<function name="gtk_vscrollbar_new">
<description>
-A #GtkRcPropertyParser for use with gtk_settings_install_property_parser()
-or gtk_widget_class_install_style_property_parser() which parses
-borders in the form
-<literal>"{ left, right, top, bottom }"</literal> for integers
-%left, %right, %top and %bottom.
+Creates a new vertical scrollbar.
</description>
<parameters>
-<parameter name="pspec">
-<parameter_description> a #GParamSpec
-</parameter_description>
-</parameter>
-<parameter name="gstring">
-<parameter_description> the #GString to be parsed
-</parameter_description>
-</parameter>
-<parameter name="property_value">
-<parameter_description> a #GValue which must hold boxed values.
+<parameter name="adjustment">
+<parameter_description> the #GtkAdjustment to use, or %NULL to create a new adjustment
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @gstring could be parsed and @property_value
-has been set to the resulting #GtkBorder.
+<return> the new #GtkVScrollbar
</return>
</function>
-<function name="gtk_text_iter_get_slice">
+<function name="gtk_vseparator_new">
<description>
-Returns the text in the given range. A "slice" is an array of
-characters encoded in UTF-8 format, including the Unicode "unknown"
-character 0xFFFC for iterable non-character elements in the buffer,
-such as images. Because images are encoded in the slice, byte and
-character offsets in the returned array will correspond to byte
-offsets in the text buffer. Note that 0xFFFC can occur in normal
-text as well, so it is not a reliable indicator that a pixbuf or
-widget is in the buffer.
+Creates a new #GtkVSeparator.
</description>
<parameters>
-<parameter name="start">
-<parameter_description> iterator at start of a range
-</parameter_description>
-</parameter>
-<parameter name="end">
-<parameter_description> iterator at end of a range
-</parameter_description>
-</parameter>
</parameters>
-<return> slice of text from the buffer
+<return> a new #GtkVSeparator.
</return>
</function>
-<function name="gtk_text_view_get_tabs">
+<function name="gtk_widget_activate">
<description>
-Gets the default tabs for @text_view. Tags in the buffer may
-override the defaults. The returned array will be %NULL if
-"standard" (8-space) tabs are used. Free the return value
-with pango_tab_array_free().
+For widgets that can be "activated" (buttons, menu items, etc.)
+this function activates them. Activation is what happens when you
+press Enter on a widget during key navigation. If @widget isn't
+activatable, the function returns %FALSE.
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="widget">
+<parameter_description> a #GtkWidget that's activatable
</parameter_description>
</parameter>
</parameters>
-<return> copy of default tab array, or %NULL if "standard"
-tabs are used; must be freed with pango_tab_array_free().
+<return> %TRUE if the widget was activatable
</return>
</function>
-<function name="gtk_print_operation_get_status">
+<function name="gtk_widget_add_accelerator">
<description>
-Returns the status of the print operation.
-Also see gtk_print_operation_get_status_string().
-
-Since: 2.10
+Installs an accelerator for this @widget in @accel_group that causes
+ accel_signal to be emitted if the accelerator is activated.
+The @accel_group needs to be added to the widget's toplevel via
+gtk_window_add_accel_group(), and the signal must be of type %G_RUN_ACTION.
+Accelerators added through this function are not user changeable during
+runtime. If you want to support accelerators that can be changed by the
+user, use gtk_accel_map_add_entry() and gtk_widget_set_accel_path() or
+gtk_menu_item_set_accel_path() instead.
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter name="widget">
+<parameter_description> widget to install an accelerator on
+</parameter_description>
+</parameter>
+<parameter name="accel_signal">
+<parameter_description> widget signal to emit on accelerator activation
+</parameter_description>
+</parameter>
+<parameter name="accel_group">
+<parameter_description> accel group for this widget, added to its toplevel
+</parameter_description>
+</parameter>
+<parameter name="accel_key">
+<parameter_description> GDK keyval of the accelerator
+</parameter_description>
+</parameter>
+<parameter name="accel_mods">
+<parameter_description> modifier key combination of the accelerator
+</parameter_description>
+</parameter>
+<parameter name="accel_flags">
+<parameter_description> flag accelerators, e.g. %GTK_ACCEL_VISIBLE
</parameter_description>
</parameter>
</parameters>
-<return> the status of the print operation
-
-</return>
+<return></return>
</function>
-<function name="gtk_widget_set_name">
+<function name="gtk_widget_add_events">
<description>
-Widgets can be named, which allows you to refer to them from a
-gtkrc file. You can apply a style to widgets with a particular name
-in the gtkrc file. See the documentation for gtkrc files (on the
-same page as the docs for #GtkRcStyle).
-
-Note that widget names are separated by periods in paths (see
-gtk_widget_path()), so names with embedded periods may cause confusion.
+Adds the events in the bitfield @events to the event mask for
+ widget See gtk_widget_set_events() for details.
</description>
<parameters>
@@ -63861,741 +63886,698 @@ gtk_widget_path()), so names with embedded periods may cause confusion.
<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="name">
-<parameter_description> name for the widget
+<parameter name="events">
+<parameter_description> an event mask, see #GdkEventMask
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_file_chooser_set_local_only">
+<function name="gtk_widget_add_mnemonic_label">
<description>
-Sets whether only local files can be selected in the
-file selector. If @local_only is %TRUE (the default),
-then the selected file are files are guaranteed to be
-accessible through the operating systems native file
-file system and therefore the application only
-needs to worry about the filename functions in
-#GtkFileChooser, like gtk_file_chooser_get_filename(),
-rather than the URI functions like
-gtk_file_chooser_get_uri(),
+Adds a widget to the list of mnemonic labels for
+this widget. (See gtk_widget_list_mnemonic_labels()). Note the
+list of mnemonic labels for the widget is cleared when the
+widget is destroyed, so the caller must make sure to update
+its internal state at this point as well, by using a connection
+to the #GtkWidget::destroy signal or a weak notifier.
Since: 2.4
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="local_only">
-<parameter_description> %TRUE if only local files can be selected
+<parameter name="label">
+<parameter_description> a #GtkWidget that acts as a mnemonic label for @widget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_draw_resize_grip">
+<function name="gtk_widget_can_activate_accel">
<description>
-Draws a resize grip in the given rectangle on @window using the given
-parameters.
+Determines whether an accelerator that activates the signal
+identified by @signal_id can currently be activated.
+This is done by emitting the #GtkWidget::can-activate-accel
+signal on @widget; if the signal isn't overridden by a
+handler or in a derived widget, then the default check is
+that the widget must be sensitive, and the widget and all
+its ancestors mapped.
-Deprecated: 2.0: Use gtk_paint_resize_grip() instead.
+Since: 2.4
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
-</parameter_description>
-</parameter>
-<parameter name="edge">
-<parameter_description> the edge in which to draw the resize grip
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> the x origin of the rectangle in which to draw the resize grip
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> the y origin of the rectangle in which to draw the resize grip
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> the width of the rectangle in which to draw the resize grip
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> the height of the rectangle in which to draw the resize grip
+<parameter name="signal_id">
+<parameter_description> the ID of a signal installed on @widget
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the accelerator can be activated.
+
+</return>
</function>
-<function name="gtk_print_operation_set_default_page_setup">
+<function name="gtk_widget_child_focus">
<description>
-Makes @default_page_setup the default page setup for @op.
+This function is used by custom widget implementations; if you're
+writing an app, you'd use gtk_widget_grab_focus() to move the focus
+to a particular widget, and gtk_container_set_focus_chain() to
+change the focus tab order. So you may want to investigate those
+functions instead.
-This page setup will be used by gtk_print_operation_run(),
-but it can be overridden on a per-page basis by connecting
-to the #GtkPrintOperation::request-page-setup signal.
+gtk_widget_child_focus() is called by containers as the user moves
+around the window using keyboard shortcuts. @direction indicates
+what kind of motion is taking place (up, down, left, right, tab
+forward, tab backward). gtk_widget_child_focus() emits the
+#GtkWidget::focus signal; widgets override the default handler
+for this signal in order to implement appropriate focus behavior.
+
+The default ::focus handler for a widget should return %TRUE if
+moving in @direction left the focus on a focusable location inside
+that widget, and %FALSE if moving in @direction moved the focus
+outside the widget. If returning %TRUE, widgets normally
+call gtk_widget_grab_focus() to place the focus accordingly;
+if returning %FALSE, they don't modify the current focus location.
+
+This function replaces gtk_container_focus() from GTK+ 1.2.
+It was necessary to check that the child was visible, sensitive,
+and focusable before calling gtk_container_focus().
+gtk_widget_child_focus() returns %FALSE if the widget is not
+currently in a focusable state, so there's no need for those checks.
-Since: 2.10
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="default_page_setup">
-<parameter_description> a #GtkPageSetup, or %NULL
+<parameter name="direction">
+<parameter_description> direction of focus movement
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if focus ended up inside @widget
+</return>
</function>
-<function name="gtk_viewport_get_shadow_type">
+<function name="gtk_widget_child_notify">
<description>
-Gets the shadow type of the #GtkViewport. See
-gtk_viewport_set_shadow_type().
-
+Emits a #GtkWidget::child-notify signal for the
+<link linkend="child-properties">child property</link> @child_property
+on @widget.
+
+This is the analogue of g_object_notify() for child properties.
</description>
<parameters>
-<parameter name="viewport">
-<parameter_description> a #GtkViewport
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="child_property">
+<parameter_description> the name of a child property installed on the
+class of @widget<!-- -->'s parent
</parameter_description>
</parameter>
</parameters>
-<return> the shadow type
-</return>
+<return></return>
</function>
-<function name="gtk_label_get_current_uri">
+<function name="gtk_widget_class_find_style_property">
<description>
-Returns the URI for the currently active link in the label.
-The active link is the one under the mouse pointer or, in a
-selectable label, the link in which the text cursor is currently
-positioned.
-
-This function is intended for use in a #GtkLabel::activate-link handler
-or for use in a #GtkWidget::query-tooltip handler.
+Finds a style property of a widget class by name.
-Since: 2.18
+Since: 2.2
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="klass">
+<parameter_description> a #GtkWidgetClass
+</parameter_description>
+</parameter>
+<parameter name="property_name">
+<parameter_description> the name of the style property to find
</parameter_description>
</parameter>
</parameters>
-<return> the currently active URI. The string is owned by GTK+ and must
-not be freed or modified.
-
+<return> the #GParamSpec of the style property or %NULL if @class has no
+style property with that name.
</return>
</function>
-<function name="gtk_tree_model_iter_next">
+<function name="gtk_widget_class_install_style_property">
<description>
-Sets @iter to point to the node following it at the current level. If there
-is no next @iter, %FALSE is returned and @iter is set to be invalid.
-
+Installs a style property on a widget class. The parser for the
+style property is determined by the value type of @pspec.
</description>
<parameters>
-<parameter name="tree_model">
-<parameter_description> A #GtkTreeModel.
+<parameter name="klass">
+<parameter_description> a #GtkWidgetClass
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> The #GtkTreeIter.
+<parameter name="pspec">
+<parameter_description> the #GParamSpec for the property
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter has been changed to the next node.
-</return>
+<return></return>
</function>
-<function name="gtk_text_iter_set_line">
+<function name="gtk_widget_class_install_style_property_parser">
<description>
-Moves iterator @iter to the start of the line @line_number. If
- line_number is negative or larger than the number of lines in the
-buffer, moves @iter to the start of the last line in the buffer.
-
+Installs a style property on a widget class.
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="klass">
+<parameter_description> a #GtkWidgetClass
</parameter_description>
</parameter>
-<parameter name="line_number">
-<parameter_description> line number (counted from 0)
+<parameter name="pspec">
+<parameter_description> the #GParamSpec for the style property
+</parameter_description>
+</parameter>
+<parameter name="parser">
+<parameter_description> the parser for the style property
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_settings_set_duplex">
+<function name="gtk_widget_class_list_style_properties">
<description>
-Sets the value of %GTK_PRINT_SETTINGS_DUPLEX.
+Returns all style properties of a widget class.
-Since: 2.10
+Since: 2.2
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="klass">
+<parameter_description> a #GtkWidgetClass
</parameter_description>
</parameter>
-<parameter name="duplex">
-<parameter_description> a #GtkPrintDuplex value
+<parameter name="n_properties">
+<parameter_description> location to return the number of style properties found
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> an newly allocated array of #GParamSpec*. The array must
+be freed with g_free().
+</return>
</function>
-<function name="gtk_item_factory_create_items">
+<function name="gtk_widget_class_path">
<description>
-Creates the menu items from the @entries.
+Same as gtk_widget_path(), but always uses the name of a widget's type,
+never uses a custom name set with gtk_widget_set_name().
-Deprecated: 2.4: Use #GtkUIManager instead.
</description>
<parameters>
-<parameter name="ifactory">
-<parameter_description> a #GtkItemFactory
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="n_entries">
-<parameter_description> the length of @entries
+<parameter name="path_length">
+<parameter_description> location to store the length of the class path, or %NULL
</parameter_description>
</parameter>
-<parameter name="entries">
-<parameter_description> an array of #GtkItemFactoryEntry<!-- -->s whose @callback members
-must by of type #GtkItemFactoryCallback1
+<parameter name="path">
+<parameter_description> location to store the class path as an allocated string, or %NULL
</parameter_description>
</parameter>
-<parameter name="callback_data">
-<parameter_description> data passed to the callback functions of all entries
+<parameter name="path_reversed">
+<parameter_description> location to store the reverse class path as an allocated
+string, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_file_chooser_remove_filter">
+<function name="gtk_widget_common_ancestor">
<description>
-Removes @filter from the list of filters that the user can select between.
+Find the common ancestor of @widget_a and @widget_b that
+is closest to the two widgets.
-Since: 2.4
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="widget_a">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="filter">
-<parameter_description> a #GtkFileFilter
+<parameter name="widget_b">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the closest common ancestor of @widget_a and
+ widget_b or %NULL if @widget_a and @widget_b do not
+share a common ancestor.
+</return>
</function>
-<function name="gtk_entry_buffer_get_max_length">
+<function name="gtk_widget_create_pango_context">
<description>
-Retrieves the maximum allowed length of the text in
- buffer See gtk_entry_buffer_set_max_length().
+Creates a new #PangoContext with the appropriate font map,
+font description, and base direction for drawing text for
+this widget. See also gtk_widget_get_pango_context().
-Since: 2.18
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkEntryBuffer
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> the maximum allowed number of characters
-in #GtkEntryBuffer, or 0 if there is no maximum.
-
+<return> the new #PangoContext
</return>
</function>
-<function name="gtk_status_icon_set_blinking">
+<function name="gtk_widget_create_pango_layout">
<description>
-Makes the status icon start or stop blinking.
-Note that blinking user interface elements may be problematic
-for some users, and thus may be turned off, in which case
-this setting has no effect.
+Creates a new #PangoLayout with the appropriate font map,
+font description, and base direction for drawing text for
+this widget.
-Since: 2.10
+If you keep a #PangoLayout created in this way around, in order to
+notify the layout of changes to the base direction or font of this
+widget, you must call pango_layout_context_changed() in response to
+the #GtkWidget::style-set and #GtkWidget::direction-changed signals
+for the widget.
-Deprecated: 2.22: This function will be removed in GTK+ 3
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="blinking">
-<parameter_description> %TRUE to turn blinking on, %FALSE to turn it off
+<parameter name="text">
+<parameter_description> text to set on the layout (can be %NULL)
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the new #PangoLayout
+</return>
</function>
-<function name="gtk_draw_box_gap">
+<function name="gtk_widget_destroy">
<description>
-Draws a box in @window using the given style and state and shadow type,
-leaving a gap in one side.
+Destroys a widget. Equivalent to gtk_object_destroy(), except that
+you don't have to cast the widget to #GtkObject. When a widget is
+destroyed, it will break any references it holds to other objects.
+If the widget is inside a container, the widget will be removed
+from the container. If the widget is a toplevel (derived from
+#GtkWindow), it will be removed from the list of toplevels, and the
+reference GTK+ holds to it will be removed. Removing a
+widget from its container or the list of toplevels results in the
+widget being finalized, unless you've added additional references
+to the widget with g_object_ref().
-Deprecated: 2.0: Use gtk_paint_box_gap() instead.
+In most cases, only toplevel widgets (windows) require explicit
+destruction, because when you destroy a toplevel its children will
+be destroyed as well.
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
-</parameter_description>
-</parameter>
-<parameter name="shadow_type">
-<parameter_description> type of shadow to draw
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> x origin of the rectangle
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> y origin of the rectangle
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> width of the rectangle
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> width of the rectangle
-</parameter_description>
-</parameter>
-<parameter name="gap_side">
-<parameter_description> side in which to leave the gap
-</parameter_description>
-</parameter>
-<parameter name="gap_x">
-<parameter_description> starting position of the gap
-</parameter_description>
-</parameter>
-<parameter name="gap_width">
-<parameter_description> width of the gap
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_adjustment_get_step_increment">
+<function name="gtk_widget_destroyed">
<description>
-Retrieves the step increment of the adjustment.
-
-Since: 2.14
+This function sets * widget_pointer to %NULL if @widget_pointer !=
+%NULL. It's intended to be used as a callback connected to the
+"destroy" signal of a widget. You connect gtk_widget_destroyed()
+as a signal handler, and pass the address of your widget variable
+as user data. Then when the widget is destroyed, the variable will
+be set to %NULL. Useful for example to avoid multiple copies
+of the same dialog.
</description>
<parameters>
-<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="widget_pointer">
+<parameter_description> address of a variable that contains @widget
</parameter_description>
</parameter>
</parameters>
-<return> The current step increment of the adjustment.
-
-</return>
+<return></return>
</function>
-<function name="gtk_print_settings_set_orientation">
+<function name="gtk_widget_draw">
<description>
-Sets the value of %GTK_PRINT_SETTINGS_ORIENTATION.
-
-Since: 2.10
+In GTK+ 1.2, this function would immediately render the
+region @area of a widget, by invoking the virtual draw method of a
+widget. In GTK+ 2.0, the draw method is gone, and instead
+gtk_widget_draw() simply invalidates the specified region of the
+widget, then updates the invalid region of the widget immediately.
+Usually you don't want to update the region immediately for
+performance reasons, so in general gtk_widget_queue_draw_area() is
+a better choice if you want to draw a region of a widget.
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="orientation">
-<parameter_description> a page orientation
+<parameter name="area">
+<parameter_description> area to draw
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_paint_focus">
+<function name="gtk_widget_ensure_style">
<description>
-Draws a focus indicator around the given rectangle on @window using the
-given style.
+Ensures that @widget has a style (@widget->style). Not a very useful
+function; most of the time, if you want the style, the widget is
+realized, and realized widgets are guaranteed to have a style
+already.
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
-</parameter_description>
-</parameter>
-<parameter name="area">
-<parameter_description> clip rectangle, or %NULL if the
-output should not be clipped
-</parameter_description>
-</parameter>
<parameter name="widget">
-<parameter_description> the widget
-</parameter_description>
-</parameter>
-<parameter name="detail">
-<parameter_description> a style detail
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> the x origin of the rectangle around which to draw a focus indicator
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> the y origin of the rectangle around which to draw a focus indicator
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> the width of the rectangle around which to draw a focus indicator
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> the height of the rectangle around which to draw a focus indicator
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_cell_renderer_toggle_set_activatable">
+<function name="gtk_widget_error_bell">
<description>
-Makes the cell renderer activatable.
+Notifies the user about an input-related error on this widget.
+If the #GtkSettings:gtk-error-bell setting is %TRUE, it calls
+gdk_window_beep(), otherwise it does nothing.
-Since: 2.18
+Note that the effect of gdk_window_beep() can be configured in many
+ways, depending on the windowing backend and the desktop environment
+or window manager that is used.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="toggle">
-<parameter_description> a #GtkCellRendererToggle.
-</parameter_description>
-</parameter>
-<parameter name="setting">
-<parameter_description> the value to set.
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_border_free">
+<function name="gtk_widget_event">
<description>
-Frees a #GtkBorder structure.
+Rarely-used function. This function is used to emit
+the event signals on a widget (those signals should never
+be emitted without using this function to do so).
+If you want to synthesize an event though, don't use this function;
+instead, use gtk_main_do_event() so the event will behave as if
+it were in the event queue. Don't synthesize expose events; instead,
+use gdk_window_invalidate_rect() to invalidate a region of the
+window.
+
</description>
<parameters>
-<parameter name="border_">
-<parameter_description> a #GtkBorder.
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="event">
+<parameter_description> a #GdkEvent
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> return from the event signal emission (%TRUE if
+the event was handled)
+</return>
</function>
-<function name="gtk_range_set_adjustment">
+<function name="gtk_widget_freeze_child_notify">
<description>
-Sets the adjustment to be used as the "model" object for this range
-widget. The adjustment indicates the current range value, the
-minimum and maximum range values, the step/page increments used
-for keybindings and scrolling, and the page size. The page size
-is normally 0 for #GtkScale and nonzero for #GtkScrollbar, and
-indicates the size of the visible area of the widget being scrolled.
-The page size affects the size of the scrollbar slider.
+Stops emission of #GtkWidget::child-notify signals on @widget. The
+signals are queued until gtk_widget_thaw_child_notify() is called
+on @widget.
+
+This is the analogue of g_object_freeze_notify() for child properties.
</description>
<parameters>
-<parameter name="range">
-<parameter_description> a #GtkRange
-</parameter_description>
-</parameter>
-<parameter name="adjustment">
-<parameter_description> a #GtkAdjustment
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_insert_at_cursor">
+<function name="gtk_widget_get_accessible">
<description>
-Simply calls gtk_text_buffer_insert(), using the current
-cursor position as the insertion point.
+Returns the accessible object that describes the widget to an
+assistive technology.
+
+If no accessibility library is loaded (i.e. no ATK implementation library is
+loaded via <envar>GTK_MODULES</envar> or via another application library,
+such as libgnome), then this #AtkObject instance may be a no-op. Likewise,
+if no class-specific #AtkObject implementation is available for the widget
+instance in question, it will inherit an #AtkObject implementation from the
+first ancestor class for which such an implementation is defined.
+
+The documentation of the <ulink url="http://developer.gnome.org/doc/API/2.0/atk/index.html">ATK</ulink>
+library contains more information about accessible objects and their uses.
+
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="text">
-<parameter_description> text in UTF-8 format
-</parameter_description>
-</parameter>
-<parameter name="len">
-<parameter_description> length of text, in bytes
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #AtkObject associated with @widget
+</return>
</function>
-<function name="gtk_clipboard_wait_for_uris">
+<function name="gtk_widget_get_action">
<description>
-Requests the contents of the clipboard as URIs. This function waits
-for the data to be received using the main loop, so events,
-timeouts, etc, may be dispatched during the wait.
+Returns the #GtkAction that @widget is a proxy for.
+See also gtk_action_get_proxies().
-Since: 2.14
+Since: 2.10
+
+Deprecated: 2.16: Use gtk_activatable_get_related_action() instead.
</description>
<parameters>
-<parameter name="clipboard">
-<parameter_description> a #GtkClipboard
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated
-%NULL-terminated array of strings which must
-be freed with g_strfreev(), or %NULL if
-retrieving the selection data failed. (This
-could happen for various reasons, in particular
-if the clipboard was empty or if the contents of
-the clipboard could not be converted into URI form.)
+<return> the action that a widget is a proxy for, or
+%NULL, if it is not attached to an action.
</return>
</function>
-<function name="gtk_target_list_add_table">
+<function name="gtk_widget_get_allocation">
<description>
-Prepends a table of #GtkTargetEntry to a target list.
+Retrieves the widget's allocation.
+
+Since: 2.18
</description>
<parameters>
-<parameter name="list">
-<parameter_description> a #GtkTargetList
-</parameter_description>
-</parameter>
-<parameter name="targets">
-<parameter_description> the table of #GtkTargetEntry
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="ntargets">
-<parameter_description> number of targets in the table
+<parameter name="allocation">
+<parameter_description> a pointer to a #GtkAllocation to copy to
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_font_selection_set_font_name">
+<function name="gtk_widget_get_ancestor">
<description>
-Sets the currently-selected font.
+Gets the first ancestor of @widget with type @widget_type. For example,
+<literal>gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)</literal> gets
+the first #GtkBox that's an ancestor of @widget. No reference will be
+added to the returned widget; it should not be unreferenced. See note
+about checking for a toplevel #GtkWindow in the docs for
+gtk_widget_get_toplevel().
-Note that the @fontsel needs to know the screen in which it will appear
-for this to work; this can be guaranteed by simply making sure that the
- fontsel is inserted in a toplevel window before you call this function.
+Note that unlike gtk_widget_is_ancestor(), gtk_widget_get_ancestor()
+considers @widget to be an ancestor of itself.
</description>
<parameters>
-<parameter name="fontsel">
-<parameter_description> a #GtkFontSelection
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="fontname">
-<parameter_description> a font name like "Helvetica 12" or "Times Bold 18"
+<parameter name="widget_type">
+<parameter_description> ancestor type
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the font could be set successfully; %FALSE if no
-such font exists or if the @fontsel doesn't belong to a particular
-screen yet.
+<return> the ancestor widget, or %NULL if not found
</return>
</function>
-<function name="gtk_container_get_focus_vadjustment">
+<function name="gtk_widget_get_app_paintable">
<description>
-Retrieves the vertical focus adjustment for the container. See
-gtk_container_set_focus_vadjustment().
+Determines whether the application intends to draw on the widget in
+an #GtkWidget::expose-event handler.
+See gtk_widget_set_app_paintable()
+
+Since: 2.18
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> the vertical focus adjustment, or %NULL if
-none has been set.
+<return> %TRUE if the widget is app paintable
+
</return>
</function>
-<function name="gtk_font_selection_get_font_name">
+<function name="gtk_widget_get_can_default">
<description>
-Gets the currently-selected font name.
-
-Note that this can be a different string than what you set with
-gtk_font_selection_set_font_name(), as the font selection widget may
-normalize font names and thus return a string with a different structure.
-For example, "Helvetica Italic Bold 12" could be normalized to
-"Helvetica Bold Italic 12". Use pango_font_description_equal()
-if you want to compare two font descriptions.
+Determines whether @widget can be a default widget. See
+gtk_widget_set_can_default().
+Since: 2.18
</description>
<parameters>
-<parameter name="fontsel">
-<parameter_description> a #GtkFontSelection
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> A string with the name of the current font, or %NULL if
-no font is selected. You must free this string with g_free().
+<return> %TRUE if @widget can be a default widget, %FALSE otherwise
+
</return>
</function>
-<function name="gtk_tree_sortable_set_sort_column_id">
+<function name="gtk_widget_get_can_focus">
<description>
-Sets the current sort column to be @sort_column_id. The @sortable will
-resort itself to reflect this change, after emitting a
-#GtkTreeSortable::sort-column-changed signal. @sort_column_id may either be
-a regular column id, or one of the following special values:
-<variablelist>
-<varlistentry>
-<term>%GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID</term>
-<listitem>the default sort function will be used, if it is set</listitem>
-</varlistentry>
-<varlistentry>
-<term>%GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID</term>
-<listitem>no sorting will occur</listitem>
-</varlistentry>
-</variablelist>
+Determines whether @widget can own the input focus. See
+gtk_widget_set_can_focus().
+
+Since: 2.18
</description>
<parameters>
-<parameter name="sortable">
-<parameter_description> A #GtkTreeSortable
-</parameter_description>
-</parameter>
-<parameter name="sort_column_id">
-<parameter_description> the sort column id to set
-</parameter_description>
-</parameter>
-<parameter name="order">
-<parameter_description> The sort order of the column
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @widget can own the input focus, %FALSE otherwise
+
+</return>
</function>
-<function name="gtk_assistant_set_page_type">
+<function name="gtk_widget_get_child_requisition">
<description>
-Sets the page type for @page. The page type determines the page
-behavior in the @assistant.
+This function is only for use in widget implementations. Obtains
+ widget->requisition, unless someone has forced a particular
+geometry on the widget (e.g. with gtk_widget_set_size_request()),
+in which case it returns that geometry instead of the widget's
+requisition.
-Since: 2.10
+This function differs from gtk_widget_size_request() in that
+it retrieves the last size request value from @widget->requisition,
+while gtk_widget_size_request() actually calls the "size_request" method
+on @widget to compute the size request and fill in @widget->requisition,
+and only then returns @widget->requisition.
+
+Because this function does not call the "size_request" method, it
+can only be used when you know that @widget->requisition is
+up-to-date, that is, gtk_widget_size_request() has been called
+since the last time a resize was queued. In general, only container
+implementations have this information; applications should use
+gtk_widget_size_request().
</description>
<parameters>
-<parameter name="assistant">
-<parameter_description> a #GtkAssistant
-</parameter_description>
-</parameter>
-<parameter name="page">
-<parameter_description> a page of @assistant
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="type">
-<parameter_description> the new type for @page
+<parameter name="requisition">
+<parameter_description> a #GtkRequisition to be filled in
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_child_focus">
+<function name="gtk_widget_get_child_visible">
<description>
-This function is used by custom widget implementations; if you're
-writing an app, you'd use gtk_widget_grab_focus() to move the focus
-to a particular widget, and gtk_container_set_focus_chain() to
-change the focus tab order. So you may want to investigate those
-functions instead.
+Gets the value set with gtk_widget_set_child_visible().
+If you feel a need to use this function, your code probably
+needs reorganization.
-gtk_widget_child_focus() is called by containers as the user moves
-around the window using keyboard shortcuts. @direction indicates
-what kind of motion is taking place (up, down, left, right, tab
-forward, tab backward). gtk_widget_child_focus() emits the
-#GtkWidget::focus signal; widgets override the default handler
-for this signal in order to implement appropriate focus behavior.
+This function is only useful for container implementations and
+never should be called by an application.
-The default ::focus handler for a widget should return %TRUE if
-moving in @direction left the focus on a focusable location inside
-that widget, and %FALSE if moving in @direction moved the focus
-outside the widget. If returning %TRUE, widgets normally
-call gtk_widget_grab_focus() to place the focus accordingly;
-if returning %FALSE, they don't modify the current focus location.
-This function replaces gtk_container_focus() from GTK+ 1.2.
-It was necessary to check that the child was visible, sensitive,
-and focusable before calling gtk_container_focus().
-gtk_widget_child_focus() returns %FALSE if the widget is not
-currently in a focusable state, so there's no need for those checks.
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the widget is mapped with the parent.
+</return>
+</function>
+<function name="gtk_widget_get_clipboard">
+<description>
+Returns the clipboard object for the given selection to
+be used with @widget. @widget must have a #GdkDisplay
+associated with it, so must be attached to a toplevel
+window.
+
+Since: 2.2
</description>
<parameters>
@@ -64603,179 +64585,157 @@ currently in a focusable state, so there's no need for those checks.
<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="direction">
-<parameter_description> direction of focus movement
+<parameter name="selection">
+<parameter_description> a #GdkAtom which identifies the clipboard
+to use. %GDK_SELECTION_CLIPBOARD gives the
+default clipboard. Another common value
+is %GDK_SELECTION_PRIMARY, which gives
+the primary X selection.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if focus ended up inside @widget
+<return> the appropriate clipboard object. If no
+clipboard already exists, a new one will
+be created. Once a clipboard object has
+been created, it is persistent for all time.
+
</return>
</function>
-<function name="gtk_file_chooser_get_preview_filename">
+<function name="gtk_widget_get_colormap">
<description>
-Gets the filename that should be previewed in a custom preview
-widget. See gtk_file_chooser_set_preview_widget().
+Gets the colormap that will be used to render @widget. No reference will
+be added to the returned colormap; it should not be unreferenced.
-Since: 2.4
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> the filename to preview, or %NULL if no file
-is selected, or if the selected file cannot be represented
-as a local filename. Free with g_free()
-
+<return> the colormap used by @widget
</return>
</function>
-<function name="gtk_scrolled_window_add_with_viewport">
+<function name="gtk_widget_get_composite_name">
<description>
-Used to add children without native scrolling capabilities. This
-is simply a convenience function; it is equivalent to adding the
-unscrollable child to a viewport, then adding the viewport to the
-scrolled window. If a child has native scrolling, use
-gtk_container_add() instead of this function.
-
-The viewport scrolls the child by moving its #GdkWindow, and takes
-the size of the child to be the size of its toplevel #GdkWindow.
-This will be very wrong for most widgets that support native scrolling;
-for example, if you add a widget such as #GtkTreeView with a viewport,
-the whole widget will scroll, including the column headings. Thus,
-widgets with native scrolling support should not be used with the
-#GtkViewport proxy.
+Obtains the composite name of a widget.
-A widget supports scrolling natively if the
-set_scroll_adjustments_signal field in #GtkWidgetClass is non-zero,
-i.e. has been filled in with a valid signal identifier.
</description>
<parameters>
-<parameter name="scrolled_window">
-<parameter_description> a #GtkScrolledWindow
-</parameter_description>
-</parameter>
-<parameter name="child">
-<parameter_description> the widget you want to scroll
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the composite name of @widget, or %NULL if @widget is not
+a composite child. The string should be freed when it is no
+longer needed.
+</return>
</function>
-<function name="gtk_cell_view_get_size_of_row">
+<function name="gtk_widget_get_default_colormap">
<description>
-Sets @requisition to the size needed by @cell_view to display
-the model row pointed to by @path.
+Obtains the default colormap used to create widgets.
-Since: 2.6
</description>
<parameters>
-<parameter name="cell_view">
-<parameter_description> a #GtkCellView
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> a #GtkTreePath
-</parameter_description>
-</parameter>
-<parameter name="requisition">
-<parameter_description> return location for the size
-</parameter_description>
-</parameter>
</parameters>
-<return> %TRUE
+<return> default widget colormap
+</return>
+</function>
+
+<function name="gtk_widget_get_default_direction">
+<description>
+Obtains the current default reading direction. See
+gtk_widget_set_default_direction().
+
+</description>
+<parameters>
+</parameters>
+<return> the current default direction.
</return>
</function>
-<function name="gtk_icon_factory_lookup">
+<function name="gtk_widget_get_default_style">
<description>
-Looks up @stock_id in the icon factory, returning an icon set
-if found, otherwise %NULL. For display to the user, you should
-use gtk_style_lookup_icon_set() on the #GtkStyle for the
-widget that will display the icon, instead of using this
-function directly, so that themes are taken into account.
+Returns the default style used by all widgets initially.
</description>
<parameters>
-<parameter name="factory">
-<parameter_description> a #GtkIconFactory
-</parameter_description>
-</parameter>
-<parameter name="stock_id">
-<parameter_description> an icon name
-</parameter_description>
-</parameter>
</parameters>
-<return> icon set of @stock_id.
+<return> the default style. This #GtkStyle object is owned
+by GTK+ and should not be modified or freed.
</return>
</function>
-<function name="gtk_tree_view_column_get_clickable">
+<function name="gtk_widget_get_default_visual">
<description>
-Returns %TRUE if the user can click on the header for the column.
+Obtains the visual of the default colormap. Not really useful;
+used to be useful before gdk_colormap_get_visual() existed.
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> a #GtkTreeViewColumn
+</parameters>
+<return> visual of the default colormap
+</return>
+</function>
+
+<function name="gtk_widget_get_direction">
+<description>
+Gets the reading direction for a particular widget. See
+gtk_widget_set_direction().
+
+
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if user can click the column header.
+<return> the reading direction for the widget.
</return>
</function>
-<function name="gtk_toggle_tool_button_new_from_stock">
+<function name="gtk_widget_get_display">
<description>
-Creates a new #GtkToggleToolButton containing the image and text from a
-stock item. Some stock ids have preprocessor macros like #GTK_STOCK_OK
-and #GTK_STOCK_APPLY.
+Get the #GdkDisplay for the toplevel window associated with
+this widget. This function can only be called after the widget
+has been added to a widget hierarchy with a #GtkWindow at the top.
-It is an error if @stock_id is not a name of a stock item.
+In general, you should only create display specific
+resources when a widget has been realized, and you should
+free those resources when the widget is unrealized.
-Since: 2.4
+Since: 2.2
</description>
<parameters>
-<parameter name="stock_id">
-<parameter_description> the name of the stock item
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> A new #GtkToggleToolButton
+<return> the #GdkDisplay for the toplevel for this widget.
</return>
</function>
-<function name="gtk_widget_realize">
+<function name="gtk_widget_get_double_buffered">
<description>
-Creates the GDK (windowing system) resources associated with a
-widget. For example, @widget->window will be created when a widget
-is realized. Normally realization happens implicitly; if you show
-a widget and all its parent containers, then the widget will be
-realized and mapped automatically.
+Determines whether the widget is double buffered.
-Realizing a widget requires all
-the widget's parent widgets to be realized; calling
-gtk_widget_realize() realizes the widget's parents in addition to
- widget itself. If a widget is not yet inside a toplevel window
-when you realize it, bad things will happen.
+See gtk_widget_set_double_buffered()
-This function is primarily used in widget implementations, and
-isn't very useful otherwise. Many times when you think you might
-need it, a better approach is to connect to a signal that will be
-called after the widget is realized automatically, such as
-GtkWidget::expose-event. Or simply g_signal_connect () to the
-GtkWidget::realize signal.
+Since: 2.18
</description>
<parameters>
@@ -64784,278 +64744,280 @@ GtkWidget::realize signal.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the widget is double buffered
+
+</return>
</function>
-<function name="gtk_widget_get_default_style">
+<function name="gtk_widget_get_events">
<description>
-Returns the default style used by all widgets initially.
+Returns the event mask for the widget (a bitfield containing flags
+from the #GdkEventMask enumeration). These are the events that the widget
+will receive.
</description>
<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
</parameters>
-<return> the default style. This #GtkStyle object is owned
-by GTK+ and should not be modified or freed.
+<return> event mask for @widget
</return>
</function>
-<function name="gtk_recent_chooser_set_sort_type">
+<function name="gtk_widget_get_extension_events">
<description>
-Changes the sorting order of the recently used resources list displayed by
- chooser
+Retrieves the extension events the widget will receive; see
+gdk_input_set_extension_events().
-Since: 2.10
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
-</parameter_description>
-</parameter>
-<parameter name="sort_type">
-<parameter_description> sort order that the chooser should use
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> extension events for @widget
+</return>
</function>
-<function name="gtk_widget_list_accel_closures">
+<function name="gtk_widget_get_has_tooltip">
<description>
-Lists the closures used by @widget for accelerator group connections
-with gtk_accel_group_connect_by_path() or gtk_accel_group_connect().
-The closures can be used to monitor accelerator changes on @widget,
-by connecting to the @GtkAccelGroup::accel-changed signal of the
-#GtkAccelGroup of a closure which can be found out with
-gtk_accel_group_from_accel_closure().
+Returns the current value of the has-tooltip property. See
+GtkWidget:has-tooltip for more information.
+
+Since: 2.12
</description>
<parameters>
<parameter name="widget">
-<parameter_description> widget to list accelerator closures for
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> a newly allocated #GList of closures
+<return> current value of has-tooltip on @widget.
+
</return>
</function>
-<function name="gtk_file_chooser_dialog_new_with_backend">
+<function name="gtk_widget_get_has_window">
<description>
-Creates a new #GtkFileChooserDialog with a specified backend. This is
-especially useful if you use gtk_file_chooser_set_local_only() to allow
-non-local files and you use a more expressive vfs, such as gnome-vfs,
-to load files.
+Determines whether @widget has a #GdkWindow of its own. See
+gtk_widget_set_has_window().
-Since: 2.4
-Deprecated: 2.14: Use gtk_file_chooser_dialog_new() instead.
+Since: 2.18
</description>
<parameters>
-<parameter name="title">
-<parameter_description> Title of the dialog, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="parent">
-<parameter_description> Transient parent of the dialog, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="action">
-<parameter_description> Open or save mode for the dialog
-</parameter_description>
-</parameter>
-<parameter name="backend">
-<parameter_description> The name of the specific filesystem backend to use.
-</parameter_description>
-</parameter>
-<parameter name="first_button_text">
-<parameter_description> stock ID or text to go in the first button, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="Varargs">
-<parameter_description> response ID for the first button, then additional (button, id) pairs, ending with %NULL
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkFileChooserDialog
+<return> %TRUE if @widget has a window, %FALSE otherwise
</return>
</function>
-<function name="gtk_tooltip_set_icon">
+<function name="gtk_widget_get_mapped">
<description>
-Sets the icon of the tooltip (which is in front of the text) to be
- pixbuf If @pixbuf is %NULL, the image will be hidden.
+Whether the widget is mapped.
-Since: 2.12
+Since: 2.20
</description>
<parameters>
-<parameter name="tooltip">
-<parameter_description> a #GtkTooltip
-</parameter_description>
-</parameter>
-<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf, or %NULL
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the widget is mapped, %FALSE otherwise.
+
+</return>
</function>
-<function name="gtk_handle_box_get_handle_position">
+<function name="gtk_widget_get_modifier_style">
<description>
-Gets the handle position of the handle box. See
-gtk_handle_box_set_handle_position().
+Returns the current modifier style for the widget. (As set by
+gtk_widget_modify_style().) If no style has previously set, a new
+#GtkRcStyle will be created with all values unset, and set as the
+modifier style for the widget. If you make changes to this rc
+style, you must call gtk_widget_modify_style(), passing in the
+returned rc style, to make sure that your changes take effect.
+
+Caution: passing the style back to gtk_widget_modify_style() will
+normally end up destroying it, because gtk_widget_modify_style() copies
+the passed-in style and sets the copy as the new modifier style,
+thus dropping any reference to the old modifier style. Add a reference
+to the modifier style if you want to keep it alive.
</description>
<parameters>
-<parameter name="handle_box">
-<parameter_description> a #GtkHandleBox
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> the current handle position.
+<return> the modifier style for the widget. This rc style is
+owned by the widget. If you want to keep a pointer to value this
+around, you must add a refcount using g_object_ref().
</return>
</function>
-<function name="gtk_recent_chooser_set_current_uri">
+<function name="gtk_widget_get_name">
<description>
-Sets @uri as the current URI for @chooser.
+Retrieves the name of a widget. See gtk_widget_set_name() for the
+significance of widget names.
-Since: 2.10
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
-</parameter_description>
-</parameter>
-<parameter name="uri">
-<parameter_description> a URI
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the URI was found.
-
+<return> name of the widget. This string is owned by GTK+ and
+should not be modified or freed
</return>
</function>
-<function name="gtk_icon_theme_list_contexts">
+<function name="gtk_widget_get_no_show_all">
<description>
-Gets the list of contexts available within the current
-hierarchy of icon themes
+Returns the current value of the GtkWidget:no-show-all property,
+which determines whether calls to gtk_widget_show_all() and
+gtk_widget_hide_all() will affect this widget.
-Since: 2.12
+Since: 2.4
</description>
<parameters>
-<parameter name="icon_theme">
-<parameter_description> a #GtkIconTheme
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> a #GList list holding the names of all the
-contexts in the theme. You must first free each element
-in the list with g_free(), then free the list itself
-with g_list_free().
+<return> the current value of the "no-show-all" property.
</return>
</function>
-<function name="gtk_paint_flat_box">
+<function name="gtk_widget_get_pango_context">
<description>
-Draws a flat box on @window with the given parameters.
+Gets a #PangoContext with the appropriate font map, font description,
+and base direction for this widget. Unlike the context returned
+by gtk_widget_create_pango_context(), this context is owned by
+the widget (it can be used until the screen for the widget changes
+or the widget is removed from its toplevel), and will be updated to
+match any changes to the widget's attributes.
+
+If you create and keep a #PangoLayout using this context, you must
+deal with changes to the context by calling pango_layout_context_changed()
+on the layout in response to the #GtkWidget::style-set and
+#GtkWidget::direction-changed signals for the widget.
+
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
-</parameter_description>
-</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
-</parameter_description>
-</parameter>
-<parameter name="state_type">
-<parameter_description> a state
-</parameter_description>
-</parameter>
-<parameter name="shadow_type">
-<parameter_description> the type of shadow to draw
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="area">
-<parameter_description> clip rectangle, or %NULL if the
-output should not be clipped
+</parameters>
+<return> the #PangoContext for the widget.
+</return>
+</function>
+
+<function name="gtk_widget_get_parent">
+<description>
+Returns the parent container of @widget.
+
+
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
+</parameters>
+<return> the parent container of @widget, or %NULL
+</return>
+</function>
+
+<function name="gtk_widget_get_parent_window">
+<description>
+Gets @widget's parent window.
+
+
+</description>
+<parameters>
<parameter name="widget">
-<parameter_description> the widget
+<parameter_description> a #GtkWidget.
</parameter_description>
</parameter>
-<parameter name="detail">
-<parameter_description> a style detail
+</parameters>
+<return> the parent window of @widget.
+</return>
+</function>
+
+<function name="gtk_widget_get_pointer">
+<description>
+Obtains the location of the mouse pointer in widget coordinates.
+Widget coordinates are a bit odd; for historical reasons, they are
+defined as @widget->window coordinates for widgets that are not
+#GTK_NO_WINDOW widgets, and are relative to @widget->allocation.x,
+ widget->allocation.y for widgets that are #GTK_NO_WINDOW widgets.
+
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
<parameter name="x">
-<parameter_description> x origin of the box
+<parameter_description> return location for the X coordinate, or %NULL
</parameter_description>
</parameter>
<parameter name="y">
-<parameter_description> y origin of the box
-</parameter_description>
-</parameter>
-<parameter name="width">
-<parameter_description> the width of the box
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> the height of the box
+<parameter_description> return location for the Y coordinate, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_assistant_insert_page">
+<function name="gtk_widget_get_realized">
<description>
-Inserts a page in the @assistant at a given position.
+Determines whether @widget is realized.
-Since: 2.10
+Since: 2.20
</description>
<parameters>
-<parameter name="assistant">
-<parameter_description> a #GtkAssistant
-</parameter_description>
-</parameter>
-<parameter name="page">
+<parameter name="widget">
<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> the index (starting at 0) at which to insert the page,
-or -1 to append the page to the @assistant
-</parameter_description>
-</parameter>
</parameters>
-<return> the index (starting from 0) of the inserted page
+<return> %TRUE if @widget is realized, %FALSE otherwise
</return>
</function>
-<function name="gtk_widget_get_tooltip_text">
+<function name="gtk_widget_get_receives_default">
<description>
-Gets the contents of the tooltip for @widget.
+Determines whether @widget is alyways treated as default widget
+withing its toplevel when it has the focus, even if another widget
+is the default.
-Since: 2.12
+See gtk_widget_set_receives_default().
+
+Since: 2.18
</description>
<parameters>
@@ -65064,47 +65026,51 @@ Since: 2.12
</parameter_description>
</parameter>
</parameters>
-<return> the tooltip text, or %NULL. You should free the
-returned string with g_free() when done.
+<return> %TRUE if @widget acts as default widget when focussed,
+%FALSE otherwise
</return>
</function>
-<function name="gtk_entry_unset_invisible_char">
+<function name="gtk_widget_get_requisition">
<description>
-Unsets the invisible char previously set with
-gtk_entry_set_invisible_char(). So that the
-default invisible char is used again.
+Retrieves the widget's requisition.
-Since: 2.16
+This function should only be used by widget implementations in
+order to figure whether the widget's requisition has actually
+changed after some internal state change (so that they can call
+gtk_widget_queue_resize() instead of gtk_widget_queue_draw()).
+
+Normally, gtk_widget_size_request() should be used.
+
+Since: 2.20
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="requisition">
+<parameter_description> a pointer to a #GtkRequisition to copy to
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_set_uposition">
+<function name="gtk_widget_get_root_window">
<description>
-Sets the position of a widget. The funny "u" in the name comes from
-the "user position" hint specified by the X Window System, and
-exists for legacy reasons. This function doesn't work if a widget
-is inside a container; it's only really useful on #GtkWindow.
+Get the root window where this widget is located. This function can
+only be called after the widget has been added to a widget
+hierarchy with #GtkWindow at the top.
-Don't use this function to center dialogs over the main application
-window; most window managers will do the centering on your behalf
-if you call gtk_window_set_transient_for(), and it's really not
-possible to get the centering to work correctly in all cases from
-application code. But if you insist, use gtk_window_set_position()
-to set #GTK_WIN_POS_CENTER_ON_PARENT, don't do the centering
-manually.
+The root window is useful for such purposes as creating a popup
+#GdkWindow associated with the window. In general, you should only
+create display specific resources when a widget has been realized,
+and you should free those resources when the widget is unrealized.
-Note that although @x and @y can be individually unset, the position
-is not honoured unless both @x and @y are set.
+Since: 2.2
</description>
<parameters>
@@ -65112,164 +65078,234 @@ is not honoured unless both @x and @y are set.
<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> x position; -1 to unset x; -2 to leave x unchanged
+</parameters>
+<return> the #GdkWindow root window for the toplevel for this widget.
+
+</return>
+</function>
+
+<function name="gtk_widget_get_screen">
+<description>
+Get the #GdkScreen from the toplevel window associated with
+this widget. This function can only be called after the widget
+has been added to a widget hierarchy with a #GtkWindow
+at the top.
+
+In general, you should only create screen specific
+resources when a widget has been realized, and you should
+free those resources when the widget is unrealized.
+
+Since: 2.2
+
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> y position; -1 to unset y; -2 to leave y unchanged
+</parameters>
+<return> the #GdkScreen for the toplevel for this widget.
+
+</return>
+</function>
+
+<function name="gtk_widget_get_sensitive">
+<description>
+Returns the widget's sensitivity (in the sense of returning
+the value that has been set using gtk_widget_set_sensitive()).
+
+The effective sensitivity of a widget is however determined by both its
+own and its parent widget's sensitivity. See gtk_widget_is_sensitive().
+
+Since: 2.18
+
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the widget is sensitive
+
+</return>
</function>
-<function name="gtk_text_buffer_apply_tag">
+<function name="gtk_widget_get_settings">
<description>
-Emits the "apply-tag" signal on @buffer. The default
-handler for the signal applies @tag to the given range.
- start and @end do not have to be in order.
+Gets the settings object holding the settings (global property
+settings, RC file information, etc) used for this widget.
+
+Note that this function can only be called when the #GtkWidget
+is attached to a toplevel, since the settings object is specific
+to a particular #GdkScreen.
+
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="tag">
-<parameter_description> a #GtkTextTag
+</parameters>
+<return> the relevant #GtkSettings object
+</return>
+</function>
+
+<function name="gtk_widget_get_size_request">
+<description>
+Gets the size request that was explicitly set for the widget using
+gtk_widget_set_size_request(). A value of -1 stored in @width or
+ height indicates that that dimension has not been set explicitly
+and the natural requisition of the widget will be used intead. See
+gtk_widget_set_size_request(). To get the size a widget will
+actually use, call gtk_widget_size_request() instead of
+this function.
+
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="start">
-<parameter_description> one bound of range to be tagged
+<parameter name="width">
+<parameter_description> return location for width, or %NULL
</parameter_description>
</parameter>
-<parameter name="end">
-<parameter_description> other bound of range to be tagged
+<parameter name="height">
+<parameter_description> return location for height, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_settings_get_bool">
+<function name="gtk_widget_get_snapshot">
<description>
-Returns the boolean represented by the value
-that is associated with @key.
+Create a #GdkPixmap of the contents of the widget and its children.
-The string "true" represents %TRUE, any other
-string %FALSE.
+Works even if the widget is obscured. The depth and visual of the
+resulting pixmap is dependent on the widget being snapshot and likely
+differs from those of a target widget displaying the pixmap.
+The function gdk_pixbuf_get_from_drawable() can be used to convert
+the pixmap to a visual independant representation.
-Since: 2.10
+The snapshot area used by this function is the @widget's allocation plus
+any extra space occupied by additional windows belonging to this widget
+(such as the arrows of a spin button).
+Thus, the resulting snapshot pixmap is possibly larger than the allocation.
+
+If @clip_rect is non-%NULL, the resulting pixmap is shrunken to
+match the specified clip_rect. The (x,y) coordinates of @clip_rect are
+interpreted widget relative. If width or height of @clip_rect are 0 or
+negative, the width or height of the resulting pixmap will be shrunken
+by the respective amount.
+For instance a @clip_rect <literal>{ +5, +5, -10, -10 }</literal> will
+chop off 5 pixels at each side of the snapshot pixmap.
+If non-%NULL, @clip_rect will contain the exact widget-relative snapshot
+coordinates upon return. A @clip_rect of <literal>{ -1, -1, 0, 0 }</literal>
+can be used to preserve the auto-grown snapshot area and use @clip_rect
+as a pure output parameter.
+
+The returned pixmap can be %NULL, if the resulting @clip_area was empty.
+
+Since: 2.14
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="key">
-<parameter_description> a key
+<parameter name="clip_rect">
+<parameter_description> a #GdkRectangle or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE, if @key maps to a true value.
+<return> #GdkPixmap snapshot of the widget
</return>
</function>
-<function name="gtk_check_menu_item_get_active">
+<function name="gtk_widget_get_state">
<description>
-Returns whether the check menu item is active. See
-gtk_check_menu_item_set_active ().
+Returns the widget's state. See gtk_widget_set_state().
+Since: 2.18
</description>
<parameters>
-<parameter name="check_menu_item">
-<parameter_description> a #GtkCheckMenuItem
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the menu item is checked.
-</return>
-</function>
-
-<function name="gtk_widget_get_default_direction">
-<description>
-Obtains the current default reading direction. See
-gtk_widget_set_default_direction().
-
+<return> the state of @widget.
-</description>
-<parameters>
-</parameters>
-<return> the current default direction.
</return>
</function>
-<function name="gtk_window_add_accel_group">
+<function name="gtk_widget_get_style">
<description>
-Associate @accel_group with @window, such that calling
-gtk_accel_groups_activate() on @window will activate accelerators
-in @accel_group.
+Simply an accessor function that returns @widget->style.
+
</description>
<parameters>
-<parameter name="window">
-<parameter_description> window to attach accelerator group to
-</parameter_description>
-</parameter>
-<parameter name="accel_group">
-<parameter_description> a #GtkAccelGroup
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the widget's #GtkStyle
+</return>
</function>
-<function name="gtk_recent_filter_add_pixbuf_formats">
+<function name="gtk_widget_get_tooltip_markup">
<description>
-Adds a rule allowing image files in the formats supported
-by GdkPixbuf.
+Gets the contents of the tooltip for @widget.
-Since: 2.10
+Since: 2.12
</description>
<parameters>
-<parameter name="filter">
-<parameter_description> a #GtkRecentFilter
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the tooltip text, or %NULL. You should free the
+returned string with g_free() when done.
+
+</return>
</function>
-<function name="gtk_text_view_get_pixels_below_lines">
+<function name="gtk_widget_get_tooltip_text">
<description>
-Gets the value set by gtk_text_view_set_pixels_below_lines().
+Gets the contents of the tooltip for @widget.
+Since: 2.12
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> default number of blank pixels below paragraphs
+<return> the tooltip text, or %NULL. You should free the
+returned string with g_free() when done.
+
</return>
</function>
-<function name="gtk_widget_get_receives_default">
+<function name="gtk_widget_get_tooltip_window">
<description>
-Determines whether @widget is alyways treated as default widget
-withing its toplevel when it has the focus, even if another widget
-is the default.
-
-See gtk_widget_set_receives_default().
+Returns the #GtkWindow of the current tooltip. This can be the
+GtkWindow created by default, or the custom tooltip window set
+using gtk_widget_set_tooltip_window().
-Since: 2.18
+Since: 2.12
</description>
<parameters>
@@ -65278,343 +65314,311 @@ Since: 2.18
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @widget acts as default widget when focussed,
-%FALSE otherwise
+<return> The #GtkWindow of the current tooltip.
</return>
</function>
-<function name="gtk_message_dialog_format_secondary_markup">
+<function name="gtk_widget_get_toplevel">
<description>
-Sets the secondary text of the message dialog to be @message_format (with
-printf()-style), which is marked up with the
-<link linkend="PangoMarkupFormat">Pango text markup language</link>.
-
-Note that setting a secondary text makes the primary text become
-bold, unless you have provided explicit markup.
-
-Due to an oversight, this function does not escape special XML characters
-like gtk_message_dialog_new_with_markup() does. Thus, if the arguments
-may contain special XML characters, you should use g_markup_printf_escaped()
-to escape it.
+This function returns the topmost widget in the container hierarchy
+ widget is a part of. If @widget has no parent widgets, it will be
+returned as the topmost widget. No reference will be added to the
+returned widget; it should not be unreferenced.
-<informalexample><programlisting>
-gchar *msg;
+Note the difference in behavior vs. gtk_widget_get_ancestor();
+<literal>gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW)</literal>
+would return
+%NULL if @widget wasn't inside a toplevel window, and if the
+window was inside a #GtkWindow-derived widget which was in turn
+inside the toplevel #GtkWindow. While the second case may
+seem unlikely, it actually happens when a #GtkPlug is embedded
+inside a #GtkSocket within the same application.
-msg = g_markup_printf_escaped (message_format, ...);
-gtk_message_dialog_format_secondary_markup (message_dialog, "%s", msg);
-g_free (msg);
-</programlisting></informalexample>
+To reliably find the toplevel #GtkWindow, use
+gtk_widget_get_toplevel() and check if the %TOPLEVEL flags
+is set on the result.
+|[
+GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
+if (gtk_widget_is_toplevel (toplevel))
+{
+/ * Perform action on toplevel. * /
+}
+]|
-Since: 2.6
</description>
<parameters>
-<parameter name="message_dialog">
-<parameter_description> a #GtkMessageDialog
-</parameter_description>
-</parameter>
-<parameter name="message_format">
-<parameter_description> printf()-style markup string (see
- <link linkend="PangoMarkupFormat">Pango markup format</link>), or %NULL
-</parameter_description>
-</parameter>
-<parameter name="Varargs">
-<parameter_description> arguments for @message_format
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the topmost ancestor of @widget, or @widget itself
+if there's no ancestor.
+</return>
</function>
-<function name="gtk_style_ref">
+<function name="gtk_widget_get_visible">
<description>
-Increase the reference count of @style.
+Determines whether the widget is visible. Note that this doesn't
+take into account whether the widget's parent is also visible
+or the widget is obscured in any way.
-Deprecated: 2.0: use g_object_ref() instead.
+See gtk_widget_set_visible().
+
+Since: 2.18
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle.
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> @style.
+<return> %TRUE if the widget is visible
+
</return>
</function>
-<function name="gtk_print_settings_set_output_bin">
+<function name="gtk_widget_get_visual">
<description>
-Sets the value of %GTK_PRINT_SETTINGS_OUTPUT_BIN.
+Gets the visual that will be used to render @widget.
-Since: 2.10
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
-</parameter_description>
-</parameter>
-<parameter name="output_bin">
-<parameter_description> the output bin
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the visual for @widget
+</return>
</function>
-<function name="gtk_status_icon_get_icon_name">
+<function name="gtk_widget_get_window">
<description>
-Gets the name of the icon being displayed by the #GtkStatusIcon.
-The storage type of the status icon must be %GTK_IMAGE_EMPTY or
-%GTK_IMAGE_ICON_NAME (see gtk_status_icon_get_storage_type()).
-The returned string is owned by the #GtkStatusIcon and should not
-be freed or modified.
+Returns the widget's window if it is realized, %NULL otherwise
-Since: 2.10
+Since: 2.14
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> name of the displayed icon, or %NULL if the image is empty.
+<return> @widget's window.
</return>
</function>
-<function name="gtk_tree_view_column_set_widget">
+<function name="gtk_widget_grab_default">
<description>
-Sets the widget in the header to be @widget. If widget is %NULL, then the
-header button is set with a #GtkLabel set to the title of @tree_column.
+Causes @widget to become the default widget. @widget must have the
+%GTK_CAN_DEFAULT flag set; typically you have to set this flag
+yourself by calling <literal>gtk_widget_set_can_default (@widget,
+%TRUE)</literal>. The default widget is activated when
+the user presses Enter in a window. Default widgets must be
+activatable, that is, gtk_widget_activate() should affect them.
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn.
-</parameter_description>
-</parameter>
<parameter name="widget">
-<parameter_description> A child #GtkWidget, or %NULL.
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_pop_composite_child">
+<function name="gtk_widget_grab_focus">
<description>
-Cancels the effect of a previous call to gtk_widget_push_composite_child().
+Causes @widget to have the keyboard focus for the #GtkWindow it's
+inside. @widget must be a focusable widget, such as a #GtkEntry;
+something like #GtkFrame won't work.
+
+More precisely, it must have the %GTK_CAN_FOCUS flag set. Use
+gtk_widget_set_can_focus() to modify that flag.
+
+The widget also needs to be realized and mapped. This is indicated by the
+related signals. Grabbing the focus immediately after creating the widget
+will likely fail and cause critical warnings.
</description>
<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_entry_completion_set_popup_completion">
+<function name="gtk_widget_has_default">
<description>
-Sets whether the completions should be presented in a popup window.
+Determines whether @widget is the current default widget within its
+toplevel. See gtk_widget_set_can_default().
-Since: 2.6
+Since: 2.18
</description>
<parameters>
-<parameter name="completion">
-<parameter_description> a #GtkEntryCompletion
-</parameter_description>
-</parameter>
-<parameter name="popup_completion">
-<parameter_description> %TRUE to do popup completion
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @widget is the current default widget within
+its toplevel, %FALSE otherwise
+
+</return>
</function>
-<function name="gtk_tree_view_is_rubber_banding_active">
+<function name="gtk_widget_has_focus">
<description>
-Returns whether a rubber banding operation is currently being done
-in @tree_view.
+Determines if the widget has the global input focus. See
+gtk_widget_is_focus() for the difference between having the global
+input focus, and only having the focus within a toplevel.
-Since: 2.12
+Since: 2.18
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if a rubber banding operation is currently being
-done in @tree_view.
+<return> %TRUE if the widget has the global input focus.
</return>
</function>
-<function name="gtk_tree_view_tree_to_widget_coords">
+<function name="gtk_widget_has_grab">
<description>
-Converts tree coordinates (coordinates in full scrollable area of the tree)
-to bin_window coordinates.
+Determines whether the widget is currently grabbing events, so it
+is the only widget receiving input events (keyboard and mouse).
-Deprecated: 2.12: Due to historial reasons the name of this function is
-incorrect. For converting bin_window coordinates to coordinates relative
-to bin_window, please see
-gtk_tree_view_convert_bin_window_to_widget_coords().
+See also gtk_grab_add().
+Since: 2.18
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
-</parameter_description>
-</parameter>
-<parameter name="tx">
-<parameter_description> tree X coordinate
-</parameter_description>
-</parameter>
-<parameter name="ty">
-<parameter_description> tree Y coordinate
-</parameter_description>
-</parameter>
-<parameter name="wx">
-<parameter_description> return location for X coordinate relative to bin_window
-</parameter_description>
-</parameter>
-<parameter name="wy">
-<parameter_description> return location for Y coordinate relative to bin_window
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the widget is in the grab_widgets stack
+
+</return>
</function>
-<function name="gtk_tree_view_column_set_min_width">
+<function name="gtk_widget_has_rc_style">
<description>
-Sets the minimum width of the @tree_column. If @min_width is -1, then the
-minimum width is unset.
+Determines if the widget style has been looked up through the rc mechanism.
+
+Since: 2.20
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn.
-</parameter_description>
-</parameter>
-<parameter name="min_width">
-<parameter_description> The minimum width of the column in pixels, or -1.
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the widget has been looked up through the rc
+mechanism, %FALSE otherwise.
+
+</return>
</function>
-<function name="gtk_box_set_child_packing">
+<function name="gtk_widget_has_screen">
<description>
-Sets the way @child is packed into @box.
+Checks whether there is a #GdkScreen is associated with
+this widget. All toplevel widgets have an associated
+screen, and all widgets added into a hierarchy with a toplevel
+window at the top.
+
+Since: 2.2
</description>
<parameters>
-<parameter name="box">
-<parameter_description> a #GtkBox
-</parameter_description>
-</parameter>
-<parameter name="child">
-<parameter_description> the #GtkWidget of the child to set
-</parameter_description>
-</parameter>
-<parameter name="expand">
-<parameter_description> the new value of the #GtkBox:expand child property
-</parameter_description>
-</parameter>
-<parameter name="fill">
-<parameter_description> the new value of the #GtkBox:fill child property
-</parameter_description>
-</parameter>
-<parameter name="padding">
-<parameter_description> the new value of the #GtkBox:padding child property
-</parameter_description>
-</parameter>
-<parameter name="pack_type">
-<parameter_description> the new value of the #GtkBox:pack-type child property
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if there is a #GdkScreen associcated
+with the widget.
+
+</return>
</function>
-<function name="gtk_image_set_from_pixbuf">
+<function name="gtk_widget_hide">
<description>
-See gtk_image_new_from_pixbuf() for details.
+Reverses the effects of gtk_widget_show(), causing the widget to be
+hidden (invisible to the user).
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GtkImage
-</parameter_description>
-</parameter>
-<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf or %NULL
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_drag_dest_set_target_list">
+<function name="gtk_widget_hide_all">
<description>
-Sets the target types that this widget can accept from drag-and-drop.
-The widget must first be made into a drag destination with
-gtk_drag_dest_set().
+Recursively hides a widget and any child widgets.
+
+Deprecated: 2.24: Use gtk_widget_hide() instead.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget that's a drag destination
-</parameter_description>
-</parameter>
-<parameter name="target_list">
-<parameter_description> list of droppable targets, or %NULL for none
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_selection_add_target">
+<function name="gtk_widget_hide_on_delete">
<description>
-Appends a specified target to the list of supported targets for a
-given widget and selection.
+Utility function; intended to be connected to the #GtkWidget::delete-event
+signal on a #GtkWindow. The function calls gtk_widget_hide() on its
+argument, then returns %TRUE. If connected to ::delete-event, the
+result is that clicking the close button for a window (on the
+window frame, top right corner usually) will hide but not destroy
+the window. By default, GTK+ destroys windows when ::delete-event
+is received.
+
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkTarget
-</parameter_description>
-</parameter>
-<parameter name="selection">
-<parameter_description> the selection
-</parameter_description>
-</parameter>
-<parameter name="target">
-<parameter_description> target to add.
-</parameter_description>
-</parameter>
-<parameter name="info">
-<parameter_description> A unsigned integer which will be passed back to the application.
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE
+</return>
</function>
-<function name="gtk_widget_modify_fg">
+<function name="gtk_widget_input_shape_combine_mask">
<description>
-Sets the foreground color for a widget in a particular state.
-All other style values are left untouched. See also
-gtk_widget_modify_style().
+Sets an input shape for this widget's GDK window. This allows for
+windows which react to mouse click in a nonrectangular region, see
+gdk_window_input_shape_combine_mask() for more information.
+
+Since: 2.10
</description>
<parameters>
@@ -65622,669 +65626,815 @@ gtk_widget_modify_style().
<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="state">
-<parameter_description> the state for which to set the foreground color
+<parameter name="shape_mask">
+<parameter_description> shape to be added, or %NULL to remove an existing shape
</parameter_description>
</parameter>
-<parameter name="color">
-<parameter_description> the color to assign (does not need to be allocated),
-or %NULL to undo the effect of previous calls to
-of gtk_widget_modify_fg().
+<parameter name="offset_x">
+<parameter_description> X position of shape mask with respect to @window
+</parameter_description>
+</parameter>
+<parameter name="offset_y">
+<parameter_description> Y position of shape mask with respect to @window
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_insert_column">
+<function name="gtk_widget_intersect">
<description>
-This inserts the @column into the @tree_view at @position. If @position is
--1, then the column is inserted at the end. If @tree_view has
-"fixed_height" mode enabled, then @column must have its "sizing" property
-set to be GTK_TREE_VIEW_COLUMN_FIXED.
+Computes the intersection of a @widget's area and @area, storing
+the intersection in @intersection, and returns %TRUE if there was
+an intersection. @intersection may be %NULL if you're only
+interested in whether there was an intersection.
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView.
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="column">
-<parameter_description> The #GtkTreeViewColumn to be inserted.
+<parameter name="area">
+<parameter_description> a rectangle
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> The position to insert @column in.
+<parameter name="intersection">
+<parameter_description> rectangle to store intersection of @widget and @area
</parameter_description>
</parameter>
</parameters>
-<return> The number of columns in @tree_view after insertion.
+<return> %TRUE if there was an intersection
</return>
</function>
-<function name="gtk_image_menu_item_set_image">
+<function name="gtk_widget_is_ancestor">
<description>
-Sets the image of @image_menu_item to the given widget.
-Note that it depends on the show-menu-images setting whether
-the image will be displayed or not.
+Determines whether @widget is somewhere inside @ancestor, possibly with
+intermediate containers.
+
</description>
<parameters>
-<parameter name="image_menu_item">
-<parameter_description> a #GtkImageMenuItem.
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="image">
-<parameter_description> a widget to set as the image for the menu item.
+<parameter name="ancestor">
+<parameter_description> another #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if @ancestor contains @widget as a child,
+grandchild, great grandchild, etc.
+</return>
</function>
-<function name="gtk_image_new_from_image">
+<function name="gtk_widget_is_composited">
<description>
-Creates a #GtkImage widget displaying a @image with a @mask.
-A #GdkImage is a client-side image buffer in the pixel format of the
-current display. The #GtkImage does not assume a reference to the
-image or mask; you still need to unref them if you own references.
-#GtkImage will add its own reference rather than adopting yours.
+Whether @widget can rely on having its alpha channel
+drawn correctly. On X11 this function returns whether a
+compositing manager is running for @widget's screen.
+Please note that the semantics of this call will change
+in the future if used on a widget that has a composited
+window in its hierarchy (as set by gdk_window_set_composited()).
+
+Since: 2.10
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GdkImage, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="mask">
-<parameter_description> a #GdkBitmap, or %NULL
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkImage
+<return> %TRUE if the widget can rely on its alpha
+channel being drawn correctly.
+
</return>
</function>
-<function name="gtk_cell_renderer_spinner_new">
+<function name="gtk_widget_is_drawable">
<description>
-Returns a new cell renderer which will show a spinner to indicate
-activity.
+Determines whether @widget can be drawn to. A widget can be drawn
+to if it is mapped and visible.
-Since: 2.20
+Since: 2.18
</description>
<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GtkCellRenderer
+<return> %TRUE if @widget is drawable, %FALSE otherwise
</return>
</function>
-<function name="gtk_window_new">
+<function name="gtk_widget_is_focus">
<description>
-Creates a new #GtkWindow, which is a toplevel window that can
-contain other widgets. Nearly always, the type of the window should
-be #GTK_WINDOW_TOPLEVEL. If you're implementing something like a
-popup menu from scratch (which is a bad idea, just use #GtkMenu),
-you might use #GTK_WINDOW_POPUP. #GTK_WINDOW_POPUP is not for
-dialogs, though in some other toolkits dialogs are called "popups".
-In GTK+, #GTK_WINDOW_POPUP means a pop-up menu or pop-up tooltip.
-On X11, popup windows are not controlled by the <link
-linkend="gtk-X11-arch">window manager</link>.
-
-If you simply want an undecorated window (no window borders), use
-gtk_window_set_decorated(), don't use #GTK_WINDOW_POPUP.
+Determines if the widget is the focus widget within its
+toplevel. (This does not mean that the %HAS_FOCUS flag is
+necessarily set; %HAS_FOCUS will only be set if the
+toplevel widget additionally has the global input focus.)
</description>
<parameters>
-<parameter name="type">
-<parameter_description> type of window
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkWindow.
+<return> %TRUE if the widget is the focus widget.
</return>
</function>
-<function name="gtk_tree_row_reference_new_proxy">
+<function name="gtk_widget_is_sensitive">
<description>
-You do not need to use this function. Creates a row reference based on
- path This reference will keep pointing to the node pointed to by @path,
-so long as it exists. If @path isn't a valid path in @model, then %NULL is
-returned. However, unlike references created with
-gtk_tree_row_reference_new(), it does not listen to the model for changes.
-The creator of the row reference must do this explicitly using
-gtk_tree_row_reference_inserted(), gtk_tree_row_reference_deleted(),
-gtk_tree_row_reference_reordered().
-
-These functions must be called exactly once per proxy when the
-corresponding signal on the model is emitted. This single call
-updates all row references for that proxy. Since built-in GTK+
-objects like #GtkTreeView already use this mechanism internally,
-using them as the proxy object will produce unpredictable results.
-Further more, passing the same object as @model and @proxy
-doesn't work for reasons of internal implementation.
-
-This type of row reference is primarily meant by structures that need to
-carefully monitor exactly when a row reference updates itself, and is not
-generally needed by most applications.
+Returns the widget's effective sensitivity, which means
+it is sensitive itself and also its parent widget is sensntive
+Since: 2.18
</description>
<parameters>
-<parameter name="proxy">
-<parameter_description> A proxy #GObject
-</parameter_description>
-</parameter>
-<parameter name="model">
-<parameter_description> A #GtkTreeModel
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> A valid #GtkTreePath to monitor
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> A newly allocated #GtkTreeRowReference, or %NULL
+<return> %TRUE if the widget is effectively sensitive
+
</return>
</function>
-<function name="gtk_selection_data_get_length">
+<function name="gtk_widget_is_toplevel">
<description>
-Retrieves the length of the raw data of the selection.
+Determines whether @widget is a toplevel widget. Currently only
+#GtkWindow and #GtkInvisible are toplevel widgets. Toplevel
+widgets have no parent widget.
-Since: 2.14
+Since: 2.18
</description>
<parameters>
-<parameter name="selection_data">
-<parameter_description> a pointer to a #GtkSelectionData structure.
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> the length of the data of the selection.
+<return> %TRUE if @widget is a toplevel, %FALSE otherwise
</return>
</function>
-<function name="gtk_tree_model_sort_new_with_model">
+<function name="gtk_widget_keynav_failed">
<description>
-Creates a new #GtkTreeModel, with @child_model as the child model.
+This function should be called whenever keyboard navigation within
+a single widget hits a boundary. The function emits the
+#GtkWidget::keynav-failed signal on the widget and its return
+value should be interpreted in a way similar to the return value of
+gtk_widget_child_focus():
+
+When %TRUE is returned, stay in the widget, the failed keyboard
+navigation is Ok and/or there is nowhere we can/should move the
+focus to.
+
+When %FALSE is returned, the caller should continue with keyboard
+navigation outside the widget, e.g. by calling
+gtk_widget_child_focus() on the widget's toplevel.
+
+The default ::keynav-failed handler returns %TRUE for
+%GTK_DIR_TAB_FORWARD and %GTK_DIR_TAB_BACKWARD. For the other
+values of #GtkDirectionType, it looks at the
+#GtkSettings:gtk-keynav-cursor-only setting and returns %FALSE
+if the setting is %TRUE. This way the entire user interface
+becomes cursor-navigatable on input devices such as mobile phones
+which only have cursor keys but no tab key.
+
+Whenever the default handler returns %TRUE, it also calls
+gtk_widget_error_bell() to notify the user of the failed keyboard
+navigation.
+A use case for providing an own implementation of ::keynav-failed
+(either by connecting to it or by overriding it) would be a row of
+#GtkEntry widgets where the user should be able to navigate the
+entire row with the cursor keys, as e.g. known from user interfaces
+that require entering license keys.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="child_model">
-<parameter_description> A #GtkTreeModel
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="direction">
+<parameter_description> direction of focus movement
</parameter_description>
</parameter>
</parameters>
-<return> A new #GtkTreeModel.
+<return> %TRUE if stopping keyboard navigation is fine, %FALSE
+if the emitting widget should try to handle the keyboard
+navigation attempt in its parent container(s).
+
</return>
</function>
-<function name="gtk_window_group_get_current_current_grab">
+<function name="gtk_widget_list_accel_closures">
<description>
-Gets the current grab widget of the given group,
-see gtk_grab_add().
+Lists the closures used by @widget for accelerator group connections
+with gtk_accel_group_connect_by_path() or gtk_accel_group_connect().
+The closures can be used to monitor accelerator changes on @widget,
+by connecting to the @GtkAccelGroup::accel-changed signal of the
+#GtkAccelGroup of a closure which can be found out with
+gtk_accel_group_from_accel_closure().
-Since: 2.22
</description>
<parameters>
-<parameter name="window_group">
-<parameter_description> a #GtkWindowGroup
+<parameter name="widget">
+<parameter_description> widget to list accelerator closures for
</parameter_description>
</parameter>
</parameters>
-<return> the current grab widget of the group
-
+<return>
+a newly allocated #GList of closures
</return>
</function>
-<function name="gtk_range_get_restrict_to_fill_level">
+<function name="gtk_widget_list_mnemonic_labels">
<description>
-Gets whether the range is restricted to the fill level.
+Returns a newly allocated list of the widgets, normally labels, for
+which this widget is a the target of a mnemonic (see for example,
+gtk_label_set_mnemonic_widget()).
-Since: 2.12
+The widgets in the list are not individually referenced. If you
+want to iterate through the list and perform actions involving
+callbacks that might destroy the widgets, you
+<emphasis>must</emphasis> call <literal>g_list_foreach (result,
+(GFunc)g_object_ref, NULL)</literal> first, and then unref all the
+widgets afterwards.
+
+Since: 2.4
</description>
<parameters>
-<parameter name="range">
-<parameter_description> A #GtkRange
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @range is restricted to the fill level.
+<return> the list of
+mnemonic labels; free this list
+with g_list_free() when you are done with it.
</return>
</function>
-<function name="gtk_recent_filter_add_group">
+<function name="gtk_widget_map">
<description>
-Adds a rule that allows resources based on the name of the group
-to which they belong
-
-Since: 2.10
+This function is only for use in widget implementations. Causes
+a widget to be mapped if it isn't already.
</description>
<parameters>
-<parameter name="filter">
-<parameter_description> a #GtkRecentFilter
-</parameter_description>
-</parameter>
-<parameter name="group">
-<parameter_description> a group name
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_view_get_item_column">
+<function name="gtk_widget_mnemonic_activate">
<description>
-Gets the column in which the item @path is currently
-displayed. Column numbers start at 0.
+Emits the #GtkWidget::mnemonic-activate signal.
+
+The default handler for this signal activates the @widget if
+ group_cycling is %FALSE, and just grabs the focus if @group_cycling
+is %TRUE.
-Since: 2.22
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> the #GtkTreePath of the item
+<parameter name="group_cycling">
+<parameter_description> %TRUE if there are other widgets with the same mnemonic
</parameter_description>
</parameter>
</parameters>
-<return> The column in which the item is displayed
-
+<return> %TRUE if the signal has been handled
</return>
</function>
-<function name="gtk_widget_set_composite_name">
+<function name="gtk_widget_modify_base">
<description>
-Sets a widgets composite name. The widget must be
-a composite child of its parent; see gtk_widget_push_composite_child().
+Sets the base color for a widget in a particular state.
+All other style values are left untouched. The base color
+is the background color used along with the text color
+(see gtk_widget_modify_text()) for widgets such as #GtkEntry
+and #GtkTextView. See also gtk_widget_modify_style().
+
+Note that "no window" widgets (which have the %GTK_NO_WINDOW flag set)
+draw on their parent container's window and thus may not draw any
+background themselves. This is the case for e.g. #GtkLabel. To modify
+the background of such widgets, you have to set the base color on their
+parent; if you want to set the background of a rectangular area around
+a label, try placing the label in a #GtkEventBox widget and setting
+the base color on that.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget.
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="name">
-<parameter_description> the name to set
+<parameter name="state">
+<parameter_description> the state for which to set the base color
+</parameter_description>
+</parameter>
+<parameter name="color">
+<parameter_description> the color to assign (does not need to be allocated),
+or %NULL to undo the effect of previous calls to
+of gtk_widget_modify_base().
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_cut_clipboard">
+<function name="gtk_widget_modify_bg">
<description>
-Copies the currently-selected text to a clipboard, then deletes
-said text if it's editable.
+Sets the background color for a widget in a particular state.
+All other style values are left untouched. See also
+gtk_widget_modify_style().
+
+Note that "no window" widgets (which have the %GTK_NO_WINDOW flag set)
+draw on their parent container's window and thus may not draw any
+background themselves. This is the case for e.g. #GtkLabel. To modify
+the background of such widgets, you have to set the background color
+on their parent; if you want to set the background of a rectangular
+area around a label, try placing the label in a #GtkEventBox widget
+and setting the background color on that.
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="clipboard">
-<parameter_description> the #GtkClipboard object to cut to
+<parameter name="state">
+<parameter_description> the state for which to set the background color
</parameter_description>
</parameter>
-<parameter name="default_editable">
-<parameter_description> default editability of the buffer
+<parameter name="color">
+<parameter_description> the color to assign (does not need to be allocated),
+or %NULL to undo the effect of previous calls to
+of gtk_widget_modify_bg().
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_entry_buffer_set_text">
+<function name="gtk_widget_modify_cursor">
<description>
-Sets the text in the buffer.
-
-This is roughly equivalent to calling gtk_entry_buffer_delete_text()
-and gtk_entry_buffer_insert_text().
-
-Note that @n_chars is in characters, not in bytes.
+Sets the cursor color to use in a widget, overriding the
+#GtkWidget:cursor-color and #GtkWidget:secondary-cursor-color
+style properties. All other style values are left untouched.
+See also gtk_widget_modify_style().
-Since: 2.18
+Since: 2.12
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkEntryBuffer
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="chars">
-<parameter_description> the new text
+<parameter name="primary">
+<parameter_description> the color to use for primary cursor (does not need to be
+allocated), or %NULL to undo the effect of previous calls to
+of gtk_widget_modify_cursor().
</parameter_description>
</parameter>
-<parameter name="n_chars">
-<parameter_description> the number of characters in @text, or -1
+<parameter name="secondary">
+<parameter_description> the color to use for secondary cursor (does not need to be
+allocated), or %NULL to undo the effect of previous calls to
+of gtk_widget_modify_cursor().
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_entry_get_icon_storage_type">
+<function name="gtk_widget_modify_fg">
<description>
-Gets the type of representation being used by the icon
-to store image data. If the icon has no image data,
-the return value will be %GTK_IMAGE_EMPTY.
-
-Since: 2.16
+Sets the foreground color for a widget in a particular state.
+All other style values are left untouched. See also
+gtk_widget_modify_style().
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="icon_pos">
-<parameter_description> Icon position
+<parameter name="state">
+<parameter_description> the state for which to set the foreground color
+</parameter_description>
+</parameter>
+<parameter name="color">
+<parameter_description> the color to assign (does not need to be allocated),
+or %NULL to undo the effect of previous calls to
+of gtk_widget_modify_fg().
</parameter_description>
</parameter>
</parameters>
-<return> image representation being used
-
-</return>
+<return></return>
</function>
-<function name="gtk_text_view_get_iter_at_position">
+<function name="gtk_widget_modify_font">
<description>
-Retrieves the iterator pointing to the character at buffer
-coordinates @x and @y. Buffer coordinates are coordinates for
-the entire buffer, not just the currently-displayed portion.
-If you have coordinates from an event, you have to convert
-those to buffer coordinates with
-gtk_text_view_window_to_buffer_coords().
-
-Note that this is different from gtk_text_view_get_iter_at_location(),
-which returns cursor locations, i.e. positions <emphasis>between</emphasis>
-characters.
-
-Since: 2.6
+Sets the font to use for a widget. All other style values are left
+untouched. See also gtk_widget_modify_style().
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="trailing">
-<parameter_description> if non-%NULL, location to store an integer indicating where
-in the grapheme the user clicked. It will either be
-zero, or the number of characters in the grapheme.
-0 represents the trailing edge of the grapheme.
+<parameter name="font_desc">
+<parameter_description> the font description to use, or %NULL to undo
+the effect of previous calls to gtk_widget_modify_font().
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> x position, in buffer coordinates
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_widget_modify_style">
+<description>
+Modifies style values on the widget. Modifications made using this
+technique take precedence over style values set via an RC file,
+however, they will be overriden if a style is explicitely set on
+the widget using gtk_widget_set_style(). The #GtkRcStyle structure
+is designed so each field can either be set or unset, so it is
+possible, using this function, to modify some style values and
+leave the others unchanged.
+
+Note that modifications made with this function are not cumulative
+with previous calls to gtk_widget_modify_style() or with such
+functions as gtk_widget_modify_fg(). If you wish to retain
+previous values, you must first call gtk_widget_get_modifier_style(),
+make your modifications to the returned style, then call
+gtk_widget_modify_style() with that style. On the other hand,
+if you first call gtk_widget_modify_style(), subsequent calls
+to such functions gtk_widget_modify_fg() will have a cumulative
+effect with the initial modifications.
+
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> y position, in buffer coordinates
+<parameter name="style">
+<parameter_description> the #GtkRcStyle holding the style modifications
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_operation_get_embed_page_setup">
+<function name="gtk_widget_modify_text">
<description>
-Gets the value of #GtkPrintOperation::embed-page-setup property.
-
-Since: 2.18
+Sets the text color for a widget in a particular state. All other
+style values are left untouched. The text color is the foreground
+color used along with the base color (see gtk_widget_modify_base())
+for widgets such as #GtkEntry and #GtkTextView. See also
+gtk_widget_modify_style().
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="state">
+<parameter_description> the state for which to set the text color
+</parameter_description>
+</parameter>
+<parameter name="color">
+<parameter_description> the color to assign (does not need to be allocated),
+or %NULL to undo the effect of previous calls to
+of gtk_widget_modify_text().
</parameter_description>
</parameter>
</parameters>
-<return> whether page setup selection combos are embedded
-
-</return>
+<return></return>
</function>
-<function name="gtk_cell_view_get_cell_renderers">
+<function name="gtk_widget_new">
<description>
-Returns the cell renderers which have been added to @cell_view.
+This is a convenience function for creating a widget and setting
+its properties in one go. For example you might write:
+<literal>gtk_widget_new (GTK_TYPE_LABEL, "label", "Hello World", "xalign",
+0.0, NULL)</literal> to create a left-aligned label. Equivalent to
+g_object_new(), but returns a widget so you don't have to
+cast the object yourself.
-Since: 2.6
-
-Deprecated: 2.18: use gtk_cell_layout_get_cells() instead.
</description>
<parameters>
-<parameter name="cell_view">
-<parameter_description> a #GtkCellView
+<parameter name="type">
+<parameter_description> type ID of the widget to create
+</parameter_description>
+</parameter>
+<parameter name="first_property_name">
+<parameter_description> name of first property to set
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> value of first property, followed by more properties,
+%NULL-terminated
</parameter_description>
</parameter>
</parameters>
-<return> a list of cell renderers. The list, but not the
-renderers has been newly allocated and should be freed with
-g_list_free() when no longer needed.
-
+<return> a new #GtkWidget of type @widget_type
</return>
</function>
-<function name="gtk_icon_info_get_embedded_rect">
+<function name="gtk_widget_path">
<description>
-Gets the coordinates of a rectangle within the icon
-that can be used for display of information such
-as a preview of the contents of a text file.
-See gtk_icon_info_set_raw_coordinates() for further
-information about the coordinate system.
-
-Since: 2.4
+Obtains the full path to @widget. The path is simply the name of a
+widget and all its parents in the container hierarchy, separated by
+periods. The name of a widget comes from
+gtk_widget_get_name(). Paths are used to apply styles to a widget
+in gtkrc configuration files. Widget names are the type of the
+widget by default (e.g. "GtkButton") or can be set to an
+application-specific value with gtk_widget_set_name(). By setting
+the name of a widget, you allow users or theme authors to apply
+styles to that specific widget in their gtkrc
+file. @path_reversed_p fills in the path in reverse order,
+i.e. starting with @widget's name instead of starting with the name
+of @widget's outermost ancestor.
</description>
<parameters>
-<parameter name="icon_info">
-<parameter_description> a #GtkIconInfo
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="rectangle">
-<parameter_description> #GdkRectangle in which to store embedded
-rectangle coordinates; coordinates are only stored
-when this function returns %TRUE.
+<parameter name="path_length">
+<parameter_description> location to store length of the path, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="path">
+<parameter_description> location to store allocated path string, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="path_reversed">
+<parameter_description> location to store allocated reverse path string, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the icon has an embedded rectangle
-
-</return>
+<return></return>
</function>
-<function name="gtk_style_new">
+<function name="gtk_widget_pop_colormap">
<description>
-Creates a new #GtkStyle.
+Removes a colormap pushed with gtk_widget_push_colormap().
</description>
<parameters>
</parameters>
-<return> a new #GtkStyle.
-</return>
+<return></return>
</function>
-<function name="gtk_plug_get_id">
+<function name="gtk_widget_pop_composite_child">
<description>
-Gets the window ID of a #GtkPlug widget, which can then
-be used to embed this window inside another window, for
-instance with gtk_socket_add_id().
+Cancels the effect of a previous call to gtk_widget_push_composite_child().
+
+</description>
+<parameters>
+</parameters>
+<return></return>
+</function>
+<function name="gtk_widget_push_colormap">
+<description>
+Pushes @cmap onto a global stack of colormaps; the topmost
+colormap on the stack will be used to create all widgets.
+Remove @cmap with gtk_widget_pop_colormap(). There's little
+reason to use this function.
</description>
<parameters>
-<parameter name="plug">
-<parameter_description> a #GtkPlug.
+<parameter name="cmap">
+<parameter_description> a #GdkColormap
</parameter_description>
</parameter>
</parameters>
-<return> the window ID for the plug
-</return>
+<return></return>
</function>
-<function name="gtk_cell_renderer_toggle_get_active">
+<function name="gtk_widget_push_composite_child">
<description>
-Returns whether the cell renderer is active. See
-gtk_cell_renderer_toggle_set_active().
+Makes all newly-created widgets as composite children until
+the corresponding gtk_widget_pop_composite_child() call.
+A composite child is a child that's an implementation detail of the
+container it's inside and should not be visible to people using the
+container. Composite children aren't treated differently by GTK (but
+see gtk_container_foreach() vs. gtk_container_forall()), but e.g. GUI
+builders might want to treat them in a different way.
+
+Here is a simple example:
+|[
+gtk_widget_push_composite_child ();
+scrolled_window->hscrollbar = gtk_hscrollbar_new (hadjustment);
+gtk_widget_set_composite_name (scrolled_window->hscrollbar, "hscrollbar");
+gtk_widget_pop_composite_child ();
+gtk_widget_set_parent (scrolled_window->hscrollbar,
+GTK_WIDGET (scrolled_window));
+g_object_ref (scrolled_window->hscrollbar);
+]|
</description>
<parameters>
-<parameter name="toggle">
-<parameter_description> a #GtkCellRendererToggle
-</parameter_description>
-</parameter>
</parameters>
-<return> %TRUE if the cell renderer is active.
-</return>
+<return></return>
</function>
-<function name="gtk_about_dialog_set_license">
+<function name="gtk_widget_queue_clear">
<description>
-Sets the license information to be displayed in the secondary
-license dialog. If @license is %NULL, the license button is
-hidden.
+This function does the same as gtk_widget_queue_draw().
-Since: 2.6
+Deprecated: 2.2: Use gtk_widget_queue_draw() instead.
</description>
<parameters>
-<parameter name="about">
-<parameter_description> a #GtkAboutDialog
-</parameter_description>
-</parameter>
-<parameter name="license">
-<parameter_description> the license information or %NULL
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_get_reorderable">
+<function name="gtk_widget_queue_clear_area">
<description>
-Retrieves whether the user can reorder the tree via drag-and-drop. See
-gtk_tree_view_set_reorderable().
+This function is no longer different from
+gtk_widget_queue_draw_area(), though it once was. Now it just calls
+gtk_widget_queue_draw_area(). Originally
+gtk_widget_queue_clear_area() would force a redraw of the
+background for %GTK_NO_WINDOW widgets, and
+gtk_widget_queue_draw_area() would not. Now both functions ensure
+the background will be redrawn.
+Deprecated: 2.2: Use gtk_widget_queue_draw_area() instead.
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> x coordinate of upper-left corner of rectangle to redraw
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y coordinate of upper-left corner of rectangle to redraw
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> width of region to draw
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> height of region to draw
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the tree can be reordered.
-</return>
+<return></return>
</function>
-<function name="gtk_recent_chooser_get_local_only">
+<function name="gtk_widget_queue_draw">
<description>
-Gets whether only local resources should be shown in the recently used
-resources selector. See gtk_recent_chooser_set_local_only()
-
-Since: 2.10
+Equivalent to calling gtk_widget_queue_draw_area() for the
+entire area of a widget.
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if only local resources should be shown.
-
-</return>
+<return></return>
</function>
-<function name="gtk_item_factory_delete_item">
+<function name="gtk_widget_queue_draw_area">
<description>
-Deletes the menu item which was created for @path by the given
-item factory.
+Invalidates the rectangular area of @widget defined by @x, @y,
+ width and @height by calling gdk_window_invalidate_rect() on the
+widget's window and all its child windows. Once the main loop
+becomes idle (after the current batch of events has been processed,
+roughly), the window will receive expose events for the union of
+all regions that have been invalidated.
-Deprecated: 2.4: Use #GtkUIManager instead.
+Normally you would only use this function in widget
+implementations. You might also use it, or
+gdk_window_invalidate_rect() directly, to schedule a redraw of a
+#GtkDrawingArea or some portion thereof.
+
+Frequently you can just call gdk_window_invalidate_rect() or
+gdk_window_invalidate_region() instead of this function. Those
+functions will invalidate only a single window, instead of the
+widget and all its children.
+
+The advantage of adding to the invalidated region compared to
+simply drawing immediately is efficiency; using an invalid region
+ensures that you only have to redraw one time.
</description>
<parameters>
-<parameter name="ifactory">
-<parameter_description> a #GtkItemFactory
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> a path
+<parameter name="x">
+<parameter_description> x coordinate of upper-left corner of rectangle to redraw
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y coordinate of upper-left corner of rectangle to redraw
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> width of region to draw
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> height of region to draw
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_source_get_icon_name">
+<function name="gtk_widget_queue_resize">
<description>
-Retrieves the source icon name, or %NULL if none is set. The
-icon_name is not a copy, and should not be modified or expected to
-persist beyond the lifetime of the icon source.
-
+This function is only for use in widget implementations.
+Flags a widget to have its size renegotiated; should
+be called when a widget for some reason has a new size request.
+For example, when you change the text in a #GtkLabel, #GtkLabel
+queues a resize to ensure there's enough space for the new text.
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GtkIconSource
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> icon name. This string must not be modified or freed.
-</return>
+<return></return>
</function>
-<function name="gtk_text_mark_set_visible">
+<function name="gtk_widget_queue_resize_no_redraw">
<description>
-Sets the visibility of @mark; the insertion point is normally
-visible, i.e. you can see it as a vertical bar. Also, the text
-widget uses a visible mark to indicate where a drop will occur when
-dragging-and-dropping text. Most other marks are not visible.
-Marks are not visible by default.
+This function works like gtk_widget_queue_resize(),
+except that the widget is not invalidated.
+Since: 2.4
</description>
<parameters>
-<parameter name="mark">
-<parameter_description> a #GtkTextMark
-</parameter_description>
-</parameter>
-<parameter name="setting">
-<parameter_description> visibility of mark
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_set_state">
+<function name="gtk_widget_queue_shallow_draw">
<description>
-This function is for use in widget implementations. Sets the state
-of a widget (insensitive, prelighted, etc.) Usually you should set
-the state using wrapper functions such as gtk_widget_set_sensitive().
+Like gtk_widget_queue_draw(), but only windows owned
+by @widget are invalidated.
</description>
<parameters>
@@ -66292,349 +66442,372 @@ the state using wrapper functions such as gtk_widget_set_sensitive().
<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="state">
-<parameter_description> new state for @widget
-</parameter_description>
-</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tool_button_set_label">
+<function name="gtk_widget_realize">
<description>
-Sets @label as the label used for the tool button. The "label" property
-only has an effect if not overridden by a non-%NULL "label_widget" property.
-If both the "label_widget" and "label" properties are %NULL, the label
-is determined by the "stock_id" property. If the "stock_id" property is also
-%NULL, @button will not have a label.
+Creates the GDK (windowing system) resources associated with a
+widget. For example, @widget->window will be created when a widget
+is realized. Normally realization happens implicitly; if you show
+a widget and all its parent containers, then the widget will be
+realized and mapped automatically.
-Since: 2.4
+Realizing a widget requires all
+the widget's parent widgets to be realized; calling
+gtk_widget_realize() realizes the widget's parents in addition to
+ widget itself. If a widget is not yet inside a toplevel window
+when you realize it, bad things will happen.
+
+This function is primarily used in widget implementations, and
+isn't very useful otherwise. Many times when you think you might
+need it, a better approach is to connect to a signal that will be
+called after the widget is realized automatically, such as
+GtkWidget::expose-event. Or simply g_signal_connect () to the
+GtkWidget::realize signal.
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkToolButton
-</parameter_description>
-</parameter>
-<parameter name="label">
-<parameter_description> a string that will be used as label, or %NULL.
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_file_chooser_get_preview_widget_active">
+<function name="gtk_widget_ref">
<description>
-Gets whether the preview widget set by gtk_file_chooser_set_preview_widget()
-should be shown for the current filename. See
-gtk_file_chooser_set_preview_widget_active().
+Adds a reference to a widget. This function is exactly the same
+as calling g_object_ref(), and exists mostly for historical
+reasons. It can still be convenient to avoid casting a widget
+to a #GObject, it saves a small amount of typing.
-Since: 2.4
+Deprecated: 2.12: Use g_object_ref() instead.
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the preview widget is active for the current filename.
+<return> the widget that was referenced
</return>
</function>
-<function name="gtk_menu_item_set_accel_path">
+<function name="gtk_widget_region_intersect">
<description>
-Set the accelerator path on @menu_item, through which runtime changes of the
-menu item's accelerator caused by the user can be identified and saved to
-persistant storage (see gtk_accel_map_save() on this).
-To setup a default accelerator for this menu item, call
-gtk_accel_map_add_entry() with the same @accel_path.
-See also gtk_accel_map_add_entry() on the specifics of accelerator paths,
-and gtk_menu_set_accel_path() for a more convenient variant of this function.
-
-This function is basically a convenience wrapper that handles calling
-gtk_widget_set_accel_path() with the appropriate accelerator group for
-the menu item.
-
-Note that you do need to set an accelerator on the parent menu with
-gtk_menu_set_accel_group() for this to work.
-
-Note that @accel_path string will be stored in a #GQuark. Therefore, if you
-pass a static string, you can save some memory by interning it first with
-g_intern_static_string().
+Computes the intersection of a @widget's area and @region, returning
+the intersection. The result may be empty, use gdk_region_empty() to
+check.
</description>
<parameters>
-<parameter name="menu_item">
-<parameter_description> a valid #GtkMenuItem
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="accel_path">
-<parameter_description> accelerator path, corresponding to this menu item's
-functionality, or %NULL to unset the current path.
+<parameter name="region">
+<parameter_description> a #GdkRegion, in the same coordinate system as
+ widget->allocation. That is, relative to @widget->window
+for %NO_WINDOW widgets; relative to the parent window
+of @widget->window for widgets with their own window.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> A newly allocated region holding the intersection of @widget
+and @region. The coordinates of the return value are
+relative to @widget->window for %NO_WINDOW widgets, and
+relative to the parent window of @widget->window for
+widgets with their own window.
+</return>
</function>
-<function name="gtk_image_set_from_pixmap">
+<function name="gtk_widget_remove_accelerator">
<description>
-See gtk_image_new_from_pixmap() for details.
+Removes an accelerator from @widget, previously installed with
+gtk_widget_add_accelerator().
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GtkImage
+<parameter name="widget">
+<parameter_description> widget to install an accelerator on
</parameter_description>
</parameter>
-<parameter name="pixmap">
-<parameter_description> a #GdkPixmap or %NULL
+<parameter name="accel_group">
+<parameter_description> accel group for this widget
</parameter_description>
</parameter>
-<parameter name="mask">
-<parameter_description> a #GdkBitmap or %NULL
+<parameter name="accel_key">
+<parameter_description> GDK keyval of the accelerator
+</parameter_description>
+</parameter>
+<parameter name="accel_mods">
+<parameter_description> modifier key combination of the accelerator
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> whether an accelerator was installed and could be removed
+</return>
</function>
-<function name="gtk_accel_label_get_accel_width">
+<function name="gtk_widget_remove_mnemonic_label">
<description>
-Returns the width needed to display the accelerator key(s).
-This is used by menus to align all of the #GtkMenuItem widgets, and shouldn't
-be needed by applications.
+Removes a widget from the list of mnemonic labels for
+this widget. (See gtk_widget_list_mnemonic_labels()). The widget
+must have previously been added to the list with
+gtk_widget_add_mnemonic_label().
+Since: 2.4
</description>
<parameters>
-<parameter name="accel_label">
-<parameter_description> a #GtkAccelLabel.
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="label">
+<parameter_description> a #GtkWidget that was previously set as a mnemnic label for
+ widget with gtk_widget_add_mnemonic_label().
</parameter_description>
</parameter>
</parameters>
-<return> the width needed to display the accelerator key(s).
-</return>
+<return></return>
</function>
-<function name="gtk_printer_get_hard_margins">
+<function name="gtk_widget_render_icon">
<description>
-Retrieve the hard margins of @printer, i.e. the margins that define
-the area at the borders of the paper that the printer cannot print to.
+A convenience function that uses the theme engine and RC file
+settings for @widget to look up @stock_id and render it to
+a pixbuf. @stock_id should be a stock icon ID such as
+#GTK_STOCK_OPEN or #GTK_STOCK_OK. @size should be a size
+such as #GTK_ICON_SIZE_MENU. @detail should be a string that
+identifies the widget or code doing the rendering, so that
+theme engines can special-case rendering for that widget or code.
-Note: This will not succeed unless the printer's details are available,
-see gtk_printer_has_details() and gtk_printer_request_details().
+The pixels in the returned #GdkPixbuf are shared with the rest of
+the application and should not be modified. The pixbuf should be freed
+after use with g_object_unref().
-Since: 2.20
</description>
<parameters>
-<parameter name="printer">
-<parameter_description> a #GtkPrinter
-</parameter_description>
-</parameter>
-<parameter name="top">
-<parameter_description> a location to store the top margin in
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="bottom">
-<parameter_description> a location to store the bottom margin in
+<parameter name="stock_id">
+<parameter_description> a stock ID
</parameter_description>
</parameter>
-<parameter name="left">
-<parameter_description> a location to store the left margin in
+<parameter name="size">
+<parameter_description> (type int) a stock size. A size of (GtkIconSize)-1 means
+render at the size of the source and don't scale (if there are
+multiple source sizes, GTK+ picks one of the available sizes).
</parameter_description>
</parameter>
-<parameter name="right">
-<parameter_description> a location to store the right margin in
+<parameter name="detail">
+<parameter_description> render detail to pass to theme engine
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE iff the hard margins were retrieved
-
+<return> a new pixbuf, or %NULL if the
+stock ID wasn't known
</return>
</function>
-<function name="gtk_tree_view_set_headers_visible">
+<function name="gtk_widget_reparent">
<description>
-Sets the visibility state of the headers.
+Moves a widget from one #GtkContainer to another, handling reference
+count issues to avoid destroying the widget.
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView.
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="headers_visible">
-<parameter_description> %TRUE if the headers are visible
+<parameter name="new_parent">
+<parameter_description> a #GtkContainer to move the widget into
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_get_visible_range">
+<function name="gtk_widget_reset_rc_styles">
<description>
-Sets @start_path and @end_path to be the first and last visible path.
-Note that there may be invisible paths in between.
-
-The paths should be freed with gtk_tree_path_free() after use.
+Reset the styles of @widget and all descendents, so when
+they are looked up again, they get the correct values
+for the currently loaded RC file settings.
-Since: 2.8
+This function is not useful for applications.
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView
-</parameter_description>
-</parameter>
-<parameter name="start_path">
-<parameter_description> Return location for start of region, or %NULL.
-</parameter_description>
-</parameter>
-<parameter name="end_path">
-<parameter_description> Return location for end of region, or %NULL.
+<parameter name="widget">
+<parameter_description> a #GtkWidget.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE, if valid paths were placed in @start_path and @end_path.
-
-</return>
+<return></return>
</function>
-<function name="gtk_recent_info_ref">
+<function name="gtk_widget_reset_shapes">
<description>
-Increases the reference count of @recent_info by one.
+Recursively resets the shape on this widget and its descendants.
-Since: 2.10
+Deprecated: This function is being removed in GTK+ 3.0. Don't use it.
</description>
<parameters>
-<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> the recent info object with its reference count increased
-by one.
-
-</return>
+<return></return>
</function>
-<function name="gtk_tree_view_convert_tree_to_bin_window_coords">
+<function name="gtk_widget_send_expose">
<description>
-Converts tree coordinates (coordinates in full scrollable area of the tree)
-to bin_window coordinates.
+Very rarely-used function. This function is used to emit
+an expose event signals on a widget. This function is not
+normally used directly. The only time it is used is when
+propagating an expose event to a child %NO_WINDOW widget, and
+that is normally done using gtk_container_propagate_expose().
+
+If you want to force an area of a window to be redrawn,
+use gdk_window_invalidate_rect() or gdk_window_invalidate_region().
+To cause the redraw to be done immediately, follow that call
+with a call to gdk_window_process_updates().
-Since: 2.12
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
-</parameter_description>
-</parameter>
-<parameter name="tx">
-<parameter_description> tree X coordinate
-</parameter_description>
-</parameter>
-<parameter name="ty">
-<parameter_description> tree Y coordinate
-</parameter_description>
-</parameter>
-<parameter name="bx">
-<parameter_description> return location for X coordinate relative to bin_window
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="by">
-<parameter_description> return location for Y coordinate relative to bin_window
+<parameter name="event">
+<parameter_description> a expose #GdkEvent
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> return from the event signal emission (%TRUE if
+the event was handled)
+</return>
</function>
-<function name="gtk_accel_group_get_modifier_mask">
+<function name="gtk_widget_send_focus_change">
<description>
-Gets a #GdkModifierType representing the mask for this
- accel_group For example, #GDK_CONTROL_MASK, #GDK_SHIFT_MASK, etc.
+Sends the focus change @event to @widget
-Since: 2.14
+This function is not meant to be used by applications. The only time it
+should be used is when it is necessary for a #GtkWidget to assign focus
+to a widget that is semantically owned by the first widget even though
+it's not a direct child - for instance, a search entry in a floating
+window similar to the quick search in #GtkTreeView.
-</description>
-<parameters>
-<parameter name="accel_group">
-<parameter_description> a #GtkAccelGroup
-</parameter_description>
-</parameter>
-</parameters>
-<return> the modifier mask for this accel group.
+An example of its usage is:
-</return>
-</function>
+|[
+GdkEvent *fevent = gdk_event_new (GDK_FOCUS_CHANGE);
-<function name="gtk_size_group_get_widgets">
-<description>
-Returns the list of widgets associated with @size_group.
+fevent->focus_change.type = GDK_FOCUS_CHANGE;
+fevent->focus_change.in = TRUE;
+fevent->focus_change.window = gtk_widget_get_window (widget);
+if (fevent->focus_change.window != NULL)
+g_object_ref (fevent->focus_change.window);
-Since: 2.10
+gtk_widget_send_focus_change (widget, fevent);
+
+gdk_event_free (event);
+]|
+
+Since: 2.22
</description>
<parameters>
-<parameter name="size_group">
-<parameter_description> a #GtkSizeGrup
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="event">
+<parameter_description> a #GdkEvent of type GDK_FOCUS_CHANGE
</parameter_description>
</parameter>
</parameters>
-<return> a #GSList of
-widgets. The list is owned by GTK+ and should not be modified.
+<return> the return value from the event signal emission: %TRUE
+if the event was handled, and %FALSE otherwise
</return>
</function>
-<function name="gtk_cell_renderer_progress_new">
+<function name="gtk_widget_set">
<description>
-Creates a new #GtkCellRendererProgress.
+Precursor of g_object_set().
-Since: 2.6
+Deprecated: 2.0: Use g_object_set() instead.
</description>
<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="first_property_name">
+<parameter_description> name of first property to set
+</parameter_description>
+</parameter>
+<parameter name="Varargs">
+<parameter_description> value of first property, followed by more properties,
+%NULL-terminated
+</parameter_description>
+</parameter>
</parameters>
-<return> the new cell renderer
-
-</return>
+<return></return>
</function>
-<function name="gtk_cell_layout_add_attribute">
+<function name="gtk_widget_set_accel_path">
<description>
-Adds an attribute mapping to the list in @cell_layout. The @column is the
-column of the model to get a value from, and the @attribute is the
-parameter on @cell to be set from the value. So for example if column 2
-of the model contains strings, you could have the "text" attribute of a
-#GtkCellRendererText get its values from column 2.
+Given an accelerator group, @accel_group, and an accelerator path,
+ accel_path, sets up an accelerator in @accel_group so whenever the
+key binding that is defined for @accel_path is pressed, @widget
+will be activated. This removes any accelerators (for any
+accelerator group) installed by previous calls to
+gtk_widget_set_accel_path(). Associating accelerators with
+paths allows them to be modified by the user and the modifications
+to be saved for future use. (See gtk_accel_map_save().)
-Since: 2.4
+This function is a low level function that would most likely
+be used by a menu creation system like #GtkUIManager. If you
+use #GtkUIManager, setting up accelerator paths will be done
+automatically.
+
+Even when you you aren't using #GtkUIManager, if you only want to
+set up accelerators on menu items gtk_menu_item_set_accel_path()
+provides a somewhat more convenient interface.
+
+Note that @accel_path string will be stored in a #GQuark. Therefore, if you
+pass a static string, you can save some memory by interning it first with
+g_intern_static_string().
</description>
<parameters>
-<parameter name="cell_layout">
-<parameter_description> A #GtkCellLayout.
-</parameter_description>
-</parameter>
-<parameter name="cell">
-<parameter_description> A #GtkCellRenderer.
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="attribute">
-<parameter_description> An attribute on the renderer.
+<parameter name="accel_path">
+<parameter_description> path used to look up the accelerator
</parameter_description>
</parameter>
-<parameter name="column">
-<parameter_description> The column position on the model to get the attribute from.
+<parameter name="accel_group">
+<parameter_description> a #GtkAccelGroup.
</parameter_description>
</parameter>
</parameters>
@@ -66662,369 +66835,408 @@ Since: 2.18
<return></return>
</function>
-<function name="gtk_action_get_icon_name">
+<function name="gtk_widget_set_app_paintable">
<description>
-Gets the icon name of @action.
+Sets whether the application intends to draw on the widget in
+an #GtkWidget::expose-event handler.
-Since: 2.16
+This is a hint to the widget and does not affect the behavior of
+the GTK+ core; many widgets ignore this flag entirely. For widgets
+that do pay attention to the flag, such as #GtkEventBox and #GtkWindow,
+the effect is to suppress default themed drawing of the widget's
+background. (Children of the widget will still be drawn.) The application
+is then entirely responsible for drawing the widget background.
+
+Note that the background is still drawn when the widget is mapped.
+If this is not suitable (e.g. because you want to make a transparent
+window using an RGBA visual), you can work around this by doing:
+|[
+gtk_widget_realize (window);
+gdk_window_set_back_pixmap (window->window, NULL, FALSE);
+gtk_widget_show (window);
+]|
</description>
<parameters>
-<parameter name="action">
-<parameter_description> a #GtkAction
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-</parameters>
-<return> the icon name
-
-</return>
-</function>
-
-<function name="gtk_expander_get_use_underline">
-<description>
-Returns whether an embedded underline in the expander label indicates a
-mnemonic. See gtk_expander_set_use_underline().
-
-Since: 2.4
-
-</description>
-<parameters>
-<parameter name="expander">
-<parameter_description> a #GtkExpander
+<parameter name="app_paintable">
+<parameter_description> %TRUE if the application will paint on the widget
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if an embedded underline in the expander label
-indicates the mnemonic accelerator keys.
-
-</return>
+<return></return>
</function>
-<function name="gtk_print_settings_set_finishings">
+<function name="gtk_widget_set_can_default">
<description>
-Sets the value of %GTK_PRINT_SETTINGS_FINISHINGS.
+Specifies whether @widget can be a default widget. See
+gtk_widget_grab_default() for details about the meaning of
+"default".
-Since: 2.10
+Since: 2.18
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="finishings">
-<parameter_description> the finishings
+<parameter name="can_default">
+<parameter_description> whether or not @widget can be a default widget.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_action_group_get_sensitive">
+<function name="gtk_widget_set_can_focus">
<description>
-Returns %TRUE if the group is sensitive. The constituent actions
-can only be logically sensitive (see gtk_action_is_sensitive()) if
-they are sensitive (see gtk_action_get_sensitive()) and their group
-is sensitive.
+Specifies whether @widget can own the input focus. See
+gtk_widget_grab_focus() for actually setting the input focus on a
+widget.
-Since: 2.4
+Since: 2.18
</description>
<parameters>
-<parameter name="action_group">
-<parameter_description> the action group
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="can_focus">
+<parameter_description> whether or not @widget can own the input focus.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the group is sensitive.
-
-</return>
+<return></return>
</function>
-<function name="gtk_rc_property_parse_flags">
+<function name="gtk_widget_set_child_visible">
<description>
-A #GtkRcPropertyParser for use with gtk_settings_install_property_parser()
-or gtk_widget_class_install_style_property_parser() which parses flags.
+Sets whether @widget should be mapped along with its when its parent
+is mapped and @widget has been shown with gtk_widget_show().
-Flags can be specified by their name, their nickname or
-numerically. Multiple flags can be specified in the form
-<literal>"( flag1 | flag2 | ... )"</literal>.
+The child visibility can be set for widget before it is added to
+a container with gtk_widget_set_parent(), to avoid mapping
+children unnecessary before immediately unmapping them. However
+it will be reset to its default state of %TRUE when the widget
+is removed from a container.
+Note that changing the child visibility of a widget does not
+queue a resize on the widget. Most of the time, the size of
+a widget is computed from all visible children, whether or
+not they are mapped. If this is not the case, the container
+can queue a resize itself.
+
+This function is only useful for container implementations and
+never should be called by an application.
</description>
<parameters>
-<parameter name="pspec">
-<parameter_description> a #GParamSpec
-</parameter_description>
-</parameter>
-<parameter name="gstring">
-<parameter_description> the #GString to be parsed
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="property_value">
-<parameter_description> a #GValue which must hold flags values.
+<parameter name="is_visible">
+<parameter_description> if %TRUE, @widget should be mapped along with its parent.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @gstring could be parsed and @property_value
-has been set to the resulting flags value.
-</return>
+<return></return>
</function>
-<function name="gtk_print_operation_set_custom_tab_label">
+<function name="gtk_widget_set_colormap">
<description>
-Sets the label for the tab holding custom widgets.
-
-Since: 2.10
+Sets the colormap for the widget to the given value. Widget must not
+have been previously realized. This probably should only be used
+from an <function>init()</function> function (i.e. from the constructor
+for the widget).
</description>
<parameters>
-<parameter name="op">
-<parameter_description> a #GtkPrintOperation
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="label">
-<parameter_description> the label to use, or %NULL to use the default label
+<parameter name="colormap">
+<parameter_description> a colormap
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_calendar_set_detail_height_rows">
+<function name="gtk_widget_set_composite_name">
<description>
-Updates the height of detail cells.
-See #GtkCalendar:detail-height-rows.
-
-Since: 2.14
+Sets a widgets composite name. The widget must be
+a composite child of its parent; see gtk_widget_push_composite_child().
</description>
<parameters>
-<parameter name="calendar">
-<parameter_description> a #GtkCalendar.
+<parameter name="widget">
+<parameter_description> a #GtkWidget.
</parameter_description>
</parameter>
-<parameter name="rows">
-<parameter_description> detail height in rows.
+<parameter name="name">
+<parameter_description> the name to set
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_combo_box_entry_new_text">
+<function name="gtk_widget_set_default_colormap">
<description>
-Convenience function which constructs a new editable text combo box, which
-is a #GtkComboBoxEntry just displaying strings. If you use this function to
-create a text combo box, you should only manipulate its data source with
-the following convenience functions: gtk_combo_box_append_text(),
-gtk_combo_box_insert_text(), gtk_combo_box_prepend_text() and
-gtk_combo_box_remove_text().
-
-Since: 2.4
+Sets the default colormap to use when creating widgets.
+gtk_widget_push_colormap() is a better function to use if
+you only want to affect a few widgets, rather than all widgets.
</description>
<parameters>
+<parameter name="colormap">
+<parameter_description> a #GdkColormap
+</parameter_description>
+</parameter>
</parameters>
-<return> A new text #GtkComboBoxEntry.
-
-</return>
+<return></return>
</function>
-<function name="gtk_ctree_node_set_pixtext">
+<function name="gtk_widget_set_default_direction">
<description>
+Sets the default reading direction for widgets where the
+direction has not been explicitly set by gtk_widget_set_direction().
</description>
<parameters>
-<parameter name="mask">
-<parameter_description>
+<parameter name="dir">
+<parameter_description> the new default direction. This cannot be
+%GTK_TEXT_DIR_NONE.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_notebook_query_tab_label_packing">
+<function name="gtk_widget_set_direction">
<description>
-Query the packing attributes for the tab label of the page
-containing @child.
+Sets the reading direction on a particular widget. This direction
+controls the primary direction for widgets containing text,
+and also the direction in which the children of a container are
+packed. The ability to set the direction is present in order
+so that correct localization into languages with right-to-left
+reading directions can be done. Generally, applications will
+let the default reading direction present, except for containers
+where the containers are arranged in an order that is explicitely
+visual rather than logical (such as buttons for text justification).
-Deprecated: 2.20: Modify the #GtkNotebook:tab-expand and
-#GtkNotebook:tab-fill child properties instead.
+If the direction is set to %GTK_TEXT_DIR_NONE, then the value
+set by gtk_widget_set_default_direction() will be used.
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
-</parameter_description>
-</parameter>
-<parameter name="child">
-<parameter_description> the page
-</parameter_description>
-</parameter>
-<parameter name="expand">
-<parameter_description> location to store the expand value (or NULL)
-</parameter_description>
-</parameter>
-<parameter name="fill">
-<parameter_description> location to store the fill value (or NULL)
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="pack_type">
-<parameter_description> location to store the pack_type (or NULL)
+<parameter name="dir">
+<parameter_description> the new direction
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_plug_construct">
+<function name="gtk_widget_set_double_buffered">
<description>
-Finish the initialization of @plug for a given #GtkSocket identified by
- socket_id This function will generally only be used by classes deriving from #GtkPlug.
+Widgets are double buffered by default; you can use this function
+to turn off the buffering. "Double buffered" simply means that
+gdk_window_begin_paint_region() and gdk_window_end_paint() are called
+automatically around expose events sent to the
+widget. gdk_window_begin_paint() diverts all drawing to a widget's
+window to an offscreen buffer, and gdk_window_end_paint() draws the
+buffer to the screen. The result is that users see the window
+update in one smooth step, and don't see individual graphics
+primitives being rendered.
+
+In very simple terms, double buffered widgets don't flicker,
+so you would only use this function to turn off double buffering
+if you had special needs and really knew what you were doing.
+
+Note: if you turn off double-buffering, you have to handle
+expose events, since even the clearing to the background color or
+pixmap will not happen automatically (as it is done in
+gdk_window_begin_paint()).
</description>
<parameters>
-<parameter name="plug">
-<parameter_description> a #GtkPlug.
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="socket_id">
-<parameter_description> the XID of the socket's window.
+<parameter name="double_buffered">
+<parameter_description> %TRUE to double-buffer a widget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_action_activate">
+<function name="gtk_widget_set_events">
<description>
-Emits the "activate" signal on the specified action, if it isn't
-insensitive. This gets called by the proxy widgets when they get
-activated.
-
-It can also be used to manually activate an action.
-
-Since: 2.4
+Sets the event mask (see #GdkEventMask) for a widget. The event
+mask determines which events a widget will receive. Keep in mind
+that different widgets have different default event masks, and by
+changing the event mask you may disrupt a widget's functionality,
+so be careful. This function must be called while a widget is
+unrealized. Consider gtk_widget_add_events() for widgets that are
+already realized, or if you want to preserve the existing event
+mask. This function can't be used with #GTK_NO_WINDOW widgets;
+to get events on those widgets, place them inside a #GtkEventBox
+and receive events on the event box.
</description>
<parameters>
-<parameter name="action">
-<parameter_description> the action object
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="events">
+<parameter_description> event mask
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tool_palette_get_vadjustment">
+<function name="gtk_widget_set_extension_events">
<description>
-Gets the vertical adjustment of the tool palette.
-
-Since: 2.20
+Sets the extension events mask to @mode. See #GdkExtensionMode
+and gdk_input_set_extension_events().
</description>
<parameters>
-<parameter name="palette">
-<parameter_description> a #GtkToolPalette
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="mode">
+<parameter_description> bitfield of extension events to receive
</parameter_description>
</parameter>
</parameters>
-<return> the vertical adjustment of @palette
-
-</return>
+<return></return>
</function>
-<function name="gtk_tree_path_get_depth">
+<function name="gtk_widget_set_has_tooltip">
<description>
-Returns the current depth of @path.
+Sets the has-tooltip property on @widget to @has_tooltip. See
+GtkWidget:has-tooltip for more information.
+Since: 2.12
</description>
<parameters>
-<parameter name="path">
-<parameter_description> A #GtkTreePath.
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="has_tooltip">
+<parameter_description> whether or not @widget has a tooltip.
</parameter_description>
</parameter>
</parameters>
-<return> The depth of @path
-</return>
+<return></return>
</function>
-<function name="gtk_dialog_get_action_area">
+<function name="gtk_widget_set_has_window">
<description>
-Returns the action area of @dialog.
+Specifies whether @widget has a #GdkWindow of its own. Note that
+all realized widgets have a non-%NULL "window" pointer
+(gtk_widget_get_window() never returns a %NULL window when a widget
+is realized), but for many of them it's actually the #GdkWindow of
+one of its parent widgets. Widgets that do not create a %window for
+themselves in GtkWidget::realize() must announce this by
+calling this function with @has_window = %FALSE.
-Since: 2.14
+This function should only be called by widget implementations,
+and they should call it in their init() function.
+
+Since: 2.18
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkDialog
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="has_window">
+<parameter_description> whether or not @widget has a window.
</parameter_description>
</parameter>
</parameters>
-<return> the action area.
-
-</return>
+<return></return>
</function>
-<function name="gtk_info_bar_new">
+<function name="gtk_widget_set_mapped">
<description>
-Creates a new #GtkInfoBar object.
+Marks the widget as being realized.
-Since: 2.18
+This function should only ever be called in a derived widget's
+"map" or "unmap" implementation.
+
+Since: 2.20
</description>
<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="mapped">
+<parameter_description> %TRUE to mark the widget as mapped
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GtkInfoBar object
-
-</return>
+<return></return>
</function>
-<function name="gtk_image_get_gicon">
+<function name="gtk_widget_set_name">
<description>
-Gets the #GIcon and size being displayed by the #GtkImage.
-The storage type of the image must be %GTK_IMAGE_EMPTY or
-%GTK_IMAGE_GICON (see gtk_image_get_storage_type()).
-The caller of this function does not own a reference to the
-returned #GIcon.
+Widgets can be named, which allows you to refer to them from a
+gtkrc file. You can apply a style to widgets with a particular name
+in the gtkrc file. See the documentation for gtkrc files (on the
+same page as the docs for #GtkRcStyle).
-Since: 2.14
+Note that widget names are separated by periods in paths (see
+gtk_widget_path()), so names with embedded periods may cause confusion.
</description>
<parameters>
-<parameter name="image">
-<parameter_description> a #GtkImage
-</parameter_description>
-</parameter>
-<parameter name="gicon">
-<parameter_description> place to store a
-#GIcon, or %NULL
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> place to store an icon size,
-or %NULL
+<parameter name="name">
+<parameter_description> name for the widget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_get_root_window">
+<function name="gtk_widget_set_no_show_all">
<description>
-Get the root window where this widget is located. This function can
-only be called after the widget has been added to a widget
-hierarchy with #GtkWindow at the top.
+Sets the #GtkWidget:no-show-all property, which determines whether
+calls to gtk_widget_show_all() and gtk_widget_hide_all() will affect
+this widget.
-The root window is useful for such purposes as creating a popup
-#GdkWindow associated with the window. In general, you should only
-create display specific resources when a widget has been realized,
-and you should free those resources when the widget is unrealized.
+This is mostly for use in constructing widget hierarchies with externally
+controlled visibility, see #GtkUIManager.
-Since: 2.2
+Since: 2.4
</description>
<parameters>
@@ -67032,255 +67244,261 @@ Since: 2.2
<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
+<parameter name="no_show_all">
+<parameter_description> the new value for the "no-show-all" property
+</parameter_description>
+</parameter>
</parameters>
-<return> the #GdkWindow root window for the toplevel for this widget.
-
-</return>
+<return></return>
</function>
-<function name="gtk_icon_view_scroll_to_path">
+<function name="gtk_widget_set_parent">
<description>
-Moves the alignments of @icon_view to the position specified by @path.
- row_align determines where the row is placed, and @col_align determines
-where @column is placed. Both are expected to be between 0.0 and 1.0.
-0.0 means left/top alignment, 1.0 means right/bottom alignment, 0.5 means
-center.
-
-If @use_align is %FALSE, then the alignment arguments are ignored, and the
-tree does the minimum amount of work to scroll the item onto the screen.
-This means that the item will be scrolled to the edge closest to its current
-position. If the item is currently visible on the screen, nothing is done.
-
-This function only works if the model is set, and @path is a valid row on
-the model. If the model changes before the @icon_view is realized, the
-centered path will be modified to reflect this change.
-
-Since: 2.8
+This function is useful only when implementing subclasses of
+#GtkContainer.
+Sets the container as the parent of @widget, and takes care of
+some details such as updating the state and style of the child
+to reflect its new location. The opposite function is
+gtk_widget_unparent().
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> A #GtkIconView.
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> The path of the item to move to.
-</parameter_description>
-</parameter>
-<parameter name="use_align">
-<parameter_description> whether to use alignment arguments, or %FALSE.
-</parameter_description>
-</parameter>
-<parameter name="row_align">
-<parameter_description> The vertical alignment of the item specified by @path.
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="col_align">
-<parameter_description> The horizontal alignment of the item specified by @path.
+<parameter name="parent">
+<parameter_description> parent container
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tool_button_set_stock_id">
+<function name="gtk_widget_set_parent_window">
<description>
-Sets the name of the stock item. See gtk_tool_button_new_from_stock().
-The stock_id property only has an effect if not
-overridden by non-%NULL "label" and "icon_widget" properties.
-
-Since: 2.4
+Sets a non default parent window for @widget.
</description>
<parameters>
-<parameter name="button">
-<parameter_description> a #GtkToolButton
+<parameter name="widget">
+<parameter_description> a #GtkWidget.
</parameter_description>
</parameter>
-<parameter name="stock_id">
-<parameter_description> a name of a stock item, or %NULL
+<parameter name="parent_window">
+<parameter_description> the new parent window.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_printer_get_job_count">
+<function name="gtk_widget_set_realized">
<description>
-Gets the number of jobs currently queued on the printer.
+Marks the widget as being realized.
-Since: 2.10
+This function should only ever be called in a derived widget's
+"realize" or "unrealize" implementation.
+
+Since: 2.20
</description>
<parameters>
-<parameter name="printer">
-<parameter_description> a #GtkPrinter
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="realized">
+<parameter_description> %TRUE to mark the widget as realized
</parameter_description>
</parameter>
</parameters>
-<return> the number of jobs on @printer
-
-</return>
+<return></return>
</function>
-<function name="gtk_window_set_screen">
+<function name="gtk_widget_set_receives_default">
<description>
-Sets the #GdkScreen where the @window is displayed; if
-the window is already mapped, it will be unmapped, and
-then remapped on the new screen.
+Specifies whether @widget will be treated as the default widget
+within its toplevel when it has the focus, even if another widget
+is the default.
-Since: 2.2
+See gtk_widget_grab_default() for details about the meaning of
+"default".
+
+Since: 2.18
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow.
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="screen">
-<parameter_description> a #GdkScreen.
+<parameter name="receives_default">
+<parameter_description> whether or not @widget can be a default widget.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_hsv_new">
+<function name="gtk_widget_set_redraw_on_allocate">
<description>
-Creates a new HSV color selector.
+Sets whether the entire widget is queued for drawing when its size
+allocation changes. By default, this setting is %TRUE and
+the entire widget is redrawn on every size change. If your widget
+leaves the upper left unchanged when made bigger, turning this
+setting off will improve performance.
-Since: 2.14
+Note that for %NO_WINDOW widgets setting this flag to %FALSE turns
+off all allocation on resizing: the widget will not even redraw if
+its position changes; this is to allow containers that don't draw
+anything to avoid excess invalidations. If you set this flag on a
+%NO_WINDOW widget that <emphasis>does</emphasis> draw on @widget->window,
+you are responsible for invalidating both the old and new allocation
+of the widget when the widget is moved and responsible for invalidating
+regions newly when the widget increases size.
</description>
<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="redraw_on_allocate">
+<parameter_description> if %TRUE, the entire widget will be redrawn
+when it is allocated to a new size. Otherwise, only the
+new portion of the widget will be redrawn.
+</parameter_description>
+</parameter>
</parameters>
-<return> A newly-created HSV color selector.
-
-</return>
+<return></return>
</function>
-<function name="gtk_test_create_widget">
+<function name="gtk_widget_set_scroll_adjustments">
<description>
-This function wraps g_object_new() for widget types.
-It'll automatically show all created non window widgets, also
-g_object_ref_sink() them (to keep them alive across a running test)
-and set them up for destruction during the next test teardown phase.
+For widgets that support scrolling, sets the scroll adjustments and
+returns %TRUE. For widgets that don't support scrolling, does
+nothing and returns %FALSE. Widgets that don't support scrolling
+can be scrolled by placing them in a #GtkViewport, which does
+support scrolling.
-Since: 2.14
</description>
<parameters>
-<parameter name="widget_type">
-<parameter_description> a valid widget type.
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="first_property_name">
-<parameter_description> Name of first property to set or %NULL
+<parameter name="hadjustment">
+<parameter_description> an adjustment for horizontal scrolling, or %NULL
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> value to set the first property to, followed by more
-name-value pairs, terminated by %NULL
+<parameter name="vadjustment">
+<parameter_description> an adjustment for vertical scrolling, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> a newly created widget.
-
+<return> %TRUE if the widget supports scrolling
</return>
</function>
-<function name="gtk_print_settings_set_paper_height">
+<function name="gtk_widget_set_sensitive">
<description>
-Sets the value of %GTK_PRINT_SETTINGS_PAPER_HEIGHT.
-
-Since: 2.10
+Sets the sensitivity of a widget. A widget is sensitive if the user
+can interact with it. Insensitive widgets are "grayed out" and the
+user can't interact with them. Insensitive widgets are known as
+"inactive", "disabled", or "ghosted" in some other toolkits.
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
-</parameter_description>
-</parameter>
-<parameter name="height">
-<parameter_description> the paper height
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="unit">
-<parameter_description> the units of @height
+<parameter name="sensitive">
+<parameter_description> %TRUE to make the widget sensitive
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_init">
+<function name="gtk_widget_set_size_request">
<description>
-Call this function before using any other GTK+ functions in your GUI
-applications. It will initialize everything needed to operate the
-toolkit and parses some standard command line options. @argc and
- argv are adjusted accordingly so your own code will
-never see those standard arguments.
+Sets the minimum size of a widget; that is, the widget's size
+request will be @width by @height. You can use this function to
+force a widget to be either larger or smaller than it normally
+would be.
-Note that there are some alternative ways to initialize GTK+:
-if you are calling gtk_parse_args(), gtk_init_check(),
-gtk_init_with_args() or g_option_context_parse() with
-the option group returned by gtk_get_option_group(), you
-<emphasis>don't</emphasis> have to call gtk_init().
+In most cases, gtk_window_set_default_size() is a better choice for
+toplevel windows than this function; setting the default size will
+still allow users to shrink the window. Setting the size request
+will force them to leave the window at least as large as the size
+request. When dealing with window sizes,
+gtk_window_set_geometry_hints() can be a useful function as well.
-<note><para>
-This function will terminate your program if it was unable to initialize
-the GUI for some reason. If you want your program to fall back to a
-textual interface you want to call gtk_init_check() instead.
-</para></note>
+Note the inherent danger of setting any fixed size - themes,
+translations into other languages, different fonts, and user action
+can all change the appropriate size for a given widget. So, it's
+basically impossible to hardcode a size that will always be
+correct.
-<note><para>
-Since 2.18, GTK+ calls <literal>signal (SIGPIPE, SIG_IGN)</literal>
-during initialization, to ignore SIGPIPE signals, since these are
-almost never wanted in graphical applications. If you do need to
-handle SIGPIPE for some reason, reset the handler after gtk_init(),
-but notice that other libraries (e.g. libdbus or gvfs) might do
-similar things.
-</para></note>
+The size request of a widget is the smallest size a widget can
+accept while still functioning well and drawing itself correctly.
+However in some strange cases a widget may be allocated less than
+its requested size, and in many cases a widget may be allocated more
+space than it requested.
+
+If the size request in a given direction is -1 (unset), then
+the "natural" size request of the widget will be used instead.
+
+Widgets can't actually be allocated a size less than 1 by 1, but
+you can pass 0,0 to this function to mean "as small as possible."
</description>
<parameters>
-<parameter name="argc">
-<parameter_description> Address of the <parameter>argc</parameter> parameter of your
-main() function. Changed if any arguments were handled.
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="argv">
-<parameter_description> Address of the <parameter>argv</parameter> parameter of main().
-Any parameters understood by gtk_init() are stripped before return.
+<parameter name="width">
+<parameter_description> width @widget should request, or -1 to unset
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> height @widget should request, or -1 to unset
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_set_model">
+<function name="gtk_widget_set_state">
<description>
-Sets the model for a #GtkTreeView. If the @tree_view already has a model
-set, it will remove it before setting the new model. If @model is %NULL,
-then it will unset the old model.
+This function is for use in widget implementations. Sets the state
+of a widget (insensitive, prelighted, etc.) Usually you should set
+the state using wrapper functions such as gtk_widget_set_sensitive().
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeNode.
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="model">
-<parameter_description> The model.
+<parameter name="state">
+<parameter_description> new state for @widget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_style_get">
+<function name="gtk_widget_set_style">
<description>
-Gets the values of a multiple style properties of @widget.
+Sets the #GtkStyle for a widget (@widget->style). You probably don't
+want to use this function; it interacts badly with themes, because
+themes work by replacing the #GtkStyle. Instead, use
+gtk_widget_modify_style().
</description>
<parameters>
@@ -67288,2906 +67506,3200 @@ Gets the values of a multiple style properties of @widget.
<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="first_property_name">
-<parameter_description> the name of the first property to get
-</parameter_description>
-</parameter>
-<parameter name="Varargs">
-<parameter_description> pairs of property names and locations to
-return the property values, starting with the location for
- first_property_name, terminated by %NULL.
+<parameter name="style">
+<parameter_description> a #GtkStyle, or %NULL to remove the effect of a previous
+gtk_widget_set_style() and go back to the default style
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_view_item_activated">
+<function name="gtk_widget_set_tooltip_markup">
<description>
-Activates the item determined by @path.
+Sets @markup as the contents of the tooltip, which is marked up with
+the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
-Since: 2.6
+This function will take care of setting GtkWidget:has-tooltip to %TRUE
+and of the default handler for the GtkWidget::query-tooltip signal.
+
+See also the GtkWidget:tooltip-markup property and
+gtk_tooltip_set_markup().
+
+Since: 2.12
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> A #GtkIconView
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="path">
-<parameter_description> The #GtkTreePath to be activated
+<parameter name="markup">
+<parameter_description> the contents of the tooltip for @widget, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_view_new">
+<function name="gtk_widget_set_tooltip_text">
<description>
-Creates a new #GtkTextView. If you don't call gtk_text_view_set_buffer()
-before using the text view, an empty default buffer will be created
-for you. Get the buffer with gtk_text_view_get_buffer(). If you want
-to specify your own buffer, consider gtk_text_view_new_with_buffer().
+Sets @text as the contents of the tooltip. This function will take
+care of setting GtkWidget:has-tooltip to %TRUE and of the default
+handler for the GtkWidget::query-tooltip signal.
+See also the GtkWidget:tooltip-text property and gtk_tooltip_set_text().
+
+Since: 2.12
</description>
<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="text">
+<parameter_description> the contents of the tooltip for @widget
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GtkTextView
-</return>
+<return></return>
</function>
-<function name="gtk_icon_view_get_tooltip_column">
+<function name="gtk_widget_set_tooltip_window">
<description>
-Returns the column of @icon_view's model which is being used for
-displaying tooltips on @icon_view's rows.
+Replaces the default, usually yellow, window used for displaying
+tooltips with @custom_window. GTK+ will take care of showing and
+hiding @custom_window at the right moment, to behave likewise as
+the default tooltip window. If @custom_window is %NULL, the default
+tooltip window will be used.
+
+If the custom window should have the default theming it needs to
+have the name "gtk-tooltip", see gtk_widget_set_name().
Since: 2.12
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="custom_window">
+<parameter_description> a #GtkWindow, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> the index of the tooltip column that is currently being
-used, or -1 if this is disabled.
-
-</return>
+<return></return>
</function>
-<function name="gtk_tool_button_new_from_stock">
+<function name="gtk_widget_set_uposition">
<description>
-Creates a new #GtkToolButton containing the image and text from a
-stock item. Some stock ids have preprocessor macros like #GTK_STOCK_OK
-and #GTK_STOCK_APPLY.
+Sets the position of a widget. The funny "u" in the name comes from
+the "user position" hint specified by the X Window System, and
+exists for legacy reasons. This function doesn't work if a widget
+is inside a container; it's only really useful on #GtkWindow.
-It is an error if @stock_id is not a name of a stock item.
+Don't use this function to center dialogs over the main application
+window; most window managers will do the centering on your behalf
+if you call gtk_window_set_transient_for(), and it's really not
+possible to get the centering to work correctly in all cases from
+application code. But if you insist, use gtk_window_set_position()
+to set #GTK_WIN_POS_CENTER_ON_PARENT, don't do the centering
+manually.
-Since: 2.4
+Note that although @x and @y can be individually unset, the position
+is not honoured unless both @x and @y are set.
</description>
<parameters>
-<parameter name="stock_id">
-<parameter_description> the name of the stock item
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> x position; -1 to unset x; -2 to leave x unchanged
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y position; -1 to unset y; -2 to leave y unchanged
</parameter_description>
</parameter>
</parameters>
-<return> A new #GtkToolButton
-
-</return>
+<return></return>
</function>
-<function name="gtk_print_run_page_setup_dialog_async">
+<function name="gtk_widget_set_usize">
<description>
-Runs a page setup dialog, letting the user modify the values from @page_setup.
+Sets the minimum size of a widget; that is, the widget's size
+request will be @width by @height. You can use this function to
+force a widget to be either larger or smaller than it is. The
+strange "usize" name dates from the early days of GTK+, and derives
+from X Window System terminology. In many cases,
+gtk_window_set_default_size() is a better choice for toplevel
+windows than this function; setting the default size will still
+allow users to shrink the window. Setting the usize will force them
+to leave the window at least as large as the usize. When dealing
+with window sizes, gtk_window_set_geometry_hints() can be a useful
+function as well.
-In contrast to gtk_print_run_page_setup_dialog(), this function returns after
-showing the page setup dialog on platforms that support this, and calls @done_cb
-from a signal handler for the ::response signal of the dialog.
+Note the inherent danger of setting any fixed size - themes,
+translations into other languages, different fonts, and user action
+can all change the appropriate size for a given widget. So, it's
+basically impossible to hardcode a size that will always be
+correct.
-Since: 2.10
+Deprecated: 2.2: Use gtk_widget_set_size_request() instead.
</description>
<parameters>
-<parameter name="parent">
-<parameter_description> transient parent, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="page_setup">
-<parameter_description> an existing #GtkPageSetup, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="done_cb">
-<parameter_description> a function to call when the user saves the modified page setup
+<parameter name="width">
+<parameter_description> minimum width, or -1 to unset
</parameter_description>
</parameter>
-<parameter name="data">
-<parameter_description> user data to pass to @done_cb
+<parameter name="height">
+<parameter_description> minimum height, or -1 to unset
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_hsv_get_color">
+<function name="gtk_widget_set_visible">
<description>
-Queries the current color in an HSV color selector.
-Returned values will be in the [0.0, 1.0] range.
+Sets the visibility state of @widget. Note that setting this to
+%TRUE doesn't mean the widget is actually viewable, see
+gtk_widget_get_visible().
-Since: 2.14
+This function simply calls gtk_widget_show() or gtk_widget_hide()
+but is nicer to use when the visibility of the widget depends on
+some condition.
+
+Since: 2.18
</description>
<parameters>
-<parameter name="hsv">
-<parameter_description> An HSV color selector
-</parameter_description>
-</parameter>
-<parameter name="h">
-<parameter_description> Return value for the hue
-</parameter_description>
-</parameter>
-<parameter name="s">
-<parameter_description> Return value for the saturation
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="v">
-<parameter_description> Return value for the value
+<parameter name="visible">
+<parameter_description> whether the widget should be shown or not
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_file_filter_add_mime_type">
+<function name="gtk_widget_set_window">
<description>
-Adds a rule allowing a given mime type to @filter.
+Sets a widget's window. This function should only be used in a
+widget's GtkWidget::realize() implementation. The %window passed is
+usually either new window created with gdk_window_new(), or the
+window of its parent widget as returned by
+gtk_widget_get_parent_window().
-Since: 2.4
+Widgets must indicate whether they will create their own #GdkWindow
+by calling gtk_widget_set_has_window(). This is usually done in the
+widget's init() function.
+
+Since: 2.18
</description>
<parameters>
-<parameter name="filter">
-<parameter_description> A #GtkFileFilter
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="mime_type">
-<parameter_description> name of a MIME type
+<parameter name="window">
+<parameter_description> a #GdkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_file_chooser_button_new_with_backend">
+<function name="gtk_widget_shape_combine_mask">
<description>
-Creates a new file-selecting button widget using @backend.
-
-Since: 2.6
-Deprecated: 2.14: Use gtk_file_chooser_button_new() instead.
+Sets a shape for this widget's GDK window. This allows for
+transparent windows etc., see gdk_window_shape_combine_mask()
+for more information.
</description>
<parameters>
-<parameter name="title">
-<parameter_description> the title of the browse dialog.
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="action">
-<parameter_description> the open mode for the widget.
+<parameter name="shape_mask">
+<parameter_description> shape to be added, or %NULL to remove an existing shape
</parameter_description>
</parameter>
-<parameter name="backend">
-<parameter_description> the name of the #GtkFileSystem backend to use.
+<parameter name="offset_x">
+<parameter_description> X position of shape mask with respect to @window
+</parameter_description>
+</parameter>
+<parameter name="offset_y">
+<parameter_description> Y position of shape mask with respect to @window
</parameter_description>
</parameter>
</parameters>
-<return> a new button widget.
-
-</return>
+<return></return>
</function>
-<function name="gtk_cell_renderer_text_new">
+<function name="gtk_widget_show">
<description>
-Creates a new #GtkCellRendererText. Adjust how text is drawn using
-object properties. Object properties can be
-set globally (with g_object_set()). Also, with #GtkTreeViewColumn,
-you can bind a property to a value in a #GtkTreeModel. For example,
-you can bind the "text" property on the cell renderer to a string
-value in the model, thus rendering a different string in each row
-of the #GtkTreeView
+Flags a widget to be displayed. Any widget that isn't shown will
+not appear on the screen. If you want to show all the widgets in a
+container, it's easier to call gtk_widget_show_all() on the
+container, instead of individually showing the widgets.
+Remember that you have to show the containers containing a widget,
+in addition to the widget itself, before it will appear onscreen.
+
+When a toplevel container is shown, it is immediately realized and
+mapped; other shown widgets are realized and mapped when their
+toplevel container is realized and mapped.
</description>
<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
</parameters>
-<return> the new cell renderer
-</return>
+<return></return>
</function>
-<function name="gtk_socket_new">
+<function name="gtk_widget_show_all">
<description>
-Create a new empty #GtkSocket.
+Recursively shows a widget, and any child widgets (if the widget is
+a container).
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_widget_show_now">
+<description>
+Shows a widget. If the widget is an unmapped toplevel widget
+(i.e. a #GtkWindow that has not yet been shown), enter the main
+loop and wait for the window to actually be mapped. Be careful;
+because the main loop is running, anything can happen during
+this function.
</description>
<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
</parameters>
-<return> the new #GtkSocket.
-</return>
+<return></return>
</function>
-<function name="gtk_ctree_node_set_pixmap">
+<function name="gtk_widget_size_allocate">
<description>
+This function is only used by #GtkContainer subclasses, to assign a size
+and position to their child widgets.
</description>
<parameters>
-<parameter name="mask">
-<parameter_description>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="allocation">
+<parameter_description> position and size to be allocated to @widget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_settings_set_quality">
+<function name="gtk_widget_size_request">
<description>
-Sets the value of %GTK_PRINT_SETTINGS_QUALITY.
+This function is typically used when implementing a #GtkContainer
+subclass. Obtains the preferred size of a widget. The container
+uses this information to arrange its child widgets and decide what
+size allocations to give them with gtk_widget_size_allocate().
-Since: 2.10
+You can also call this function from an application, with some
+caveats. Most notably, getting a size request requires the widget
+to be associated with a screen, because font information may be
+needed. Multihead-aware applications should keep this in mind.
+
+Also remember that the size request is not necessarily the size
+a widget will actually be allocated.
+
+See also gtk_widget_get_child_requisition().
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="quality">
-<parameter_description> a #GtkPrintQuality value
+<parameter name="requisition">
+<parameter_description> a #GtkRequisition to be filled in
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_iter_forward_word_end">
+<function name="gtk_widget_style_attach">
<description>
-Moves forward to the next word end. (If @iter is currently on a
-word end, moves forward to the next one after that.) Word breaks
-are determined by Pango and should be correct for nearly any
-language (if not, the correct fix would be to the Pango word break
-algorithms).
+This function attaches the widget's #GtkStyle to the widget's
+#GdkWindow. It is a replacement for
+
+<programlisting>
+widget->style = gtk_style_attach (widget->style, widget->window);
+</programlisting>
+
+and should only ever be called in a derived widget's "realize"
+implementation which does not chain up to its parent class'
+"realize" implementation, because one of the parent classes
+(finally #GtkWidget) would attach the style itself.
+Since: 2.20
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter moved and is not the end iterator
-</return>
+<return></return>
</function>
-<function name="gtk_label_get_layout_offsets">
+<function name="gtk_widget_style_get">
<description>
-Obtains the coordinates where the label will draw the #PangoLayout
-representing the text in the label; useful to convert mouse events
-into coordinates inside the #PangoLayout, e.g. to take some action
-if some part of the label is clicked. Of course you will need to
-create a #GtkEventBox to receive the events, and pack the label
-inside it, since labels are a #GTK_NO_WINDOW widget. Remember
-when using the #PangoLayout functions you need to convert to
-and from pixels using PANGO_PIXELS() or #PANGO_SCALE.
+Gets the values of a multiple style properties of @widget.
</description>
<parameters>
-<parameter name="label">
-<parameter_description> a #GtkLabel
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> location to store X offset of layout, or %NULL
+<parameter name="first_property_name">
+<parameter_description> the name of the first property to get
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> location to store Y offset of layout, or %NULL
+<parameter name="Varargs">
+<parameter_description> pairs of property names and locations to
+return the property values, starting with the location for
+ first_property_name, terminated by %NULL.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_image_menu_item_set_accel_group">
+<function name="gtk_widget_style_get_property">
<description>
-Specifies an @accel_group to add the menu items accelerator to
-(this only applies to stock items so a stock item must already
-be set, make sure to call gtk_image_menu_item_set_use_stock()
-and gtk_menu_item_set_label() with a valid stock item first).
+Gets the value of a style property of @widget.
-If you want this menu item to have changeable accelerators then
-you shouldnt need this (see gtk_image_menu_item_new_from_stock()).
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+<parameter name="property_name">
+<parameter_description> the name of a style property
+</parameter_description>
+</parameter>
+<parameter name="value">
+<parameter_description> location to return the property value
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-Since: 2.16
+<function name="gtk_widget_style_get_valist">
+<description>
+Non-vararg variant of gtk_widget_style_get(). Used primarily by language
+bindings.
</description>
<parameters>
-<parameter name="image_menu_item">
-<parameter_description> a #GtkImageMenuItem
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="accel_group">
-<parameter_description> the #GtkAccelGroup
+<parameter name="first_property_name">
+<parameter_description> the name of the first property to get
+</parameter_description>
+</parameter>
+<parameter name="var_args">
+<parameter_description> a <type>va_list</type> of pairs of property names and
+locations to return the property values, starting with the location
+for @first_property_name.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_recent_info_get_visited">
+<function name="gtk_widget_thaw_child_notify">
<description>
-Gets the timestamp (seconds from system's Epoch) when the resource
-was last visited.
-
-Since: 2.10
+Reverts the effect of a previous call to gtk_widget_freeze_child_notify().
+This causes all queued #GtkWidget::child-notify signals on @widget to be
+emitted.
</description>
<parameters>
-<parameter name="info">
-<parameter_description> a #GtkRecentInfo
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> the number of seconds elapsed from system's Epoch when
-the resource was last visited, or -1 on failure.
-
-</return>
+<return></return>
</function>
-<function name="gtk_test_display_button_window">
+<function name="gtk_widget_translate_coordinates">
<description>
-Create a window with window title @window_title, text contents @dialog_text,
-and a number of buttons, according to the paired argument list given
-as @... parameters.
-Each button is created with a @label and a ::clicked signal handler that
-incremrents the integer stored in @nump.
-The window will be automatically shown with gtk_widget_show_now() after
-creation, so when this function returns it has already been mapped,
-resized and positioned on screen.
-The window will quit any running gtk_main()-loop when destroyed, and it
-will automatically be destroyed upon test function teardown.
+Translate coordinates relative to @src_widget's allocation to coordinates
+relative to @dest_widget's allocations. In order to perform this
+operation, both widgets must be realized, and must share a common
+toplevel.
-Since: 2.14
</description>
<parameters>
-<parameter name="window_title">
-<parameter_description> Title of the window to be displayed.
+<parameter name="src_widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="dialog_text">
-<parameter_description> Text inside the window to be displayed.
+<parameter name="dest_widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="Varargs">
-<parameter_description> %NULL terminated list of (const char *label, int *nump) pairs.
+<parameter name="src_x">
+<parameter_description> X position relative to @src_widget
+</parameter_description>
+</parameter>
+<parameter name="src_y">
+<parameter_description> Y position relative to @src_widget
+</parameter_description>
+</parameter>
+<parameter name="dest_x">
+<parameter_description> location to store X position relative to @dest_widget
+</parameter_description>
+</parameter>
+<parameter name="dest_y">
+<parameter_description> location to store Y position relative to @dest_widget
</parameter_description>
</parameter>
</parameters>
-<return> a widget pointer to the newly created GtkWindow.
-
+<return> %FALSE if either widget was not realized, or there
+was no common ancestor. In this case, nothing is stored in
+* dest_x and * dest_y Otherwise %TRUE.
</return>
</function>
-<function name="gtk_dialog_get_content_area">
+<function name="gtk_widget_trigger_tooltip_query">
<description>
-Returns the content area of @dialog.
+Triggers a tooltip query on the display where the toplevel of @widget
+is located. See gtk_tooltip_trigger_tooltip_query() for more
+information.
-Since: 2.14
+Since: 2.12
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkDialog
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> the content area #GtkVBox.
-
-</return>
+<return></return>
</function>
-<function name="gtk_container_get_focus_hadjustment">
+<function name="gtk_widget_unmap">
<description>
-Retrieves the horizontal focus adjustment for the container. See
-gtk_container_set_focus_hadjustment ().
-
+This function is only for use in widget implementations. Causes
+a widget to be unmapped if it's currently mapped.
</description>
<parameters>
-<parameter name="container">
-<parameter_description> a #GtkContainer
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
-<return> the horizontal focus adjustment, or %NULL if
-none has been set.
-</return>
+<return></return>
</function>
-<function name="gtk_window_set_transient_for">
+<function name="gtk_widget_unparent">
<description>
-Dialog windows should be set transient for the main application
-window they were spawned from. This allows <link
-linkend="gtk-X11-arch">window managers</link> to e.g. keep the
-dialog on top of the main window, or center the dialog over the
-main window. gtk_dialog_new_with_buttons() and other convenience
-functions in GTK+ will sometimes call
-gtk_window_set_transient_for() on your behalf.
-
-Passing %NULL for @parent unsets the current transient window.
-
-On Windows, this function puts the child window on top of the parent,
-much as the window manager would have done on X.
+This function is only for use in widget implementations.
+Should be called by implementations of the remove method
+on #GtkContainer, to dissociate a child from the container.
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
-<parameter name="parent">
-<parameter_description> parent window, or %NULL
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_widget_unrealize">
+<description>
+This function is only useful in widget implementations.
+Causes a widget to be unrealized (frees all GDK resources
+associated with the widget, such as @widget->window).
+
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_status_icon_set_from_pixbuf">
+<function name="gtk_widget_unref">
<description>
-Makes @status_icon display @pixbuf.
-See gtk_status_icon_new_from_pixbuf() for details.
+Inverse of gtk_widget_ref(). Equivalent to g_object_unref().
-Since: 2.10
+Deprecated: 2.12: Use g_object_unref() instead.
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
-</parameter_description>
-</parameter>
-<parameter name="pixbuf">
-<parameter_description> a #GdkPixbuf or %NULL
+<parameter name="widget">
+<parameter_description> a #GtkWidget
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_iter_ends_tag">
+<function name="gtk_window_activate_default">
<description>
-Returns %TRUE if @tag is toggled off at exactly this point. If @tag
-is %NULL, returns %TRUE if any tag is toggled off at this point. Note
-that the gtk_text_iter_ends_tag () returns %TRUE if @iter is the
-<emphasis>end</emphasis> of the tagged range;
-gtk_text_iter_has_tag () tells you whether an iterator is
-<emphasis>within</emphasis> a tagged range.
+Activates the default widget for the window, unless the current
+focused widget has been configured to receive the default action
+(see gtk_widget_set_receives_default()), in which case the
+focused widget is activated.
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
-</parameter_description>
-</parameter>
-<parameter name="tag">
-<parameter_description> a #GtkTextTag, or %NULL
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return> whether @iter is the end of a range tagged with @tag
-
+<return> %TRUE if a widget got activated.
</return>
</function>
-<function name="gtk_font_selection_dialog_get_cancel_button">
+<function name="gtk_window_activate_focus">
<description>
-Gets the 'Cancel' button.
+Activates the current focused widget within the window.
-Since: 2.14
</description>
<parameters>
-<parameter name="fsd">
-<parameter_description> a #GtkFontSelectionDialog
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkWidget used in the dialog for the 'Cancel' button.
-
+<return> %TRUE if a widget got activated.
</return>
</function>
-<function name="gtk_action_group_translate_string">
+<function name="gtk_window_activate_key">
<description>
-Translates a string using the specified translate_func(). This
-is mainly intended for language bindings.
+Activates mnemonics and accelerators for this #GtkWindow. This is normally
+called by the default ::key_press_event handler for toplevel windows,
+however in some cases it may be useful to call this directly when
+overriding the standard key handling for a toplevel window.
-Since: 2.6
+Since: 2.4
</description>
<parameters>
-<parameter name="action_group">
-<parameter_description> a #GtkActionGroup
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="string">
-<parameter_description> a string
+<parameter name="event">
+<parameter_description> a #GdkEventKey
</parameter_description>
</parameter>
</parameters>
-<return> the translation of @string
+<return> %TRUE if a mnemonic or accelerator was found and activated.
</return>
</function>
-<function name="gtk_print_unix_dialog_get_settings">
+<function name="gtk_window_add_accel_group">
<description>
-Gets a new #GtkPrintSettings object that represents the
-current values in the print dialog. Note that this creates a
-<emphasis>new object</emphasis>, and you need to unref it
-if don't want to keep it.
-
-Since: 2.10
+Associate @accel_group with @window, such that calling
+gtk_accel_groups_activate() on @window will activate accelerators
+in @accel_group.
</description>
<parameters>
-<parameter name="dialog">
-<parameter_description> a #GtkPrintUnixDialog
+<parameter name="window">
+<parameter_description> window to attach accelerator group to
+</parameter_description>
+</parameter>
+<parameter name="accel_group">
+<parameter_description> a #GtkAccelGroup
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkPrintSettings object with the values from @dialog
-
-</return>
+<return></return>
</function>
-<function name="gtk_assistant_get_page_header_image">
+<function name="gtk_window_add_mnemonic">
<description>
-Gets the header image for @page.
-
-Since: 2.10
+Adds a mnemonic to this window.
</description>
<parameters>
-<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="page">
-<parameter_description> a page of @assistant
+<parameter name="keyval">
+<parameter_description> the mnemonic
+</parameter_description>
+</parameter>
+<parameter name="target">
+<parameter_description> the widget that gets activated by the mnemonic
</parameter_description>
</parameter>
</parameters>
-<return> the header image for @page, or %NULL
-if there's no header image for the page.
-
-</return>
+<return></return>
</function>
-<function name="gtk_draw_flat_box">
+<function name="gtk_window_begin_move_drag">
<description>
-Draws a flat box on @window with the given parameters.
+Starts moving a window. This function is used if an application has
+window movement grips. When GDK can support it, the window movement
+will be done using the standard mechanism for the <link
+linkend="gtk-X11-arch">window manager</link> or windowing
+system. Otherwise, GDK will try to emulate window movement,
+potentially not all that well, depending on the windowing system.
-Deprecated: 2.0: Use gtk_paint_flat_box() instead.
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="window">
-<parameter_description> a #GdkWindow
+<parameter name="button">
+<parameter_description> mouse button that initiated the drag
</parameter_description>
</parameter>
-<parameter name="state_type">
-<parameter_description> a state
+<parameter name="root_x">
+<parameter_description> X position where the user clicked to initiate the drag, in root window coordinates
</parameter_description>
</parameter>
-<parameter name="shadow_type">
-<parameter_description> the type of shadow to draw
+<parameter name="root_y">
+<parameter_description> Y position where the user clicked to initiate the drag
</parameter_description>
</parameter>
-<parameter name="x">
-<parameter_description> x origin of the box
+<parameter name="timestamp">
+<parameter_description> timestamp from the click event that initiated the drag
</parameter_description>
</parameter>
-<parameter name="y">
-<parameter_description> y origin of the box
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_window_begin_resize_drag">
+<description>
+Starts resizing a window. This function is used if an application
+has window resizing controls. When GDK can support it, the resize
+will be done using the standard mechanism for the <link
+linkend="gtk-X11-arch">window manager</link> or windowing
+system. Otherwise, GDK will try to emulate window resizing,
+potentially not all that well, depending on the windowing system.
+
+
+</description>
+<parameters>
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> the width of the box
+<parameter name="button">
+<parameter_description> mouse button that initiated the drag
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> the height of the box
+<parameter name="edge">
+<parameter_description> position of the resize control
+</parameter_description>
+</parameter>
+<parameter name="root_x">
+<parameter_description> X position where the user clicked to initiate the drag, in root window coordinates
+</parameter_description>
+</parameter>
+<parameter name="root_y">
+<parameter_description> Y position where the user clicked to initiate the drag
+</parameter_description>
+</parameter>
+<parameter name="timestamp">
+<parameter_description> timestamp from the click event that initiated the drag
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_tag_table_new">
+<function name="gtk_window_deiconify">
<description>
-Creates a new #GtkTextTagTable. The table contains no tags by
-default.
+Asks to deiconify (i.e. unminimize) the specified @window. Note
+that you shouldn't assume the window is definitely deiconified
+afterward, because other entities (e.g. the user or <link
+linkend="gtk-X11-arch">window manager</link>) could iconify it
+again before your code which assumes deiconification gets to run.
+You can track iconification via the "window-state-event" signal
+on #GtkWidget.
</description>
<parameters>
+<parameter name="window">
+<parameter_description> a #GtkWindow
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GtkTextTagTable
-</return>
+<return></return>
</function>
-<function name="gtk_tool_palette_get_drop_group">
+<function name="gtk_window_fullscreen">
<description>
-Gets the group at position (x, y).
+Asks to place @window in the fullscreen state. Note that you
+shouldn't assume the window is definitely full screen afterward,
+because other entities (e.g. the user or <link
+linkend="gtk-X11-arch">window manager</link>) could unfullscreen it
+again, and not all window managers honor requests to fullscreen
+windows. But normally the window will end up fullscreen. Just
+don't write code that crashes if not.
-Since: 2.20
+You can track the fullscreen state via the "window-state-event" signal
+on #GtkWidget.
+
+Since: 2.2
</description>
<parameters>
-<parameter name="palette">
-<parameter_description> a #GtkToolPalette
-</parameter_description>
-</parameter>
-<parameter name="x">
-<parameter_description> the x position
-</parameter_description>
-</parameter>
-<parameter name="y">
-<parameter_description> the y position
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkToolItemGroup at position or %NULL
-if there is no such group
-
-</return>
+<return></return>
</function>
-<function name="gtk_dialog_new_with_buttons">
+<function name="gtk_window_get_accept_focus">
<description>
-Creates a new #GtkDialog with title @title (or %NULL for the default
-title; see gtk_window_set_title()) and transient parent @parent (or
-%NULL for none; see gtk_window_set_transient_for()). The @flags
-argument can be used to make the dialog modal (#GTK_DIALOG_MODAL)
-and/or to have it destroyed along with its transient parent
-(#GTK_DIALOG_DESTROY_WITH_PARENT). After @flags, button
-text/response ID pairs should be listed, with a %NULL pointer ending
-the list. Button text can be either a stock ID such as
-#GTK_STOCK_OK, or some arbitrary text. A response ID can be
-any positive number, or one of the values in the #GtkResponseType
-enumeration. If the user clicks one of these dialog buttons,
-#GtkDialog will emit the #GtkDialog::response signal with the corresponding
-response ID. If a #GtkDialog receives the #GtkWidget::delete-event signal,
-it will emit ::response with a response ID of #GTK_RESPONSE_DELETE_EVENT.
-However, destroying a dialog does not emit the ::response signal;
-so be careful relying on ::response when using the
-#GTK_DIALOG_DESTROY_WITH_PARENT flag. Buttons are from left to right,
-so the first button in the list will be the leftmost button in the dialog.
-
-Here's a simple example:
-|[
-GtkWidget *dialog = gtk_dialog_new_with_buttons ("My dialog",
-main_app_window,
-GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT,
-GTK_STOCK_OK,
-GTK_RESPONSE_ACCEPT,
-GTK_STOCK_CANCEL,
-GTK_RESPONSE_REJECT,
-NULL);
-]|
+Gets the value set by gtk_window_set_accept_focus().
+Since: 2.4
</description>
<parameters>
-<parameter name="title">
-<parameter_description> Title of the dialog, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="parent">
-<parameter_description> Transient parent of the dialog, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> from #GtkDialogFlags
-</parameter_description>
-</parameter>
-<parameter name="first_button_text">
-<parameter_description> stock ID or text to go in first button, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="Varargs">
-<parameter_description> response ID for first button, then additional buttons, ending with %NULL
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkDialog
+<return> %TRUE if window should receive the input focus
+
</return>
</function>
-<function name="gtk_file_chooser_set_current_name">
+<function name="gtk_window_get_decorated">
<description>
-Sets the current name in the file selector, as if entered
-by the user. Note that the name passed in here is a UTF-8
-string rather than a filename. This function is meant for
-such uses as a suggested name in a "Save As..." dialog.
-
-If you want to preselect a particular existing file, you should use
-gtk_file_chooser_set_filename() or gtk_file_chooser_set_uri() instead.
-Please see the documentation for those functions for an example of using
-gtk_file_chooser_set_current_name() as well.
+Returns whether the window has been set to have decorations
+such as a title bar via gtk_window_set_decorated().
-Since: 2.4
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
-</parameter_description>
-</parameter>
-<parameter name="name">
-<parameter_description> the filename to use, as a UTF-8 string
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the window has been set to have decorations
+</return>
</function>
-<function name="gtk_set_locale">
+<function name="gtk_window_get_default_icon_list">
<description>
-Initializes internationalization support for GTK+. gtk_init()
-automatically does this, so there is typically no point
-in calling this function.
+Gets the value set by gtk_window_set_default_icon_list().
+The list is a copy and should be freed with g_list_free(),
+but the pixbufs in the list have not had their reference count
+incremented.
-If you are calling this function because you changed the locale
-after GTK+ is was initialized, then calling this function
-may help a bit. (Note, however, that changing the locale
-after GTK+ is initialized may produce inconsistent results and
-is not really supported.)
-In detail - sets the current locale according to the
-program environment. This is the same as calling the C library function
-<literal>setlocale (LC_ALL, "")</literal> but also takes care of the
-locale specific setup of the windowing system used by GDK.
+</description>
+<parameters>
+</parameters>
+<return> copy of default icon list
+</return>
+</function>
+<function name="gtk_window_get_default_icon_name">
+<description>
+Returns the fallback icon name for windows that has been set
+with gtk_window_set_default_icon_name(). The returned
+string is owned by GTK+ and should not be modified. It
+is only valid until the next call to
+gtk_window_set_default_icon_name().
+
+Since: 2.16
</description>
<parameters>
</parameters>
-<return> a string corresponding to the locale set, typically in the
-form lang_COUNTRY, where lang is an ISO-639 language code, and
-COUNTRY is an ISO-3166 country code. On Unix, this form matches the
-result of the setlocale(); it is also used on other machines, such as
-Windows, where the C library returns a different result. The string is
-owned by GTK+ and should not be modified or freed.
+<return> the fallback icon name for windows
+
</return>
</function>
-<function name="gtk_text_view_get_iter_location">
+<function name="gtk_window_get_default_size">
<description>
-Gets a rectangle which roughly contains the character at @iter.
-The rectangle position is in buffer coordinates; use
-gtk_text_view_buffer_to_window_coords() to convert these
-coordinates to coordinates for one of the windows in the text view.
+Gets the default size of the window. A value of -1 for the width or
+height indicates that a default size has not been explicitly set
+for that dimension, so the "natural" size of the window will be
+used.
+
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="width">
+<parameter_description> location to store the default width, or %NULL
</parameter_description>
</parameter>
-<parameter name="location">
-<parameter_description> bounds of the character at @iter
+<parameter name="height">
+<parameter_description> location to store the default height, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_file_chooser_unselect_file">
+<function name="gtk_window_get_default_widget">
<description>
-Unselects the file referred to by @file. If the file is not in the current
-directory, does not exist, or is otherwise not currently selected, does nothing.
+Returns the default widget for @window. See gtk_window_set_default()
+for more details.
Since: 2.14
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
-</parameter_description>
-</parameter>
-<parameter name="file">
-<parameter_description> a #GFile
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the default widget, or %NULL if there is none.
+
+</return>
</function>
-<function name="gtk_widget_get_name">
+<function name="gtk_window_get_deletable">
<description>
-Retrieves the name of a widget. See gtk_widget_set_name() for the
-significance of widget names.
+Returns whether the window has been set to have a close button
+via gtk_window_set_deletable().
+Since: 2.10
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return> name of the widget. This string is owned by GTK+ and
-should not be modified or freed
+<return> %TRUE if the window has been set to have a close button
+
</return>
</function>
-<function name="gtk_expander_get_label_widget">
+<function name="gtk_window_get_destroy_with_parent">
<description>
-Retrieves the label widget for the frame. See
-gtk_expander_set_label_widget().
+Returns whether the window will be destroyed with its transient parent. See
+gtk_window_set_destroy_with_parent ().
-Since: 2.4
</description>
<parameters>
-<parameter name="expander">
-<parameter_description> a #GtkExpander
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the label widget, or %NULL if there is none.
-
+<return> %TRUE if the window will be destroyed with its transient parent.
</return>
</function>
-<function name="gtk_widget_get_composite_name">
+<function name="gtk_window_get_focus">
<description>
-Obtains the composite name of a widget.
+Retrieves the current focused widget within the window.
+Note that this is the widget that would have the focus
+if the toplevel window focused; if the toplevel window
+is not focused then <literal>gtk_widget_has_focus (widget)</literal> will
+not be %TRUE for the widget.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the composite name of @widget, or %NULL if @widget is not
-a composite child. The string should be freed when it is no
-longer needed.
+<return> the currently focused widget, or %NULL if there is none.
</return>
</function>
-<function name="gtk_range_get_slider_size_fixed">
+<function name="gtk_window_get_focus_on_map">
<description>
-This function is useful mainly for #GtkRange subclasses.
-
-See gtk_range_set_slider_size_fixed().
+Gets the value set by gtk_window_set_focus_on_map().
-Since: 2.20
+Since: 2.6
</description>
<parameters>
-<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return> whether the range's slider has a fixed size.
+<return> %TRUE if window should receive the input focus when
+mapped.
</return>
</function>
-<function name="gtk_icon_size_lookup_for_settings">
+<function name="gtk_window_get_frame_dimensions">
<description>
-Obtains the pixel size of a semantic icon size, possibly
-modified by user preferences for a particular
-#GtkSettings. Normally @size would be
-#GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc. This function
-isn't normally needed, gtk_widget_render_icon() is the usual
-way to get an icon for rendering, then just look at the size of
-the rendered pixbuf. The rendered pixbuf may not even correspond to
-the width/height returned by gtk_icon_size_lookup(), because themes
-are free to render the pixbuf however they like, including changing
-the usual size.
+(Note: this is a special-purpose function intended for the
+framebuffer port; see gtk_window_set_has_frame(). It will not
+return the size of the window border drawn by the <link
+linkend="gtk-X11-arch">window manager</link>, which is the normal
+case when using a windowing system. See
+gdk_window_get_frame_extents() to get the standard window border
+extents.)
-Since: 2.2
+Retrieves the dimensions of the frame window for this toplevel.
+See gtk_window_set_has_frame(), gtk_window_set_frame_dimensions().
+
+Deprecated: 2.24: This function will be removed in GTK+ 3
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkSettings object, used to determine
-which set of user preferences to used.
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="size">
-<parameter_description> an icon size
+<parameter name="left">
+<parameter_description> location to store the width of the frame at the left, or %NULL
</parameter_description>
</parameter>
-<parameter name="width">
-<parameter_description> location to store icon width
+<parameter name="top">
+<parameter_description> location to store the height of the frame at the top, or %NULL
</parameter_description>
</parameter>
-<parameter name="height">
-<parameter_description> location to store icon height
+<parameter name="right">
+<parameter_description> location to store the width of the frame at the returns, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="bottom">
+<parameter_description> location to store the height of the frame at the bottom, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @size was a valid size
-
-</return>
+<return></return>
</function>
-<function name="gtk_tree_model_sort_convert_child_path_to_path">
+<function name="gtk_window_get_gravity">
<description>
-Converts @child_path to a path relative to @tree_model_sort. That is,
- child_path points to a path in the child model. The returned path will
-point to the same row in the sorted model. If @child_path isn't a valid
-path on the child model, then %NULL is returned.
+Gets the value set by gtk_window_set_gravity().
</description>
<parameters>
-<parameter name="tree_model_sort">
-<parameter_description> A #GtkTreeModelSort
-</parameter_description>
-</parameter>
-<parameter name="child_path">
-<parameter_description> A #GtkTreePath to convert
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return> A newly allocated #GtkTreePath, or %NULL
+<return> window gravity
</return>
</function>
-<function name="gtk_action_set_stock_id">
+<function name="gtk_window_get_group">
<description>
-Sets the stock id on @action
+Returns the group for @window or the default group, if
+ window is %NULL or if @window does not have an explicit
+window group.
-Since: 2.16
+Since: 2.10
</description>
<parameters>
-<parameter name="action">
-<parameter_description> a #GtkAction
-</parameter_description>
-</parameter>
-<parameter name="stock_id">
-<parameter_description> the stock id
+<parameter name="window">
+<parameter_description> a #GtkWindow, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the #GtkWindowGroup for a window or the default group
+
+</return>
</function>
-<function name="gtk_scale_set_value_pos">
+<function name="gtk_window_get_has_frame">
<description>
-Sets the position in which the current value is displayed.
+Accessor for whether the window has a frame window exterior to
+ window->window. Gets the value set by gtk_window_set_has_frame ().
+
+Deprecated: 2.24: This function will be removed in GTK+ 3
</description>
<parameters>
-<parameter name="scale">
-<parameter_description> a #GtkScale
-</parameter_description>
-</parameter>
-<parameter name="pos">
-<parameter_description> the position in which the current value is displayed
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if a frame has been added to the window
+via gtk_window_set_has_frame().
+
+</return>
</function>
-<function name="gtk_spin_button_new_with_range">
+<function name="gtk_window_get_icon">
<description>
-This is a convenience constructor that allows creation of a numeric
-#GtkSpinButton without manually creating an adjustment. The value is
-initially set to the minimum value and a page increment of 10 * @step
-is the default. The precision of the spin button is equivalent to the
-precision of @step.
-
-Note that the way in which the precision is derived works best if @step
-is a power of ten. If the resulting precision is not suitable for your
-needs, use gtk_spin_button_set_digits() to correct it.
+Gets the value set by gtk_window_set_icon() (or if you've
+called gtk_window_set_icon_list(), gets the first icon in
+the icon list).
</description>
<parameters>
-<parameter name="min">
-<parameter_description> Minimum allowable value
-</parameter_description>
-</parameter>
-<parameter name="max">
-<parameter_description> Maximum allowable value
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="step">
-<parameter_description> Increment added or subtracted by spinning the widget
+</parameters>
+<return> icon for window
+</return>
+</function>
+
+<function name="gtk_window_get_icon_list">
+<description>
+Retrieves the list of icons set by gtk_window_set_icon_list().
+The list is copied, but the reference count on each
+member won't be incremented.
+
+
+</description>
+<parameters>
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return> The new spin button as a #GtkWidget.
+<return> copy of window's icon list
</return>
</function>
-<function name="gtk_icon_view_set_columns">
+<function name="gtk_window_get_icon_name">
<description>
-Sets the ::columns property which determines in how
-many columns the icons are arranged. If @columns is
--1, the number of columns will be chosen automatically
-to fill the available area.
+Returns the name of the themed icon for the window,
+see gtk_window_set_icon_name().
Since: 2.6
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
-</parameter_description>
-</parameter>
-<parameter name="columns">
-<parameter_description> the number of columns
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the icon name or %NULL if the window has
+no themed icon
+
+</return>
</function>
-<function name="gtk_entry_set_icon_activatable">
+<function name="gtk_window_get_mnemonic_modifier">
<description>
-Sets whether the icon is activatable.
+Returns the mnemonic modifier for this window. See
+gtk_window_set_mnemonic_modifier().
-Since: 2.16
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> A #GtkEntry
-</parameter_description>
-</parameter>
-<parameter name="icon_pos">
-<parameter_description> Icon position
-</parameter_description>
-</parameter>
-<parameter name="activatable">
-<parameter_description> %TRUE if the icon should be activatable
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the modifier mask used to activate
+mnemonics on this window.
+</return>
</function>
-<function name="gtk_text_view_backward_display_line_start">
+<function name="gtk_window_get_modal">
<description>
-Moves the given @iter backward to the next display line start.
-A display line is different from a paragraph. Paragraphs are
-separated by newlines or other paragraph separator characters.
-Display lines are created by line-wrapping a paragraph. If
-wrapping is turned off, display lines and paragraphs will be the
-same. Display lines are divided differently for each view, since
-they depend on the view's width; paragraphs are the same in all
-views, since they depend on the contents of the #GtkTextBuffer.
+Returns whether the window is modal. See gtk_window_set_modal().
</description>
<parameters>
-<parameter name="text_view">
-<parameter_description> a #GtkTextView
-</parameter_description>
-</parameter>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter was moved and is not on the end iterator
+<return> %TRUE if the window is set to be modal and
+establishes a grab when shown
</return>
</function>
-<function name="gtk_tree_view_get_fixed_height_mode">
+<function name="gtk_window_get_opacity">
<description>
-Returns whether fixed height mode is turned on for @tree_view.
+Fetches the requested opacity for this window. See
+gtk_window_set_opacity().
-Since: 2.6
+Since: 2.12
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @tree_view is in fixed height mode
+<return> the requested opacity for this window.
</return>
</function>
-<function name="gtk_cell_renderer_activate">
+<function name="gtk_window_get_position">
<description>
-Passes an activate event to the cell renderer for possible processing.
-Some cell renderers may use events; for example, #GtkCellRendererToggle
-toggles when it gets a mouse click.
+This function returns the position you need to pass to
+gtk_window_move() to keep @window in its current position. This
+means that the meaning of the returned value varies with window
+gravity. See gtk_window_move() for more details.
+
+If you haven't changed the window gravity, its gravity will be
+#GDK_GRAVITY_NORTH_WEST. This means that gtk_window_get_position()
+gets the position of the top-left corner of the window manager
+frame for the window. gtk_window_move() sets the position of this
+same top-left corner.
+
+gtk_window_get_position() is not 100% reliable because the X Window System
+does not specify a way to obtain the geometry of the
+decorations placed on a window by the window manager.
+Thus GTK+ is using a "best guess" that works with most
+window managers.
+
+Moreover, nearly all window managers are historically broken with
+respect to their handling of window gravity. So moving a window to
+its current position as returned by gtk_window_get_position() tends
+to result in moving the window slightly. Window managers are
+slowly getting better over time.
+
+If a window has gravity #GDK_GRAVITY_STATIC the window manager
+frame is not relevant, and thus gtk_window_get_position() will
+always produce accurate results. However you can't use static
+gravity to do things like place a window in a corner of the screen,
+because static gravity ignores the window manager decorations.
+
+If you are saving and restoring your application's window
+positions, you should know that it's impossible for applications to
+do this without getting it somewhat wrong because applications do
+not have sufficient knowledge of window manager state. The Correct
+Mechanism is to support the session management protocol (see the
+"GnomeClient" object in the GNOME libraries for example) and allow
+the window manager to save your window sizes and positions.
</description>
<parameters>
-<parameter name="cell">
-<parameter_description> a #GtkCellRenderer
-</parameter_description>
-</parameter>
-<parameter name="event">
-<parameter_description> a #GdkEvent
-</parameter_description>
-</parameter>
-<parameter name="widget">
-<parameter_description> widget that received the event
-</parameter_description>
-</parameter>
-<parameter name="path">
-<parameter_description> widget-dependent string representation of the event location;
-e.g. for #GtkTreeView, a string representation of #GtkTreePath
-</parameter_description>
-</parameter>
-<parameter name="background_area">
-<parameter_description> background area as passed to gtk_cell_renderer_render()
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="cell_area">
-<parameter_description> cell area as passed to gtk_cell_renderer_render()
+<parameter name="root_x">
+<parameter_description> return location for X coordinate of gravity-determined reference point
</parameter_description>
</parameter>
-<parameter name="flags">
-<parameter_description> render flags
+<parameter name="root_y">
+<parameter_description> return location for Y coordinate of gravity-determined reference point
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the event was consumed/handled
-</return>
+<return></return>
</function>
-<function name="gtk_widget_get_parent">
+<function name="gtk_window_get_resizable">
<description>
-Returns the parent container of @widget.
+Gets the value set by gtk_window_set_resizable().
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the parent container of @widget, or %NULL
+<return> %TRUE if the user can resize the window
</return>
</function>
-<function name="gtk_icon_source_get_state_wildcarded">
+<function name="gtk_window_get_role">
<description>
-Gets the value set by gtk_icon_source_set_state_wildcarded().
+Returns the role of the window. See gtk_window_set_role() for
+further explanation.
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GtkIconSource
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if this icon source is a base for any widget state variant
+<return> the role of the window if set, or %NULL. The
+returned is owned by the widget and must not be modified
+or freed.
</return>
</function>
-<function name="gtk_style_unref">
+<function name="gtk_window_get_screen">
<description>
-Decrease the reference count of @style.
+Returns the #GdkScreen associated with @window.
-Deprecated: 2.0: use g_object_unref() instead.
+Since: 2.2
</description>
<parameters>
-<parameter name="style">
-<parameter_description> a #GtkStyle.
+<parameter name="window">
+<parameter_description> a #GtkWindow.
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> a #GdkScreen.
+
+</return>
</function>
-<function name="gtk_widget_set_usize">
+<function name="gtk_window_get_size">
<description>
-Sets the minimum size of a widget; that is, the widget's size
-request will be @width by @height. You can use this function to
-force a widget to be either larger or smaller than it is. The
-strange "usize" name dates from the early days of GTK+, and derives
-from X Window System terminology. In many cases,
-gtk_window_set_default_size() is a better choice for toplevel
-windows than this function; setting the default size will still
-allow users to shrink the window. Setting the usize will force them
-to leave the window at least as large as the usize. When dealing
-with window sizes, gtk_window_set_geometry_hints() can be a useful
-function as well.
+Obtains the current size of @window. If @window is not onscreen,
+it returns the size GTK+ will suggest to the <link
+linkend="gtk-X11-arch">window manager</link> for the initial window
+size (but this is not reliably the same as the size the window
+manager will actually select). The size obtained by
+gtk_window_get_size() is the last size received in a
+#GdkEventConfigure, that is, GTK+ uses its locally-stored size,
+rather than querying the X server for the size. As a result, if you
+call gtk_window_resize() then immediately call
+gtk_window_get_size(), the size won't have taken effect yet. After
+the window manager processes the resize request, GTK+ receives
+notification that the size has changed via a configure event, and
+the size of the window gets updated.
-Note the inherent danger of setting any fixed size - themes,
-translations into other languages, different fonts, and user action
-can all change the appropriate size for a given widget. So, it's
-basically impossible to hardcode a size that will always be
-correct.
+Note 1: Nearly any use of this function creates a race condition,
+because the size of the window may change between the time that you
+get the size and the time that you perform some action assuming
+that size is the current size. To avoid race conditions, connect to
+"configure-event" on the window and adjust your size-dependent
+state to match the size delivered in the #GdkEventConfigure.
+
+Note 2: The returned size does <emphasis>not</emphasis> include the
+size of the window manager decorations (aka the window frame or
+border). Those are not drawn by GTK+ and GTK+ has no reliable
+method of determining their size.
+
+Note 3: If you are getting a window size in order to position
+the window onscreen, there may be a better way. The preferred
+way is to simply set the window's semantic type with
+gtk_window_set_type_hint(), which allows the window manager to
+e.g. center dialogs. Also, if you set the transient parent of
+dialogs with gtk_window_set_transient_for() window managers
+will often center the dialog over its parent window. It's
+much preferred to let the window manager handle these
+things rather than doing it yourself, because all apps will
+behave consistently and according to user prefs if the window
+manager handles it. Also, the window manager can take the size
+of the window decorations/border into account, while your
+application cannot.
+
+In any case, if you insist on application-specified window
+positioning, there's <emphasis>still</emphasis> a better way than
+doing it yourself - gtk_window_set_position() will frequently
+handle the details for you.
-Deprecated: 2.2: Use gtk_widget_set_size_request() instead.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
<parameter name="width">
-<parameter_description> minimum width, or -1 to unset
+<parameter_description> return location for width, or %NULL
</parameter_description>
</parameter>
<parameter name="height">
-<parameter_description> minimum height, or -1 to unset
+<parameter_description> return location for height, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_spin_button_set_wrap">
+<function name="gtk_window_get_skip_pager_hint">
<description>
-Sets the flag that determines if a spin button value wraps around to the
-opposite limit when the upper or lower limit of the range is exceeded.
+Gets the value set by gtk_window_set_skip_pager_hint().
+
+Since: 2.2
</description>
<parameters>
-<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
-</parameter_description>
-</parameter>
-<parameter name="wrap">
-<parameter_description> a flag indicating if wrapping behavior is performed.
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if window shouldn't be in pager
+
+</return>
</function>
-<function name="gtk_border_copy">
+<function name="gtk_window_get_skip_taskbar_hint">
<description>
-Copies a #GtkBorder structure.
+Gets the value set by gtk_window_set_skip_taskbar_hint()
+
+Since: 2.2
</description>
<parameters>
-<parameter name="border_">
-<parameter_description> a #GtkBorder.
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return> a copy of @border_.
+<return> %TRUE if window shouldn't be in taskbar
+
</return>
</function>
-<function name="gtk_recent_action_new">
+<function name="gtk_window_get_title">
<description>
-Creates a new #GtkRecentAction object. To add the action to
-a #GtkActionGroup and set the accelerator for the action,
-call gtk_action_group_add_action_with_accel().
+Retrieves the title of the window. See gtk_window_set_title().
-Since: 2.12
</description>
<parameters>
-<parameter name="name">
-<parameter_description> a unique name for the action
-</parameter_description>
-</parameter>
-<parameter name="label">
-<parameter_description> the label displayed in menu items and on buttons, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="tooltip">
-<parameter_description> a tooltip for the action, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="stock_id">
-<parameter_description> the stock icon to display in widgets representing the
-action, or %NULL
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the newly created #GtkRecentAction.
-
+<return> the title of the window, or %NULL if none has
+been set explicitely. The returned string is owned by the widget
+and must not be modified or freed.
</return>
</function>
-<function name="gtk_link_button_set_uri_hook">
+<function name="gtk_window_get_transient_for">
<description>
-Sets @func as the function that should be invoked every time a user clicks
-a #GtkLinkButton. This function is called before every callback registered
-for the "clicked" signal.
-
-If no uri hook has been set, GTK+ defaults to calling gtk_show_uri().
+Fetches the transient parent for this window. See
+gtk_window_set_transient_for().
-Since: 2.10
</description>
<parameters>
-<parameter name="func">
-<parameter_description> a function called each time a #GtkLinkButton is clicked, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="data">
-<parameter_description> user data to be passed to @func, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="destroy">
-<parameter_description> a #GDestroyNotify that gets called when @data is no longer needed, or %NULL
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the previously set hook function.
-
+<return> the transient parent for this window, or %NULL
+if no transient parent has been set.
</return>
</function>
-<function name="gtk_status_icon_set_screen">
+<function name="gtk_window_get_type_hint">
<description>
-Sets the #GdkScreen where @status_icon is displayed; if
-the icon is already mapped, it will be unmapped, and
-then remapped on the new screen.
+Gets the type hint for this window. See gtk_window_set_type_hint().
-Since: 2.12
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
-</parameter_description>
-</parameter>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the type hint for @window.
+</return>
</function>
-<function name="gtk_recent_chooser_unselect_uri">
+<function name="gtk_window_get_urgency_hint">
<description>
-Unselects @uri inside @chooser.
+Gets the value set by gtk_window_set_urgency_hint()
-Since: 2.10
+Since: 2.8
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
-</parameter_description>
-</parameter>
-<parameter name="uri">
-<parameter_description> a URI
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if window is urgent
+
+</return>
</function>
-<function name="gtk_draw_insertion_cursor">
+<function name="gtk_window_get_window_type">
<description>
-Draws a text caret on @drawable at @location. This is not a style function
-but merely a convenience function for drawing the standard cursor shape.
+Gets the type of the window. See #GtkWindowType.
-Since: 2.4
+Since: 2.20
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
-</parameter_description>
-</parameter>
-<parameter name="drawable">
-<parameter_description> a #GdkDrawable
-</parameter_description>
-</parameter>
-<parameter name="area">
-<parameter_description> rectangle to which the output is clipped, or %NULL if the
-output should not be clipped
-</parameter_description>
-</parameter>
-<parameter name="location">
-<parameter_description> location where to draw the cursor (@location->width is ignored)
-</parameter_description>
-</parameter>
-<parameter name="is_primary">
-<parameter_description> if the cursor should be the primary cursor color.
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="direction">
-<parameter_description> whether the cursor is left-to-right or
-right-to-left. Should never be #GTK_TEXT_DIR_NONE
+</parameters>
+<return> the type of the window
+
+</return>
+</function>
+
+<function name="gtk_window_group_add_window">
+<description>
+Adds a window to a #GtkWindowGroup.
+
+</description>
+<parameters>
+<parameter name="window_group">
+<parameter_description> a #GtkWindowGroup
</parameter_description>
</parameter>
-<parameter name="draw_arrow">
-<parameter_description> %TRUE to draw a directional arrow on the
-cursor. Should be %FALSE unless the cursor is split.
+<parameter name="window">
+<parameter_description> the #GtkWindow to add
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_layout_set_preedit_string">
+<function name="gtk_window_group_get_current_current_grab">
<description>
-Set the preedit string and attributes. The preedit string is a
-string showing text that is currently being edited and not
-yet committed into the buffer.
+Gets the current grab widget of the given group,
+see gtk_grab_add().
+
+Since: 2.22
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #PangoLayout
-</parameter_description>
-</parameter>
-<parameter name="preedit_string">
-<parameter_description> a string to display at the insertion point
-</parameter_description>
-</parameter>
-<parameter name="preedit_attrs">
-<parameter_description> a #PangoAttrList of attributes that apply to @preedit_string
-</parameter_description>
-</parameter>
-<parameter name="cursor_pos">
-<parameter_description> position of cursor within preedit string in chars
+<parameter name="window_group">
+<parameter_description> a #GtkWindowGroup
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the current grab widget of the group
+
+</return>
</function>
-<function name="gtk_toolbar_get_relief_style">
+<function name="gtk_window_group_list_windows">
<description>
-Returns the relief style of buttons on @toolbar. See
-gtk_button_set_relief().
+Returns a list of the #GtkWindows that belong to @window_group.
-Since: 2.4
+Since: 2.14
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar
+<parameter name="window_group">
+<parameter_description> a #GtkWindowGroup
</parameter_description>
</parameter>
</parameters>
-<return> The relief style of buttons on @toolbar.
+<return> A newly-allocated list of
+windows inside the group.
</return>
</function>
-<function name="gtk_combo_box_prepend_text">
+<function name="gtk_window_group_new">
<description>
-Prepends @string to the list of strings stored in @combo_box. Note that
-you can only use this function with combo boxes constructed with
-gtk_combo_box_new_text().
+Creates a new #GtkWindowGroup object. Grabs added with
+gtk_grab_add() only affect windows within the same #GtkWindowGroup.
-Since: 2.4
</description>
<parameters>
-<parameter name="combo_box">
-<parameter_description> A #GtkComboBox constructed with gtk_combo_box_new_text()
+</parameters>
+<return> a new #GtkWindowGroup.
+</return>
+</function>
+
+<function name="gtk_window_group_remove_window">
+<description>
+Removes a window from a #GtkWindowGroup.
+
+</description>
+<parameters>
+<parameter name="window_group">
+<parameter_description> a #GtkWindowGroup
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> A string
+<parameter name="window">
+<parameter_description> the #GtkWindow to remove
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_buffer_get_copy_target_list">
+<function name="gtk_window_has_group">
<description>
-This function returns the list of targets this text buffer can
-provide for copying and as DND source. The targets in the list are
-added with %info values from the #GtkTextBufferTargetInfo enum,
-using gtk_target_list_add_rich_text_targets() and
-gtk_target_list_add_text_targets().
+Returns whether @window has an explicit window group.
-Since: 2.10
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkTargetList
+<return> %TRUE if @window has an explicit window group.
+Since 2.22
</return>
</function>
-<function name="gtk_status_icon_get_blinking">
+<function name="gtk_window_has_toplevel_focus">
<description>
-Returns whether the icon is blinking, see
-gtk_status_icon_set_blinking().
-
-Since: 2.10
+Returns whether the input focus is within this GtkWindow.
+For real toplevel windows, this is identical to gtk_window_is_active(),
+but for embedded windows, like #GtkPlug, the results will differ.
-Deprecated: 2.22: This function will be removed in GTK+ 3
+Since: 2.4
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the icon is blinking
+<return> %TRUE if the input focus is within this GtkWindow
</return>
</function>
-<function name="gtk_range_set_fill_level">
+<function name="gtk_window_iconify">
<description>
-Set the new position of the fill level indicator.
-
-The "fill level" is probably best described by its most prominent
-use case, which is an indicator for the amount of pre-buffering in
-a streaming media player. In that use case, the value of the range
-would indicate the current play position, and the fill level would
-be the position up to which the file/stream has been downloaded.
+Asks to iconify (i.e. minimize) the specified @window. Note that
+you shouldn't assume the window is definitely iconified afterward,
+because other entities (e.g. the user or <link
+linkend="gtk-X11-arch">window manager</link>) could deiconify it
+again, or there may not be a window manager in which case
+iconification isn't possible, etc. But normally the window will end
+up iconified. Just don't write code that crashes if not.
-This amount of prebuffering can be displayed on the range's trough
-and is themeable separately from the trough. To enable fill level
-display, use gtk_range_set_show_fill_level(). The range defaults
-to not showing the fill level.
+It's permitted to call this function before showing a window,
+in which case the window will be iconified before it ever appears
+onscreen.
-Additionally, it's possible to restrict the range's slider position
-to values which are smaller than the fill level. This is controller
-by gtk_range_set_restrict_to_fill_level() and is by default
-enabled.
+You can track iconification via the "window-state-event" signal
+on #GtkWidget.
-Since: 2.12
</description>
<parameters>
-<parameter name="range">
-<parameter_description> a #GtkRange
-</parameter_description>
-</parameter>
-<parameter name="fill_level">
-<parameter_description> the new position of the fill level indicator
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_set_grid_lines">
+<function name="gtk_window_is_active">
<description>
-Sets which grid lines to draw in @tree_view.
+Returns whether the window is part of the current active toplevel.
+(That is, the toplevel window receiving keystrokes.)
+The return value is %TRUE if the window is active toplevel
+itself, but also if it is, say, a #GtkPlug embedded in the active toplevel.
+You might use this function if you wanted to draw a widget
+differently in an active window from a widget in an inactive window.
+See gtk_window_has_toplevel_focus()
-Since: 2.10
+Since: 2.4
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> a #GtkTreeView
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="grid_lines">
-<parameter_description> a #GtkTreeViewGridLines value indicating which grid lines to
-enable.
+</parameters>
+<return> %TRUE if the window part of the current active window.
+
+</return>
+</function>
+
+<function name="gtk_window_list_toplevels">
+<description>
+Returns a list of all existing toplevel windows. The widgets
+in the list are not individually referenced. If you want
+to iterate through the list and perform actions involving
+callbacks that might destroy the widgets, you <emphasis>must</emphasis> call
+<literal>g_list_foreach (result, (GFunc)g_object_ref, NULL)</literal> first, and
+then unref all the widgets afterwards.
+
+
+</description>
+<parameters>
+</parameters>
+<return> list of toplevel widgets
+</return>
+</function>
+
+<function name="gtk_window_maximize">
+<description>
+Asks to maximize @window, so that it becomes full-screen. Note that
+you shouldn't assume the window is definitely maximized afterward,
+because other entities (e.g. the user or <link
+linkend="gtk-X11-arch">window manager</link>) could unmaximize it
+again, and not all window managers support maximization. But
+normally the window will end up maximized. Just don't write code
+that crashes if not.
+
+It's permitted to call this function before showing a window,
+in which case the window will be maximized when it appears onscreen
+initially.
+
+You can track maximization via the "window-state-event" signal
+on #GtkWidget.
+
+
+</description>
+<parameters>
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_page_setup_get_bottom_margin">
+<function name="gtk_window_mnemonic_activate">
<description>
-Gets the bottom margin in units of @unit.
-
-Since: 2.10
+Activates the targets associated with the mnemonic.
</description>
<parameters>
-<parameter name="setup">
-<parameter_description> a #GtkPageSetup
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="unit">
-<parameter_description> the unit for the return value
+<parameter name="keyval">
+<parameter_description> the mnemonic
+</parameter_description>
+</parameter>
+<parameter name="modifier">
+<parameter_description> the modifiers
</parameter_description>
</parameter>
</parameters>
-<return> the bottom margin
-
+<return> %TRUE if the activation is done.
</return>
</function>
-<function name="gtk_tool_palette_add_drag_dest">
+<function name="gtk_window_move">
<description>
-Sets @palette as drag source (see gtk_tool_palette_set_drag_source())
-and sets @widget as a drag destination for drags from @palette.
-See gtk_drag_dest_set().
+Asks the <link linkend="gtk-X11-arch">window manager</link> to move
+ window to the given position. Window managers are free to ignore
+this; most window managers ignore requests for initial window
+positions (instead using a user-defined placement algorithm) and
+honor requests after the window has already been shown.
-Since: 2.20
+Note: the position is the position of the gravity-determined
+reference point for the window. The gravity determines two things:
+first, the location of the reference point in root window
+coordinates; and second, which point on the window is positioned at
+the reference point.
+
+By default the gravity is #GDK_GRAVITY_NORTH_WEST, so the reference
+point is simply the @x, @y supplied to gtk_window_move(). The
+top-left corner of the window decorations (aka window frame or
+border) will be placed at @x, @y. Therefore, to position a window
+at the top left of the screen, you want to use the default gravity
+(which is #GDK_GRAVITY_NORTH_WEST) and move the window to 0,0.
+
+To position a window at the bottom right corner of the screen, you
+would set #GDK_GRAVITY_SOUTH_EAST, which means that the reference
+point is at @x + the window width and @y + the window height, and
+the bottom-right corner of the window border will be placed at that
+reference point. So, to place a window in the bottom right corner
+you would first set gravity to south east, then write:
+<literal>gtk_window_move (window, gdk_screen_width () - window_width,
+gdk_screen_height () - window_height)</literal> (note that this
+example does not take multi-head scenarios into account).
+
+The Extended Window Manager Hints specification at <ulink
+url="http://www.freedesktop.org/Standards/wm-spec">
+http://www.freedesktop.org/Standards/wm-spec</ulink> has a
+nice table of gravities in the "implementation notes" section.
+
+The gtk_window_get_position() documentation may also be relevant.
</description>
<parameters>
-<parameter name="palette">
-<parameter_description> a #GtkToolPalette
-</parameter_description>
-</parameter>
-<parameter name="widget">
-<parameter_description> a #GtkWidget which should be a drag destination for @palette
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> the flags that specify what actions GTK+ should take for drops
-on that widget
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="targets">
-<parameter_description> the #GtkToolPaletteDragTarget<!-- -->s which the widget
-should support
+<parameter name="x">
+<parameter_description> X coordinate to move window to
</parameter_description>
</parameter>
-<parameter name="actions">
-<parameter_description> the #GdkDragAction<!-- -->s which the widget should suppport
+<parameter name="y">
+<parameter_description> Y coordinate to move window to
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_print_settings_get_collate">
+<function name="gtk_window_new">
<description>
-Gets the value of %GTK_PRINT_SETTINGS_COLLATE.
+Creates a new #GtkWindow, which is a toplevel window that can
+contain other widgets. Nearly always, the type of the window should
+be #GTK_WINDOW_TOPLEVEL. If you're implementing something like a
+popup menu from scratch (which is a bad idea, just use #GtkMenu),
+you might use #GTK_WINDOW_POPUP. #GTK_WINDOW_POPUP is not for
+dialogs, though in some other toolkits dialogs are called "popups".
+In GTK+, #GTK_WINDOW_POPUP means a pop-up menu or pop-up tooltip.
+On X11, popup windows are not controlled by the <link
+linkend="gtk-X11-arch">window manager</link>.
+
+If you simply want an undecorated window (no window borders), use
+gtk_window_set_decorated(), don't use #GTK_WINDOW_POPUP.
-Since: 2.10
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="type">
+<parameter_description> type of window
</parameter_description>
</parameter>
</parameters>
-<return> whether to collate the printed pages
-
+<return> a new #GtkWindow.
</return>
</function>
-<function name="gtk_toolbar_insert_item">
+<function name="gtk_window_parse_geometry">
<description>
-Inserts a new item into the toolbar. You must specify the position in the
-toolbar where it will be inserted.
+Parses a standard X Window System geometry string - see the
+manual page for X (type 'man X') for details on this.
+gtk_window_parse_geometry() does work on all GTK+ ports
+including Win32 but is primarily intended for an X environment.
- callback must be a pointer to a function taking a #GtkWidget and a gpointer as
-arguments. Use G_CALLBACK() to cast the function to #GCallback.
+If either a size or a position can be extracted from the
+geometry string, gtk_window_parse_geometry() returns %TRUE
+and calls gtk_window_set_default_size() and/or gtk_window_move()
+to resize/move the window.
+
+If gtk_window_parse_geometry() returns %TRUE, it will also
+set the #GDK_HINT_USER_POS and/or #GDK_HINT_USER_SIZE hints
+indicating to the window manager that the size/position of
+the window was user-specified. This causes most window
+managers to honor the geometry.
+
+Note that for gtk_window_parse_geometry() to work as expected, it has
+to be called when the window has its "final" size, i.e. after calling
+gtk_widget_show_all() on the contents and gtk_window_set_geometry_hints()
+on the window.
+|[
+#include <gtk/gtk.h>
+
+static void
+fill_with_content (GtkWidget *vbox)
+{
+/ * fill with content... * /
+}
+
+int
+main (int argc, char *argv[])
+{
+GtkWidget *window, *vbox;
+GdkGeometry size_hints = {
+100, 50, 0, 0, 100, 50, 10, 10, 0.0, 0.0, GDK_GRAVITY_NORTH_WEST
+};
+
+gtk_init (&argc, &argv);
+
+window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
+vbox = gtk_vbox_new (FALSE, 0);
+
+gtk_container_add (GTK_CONTAINER (window), vbox);
+fill_with_content (vbox);
+gtk_widget_show_all (vbox);
+
+gtk_window_set_geometry_hints (GTK_WINDOW (window),
+window,
+&size_hints,
+GDK_HINT_MIN_SIZE |
+GDK_HINT_BASE_SIZE |
+GDK_HINT_RESIZE_INC);
+
+if (argc > 1)
+{
+if (!gtk_window_parse_geometry (GTK_WINDOW (window), argv[1]))
+fprintf (stderr, "Failed to parse '%s'\n", argv[1]);
+}
+
+gtk_widget_show_all (window);
+gtk_main ();
+
+return 0;
+}
+]|
-Deprecated: 2.4: Use gtk_toolbar_insert() instead.
</description>
<parameters>
-<parameter name="toolbar">
-<parameter_description> a #GtkToolbar.
-</parameter_description>
-</parameter>
-<parameter name="text">
-<parameter_description> give your toolbar button a label.
-</parameter_description>
-</parameter>
-<parameter name="tooltip_text">
-<parameter_description> a string that appears when the user holds the mouse over this item.
-</parameter_description>
-</parameter>
-<parameter name="tooltip_private_text">
-<parameter_description> use with #GtkTipsQuery.
-</parameter_description>
-</parameter>
-<parameter name="icon">
-<parameter_description> a #GtkWidget that should be used as the button's icon.
-</parameter_description>
-</parameter>
-<parameter name="callback">
-<parameter_description> the function to be executed when the button is pressed.
-</parameter_description>
-</parameter>
-<parameter name="user_data">
-<parameter_description> a pointer to any data you wish to be passed to the callback.
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> the number of widgets to insert this item after.
+<parameter name="geometry">
+<parameter_description> geometry string
</parameter_description>
</parameter>
</parameters>
-<return> the new toolbar item as a #GtkWidget.
-
+<return> %TRUE if string was parsed successfully
</return>
</function>
-<function name="gtk_icon_info_new_for_pixbuf">
+<function name="gtk_window_present">
<description>
-Creates a #GtkIconInfo for a #GdkPixbuf.
+Presents a window to the user. This may mean raising the window
+in the stacking order, deiconifying it, moving it to the current
+desktop, and/or giving it the keyboard focus, possibly dependent
+on the user's platform, window manager, and preferences.
+
+If @window is hidden, this function calls gtk_widget_show()
+as well.
+
+This function should be used when the user tries to open a window
+that's already open. Say for example the preferences dialog is
+currently open, and the user chooses Preferences from the menu
+a second time; use gtk_window_present() to move the already-open dialog
+where the user can see it.
+
+If you are calling this function in response to a user interaction,
+it is preferable to use gtk_window_present_with_time().
-Since: 2.14
</description>
<parameters>
-<parameter name="icon_theme">
-<parameter_description> a #GtkIconTheme
-</parameter_description>
-</parameter>
-<parameter name="pixbuf">
-<parameter_description> the pixbuf to wrap in a #GtkIconInfo
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkIconInfo
-
-</return>
+<return></return>
</function>
-<function name="gtk_widget_add_mnemonic_label">
+<function name="gtk_window_present_with_time">
<description>
-Adds a widget to the list of mnemonic labels for
-this widget. (See gtk_widget_list_mnemonic_labels()). Note the
-list of mnemonic labels for the widget is cleared when the
-widget is destroyed, so the caller must make sure to update
-its internal state at this point as well, by using a connection
-to the #GtkWidget::destroy signal or a weak notifier.
+Presents a window to the user in response to a user interaction.
+If you need to present a window without a timestamp, use
+gtk_window_present(). See gtk_window_present() for details.
-Since: 2.4
+Since: 2.8
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="label">
-<parameter_description> a #GtkWidget that acts as a mnemonic label for @widget
+<parameter name="timestamp">
+<parameter_description> the timestamp of the user interaction (typically a
+button or key press event) which triggered this call
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_test_create_simple_window">
+<function name="gtk_window_propagate_key_event">
<description>
-Create a simple window with window title @window_title and
-text contents @dialog_text.
-The window will quit any running gtk_main()-loop when destroyed, and it
-will automatically be destroyed upon test function teardown.
+Propagate a key press or release event to the focus widget and
+up the focus container chain until a widget handles @event.
+This is normally called by the default ::key_press_event and
+::key_release_event handlers for toplevel windows,
+however in some cases it may be useful to call this directly when
+overriding the standard key handling for a toplevel window.
-Since: 2.14
+Since: 2.4
</description>
<parameters>
-<parameter name="window_title">
-<parameter_description> Title of the window to be displayed.
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="dialog_text">
-<parameter_description> Text inside the window to be displayed.
+<parameter name="event">
+<parameter_description> a #GdkEventKey
</parameter_description>
</parameter>
</parameters>
-<return> a widget pointer to the newly created GtkWindow.
+<return> %TRUE if a widget in the focus chain handled the event.
</return>
</function>
-<function name="gtk_notebook_reorder_child">
+<function name="gtk_window_remove_accel_group">
<description>
-Reorders the page containing @child, so that it appears in position
- position If @position is greater than or equal to the number of
-children in the list or negative, @child will be moved to the end
-of the list.
+Reverses the effects of gtk_window_add_accel_group().
</description>
<parameters>
-<parameter name="notebook">
-<parameter_description> a #GtkNotebook
-</parameter_description>
-</parameter>
-<parameter name="child">
-<parameter_description> the child to move
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="position">
-<parameter_description> the new position, or -1 to move to the end
+<parameter name="accel_group">
+<parameter_description> a #GtkAccelGroup
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_event">
+<function name="gtk_window_remove_mnemonic">
<description>
-Rarely-used function. This function is used to emit
-the event signals on a widget (those signals should never
-be emitted without using this function to do so).
-If you want to synthesize an event though, don't use this function;
-instead, use gtk_main_do_event() so the event will behave as if
-it were in the event queue. Don't synthesize expose events; instead,
-use gdk_window_invalidate_rect() to invalidate a region of the
-window.
-
+Removes a mnemonic from this window.
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="event">
-<parameter_description> a #GdkEvent
+<parameter name="keyval">
+<parameter_description> the mnemonic
+</parameter_description>
+</parameter>
+<parameter name="target">
+<parameter_description> the widget that gets activated by the mnemonic
</parameter_description>
</parameter>
</parameters>
-<return> return from the event signal emission (%TRUE if
-the event was handled)
-</return>
+<return></return>
</function>
-<function name="gtk_range_set_range">
+<function name="gtk_window_reshow_with_initial_size">
<description>
-Sets the allowable values in the #GtkRange, and clamps the range
-value to be between @min and @max. (If the range has a non-zero
-page size, it is clamped between @min and @max - page-size.)
+Hides @window, then reshows it, resetting the
+default size and position of the window. Used
+by GUI builders only.
</description>
<parameters>
-<parameter name="range">
-<parameter_description> a #GtkRange
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="min">
-<parameter_description> minimum range value
+</parameters>
+<return></return>
+</function>
+
+<function name="gtk_window_resize">
+<description>
+Resizes the window as if the user had done so, obeying geometry
+constraints. The default geometry constraint is that windows may
+not be smaller than their size request; to override this
+constraint, call gtk_widget_set_size_request() to set the window's
+request to a smaller value.
+
+If gtk_window_resize() is called before showing a window for the
+first time, it overrides any default size set with
+gtk_window_set_default_size().
+
+Windows may not be resized smaller than 1 by 1 pixels.
+
+
+</description>
+<parameters>
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="max">
-<parameter_description> maximum range value
+<parameter name="width">
+<parameter_description> width in pixels to resize the window to
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> height in pixels to resize the window to
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_path_new_from_string">
+<function name="gtk_window_set_accept_focus">
<description>
-Creates a new #GtkTreePath initialized to @path. @path is expected to be a
-colon separated list of numbers. For example, the string "10:4:0" would
-create a path of depth 3 pointing to the 11th child of the root node, the 5th
-child of that 11th child, and the 1st child of that 5th child. If an invalid
-path string is passed in, %NULL is returned.
+Windows may set a hint asking the desktop environment not to receive
+the input focus. This function sets this hint.
+Since: 2.4
</description>
<parameters>
-<parameter name="path">
-<parameter_description> The string representation of a path.
+<parameter name="window">
+<parameter_description> a #GtkWindow
+</parameter_description>
+</parameter>
+<parameter name="setting">
+<parameter_description> %TRUE to let this window receive input focus
</parameter_description>
</parameter>
</parameters>
-<return> A newly-created #GtkTreePath, or %NULL
-</return>
+<return></return>
</function>
-<function name="gtk_status_icon_get_x11_window_id">
+<function name="gtk_window_set_auto_startup_notification">
<description>
-This function is only useful on the X11/freedesktop.org platform.
-It returns a window ID for the widget in the underlying
-status icon implementation. This is useful for the Galago
-notification service, which can send a window ID in the protocol
-in order for the server to position notification windows
-pointing to a status icon reliably.
+By default, after showing the first #GtkWindow, GTK+ calls
+gdk_notify_startup_complete(). Call this function to disable
+the automatic startup notification. You might do this if your
+first window is a splash screen, and you want to delay notification
+until after your real main window has been shown, for example.
-This function is not intended for other use cases which are
-more likely to be met by one of the non-X11 specific methods, such
-as gtk_status_icon_position_menu().
+In that example, you would disable startup notification
+temporarily, show your splash screen, then re-enable it so that
+showing the main window would automatically result in notification.
-Since: 2.14
+Since: 2.2
</description>
<parameters>
-<parameter name="status_icon">
-<parameter_description> a #GtkStatusIcon
+<parameter name="setting">
+<parameter_description> %TRUE to automatically do startup notification
</parameter_description>
</parameter>
</parameters>
-<return> An 32 bit unsigned integer identifier for the
-underlying X11 Window
-
-</return>
+<return></return>
</function>
-<function name="gtk_link_button_set_uri">
+<function name="gtk_window_set_decorated">
<description>
-Sets @uri as the URI where the #GtkLinkButton points. As a side-effect
-this unsets the 'visited' state of the button.
+By default, windows are decorated with a title bar, resize
+controls, etc. Some <link linkend="gtk-X11-arch">window
+managers</link> allow GTK+ to disable these decorations, creating a
+borderless window. If you set the decorated property to %FALSE
+using this function, GTK+ will do its best to convince the window
+manager not to decorate the window. Depending on the system, this
+function may not have any effect when called on a window that is
+already visible, so you should call it before calling gtk_window_show().
+
+On Windows, this function always works, since there's no window manager
+policy involved.
-Since: 2.10
</description>
<parameters>
-<parameter name="link_button">
-<parameter_description> a #GtkLinkButton
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="uri">
-<parameter_description> a valid URI
+<parameter name="setting">
+<parameter_description> %TRUE to decorate the window
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_font_button_set_title">
+<function name="gtk_window_set_default">
<description>
-Sets the title for the font selection dialog.
-
-Since: 2.4
+The default widget is the widget that's activated when the user
+presses Enter in a dialog (for example). This function sets or
+unsets the default widget for a #GtkWindow about. When setting
+(rather than unsetting) the default widget it's generally easier to
+call gtk_widget_grab_focus() on the widget. Before making a widget
+the default widget, you must set the #GTK_CAN_DEFAULT flag on the
+widget you'd like to make the default using GTK_WIDGET_SET_FLAGS().
</description>
<parameters>
-<parameter name="font_button">
-<parameter_description> a #GtkFontButton
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="title">
-<parameter_description> a string containing the font selection dialog title
+<parameter name="default_widget">
+<parameter_description> widget to be the default, or %NULL to unset the
+default widget for the toplevel.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_file_chooser_set_file">
+<function name="gtk_window_set_default_icon">
<description>
-Sets @file as the current filename for the file chooser, by changing
-to the file's parent folder and actually selecting the file in list. If
-the @chooser is in %GTK_FILE_CHOOSER_ACTION_SAVE mode, the file's base name
-will also appear in the dialog's file name entry.
+Sets an icon to be used as fallback for windows that haven't
+had gtk_window_set_icon() called on them from a pixbuf.
-If the file name isn't in the current folder of @chooser, then the current
-folder of @chooser will be changed to the folder containing @filename. This
-is equivalent to a sequence of gtk_file_chooser_unselect_all() followed by
-gtk_file_chooser_select_filename().
+Since: 2.4
-Note that the file must exist, or nothing will be done except
-for the directory change.
+</description>
+<parameters>
+<parameter name="icon">
+<parameter_description> the icon
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
-If you are implementing a <guimenuitem>File/Save As...</guimenuitem> dialog,
-you should use this function if you already have a file name to which the
-user may save; for example, when the user opens an existing file and then
-does <guimenuitem>File/Save As...</guimenuitem> on it. If you don't have
-a file name already — for example, if the user just created a new
-file and is saving it for the first time, do not call this function.
-Instead, use something similar to this:
-|[
-if (document_is_new)
-{
-/ * the user just created a new document * /
-gtk_file_chooser_set_current_folder_file (chooser, default_file_for_saving);
-gtk_file_chooser_set_current_name (chooser, "Untitled document");
-}
-else
-{
-/ * the user edited an existing document * /
-gtk_file_chooser_set_file (chooser, existing_file);
-}
-]|
+<function name="gtk_window_set_default_icon_from_file">
+<description>
+Sets an icon to be used as fallback for windows that haven't
+had gtk_window_set_icon_list() called on them from a file
+on disk. Warns on failure if @err is %NULL.
-Since: 2.14
+Since: 2.2
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
-</parameter_description>
-</parameter>
-<parameter name="file">
-<parameter_description> the #GFile to set as current
+<parameter name="filename">
+<parameter_description> location of icon file
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> location to store the error, or %NULL to ignore errors.
+<parameter name="err">
+<parameter_description> location to store error, or %NULL.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if both the folder could be changed and the file was
-selected successfully, %FALSE otherwise.
+<return> %TRUE if setting the icon succeeded.
</return>
</function>
-<function name="gtk_window_set_keep_below">
+<function name="gtk_window_set_default_icon_list">
<description>
-Asks to keep @window below, so that it stays in bottom. Note that
-you shouldn't assume the window is definitely below afterward,
-because other entities (e.g. the user or <link
-linkend="gtk-X11-arch">window manager</link>) could not keep it below,
-and not all window managers support putting windows below. But
-normally the window will be kept below. Just don't write code
-that crashes if not.
-
-It's permitted to call this function before showing a window,
-in which case the window will be kept below when it appears onscreen
-initially.
-
-You can track the below state via the "window-state-event" signal
-on #GtkWidget.
+Sets an icon list to be used as fallback for windows that haven't
+had gtk_window_set_icon_list() called on them to set up a
+window-specific icon list. This function allows you to set up the
+icon for all windows in your app at once.
-Note that, according to the <ulink
-url="http://www.freedesktop.org/Standards/wm-spec">Extended Window
-Manager Hints</ulink> specification, the above state is mainly meant
-for user preferences and should not be used by applications e.g. for
-drawing attention to their dialogs.
+See gtk_window_set_icon_list() for more details.
-Since: 2.4
</description>
<parameters>
-<parameter name="window">
-<parameter_description> a #GtkWindow
-</parameter_description>
-</parameter>
-<parameter name="setting">
-<parameter_description> whether to keep @window below other windows
+<parameter name="list">
+<parameter_description> a list of #GdkPixbuf
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_cell_view_new_with_pixbuf">
+<function name="gtk_window_set_default_icon_name">
<description>
-Creates a new #GtkCellView widget, adds a #GtkCellRendererPixbuf
-to it, and makes its show @pixbuf.
+Sets an icon to be used as fallback for windows that haven't
+had gtk_window_set_icon_list() called on them from a named
+themed icon, see gtk_window_set_icon_name().
Since: 2.6
</description>
<parameters>
-<parameter name="pixbuf">
-<parameter_description> the image to display in the cell view
+<parameter name="name">
+<parameter_description> the name of the themed icon
</parameter_description>
</parameter>
</parameters>
-<return> A newly created #GtkCellView widget.
-
-</return>
+<return></return>
</function>
-<function name="gtk_tree_sortable_sort_column_changed">
+<function name="gtk_window_set_default_size">
<description>
-Emits a #GtkTreeSortable::sort-column-changed signal on @sortable.
+Sets the default size of a window. If the window's "natural" size
+(its size request) is larger than the default, the default will be
+ignored. More generally, if the default size does not obey the
+geometry hints for the window (gtk_window_set_geometry_hints() can
+be used to set these explicitly), the default size will be clamped
+to the nearest permitted size.
+
+Unlike gtk_widget_set_size_request(), which sets a size request for
+a widget and thus would keep users from shrinking the window, this
+function only sets the initial size, just as if the user had
+resized the window themselves. Users can still shrink the window
+again as they normally would. Setting a default size of -1 means to
+use the "natural" default size (the size request of the window).
+
+For more control over a window's initial size and how resizing works,
+investigate gtk_window_set_geometry_hints().
+
+For some uses, gtk_window_resize() is a more appropriate function.
+gtk_window_resize() changes the current size of the window, rather
+than the size to be used on initial display. gtk_window_resize() always
+affects the window itself, not the geometry widget.
+
+The default size of a window only affects the first time a window is
+shown; if a window is hidden and re-shown, it will remember the size
+it had prior to hiding, rather than using the default size.
+
+Windows can't actually be 0x0 in size, they must be at least 1x1, but
+passing 0 for @width and @height is OK, resulting in a 1x1 default size.
</description>
<parameters>
-<parameter name="sortable">
-<parameter_description> A #GtkTreeSortable
+<parameter name="window">
+<parameter_description> a #GtkWindow
+</parameter_description>
+</parameter>
+<parameter name="width">
+<parameter_description> width in pixels, or -1 to unset the default width
+</parameter_description>
+</parameter>
+<parameter name="height">
+<parameter_description> height in pixels, or -1 to unset the default height
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_recent_manager_get_for_screen">
+<function name="gtk_window_set_deletable">
<description>
-Gets the recent manager object associated with @screen; if this
-function has not previously been called for the given screen,
-a new recent manager object will be created and associated with
-the screen. Recent manager objects are fairly expensive to create,
-so using this function is usually a better choice than calling
-gtk_recent_manager_new() and setting the screen yourself; by using
-this function a single recent manager object will be shared between
-users.
+By default, windows have a close button in the window frame. Some
+<link linkend="gtk-X11-arch">window managers</link> allow GTK+ to
+disable this button. If you set the deletable property to %FALSE
+using this function, GTK+ will do its best to convince the window
+manager not to show a close button. Depending on the system, this
+function may not have any effect when called on a window that is
+already visible, so you should call it before calling gtk_window_show().
-Deprecated: 2.12: This function has been deprecated and should
-not be used in newly written code. Calling this function is
-equivalent to calling gtk_recent_manager_get_default().
+On Windows, this function always works, since there's no window manager
+policy involved.
Since: 2.10
</description>
<parameters>
-<parameter name="screen">
-<parameter_description> a #GdkScreen
+<parameter name="window">
+<parameter_description> a #GtkWindow
+</parameter_description>
+</parameter>
+<parameter name="setting">
+<parameter_description> %TRUE to decorate the window as deletable
</parameter_description>
</parameter>
</parameters>
-<return> A unique #GtkRecentManager associated with the given
-screen. This recent manager is associated to the with the screen
-and can be used as long as the screen is open. Do not ref or
-unref it.
-
-</return>
+<return></return>
</function>
-<function name="gtk_icon_source_get_state">
+<function name="gtk_window_set_destroy_with_parent">
<description>
-Obtains the widget state this icon source applies to. The return
-value is only useful/meaningful if the widget state is <emphasis>not</emphasis>
-wildcarded.
-
+If @setting is %TRUE, then destroying the transient parent of @window
+will also destroy @window itself. This is useful for dialogs that
+shouldn't persist beyond the lifetime of the main window they're
+associated with, for example.
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GtkIconSource
+<parameter name="window">
+<parameter_description> a #GtkWindow
+</parameter_description>
+</parameter>
+<parameter name="setting">
+<parameter_description> whether to destroy @window with its transient parent
</parameter_description>
</parameter>
</parameters>
-<return> widget state this source matches
-</return>
+<return></return>
</function>
-<function name="gtk_icon_source_set_direction">
+<function name="gtk_window_set_focus">
<description>
-Sets the text direction this icon source is intended to be used
-with.
-
-Setting the text direction on an icon source makes no difference
-if the text direction is wildcarded. Therefore, you should usually
-call gtk_icon_source_set_direction_wildcarded() to un-wildcard it
-in addition to calling this function.
+If @focus is not the current focus widget, and is focusable, sets
+it as the focus widget for the window. If @focus is %NULL, unsets
+the focus widget for this window. To set the focus to a particular
+widget in the toplevel, it is usually more convenient to use
+gtk_widget_grab_focus() instead of this function.
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GtkIconSource
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="direction">
-<parameter_description> text direction this source applies to
+<parameter name="focus">
+<parameter_description> widget to be the new focus widget, or %NULL to unset
+any focus widget for the toplevel window.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_assistant_commit">
+<function name="gtk_window_set_focus_on_map">
<description>
-Erases the visited page history so the back button is not
-shown on the current page, and removes the cancel button
-from subsequent pages.
-
-Use this when the information provided up to the current
-page is hereafter deemed permanent and cannot be modified
-or undone. For example, showing a progress page to track
-a long-running, unreversible operation after the user has
-clicked apply on a confirmation page.
+Windows may set a hint asking the desktop environment not to receive
+the input focus when the window is mapped. This function sets this
+hint.
-Since: 2.22
+Since: 2.6
</description>
<parameters>
-<parameter name="assistant">
-<parameter_description> a #GtkAssistant
+<parameter name="window">
+<parameter_description> a #GtkWindow
+</parameter_description>
+</parameter>
+<parameter name="setting">
+<parameter_description> %TRUE to let this window receive input focus on map
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_view_enable_model_drag_dest">
+<function name="gtk_window_set_frame_dimensions">
<description>
-Turns @icon_view into a drop destination for automatic DND. Calling this
-method sets #GtkIconView:reorderable to %FALSE.
+(Note: this is a special-purpose function intended for the framebuffer
+port; see gtk_window_set_has_frame(). It will have no effect on the
+window border drawn by the window manager, which is the normal
+case when using the X Window system.)
-Since: 2.8
+For windows with frames (see gtk_window_set_has_frame()) this function
+can be used to change the size of the frame border.
+
+Deprecated: 2.24: This function will be removed in GTK+ 3
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
+<parameter name="window">
+<parameter_description> a #GtkWindow that has a frame
</parameter_description>
</parameter>
-<parameter name="targets">
-<parameter_description> the table of targets that the drag will support
+<parameter name="left">
+<parameter_description> The width of the left border
</parameter_description>
</parameter>
-<parameter name="n_targets">
-<parameter_description> the number of items in @targets
+<parameter name="top">
+<parameter_description> The height of the top border
</parameter_description>
</parameter>
-<parameter name="actions">
-<parameter_description> the bitmask of possible actions for a drag to this
-widget
+<parameter name="right">
+<parameter_description> The width of the right border
+</parameter_description>
+</parameter>
+<parameter name="bottom">
+<parameter_description> The height of the bottom border
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_view_set_tooltip_column">
+<function name="gtk_window_set_geometry_hints">
<description>
-If you only plan to have simple (text-only) tooltips on full items, you
-can use this function to have #GtkIconView handle these automatically
-for you. @column should be set to the column in @icon_view's model
-containing the tooltip texts, or -1 to disable this feature.
-
-When enabled, #GtkWidget::has-tooltip will be set to %TRUE and
- icon_view will connect a #GtkWidget::query-tooltip signal handler.
+This function sets up hints about how a window can be resized by
+the user. You can set a minimum and maximum size; allowed resize
+increments (e.g. for xterm, you can only resize by the size of a
+character); aspect ratios; and more. See the #GdkGeometry struct.
-Since: 2.12
</description>
<parameters>
-<parameter name="icon_view">
-<parameter_description> a #GtkIconView
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="column">
-<parameter_description> an integer, which is a valid column number for @icon_view's model
+<parameter name="geometry_widget">
+<parameter_description> widget the geometry hints will be applied to
+</parameter_description>
+</parameter>
+<parameter name="geometry">
+<parameter_description> struct containing geometry information
+</parameter_description>
+</parameter>
+<parameter name="geom_mask">
+<parameter_description> mask indicating which struct fields should be paid attention to
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_view_columns_autosize">
+<function name="gtk_window_set_gravity">
<description>
-Resizes all columns to their optimal width. Only works after the
-treeview has been realized.
+Window gravity defines the meaning of coordinates passed to
+gtk_window_move(). See gtk_window_move() and #GdkGravity for
+more details.
+
+The default window gravity is #GDK_GRAVITY_NORTH_WEST which will
+typically "do what you mean."
+
</description>
<parameters>
-<parameter name="tree_view">
-<parameter_description> A #GtkTreeView.
+<parameter name="window">
+<parameter_description> a #GtkWindow
+</parameter_description>
+</parameter>
+<parameter name="gravity">
+<parameter_description> window gravity
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_entry_set_icon_tooltip_text">
+<function name="gtk_window_set_has_frame">
<description>
-Sets @tooltip as the contents of the tooltip for the icon
-at the specified position.
+(Note: this is a special-purpose function for the framebuffer port,
+that causes GTK+ to draw its own window border. For most applications,
+you want gtk_window_set_decorated() instead, which tells the window
+manager whether to draw the window border.)
-Use %NULL for @tooltip to remove an existing tooltip.
+If this function is called on a window with setting of %TRUE, before
+it is realized or showed, it will have a "frame" window around
+ window->window, accessible in @window->frame. Using the signal
+frame_event you can receive all events targeted at the frame.
-See also gtk_widget_set_tooltip_text() and
-gtk_entry_set_icon_tooltip_markup().
+This function is used by the linux-fb port to implement managed
+windows, but it could conceivably be used by X-programs that
+want to do their own window decorations.
-Since: 2.16
+Deprecated: 2.24: This function will be removed in GTK+ 3
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
-</parameter_description>
-</parameter>
-<parameter name="icon_pos">
-<parameter_description> the icon position
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="tooltip">
-<parameter_description> the contents of the tooltip for the icon, or %NULL
+<parameter name="setting">
+<parameter_description> a boolean
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_text_iter_backward_chars">
+<function name="gtk_window_set_icon">
<description>
-Moves @count characters backward, if possible (if @count would move
-past the start or end of the buffer, moves to the start or end of
-the buffer). The return value indicates whether the iterator moved
-onto a dereferenceable position; if the iterator didn't move, or
-moved onto the end iterator, then %FALSE is returned. If @count is 0,
-the function does nothing and returns %FALSE.
+Sets up the icon representing a #GtkWindow. This icon is used when
+the window is minimized (also known as iconified). Some window
+managers or desktop environments may also place it in the window
+frame, or display it in other contexts.
+
+The icon should be provided in whatever size it was naturally
+drawn; that is, don't scale the image before passing it to
+GTK+. Scaling is postponed until the last minute, when the desired
+final size is known, to allow best quality.
+If you have your icon hand-drawn in multiple sizes, use
+gtk_window_set_icon_list(). Then the best size will be used.
+
+This function is equivalent to calling gtk_window_set_icon_list()
+with a 1-element list.
+
+See also gtk_window_set_default_icon_list() to set the icon
+for all windows in your application in one go.
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="count">
-<parameter_description> number of characters to move
+<parameter name="icon">
+<parameter_description> icon image, or %NULL
</parameter_description>
</parameter>
</parameters>
-<return> whether @iter moved and is dereferenceable
-
-</return>
+<return></return>
</function>
-<function name="gtk_text_iter_forward_line">
+<function name="gtk_window_set_icon_from_file">
<description>
-Moves @iter to the start of the next line. If the iter is already on the
-last line of the buffer, moves the iter to the end of the current line.
-If after the operation, the iter is at the end of the buffer and not
-dereferencable, returns %FALSE. Otherwise, returns %TRUE.
+Sets the icon for @window.
+Warns on failure if @err is %NULL.
+This function is equivalent to calling gtk_window_set_icon()
+with a pixbuf created by loading the image from @filename.
+
+Since: 2.2
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> an iterator
+<parameter name="window">
+<parameter_description> a #GtkWindow
+</parameter_description>
+</parameter>
+<parameter name="filename">
+<parameter_description> location of icon file
+</parameter_description>
+</parameter>
+<parameter name="err">
+<parameter_description> location to store error, or %NULL.
</parameter_description>
</parameter>
</parameters>
-<return> whether @iter can be dereferenced
+<return> %TRUE if setting the icon succeeded.
+
</return>
</function>
-<function name="gtk_entry_get_alignment">
+<function name="gtk_window_set_icon_list">
<description>
-Gets the value set by gtk_entry_set_alignment().
+Sets up the icon representing a #GtkWindow. The icon is used when
+the window is minimized (also known as iconified). Some window
+managers or desktop environments may also place it in the window
+frame, or display it in other contexts.
-Since: 2.4
+gtk_window_set_icon_list() allows you to pass in the same icon in
+several hand-drawn sizes. The list should contain the natural sizes
+your icon is available in; that is, don't scale the image before
+passing it to GTK+. Scaling is postponed until the last minute,
+when the desired final size is known, to allow best quality.
+
+By passing several sizes, you may improve the final image quality
+of the icon, by reducing or eliminating automatic image scaling.
+
+Recommended sizes to provide: 16x16, 32x32, 48x48 at minimum, and
+larger images (64x64, 128x128) if you have them.
+
+See also gtk_window_set_default_icon_list() to set the icon
+for all windows in your application in one go.
+
+Note that transient windows (those who have been set transient for another
+window using gtk_window_set_transient_for()) will inherit their
+icon from their transient parent. So there's no need to explicitly
+set the icon on transient windows.
</description>
<parameters>
-<parameter name="entry">
-<parameter_description> a #GtkEntry
+<parameter name="window">
+<parameter_description> a #GtkWindow
+</parameter_description>
+</parameter>
+<parameter name="list">
+<parameter_description> list of #GdkPixbuf
</parameter_description>
</parameter>
</parameters>
-<return> the alignment
-
-</return>
+<return></return>
</function>
-<function name="gtk_recent_chooser_widget_new_for_manager">
+<function name="gtk_window_set_icon_name">
<description>
-Creates a new #GtkRecentChooserWidget with a specified recent manager.
+Sets the icon for the window from a named themed icon. See
+the docs for #GtkIconTheme for more details.
-This is useful if you have implemented your own recent manager, or if you
-have a customized instance of a #GtkRecentManager object.
+Note that this has nothing to do with the WM_ICON_NAME
+property which is mentioned in the ICCCM.
-Since: 2.10
+Since: 2.6
</description>
<parameters>
-<parameter name="manager">
-<parameter_description> a #GtkRecentManager
+<parameter name="window">
+<parameter_description> a #GtkWindow
+</parameter_description>
+</parameter>
+<parameter name="name">
+<parameter_description> the name of the themed icon
</parameter_description>
</parameter>
</parameters>
-<return> a new #GtkRecentChooserWidget
-
-</return>
+<return></return>
</function>
-<function name="gtk_scale_get_layout">
+<function name="gtk_window_set_keep_above">
<description>
-Gets the #PangoLayout used to display the scale.
-The returned object is owned by the scale so does
-not need to be freed by the caller.
+Asks to keep @window above, so that it stays on top. Note that
+you shouldn't assume the window is definitely above afterward,
+because other entities (e.g. the user or <link
+linkend="gtk-X11-arch">window manager</link>) could not keep it above,
+and not all window managers support keeping windows above. But
+normally the window will end kept above. Just don't write code
+that crashes if not.
-Since: 2.4
+It's permitted to call this function before showing a window,
+in which case the window will be kept above when it appears onscreen
+initially.
-</description>
-<parameters>
-<parameter name="scale">
-<parameter_description> A #GtkScale
-</parameter_description>
-</parameter>
-</parameters>
-<return> the #PangoLayout for this scale, or %NULL
-if the #GtkScale:draw-value property is %FALSE.
+You can track the above state via the "window-state-event" signal
+on #GtkWidget.
-</return>
-</function>
+Note that, according to the <ulink
+url="http://www.freedesktop.org/Standards/wm-spec">Extended Window
+Manager Hints</ulink> specification, the above state is mainly meant
+for user preferences and should not be used by applications e.g. for
+drawing attention to their dialogs.
-<function name="gtk_tree_view_column_add_attribute">
-<description>
-Adds an attribute mapping to the list in @tree_column. The @column is the
-column of the model to get a value from, and the @attribute is the
-parameter on @cell_renderer to be set from the value. So for example
-if column 2 of the model contains strings, you could have the
-"text" attribute of a #GtkCellRendererText get its values from
-column 2.
+Since: 2.4
</description>
<parameters>
-<parameter name="tree_column">
-<parameter_description> A #GtkTreeViewColumn.
-</parameter_description>
-</parameter>
-<parameter name="cell_renderer">
-<parameter_description> the #GtkCellRenderer to set attributes on
-</parameter_description>
-</parameter>
-<parameter name="attribute">
-<parameter_description> An attribute on the renderer
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="column">
-<parameter_description> The column position on the model to get the attribute from.
+<parameter name="setting">
+<parameter_description> whether to keep @window above other windows
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_action_connect_accelerator">
+<function name="gtk_window_set_keep_below">
<description>
-Installs the accelerator for @action if @action has an
-accel path and group. See gtk_action_set_accel_path() and
-gtk_action_set_accel_group()
+Asks to keep @window below, so that it stays in bottom. Note that
+you shouldn't assume the window is definitely below afterward,
+because other entities (e.g. the user or <link
+linkend="gtk-X11-arch">window manager</link>) could not keep it below,
+and not all window managers support putting windows below. But
+normally the window will be kept below. Just don't write code
+that crashes if not.
-Since multiple proxies may independently trigger the installation
-of the accelerator, the @action counts the number of times this
-function has been called and doesn't remove the accelerator until
-gtk_action_disconnect_accelerator() has been called as many times.
+It's permitted to call this function before showing a window,
+in which case the window will be kept below when it appears onscreen
+initially.
+
+You can track the below state via the "window-state-event" signal
+on #GtkWidget.
+
+Note that, according to the <ulink
+url="http://www.freedesktop.org/Standards/wm-spec">Extended Window
+Manager Hints</ulink> specification, the above state is mainly meant
+for user preferences and should not be used by applications e.g. for
+drawing attention to their dialogs.
Since: 2.4
</description>
<parameters>
-<parameter name="action">
-<parameter_description> a #GtkAction
+<parameter name="window">
+<parameter_description> a #GtkWindow
+</parameter_description>
+</parameter>
+<parameter name="setting">
+<parameter_description> whether to keep @window below other windows
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_font_selection_get_family_list">
+<function name="gtk_window_set_mnemonic_modifier">
<description>
-This returns the #GtkTreeView that lists font families, for
-example, 'Sans', 'Serif', etc.
-
-Since: 2.14
+Sets the mnemonic modifier for this window.
</description>
<parameters>
-<parameter name="fontsel">
-<parameter_description> a #GtkFontSelection
+<parameter name="window">
+<parameter_description> a #GtkWindow
+</parameter_description>
+</parameter>
+<parameter name="modifier">
+<parameter_description> the modifier mask used to activate
+mnemonics on this window.
</parameter_description>
</parameter>
</parameters>
-<return> A #GtkWidget that is part of @fontsel
-
-</return>
+<return></return>
</function>
-<function name="gtk_cell_layout_pack_end">
+<function name="gtk_window_set_mnemonics_visible">
<description>
-Adds the @cell to the end of @cell_layout. If @expand is %FALSE, then the
- cell is allocated no more space than it needs. Any unused space is
-divided evenly between cells for which @expand is %TRUE.
-
-Note that reusing the same cell renderer is not supported.
+Sets the #GtkWindow:mnemonics-visible property.
-Since: 2.4
+Since: 2.20
</description>
<parameters>
-<parameter name="cell_layout">
-<parameter_description> A #GtkCellLayout.
-</parameter_description>
-</parameter>
-<parameter name="cell">
-<parameter_description> A #GtkCellRenderer.
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="expand">
-<parameter_description> %TRUE if @cell is to be given extra space allocated to @cell_layout.
+<parameter name="setting">
+<parameter_description> the new value
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_widget_grab_default">
+<function name="gtk_window_set_modal">
<description>
-Causes @widget to become the default widget. @widget must have the
-%GTK_CAN_DEFAULT flag set; typically you have to set this flag
-yourself by calling <literal>gtk_widget_set_can_default (@widget,
-%TRUE)</literal>. The default widget is activated when
-the user presses Enter in a window. Default widgets must be
-activatable, that is, gtk_widget_activate() should affect them.
+Sets a window modal or non-modal. Modal windows prevent interaction
+with other windows in the same application. To keep modal dialogs
+on top of main application windows, use
+gtk_window_set_transient_for() to make the dialog transient for the
+parent; most <link linkend="gtk-X11-arch">window managers</link>
+will then disallow lowering the dialog below the parent.
+
+
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="window">
+<parameter_description> a #GtkWindow
+</parameter_description>
+</parameter>
+<parameter name="modal">
+<parameter_description> whether the window is modal
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_row_reference_copy">
+<function name="gtk_window_set_opacity">
<description>
-Copies a #GtkTreeRowReference.
+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 has any effect only on X screens with a compositing manager
+running. See gtk_widget_is_composited(). On Windows it should work
+always.
-Since: 2.2
+Note that setting a window's opacity after the window has been
+shown causes it to flicker once on Windows.
+
+Since: 2.12
</description>
<parameters>
-<parameter name="reference">
-<parameter_description> a #GtkTreeRowReference
+<parameter name="window">
+<parameter_description> a #GtkWindow
+</parameter_description>
+</parameter>
+<parameter name="opacity">
+<parameter_description> desired opacity, between 0 and 1
</parameter_description>
</parameter>
</parameters>
-<return> a copy of @reference.
-
-</return>
+<return></return>
</function>
-<function name="gtk_statusbar_push">
+<function name="gtk_window_set_position">
<description>
-Pushes a new message onto a statusbar's stack.
-
+Sets a position constraint for this window. If the old or new
+constraint is %GTK_WIN_POS_CENTER_ALWAYS, this will also cause
+the window to be repositioned to satisfy the new constraint.
</description>
<parameters>
-<parameter name="statusbar">
-<parameter_description> a #GtkStatusbar
-</parameter_description>
-</parameter>
-<parameter name="context_id">
-<parameter_description> the message's context id, as returned by
-gtk_statusbar_get_context_id()
+<parameter name="window">
+<parameter_description> a #GtkWindow.
</parameter_description>
</parameter>
-<parameter name="text">
-<parameter_description> the message to add to the statusbar
+<parameter name="position">
+<parameter_description> a position constraint.
</parameter_description>
</parameter>
</parameters>
-<return> a message id that can be used with
-gtk_statusbar_remove().
-</return>
+<return></return>
</function>
-<function name="gtk_text_buffer_set_text">
+<function name="gtk_window_set_resizable">
<description>
-Deletes current contents of @buffer, and inserts @text instead. If
- len is -1, @text must be nul-terminated. @text must be valid UTF-8.
+Sets whether the user can resize a window. Windows are user resizable
+by default.
</description>
<parameters>
-<parameter name="buffer">
-<parameter_description> a #GtkTextBuffer
-</parameter_description>
-</parameter>
-<parameter name="text">
-<parameter_description> UTF-8 text to insert
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="len">
-<parameter_description> length of @text in bytes
+<parameter name="resizable">
+<parameter_description> %TRUE if the user can resize this window
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_socket_add_id">
+<function name="gtk_window_set_role">
<description>
-Adds an XEMBED client, such as a #GtkPlug, to the #GtkSocket. The
-client may be in the same process or in a different process.
+This function is only useful on X11, not with other GTK+ targets.
-To embed a #GtkPlug in a #GtkSocket, you can either create the
-#GtkPlug with <literal>gtk_plug_new (0)</literal>, call
-gtk_plug_get_id() to get the window ID of the plug, and then pass that to the
-gtk_socket_add_id(), or you can call gtk_socket_get_id() to get the
-window ID for the socket, and call gtk_plug_new() passing in that
-ID.
+In combination with the window title, the window role allows a
+<link linkend="gtk-X11-arch">window manager</link> to identify "the
+same" window when an application is restarted. So for example you
+might set the "toolbox" role on your app's toolbox window, so that
+when the user restarts their session, the window manager can put
+the toolbox back in the same place.
+
+If a window already has a unique title, you don't need to set the
+role, since the WM can use the title to identify the window when
+restoring the session.
-The #GtkSocket must have already be added into a toplevel window
-before you can make this call.
</description>
<parameters>
-<parameter name="socket_">
-<parameter_description> a #GtkSocket
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="window_id">
-<parameter_description> the window ID of a client participating in the XEMBED protocol.
+<parameter name="role">
+<parameter_description> unique identifier for the window to be used when restoring a session
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_icon_source_set_icon_name">
+<function name="gtk_window_set_screen">
<description>
-Sets the name of an icon to look up in the current icon theme
-to use as a base image when creating icon variants for #GtkIconSet.
+Sets the #GdkScreen where the @window is displayed; if
+the window is already mapped, it will be unmapped, and
+then remapped on the new screen.
+
+Since: 2.2
</description>
<parameters>
-<parameter name="source">
-<parameter_description> a #GtkIconSource
+<parameter name="window">
+<parameter_description> a #GtkWindow.
</parameter_description>
</parameter>
-<parameter name="icon_name">
-<parameter_description> name of icon to use
+<parameter name="screen">
+<parameter_description> a #GdkScreen.
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_im_context_get_surrounding">
+<function name="gtk_window_set_skip_pager_hint">
<description>
-Retrieves context around the insertion point. Input methods
-typically want context in order to constrain input text based on
-existing text; this is important for languages such as Thai where
-only some sequences of characters are allowed.
-
-This function is implemented by emitting the
-GtkIMContext::retrieve_surrounding signal on the input method; in
-response to this signal, a widget should provide as much context as
-is available, up to an entire paragraph, by calling
-gtk_im_context_set_surrounding(). Note that there is no obligation
-for a widget to respond to the ::retrieve_surrounding signal, so input
-methods must be prepared to function without context.
+Windows may set a hint asking the desktop environment not to display
+the window in the pager. This function sets this hint.
+(A "pager" is any desktop navigation tool such as a workspace
+switcher that displays a thumbnail representation of the windows
+on the screen.)
+Since: 2.2
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #GtkIMContext
-</parameter_description>
-</parameter>
-<parameter name="text">
-<parameter_description> location to store a UTF-8 encoded string of text
-holding context around the insertion point.
-If the function returns %TRUE, then you must free
-the result stored in this location with g_free().
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="cursor_index">
-<parameter_description> location to store byte index of the insertion cursor
-within @text.
+<parameter name="setting">
+<parameter_description> %TRUE to keep this window from appearing in the pager
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if surrounding text was provided; in this case
-you must free the result stored in *text.
-</return>
+<return></return>
</function>
-<function name="gtk_text_iter_backward_cursor_positions">
+<function name="gtk_window_set_skip_taskbar_hint">
<description>
-Moves up to @count cursor positions. See
-gtk_text_iter_forward_cursor_position() for details.
+Windows may set a hint asking the desktop environment not to display
+the window in the task bar. This function sets this hint.
+Since: 2.2
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="count">
-<parameter_description> number of positions to move
+<parameter name="setting">
+<parameter_description> %TRUE to keep this window from appearing in the task bar
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if we moved and the new position is dereferenceable
-</return>
+<return></return>
</function>
-<function name="gtk_widget_get_settings">
+<function name="gtk_window_set_startup_id">
<description>
-Gets the settings object holding the settings (global property
-settings, RC file information, etc) used for this widget.
+Startup notification identifiers are used by desktop environment to
+track application startup, to provide user feedback and other
+features. This function changes the corresponding property on the
+underlying GdkWindow. Normally, startup identifier is managed
+automatically and you should only use this function in special cases
+like transferring focus from other processes. You should use this
+function before calling gtk_window_present() or any equivalent
+function generating a window map event.
-Note that this function can only be called when the #GtkWidget
-is attached to a toplevel, since the settings object is specific
-to a particular #GdkScreen.
+This function is only useful on X11, not with other GTK+ targets.
+Since: 2.12
</description>
<parameters>
-<parameter name="widget">
-<parameter_description> a #GtkWidget
+<parameter name="window">
+<parameter_description> a #GtkWindow
+</parameter_description>
+</parameter>
+<parameter name="startup_id">
+<parameter_description> a string with startup-notification identifier
</parameter_description>
</parameter>
</parameters>
-<return> the relevant #GtkSettings object
-</return>
+<return></return>
</function>
-<function name="gtk_recent_chooser_list_filters">
+<function name="gtk_window_set_title">
<description>
-Gets the #GtkRecentFilter objects held by @chooser.
+Sets the title of the #GtkWindow. The title of a window will be
+displayed in its title bar; on the X Window System, the title bar
+is rendered by the <link linkend="gtk-X11-arch">window
+manager</link>, so exactly how the title appears to users may vary
+according to a user's exact configuration. The title should help a
+user distinguish this window from other windows they may have
+open. A good title might include the application name and current
+document filename, for example.
-Since: 2.10
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkRecentChooser
+<parameter name="window">
+<parameter_description> a #GtkWindow
+</parameter_description>
+</parameter>
+<parameter name="title">
+<parameter_description> title of the window
</parameter_description>
</parameter>
</parameters>
-<return> A singly linked list
-of #GtkRecentFilter objects. You
-should just free the returned list using g_slist_free().
-
-</return>
+<return></return>
</function>
-<function name="gtk_print_settings_set_length">
+<function name="gtk_window_set_transient_for">
<description>
-Associates a length in units of @unit with @key.
+Dialog windows should be set transient for the main application
+window they were spawned from. This allows <link
+linkend="gtk-X11-arch">window managers</link> to e.g. keep the
+dialog on top of the main window, or center the dialog over the
+main window. gtk_dialog_new_with_buttons() and other convenience
+functions in GTK+ will sometimes call
+gtk_window_set_transient_for() on your behalf.
-Since: 2.10
+Passing %NULL for @parent unsets the current transient window.
+
+On Windows, this function puts the child window on top of the parent,
+much as the window manager would have done on X.
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
-</parameter_description>
-</parameter>
-<parameter name="value">
-<parameter_description> a length
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="unit">
-<parameter_description> the unit of @length
+<parameter name="parent">
+<parameter_description> parent window, or %NULL
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_model_get_n_columns">
+<function name="gtk_window_set_type_hint">
<description>
-Returns the number of columns supported by @tree_model.
+By setting the type hint for the window, you allow the window
+manager to decorate and handle the window in a way which is
+suitable to the function of the window in your application.
+
+This function should be called before the window becomes visible.
+
+gtk_dialog_new_with_buttons() and other convenience functions in GTK+
+will sometimes call gtk_window_set_type_hint() on your behalf.
</description>
<parameters>
-<parameter name="tree_model">
-<parameter_description> A #GtkTreeModel.
+<parameter name="window">
+<parameter_description> a #GtkWindow
+</parameter_description>
+</parameter>
+<parameter name="hint">
+<parameter_description> the window type
</parameter_description>
</parameter>
</parameters>
-<return> The number of columns.
-</return>
+<return></return>
</function>
-<function name="gtk_file_chooser_remove_shortcut_folder_uri">
+<function name="gtk_window_set_urgency_hint">
<description>
-Removes a folder URI from a file chooser's list of shortcut folders.
+Windows may set a hint asking the desktop environment to draw
+the users attention to the window. This function sets this hint.
-Since: 2.4
+Since: 2.8
</description>
<parameters>
-<parameter name="chooser">
-<parameter_description> a #GtkFileChooser
-</parameter_description>
-</parameter>
-<parameter name="uri">
-<parameter_description> URI of the folder to remove
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="error">
-<parameter_description> location to store error, or %NULL
+<parameter name="setting">
+<parameter_description> %TRUE to mark this window as urgent
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the operation succeeds, %FALSE otherwise.
-In the latter case, the @error will be set as appropriate.
-
-See also: gtk_file_chooser_add_shortcut_folder_uri()
-
-</return>
+<return></return>
</function>
-<function name="gtk_print_settings_set_resolution_xy">
+<function name="gtk_window_set_wmclass">
<description>
-Sets the values of %GTK_PRINT_SETTINGS_RESOLUTION,
-%GTK_PRINT_SETTINGS_RESOLUTION_X and
-%GTK_PRINT_SETTINGS_RESOLUTION_Y.
+Don't use this function. It sets the X Window System "class" and
+"name" hints for a window. According to the ICCCM, you should
+always set these to the same value for all windows in an
+application, and GTK+ sets them to that value by default, so calling
+this function is sort of pointless. However, you may want to call
+gtk_window_set_role() on each window in your application, for the
+benefit of the session manager. Setting the role allows the window
+manager to restore window positions when loading a saved session.
-Since: 2.16
</description>
<parameters>
-<parameter name="settings">
-<parameter_description> a #GtkPrintSettings
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="resolution_x">
-<parameter_description> the horizontal resolution in dpi
+<parameter name="wmclass_name">
+<parameter_description> window name hint
</parameter_description>
</parameter>
-<parameter name="resolution_y">
-<parameter_description> the vertical resolution in dpi
+<parameter name="wmclass_class">
+<parameter_description> window class hint
</parameter_description>
</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_tree_path_get_indices">
+<function name="gtk_window_stick">
<description>
-Returns the current indices of @path. This is an array of integers, each
-representing a node in a tree. This value should not be freed.
+Asks to stick @window, which means that it will appear on all user
+desktops. Note that you shouldn't assume the window is definitely
+stuck afterward, because other entities (e.g. the user or <link
+linkend="gtk-X11-arch">window manager</link>) could unstick it
+again, and some window managers do not support sticking
+windows. But normally the window will end up stuck. Just don't
+write code that crashes if not.
+
+It's permitted to call this function before showing a window.
+
+You can track stickiness via the "window-state-event" signal
+on #GtkWidget.
</description>
<parameters>
-<parameter name="path">
-<parameter_description> A #GtkTreePath.
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return> The current indices, or %NULL.
-</return>
+<return></return>
</function>
-<function name="gtk_spin_button_get_adjustment">
+<function name="gtk_window_unfullscreen">
<description>
-Get the adjustment associated with a #GtkSpinButton
+Asks to toggle off the fullscreen state for @window. Note that you
+shouldn't assume the window is definitely not full screen
+afterward, because other entities (e.g. the user or <link
+linkend="gtk-X11-arch">window manager</link>) could fullscreen it
+again, and not all window managers honor requests to unfullscreen
+windows. But normally the window will end up restored to its normal
+state. Just don't write code that crashes if not.
+You can track the fullscreen state via the "window-state-event" signal
+on #GtkWidget.
+
+Since: 2.2
</description>
<parameters>
-<parameter name="spin_button">
-<parameter_description> a #GtkSpinButton
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return> the #GtkAdjustment of @spin_button
-</return>
+<return></return>
</function>
-<function name="gtk_window_set_focus">
+<function name="gtk_window_unmaximize">
<description>
-If @focus is not the current focus widget, and is focusable, sets
-it as the focus widget for the window. If @focus is %NULL, unsets
-the focus widget for this window. To set the focus to a particular
-widget in the toplevel, it is usually more convenient to use
-gtk_widget_grab_focus() instead of this function.
+Asks to unmaximize @window. Note that you shouldn't assume the
+window is definitely unmaximized afterward, because other entities
+(e.g. the user or <link linkend="gtk-X11-arch">window
+manager</link>) could maximize it again, and not all window
+managers honor requests to unmaximize. But normally the window will
+end up unmaximized. Just don't write code that crashes if not.
+
+You can track maximization via the "window-state-event" signal
+on #GtkWidget.
+
</description>
<parameters>
@@ -70195,70 +70707,85 @@ gtk_widget_grab_focus() instead of this function.
<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
-<parameter name="focus">
-<parameter_description> widget to be the new focus widget, or %NULL to unset
-any focus widget for the toplevel window.
-</parameter_description>
-</parameter>
</parameters>
<return></return>
</function>
-<function name="gtk_menu_shell_get_take_focus">
+<function name="gtk_window_unstick">
<description>
-Returns %TRUE if the menu shell will take the keyboard focus on popup.
+Asks to unstick @window, which means that it will appear on only
+one of the user's desktops. Note that you shouldn't assume the
+window is definitely unstuck afterward, because other entities
+(e.g. the user or <link linkend="gtk-X11-arch">window
+manager</link>) could stick it again. But normally the window will
+end up stuck. Just don't write code that crashes if not.
+
+You can track stickiness via the "window-state-event" signal
+on #GtkWidget.
-Since: 2.8
</description>
<parameters>
-<parameter name="menu_shell">
-<parameter_description> a #GtkMenuShell
+<parameter name="window">
+<parameter_description> a #GtkWindow
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the menu shell will take the keyboard focus on popup.
+<return></return>
+</function>
-</return>
+<function name="remove_file">
+<description>
+Removes the given file from the model. If the file is not part of
+ model, this function does nothing.
+
+</description>
+<parameters>
+<parameter name="model">
+<parameter_description> the model
+</parameter_description>
+</parameter>
+<parameter name="file">
+<parameter_description> file to remove from the model. The file must have been
+added to the model previously
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
</function>
-<function name="gtk_action_create_menu_item">
+<function name="safe_fclose">
<description>
-Creates a menu item widget that proxies for the given action.
+Unix defaults for data preservation after system crash
+are unspecified, and many systems will eat your data
+in this situation unless you explicitly fsync().
-Since: 2.4
</description>
<parameters>
-<parameter name="action">
-<parameter_description> the action object
+<parameter name="f">
+<parameter_description> A FILE* stream, must have underlying fd
</parameter_description>
</parameter>
</parameters>
-<return> a menu item connected to the action.
-
+<return> %TRUE on success, %FALSE on failure, and will set errno()
</return>
</function>
-<function name="gtk_text_iter_forward_sentence_ends">
+<function name="spin_button_get_shadow_type">
<description>
-Calls gtk_text_iter_forward_sentence_end() @count times (or until
-gtk_text_iter_forward_sentence_end() returns %FALSE). If @count is
-negative, moves backward instead of forward.
+Convenience function to Get the shadow type from the underlying widget's
+style.
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> a #GtkTextIter
-</parameter_description>
-</parameter>
-<parameter name="count">
-<parameter_description> number of sentences to move
+<parameter name="spin_button">
+<parameter_description> a #GtkSpinButton
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if @iter moved and is not the end iterator
+<return> the #GtkShadowType
</return>
</function>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
