[gtkmm] Regenerate docs XML.
- From: Murray Cumming <murrayc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtkmm] Regenerate docs XML.
- Date: Tue, 4 Mar 2014 09:57:18 +0000 (UTC)
commit d21564265c330f3963302a61231bf44e63f60d42
Author: Murray Cumming <murrayc murrayc com>
Date: Tue Mar 4 09:55:02 2014 +0100
Regenerate docs XML.
gdk/src/gdk_docs.xml | 920 +++++------
gtk/src/gtk_docs.xml | 4304 ++++++++++++++++++++++++++++----------------------
2 files changed, 2820 insertions(+), 2404 deletions(-)
---
diff --git a/gdk/src/gdk_docs.xml b/gdk/src/gdk_docs.xml
index c0465ee..7efc0d8 100644
--- a/gdk/src/gdk_docs.xml
+++ b/gdk/src/gdk_docs.xml
@@ -122,7 +122,7 @@ this event is synthetic as the pointer might have not left the window.
<parameter name="GDK_CROSSING_DEVICE_SWITCH">
<parameter_description> crossing because of a device switch (i.e.
a mouse taking control of the pointer after a touch device), this event
-is synthetic as the pointer didn't leave the window.
+is synthetic as the pointer didn’t leave the window.
</parameter_description>
</parameter>
</parameters>
@@ -135,311 +135,311 @@ The standard cursors available.
</description>
<parameters>
<parameter name="GDK_X_CURSOR">
-<parameter_description> <inlinegraphic format="PNG"
fileref="X_cursor.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_ARROW">
-<parameter_description> <inlinegraphic format="PNG"
fileref="arrow.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_BASED_ARROW_DOWN">
-<parameter_description> <inlinegraphic format="PNG"
fileref="based_arrow_down.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_BASED_ARROW_UP">
-<parameter_description> <inlinegraphic format="PNG"
fileref="based_arrow_up.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_BOAT">
-<parameter_description> <inlinegraphic format="PNG"
fileref="boat.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_BOGOSITY">
-<parameter_description> <inlinegraphic format="PNG"
fileref="bogosity.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_BOTTOM_LEFT_CORNER">
-<parameter_description> <inlinegraphic format="PNG"
fileref="bottom_left_corner.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_BOTTOM_RIGHT_CORNER">
-<parameter_description> <inlinegraphic format="PNG"
fileref="bottom_right_corner.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_BOTTOM_SIDE">
-<parameter_description> <inlinegraphic format="PNG"
fileref="bottom_side.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_BOTTOM_TEE">
-<parameter_description> <inlinegraphic format="PNG"
fileref="bottom_tee.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_BOX_SPIRAL">
-<parameter_description> <inlinegraphic format="PNG"
fileref="box_spiral.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_CENTER_PTR">
-<parameter_description> <inlinegraphic format="PNG"
fileref="center_ptr.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_CIRCLE">
-<parameter_description> <inlinegraphic format="PNG"
fileref="circle.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_CLOCK">
-<parameter_description> <inlinegraphic format="PNG"
fileref="clock.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_COFFEE_MUG">
-<parameter_description> <inlinegraphic format="PNG"
fileref="coffee_mug.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_CROSS">
-<parameter_description> <inlinegraphic format="PNG"
fileref="cross.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_CROSS_REVERSE">
-<parameter_description> <inlinegraphic format="PNG"
fileref="cross_reverse.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_CROSSHAIR">
-<parameter_description> <inlinegraphic format="PNG"
fileref="crosshair.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_DIAMOND_CROSS">
-<parameter_description> <inlinegraphic format="PNG"
fileref="diamond_cross.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_DOT">
-<parameter_description> <inlinegraphic format="PNG"
fileref="dot.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_DOTBOX">
-<parameter_description> <inlinegraphic format="PNG"
fileref="dotbox.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_DOUBLE_ARROW">
-<parameter_description> <inlinegraphic format="PNG"
fileref="double_arrow.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_DRAFT_LARGE">
-<parameter_description> <inlinegraphic format="PNG"
fileref="draft_large.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_DRAFT_SMALL">
-<parameter_description> <inlinegraphic format="PNG"
fileref="draft_small.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_DRAPED_BOX">
-<parameter_description> <inlinegraphic format="PNG"
fileref="draped_box.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_EXCHANGE">
-<parameter_description> <inlinegraphic format="PNG"
fileref="exchange.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_FLEUR">
-<parameter_description> <inlinegraphic format="PNG"
fileref="fleur.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_GOBBLER">
-<parameter_description> <inlinegraphic format="PNG"
fileref="gobbler.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_GUMBY">
-<parameter_description> <inlinegraphic format="PNG"
fileref="gumby.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_HAND1">
-<parameter_description> <inlinegraphic format="PNG"
fileref="hand1.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_HAND2">
-<parameter_description> <inlinegraphic format="PNG"
fileref="hand2.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_HEART">
-<parameter_description> <inlinegraphic format="PNG"
fileref="heart.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_ICON">
-<parameter_description> <inlinegraphic format="PNG"
fileref="icon.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_IRON_CROSS">
-<parameter_description> <inlinegraphic format="PNG"
fileref="iron_cross.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_LEFT_PTR">
-<parameter_description> <inlinegraphic format="PNG"
fileref="left_ptr.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_LEFT_SIDE">
-<parameter_description> <inlinegraphic format="PNG"
fileref="left_side.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_LEFT_TEE">
-<parameter_description> <inlinegraphic format="PNG"
fileref="left_tee.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_LEFTBUTTON">
-<parameter_description> <inlinegraphic format="PNG"
fileref="leftbutton.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_LL_ANGLE">
-<parameter_description> <inlinegraphic format="PNG"
fileref="ll_angle.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_LR_ANGLE">
-<parameter_description> <inlinegraphic format="PNG"
fileref="lr_angle.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_MAN">
-<parameter_description> <inlinegraphic format="PNG"
fileref="man.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_MIDDLEBUTTON">
-<parameter_description> <inlinegraphic format="PNG"
fileref="middlebutton.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_MOUSE">
-<parameter_description> <inlinegraphic format="PNG"
fileref="mouse.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_PENCIL">
-<parameter_description> <inlinegraphic format="PNG"
fileref="pencil.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_PIRATE">
-<parameter_description> <inlinegraphic format="PNG"
fileref="pirate.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_PLUS">
-<parameter_description> <inlinegraphic format="PNG"
fileref="plus.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_QUESTION_ARROW">
-<parameter_description> <inlinegraphic format="PNG"
fileref="question_arrow.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_RIGHT_PTR">
-<parameter_description> <inlinegraphic format="PNG"
fileref="right_ptr.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_RIGHT_SIDE">
-<parameter_description> <inlinegraphic format="PNG"
fileref="right_side.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_RIGHT_TEE">
-<parameter_description> <inlinegraphic format="PNG"
fileref="right_tee.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_RIGHTBUTTON">
-<parameter_description> <inlinegraphic format="PNG"
fileref="rightbutton.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_RTL_LOGO">
-<parameter_description> <inlinegraphic format="PNG"
fileref="rtl_logo.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_SAILBOAT">
-<parameter_description> <inlinegraphic format="PNG"
fileref="sailboat.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_SB_DOWN_ARROW">
-<parameter_description> <inlinegraphic format="PNG"
fileref="sb_down_arrow.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_SB_H_DOUBLE_ARROW">
-<parameter_description> <inlinegraphic format="PNG"
fileref="sb_h_double_arrow.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_SB_LEFT_ARROW">
-<parameter_description> <inlinegraphic format="PNG"
fileref="sb_left_arrow.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_SB_RIGHT_ARROW">
-<parameter_description> <inlinegraphic format="PNG"
fileref="sb_right_arrow.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_SB_UP_ARROW">
-<parameter_description> <inlinegraphic format="PNG"
fileref="sb_up_arrow.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_SB_V_DOUBLE_ARROW">
-<parameter_description> <inlinegraphic format="PNG"
fileref="sb_v_double_arrow.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_SHUTTLE">
-<parameter_description> <inlinegraphic format="PNG"
fileref="shuttle.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_SIZING">
-<parameter_description> <inlinegraphic format="PNG"
fileref="sizing.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_SPIDER">
-<parameter_description> <inlinegraphic format="PNG"
fileref="spider.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_SPRAYCAN">
-<parameter_description> <inlinegraphic format="PNG"
fileref="spraycan.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_STAR">
-<parameter_description> <inlinegraphic format="PNG"
fileref="star.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_TARGET">
-<parameter_description> <inlinegraphic format="PNG"
fileref="target.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_TCROSS">
-<parameter_description> <inlinegraphic format="PNG"
fileref="tcross.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_TOP_LEFT_ARROW">
-<parameter_description> <inlinegraphic format="PNG"
fileref="top_left_arrow.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_TOP_LEFT_CORNER">
-<parameter_description> <inlinegraphic format="PNG"
fileref="top_left_corner.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_TOP_RIGHT_CORNER">
-<parameter_description> <inlinegraphic format="PNG"
fileref="top_right_corner.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_TOP_SIDE">
-<parameter_description> <inlinegraphic format="PNG"
fileref="top_side.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_TOP_TEE">
-<parameter_description> <inlinegraphic format="PNG"
fileref="top_tee.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_TREK">
-<parameter_description> <inlinegraphic format="PNG"
fileref="trek.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_UL_ANGLE">
-<parameter_description> <inlinegraphic format="PNG"
fileref="ul_angle.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_UMBRELLA">
-<parameter_description> <inlinegraphic format="PNG"
fileref="umbrella.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_UR_ANGLE">
-<parameter_description> <inlinegraphic format="PNG"
fileref="ur_angle.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_WATCH">
-<parameter_description> <inlinegraphic format="PNG"
fileref="watch.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_XTERM">
-<parameter_description> <inlinegraphic format="PNG"
fileref="xterm.png"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GDK_LAST_CURSOR">
@@ -547,7 +547,7 @@ is unplugged.
<enum name="GdkDeviceType">
<description>
-Indicates the device type. See <link
linkend="GdkDeviceManager.description">above</link>
+Indicates the device type. See [above][GdkDeviceManager.description]
for more information about the meaning of these device types.
</description>
@@ -652,7 +652,7 @@ useful if source and destination agree on what it means.
</parameter>
<parameter name="GDK_ACTION_PRIVATE">
<parameter_description> Special action which tells the source that the
-destination will do something that the source doesn't understand.
+destination will do something that the source doesn’t understand.
</parameter_description>
</parameter>
<parameter name="GDK_ACTION_ASK">
@@ -839,7 +839,7 @@ the events are often transformed or filtered along the way.
In some language bindings, the values %GDK_2BUTTON_PRESS and
%GDK_3BUTTON_PRESS would translate into something syntactically
-invalid (eg <literal>Gdk.EventType.2ButtonPress</literal>, where a
+invalid (eg `Gdk.EventType.2ButtonPress`, where a
symbol is not allowed to start with a number). In that case, the
aliases %GDK_DOUBLE_BUTTON_PRESS and %GDK_TRIPLE_BUTTON_PRESS can
be used instead.
@@ -1056,7 +1056,7 @@ Specifies the result of applying a #GdkFilterFunc to a native event.
</parameter>
<parameter name="GDK_FILTER_TRANSLATE">
<parameter_description> native event translated into a GDK event and stored
-in the <literal>event</literal> structure that was passed in.
+in the `event` structure that was passed in.
</parameter_description>
</parameter>
<parameter name="GDK_FILTER_REMOVE">
@@ -1254,15 +1254,15 @@ Defines how device grabs interact with other devices.
</description>
<parameters>
<parameter name="GDK_OWNERSHIP_NONE">
-<parameter_description> All other devices' events are allowed.
+<parameter_description> All other devices’ events are allowed.
</parameter_description>
</parameter>
<parameter name="GDK_OWNERSHIP_WINDOW">
-<parameter_description> Other devices' events are blocked for the grab window.
+<parameter_description> Other devices’ events are blocked for the grab window.
</parameter_description>
</parameter>
<parameter name="GDK_OWNERSHIP_APPLICATION">
-<parameter_description> Other devices' events are blocked for the whole application.
+<parameter_description> Other devices’ events are blocked for the whole application.
</parameter_description>
</parameter>
</parameters>
@@ -1305,8 +1305,8 @@ viewable.
Defines the reference point of a window and the meaning of coordinates
passed to gtk_window_move(). See gtk_window_move() and the "implementation
notes" section of the
-<ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended
-Window Manager Hints</ulink> specification for more details.
+[Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec)
+specification for more details.
</description>
<parameters>
@@ -1365,12 +1365,12 @@ An enumeration that describes the mode of an input device.
</parameter_description>
</parameter>
<parameter name="GDK_MODE_SCREEN">
-<parameter_description> the device is enabled. The device's coordinate space
+<parameter_description> the device is enabled. The device’s coordinate space
maps to the entire screen.
</parameter_description>
</parameter>
<parameter name="GDK_MODE_WINDOW">
-<parameter_description> the device is enabled. The device's coordinate space
+<parameter_description> the device is enabled. The device’s coordinate space
is mapped to a single window. The manner in which this window
is chosen is undefined, but it will typically be the same
way in which the focus window for key events is determined.
@@ -1400,7 +1400,7 @@ of a stylus on a graphics tablet.
</parameter_description>
</parameter>
<parameter name="GDK_SOURCE_CURSOR">
-<parameter_description> the device is a graphics tablet "puck" or similar device.
+<parameter_description> the device is a graphics tablet “puck” or similar device.
</parameter_description>
</parameter>
<parameter name="GDK_SOURCE_KEYBOARD">
@@ -1527,7 +1527,7 @@ in order to determine what modifiers the
currently used windowing system backend uses for particular
purposes. For example, on X11/Windows, the Control key is used for
invoking menu shortcuts (accelerators), whereas on Apple computers
-it's the Command key (which correspond to %GDK_CONTROL_MASK and
+it’s the Command key (which correspond to %GDK_CONTROL_MASK and
%GDK_MOD2_MASK, respectively).
Since: 3.4
@@ -2531,8 +2531,8 @@ coordinate in the embedder window
<enum name="GdkWindowAttributesType">
<description>
Used to indicate which fields in the #GdkWindowAttr struct should be honored.
-For example, if you filled in the "cursor" and "x" fields of #GdkWindowAttr,
-pass "@GDK_WA_X | @GDK_WA_CURSOR" to gdk_window_new(). Fields in
+For example, if you filled in the “cursor” and “x” fields of #GdkWindowAttr,
+pass “ GDK_WA_X | @GDK_WA_CURSOR” to gdk_window_new(). Fields in
#GdkWindowAttr not covered by a bit in this enum are required; for example,
the @width/@height, @wclass, and @window_type fields are required, they have
no corresponding flag in #GdkWindowAttributesType.
@@ -2657,12 +2657,12 @@ gtk_window_parse_geometry() automatically sets these flags.
</parameter_description>
</parameter>
<parameter name="GDK_HINT_USER_POS">
-<parameter_description> indicates that the window's position was explicitly set
+<parameter_description> indicates that the window’s position was explicitly set
by the user
</parameter_description>
</parameter>
<parameter name="GDK_HINT_USER_SIZE">
-<parameter_description> indicates that the window's size was explicitly set by
+<parameter_description> indicates that the window’s size was explicitly set by
the user
</parameter_description>
</parameter>
@@ -2745,7 +2745,7 @@ screen, and is created by the window system
</parameter>
<parameter name="GDK_WINDOW_OFFSCREEN">
<parameter_description> offscreen window (see
-<xref linkend="OFFSCREEN-WINDOWS"/>). Since 2.18
+[Offscreen Windows][OFFSCREEN-WINDOWS]). Since 2.18
</parameter_description>
</parameter>
</parameters>
@@ -2757,10 +2757,8 @@ These are hints for the window manager that indicate what type of function
the window has. The window manager can use this when determining decoration
and behaviour of the window. The hint must be set before mapping the window.
-See the
-<ulink url="http://www.freedesktop.org/Standards/wm-spec">Extended
-Window Manager Hints</ulink> specification for more details about
-window types.
+See the [Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec)
+specification for more details about window types.
</description>
<parameters>
@@ -2814,7 +2812,7 @@ e.g. a context menu.
</parameter_description>
</parameter>
<parameter name="GDK_WINDOW_TYPE_HINT_NOTIFICATION">
-<parameter_description> A notification - typically a "bubble"
+<parameter_description> A notification - typically a “bubble”
that belongs to a status icon.
</parameter_description>
</parameter>
@@ -2834,7 +2832,7 @@ that belongs to a status icon.
@GDK_INPUT_OUTPUT windows are the standard kind of window you might expect.
Such windows receive events and are also displayed on screen.
@GDK_INPUT_ONLY windows are invisible; they are usually placed above other
-windows in order to trap or filter the events. You can't draw on
+windows in order to trap or filter the events. You can’t draw on
@GDK_INPUT_ONLY windows.
</description>
@@ -2886,8 +2884,7 @@ Deprecated: 3.0: Use gdk_display_get_app_launch_context() instead
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>.
+[Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec).
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
@@ -3049,7 +3046,7 @@ Finds or creates an atom corresponding to a given string.
</parameter>
<parameter name="only_if_exists">
<parameter_description> if %TRUE, GDK is allowed to not create a new atom, but
-just return %GDK_NONE if the requested atom doesn't already
+just return %GDK_NONE if the requested atom doesn’t already
exists. Currently, the flag is ignored, since checking the
existance of an atom is as expensive as creating it.
</parameter_description>
@@ -3118,10 +3115,8 @@ Emits a short beep on the default display.
<description>
Creates a Cairo context for drawing to @window.
-<note><warning>
Note that calling cairo_reset_clip() on the resulting #cairo_t will
produce undefined results, so avoid it at all costs.
-</warning></note>
Since: 2.8
@@ -3431,13 +3426,12 @@ Parses a textual specification of a color and fill in the
@red, @green, and @blue fields of a #GdkColor.
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').
+(taken from the X11 `rgb.txt` file), or it can be a hexadecimal
+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”).
</description>
@@ -3457,9 +3451,8 @@ of the color, respectively. (White in the four forms is
<function name="gdk_color_to_string">
<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
+Returns a textual specification of @color in the hexadecimal
+form `\#rrrrggggbbbb`, where `r`, `g` and `b` are hex digits
representing the red, green and blue components respectively.
The returned string can be parsed by gdk_color_parse().
@@ -3589,62 +3582,24 @@ To make the cursor invisible, use %GDK_BLANK_CURSOR.
<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>
+-  #GDK_RIGHT_PTR (right-facing arrow)
+-  #GDK_CROSSHAIR (crosshair)
+-  #GDK_XTERM (I-beam)
+-  #GDK_WATCH (busy)
+-  #GDK_FLEUR (for moving objects)
+-  #GDK_HAND1 (a right-pointing hand)
+-  #GDK_HAND2 (a left-pointing hand)
+-  #GDK_LEFT_SIDE (resize left side)
+-  #GDK_RIGHT_SIDE (resize right side)
+-  #GDK_TOP_LEFT_CORNER (resize northwest corner)
+-  #GDK_TOP_RIGHT_CORNER (resize northeast corner)
+-  #GDK_BOTTOM_LEFT_CORNER (resize southwest corner)
+-  #GDK_BOTTOM_RIGHT_CORNER (resize southeast corner)
+-  #GDK_TOP_SIDE (resize top side)
+-  #GDK_BOTTOM_SIDE (resize bottom side)
+-  #GDK_SB_H_DOUBLE_ARROW (move vertical splitter)
+-  #GDK_SB_V_DOUBLE_ARROW (move horizontal splitter)
+- #GDK_BLANK_CURSOR (Blank cursor). Since 2.16
Since: 2.2
@@ -3701,9 +3656,9 @@ 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 <literal>0</literal> and the width resp. height of
+If @x or @y are `-1`, 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
@@ -3722,11 +3677,11 @@ Since: 2.4
</parameter_description>
</parameter>
<parameter name="x">
-<parameter_description> the horizontal offset of the 'hotspot' of the cursor.
+<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> the vertical offset of the “hotspot” of the cursor.
</parameter_description>
</parameter>
</parameters>
@@ -3764,11 +3719,11 @@ Since: 3.10
</parameter_description>
</parameter>
<parameter name="x">
-<parameter_description> the horizontal offset of the 'hotspot' of the cursor
+<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> the vertical offset of the “hotspot” of the cursor
</parameter_description>
</parameter>
</parameters>
@@ -4228,7 +4183,7 @@ Since: 2.20
<function name="gdk_device_get_state">
<description>
Gets the current state of a pointer device relative to @window. As a slave
-device's coordinates are those of its master pointer, this
+device’s coordinates are those of its master pointer, this
function may not be called on devices of type %GDK_DEVICE_TYPE_SLAVE,
unless there is an ongoing grab on them. See gdk_device_grab().
@@ -4351,8 +4306,8 @@ Since: 3.0
<parameter name="device">
<parameter_description> a #GdkDevice. To get the device you can use gtk_get_current_event_device()
or gdk_event_get_device() if the grab is in reaction to an event. Also, you can use
-gdk_device_manager_get_client_pointer() but only in code that isn't triggered by a
-#GdkEvent and there aren't other means to get a meaningful #GdkDevice to operate on.
+gdk_device_manager_get_client_pointer() but only in code that isn’t triggered by a
+#GdkEvent and there aren’t other means to get a meaningful #GdkDevice to operate on.
</parameter_description>
</parameter>
<parameter name="window">
@@ -4387,7 +4342,7 @@ elsewhere.
<parameter name="time_">
<parameter_description> the timestamp of the event which led to this pointer grab. This
usually comes from the #GdkEvent struct, though %GDK_CURRENT_TIME
-can be used if the time isn't known.
+can be used if the time isn’t known.
</parameter_description>
</parameter>
</parameters>
@@ -4430,7 +4385,7 @@ keyboard grabbed.
<function name="gdk_device_list_axes">
<description>
-Returns a #GList of #GdkAtom<!-- -->s, containing the labels for
+Returns a #GList of #GdkAtoms, containing the labels for
the axes that @device currently has.
Since: 3.0
@@ -4443,7 +4398,7 @@ Since: 3.0
</parameter>
</parameters>
<return>
-A #GList of #GdkAtom<!-- -->s, free with g_list_free().
+A #GList of #GdkAtoms, free with g_list_free().
</return>
</function>
@@ -4475,8 +4430,8 @@ Returns the client pointer, that is, the master pointer that acts as the core po
for this application. In X11, window managers may change this depending on the interaction
pattern under the presence of several pointers.
-You should use this function seldomly, only in code that isn't triggered by a #GdkEvent
-and there aren't other means to get a meaningful #GdkDevice to operate on.
+You should use this function seldomly, only in code that isn’t triggered by a #GdkEvent
+and there aren’t other means to get a meaningful #GdkDevice to operate on.
Since: 3.0
@@ -4532,7 +4487,7 @@ Since: 3.0
</parameter>
</parameters>
<return> a list of
-#GdkDevice<!-- -->s. The returned list must be
+#GdkDevices. The returned list must be
freed with g_list_free (). The list elements are owned by
GTK+ and must not be freed or unreffed.
@@ -4591,7 +4546,7 @@ is pressed.
<function name="gdk_device_set_mode">
<description>
Sets a the mode of an input device. The mode controls if the
-device is active and whether the device's range is mapped to the
+device is active and whether the device’s range is mapped to the
entire screen or to a single window.
@@ -4674,10 +4629,10 @@ Disables multidevice support in GDK. This call must happen prior
to gdk_display_open(), gtk_init(), gtk_init_with_args() or
gtk_init_check() in order to take effect.
-Most common GTK+ applications won't ever need to call this. Only
+Most common GTK+ applications won’t ever need to call this. Only
applications that do mixed GDK/Xlib calls could want to disable
multidevice support if such Xlib code deals with input devices in
-any way and doesn't observe the presence of XInput 2.
+any way and doesn’t observe the presence of XInput 2.
Since: 3.0
@@ -4787,8 +4742,8 @@ Free with g_object_unref() when done
<function name="gdk_display_get_default">
<description>
Gets the default #GdkDisplay. This is a convenience
-function for
-<literal>gdk_display_manager_get_default_display (gdk_display_manager_get ())</literal>.
+function for:
+`gdk_display_manager_get_default_display (gdk_display_manager_get ())`.
Since: 2.2
@@ -5138,7 +5093,7 @@ a list of #GdkDevice
Gets the singleton #GdkDisplayManager object.
When called for the first time, this function consults the
-<envar>GDK_BACKEND</envar> environment variable to find out which
+`GDK_BACKEND` environment variable to find out which
of the supported GDK backends to use (in case GDK has been compiled
with multiple backends). Applications can use gdk_set_allowed_backends()
to limit what backends can be used.
@@ -5302,7 +5257,7 @@ opened, otherwise %NULL.
<function name="gdk_display_peek_event">
<description>
-Gets a copy of the first #GdkEvent in the @display's event queue, without
+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.)
@@ -5463,9 +5418,8 @@ Since: 2.2
<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>.
+according to the
+[FreeDesktop Clipboard Specification](http://www.freedesktop.org/Standards/clipboard-manager-spec).
Since: 2.6
@@ -5500,7 +5454,7 @@ if all available targets should be saved.
<function name="gdk_display_supports_clipboard_persistence">
<description>
Returns whether the speicifed display supports clipboard
-persistance; i.e. if it's possible to store the clipboard data after an
+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.
@@ -6167,7 +6121,7 @@ to a drop initiated by the drag source.
Removes an error trap pushed with gdk_error_trap_push().
May block until an error has been definitively received
or not received from the X server. gdk_error_trap_pop_ignored()
-is preferred if you don't need to know whether an error
+is preferred if you don’t need to know whether an error
occurred, because it never has to block. If you don't
need the return value of gdk_error_trap_pop(), use
gdk_error_trap_pop_ignored().
@@ -6205,7 +6159,7 @@ This function allows X errors to be trapped instead of the normal
behavior of exiting the application. It should only be used if it
is not possible to avoid the X error in any other way. Errors are
ignored on all #GdkDisplay currently known to the
-#GdkDisplayManager. If you don't care which error happens and just
+#GdkDisplayManager. If you don’t care which error happens and just
want to ignore everything, pop with gdk_error_trap_pop_ignored().
If you need the error code, use gdk_error_trap_pop() which may have
to block and wait for the error to arrive from the X server.
@@ -6215,20 +6169,19 @@ This API exists on all platforms but only does anything on X.
You can use gdk_x11_display_error_trap_push() to ignore errors
on only a single display.
-<example>
-<title>Trapping an X error</title>
-<programlisting>
-gdk_error_trap_push (<!-- -->);
+## Trapping an X error
+
+|[<!-- language="C" -->
+gdk_error_trap_push ();
// ... Call the X function which may cause an error here ...
-if (gdk_error_trap_pop (<!-- -->))
+if (gdk_error_trap_pop ())
{
// ... Handle the error here ...
}
-</programlisting>
-</example>
+]|
</description>
<parameters>
@@ -6239,7 +6192,7 @@ if (gdk_error_trap_pop (<!-- -->))
<function name="gdk_event_copy">
<description>
Copies a #GdkEvent, copying or incrementing the reference count of the
-resources associated with it (e.g. #GdkWindow's and strings).
+resources associated with it (e.g. #GdkWindow’s and strings).
</description>
@@ -6381,7 +6334,7 @@ Extract the event window relative x/y coordinates from an event.
<function name="gdk_event_get_device">
<description>
-If the event contains a "device" field, this function will return
+If the event contains a “device” field, this function will return
it, else it will return %NULL.
Since: 3.0
@@ -6507,12 +6460,12 @@ Extract the root window relative x/y coordinates from an event.
<function name="gdk_event_get_screen">
<description>
Returns the screen for the event. The screen is
-typically the screen for <literal>event->any.window</literal>, but
+typically the screen for `event->any.window`, but
for events such as mouse events, it is the screen
where the pointer was when the event occurs -
that is, the screen which has the root window
-to which <literal>event->motion.x_root</literal> and
-<literal>event->motion.y_root</literal> are relative.
+to which `event->motion.x_root` and
+`event->motion.y_root` are relative.
Since: 2.2
@@ -6580,7 +6533,7 @@ Since: 3.2
<description>
This function returns the hardware (slave) #GdkDevice that has
triggered the event, falling back to the virtual (master) device
-(as in gdk_event_get_device()) if the event wasn't caused by
+(as in gdk_event_get_device()) if the event wasn’t caused by
interaction with a hardware device. This may happen for example
in synthesized crossing events after a #GdkWindow updates its
geometry or a grab is acquired/released.
@@ -6604,9 +6557,9 @@ Since: 3.0
<function name="gdk_event_get_state">
<description>
-If the event contains a "state" field, puts that field in @state. Otherwise
+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
+in the event. @event may be %NULL, in which case it’s treated
as if the event had no state field.
@@ -6725,7 +6678,7 @@ gdk_event_free().
<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 for event->any.window’s display, or the default event
queue if event->any.window is %NULL. See gdk_display_put_event().
</description>
@@ -6748,13 +6701,13 @@ 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:
-|[
+|[<!-- language="C" -->
{
-/ * motion_event handler * /
+// 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 * /
+// handle (x,y) motion
+gdk_event_request_motions (motion_event); // handles is_hint events
}
]|
@@ -7055,10 +7008,10 @@ counter for the last frame.
<function name="gdk_frame_clock_get_frame_time">
<description>
Gets the time that should currently be used for animations. Inside
-the processing of a frame, it's the time used to compute the
+the processing of a frame, it’s the time used to compute the
animation position of everything in a frame. Outside of a frame, it's
-the time of the conceptual "previous frame," which may be either
-the actual previous frame time, or if that's too old, an updated
+the time of the conceptual “previous frame,” which may be either
+the actual previous frame time, or if that’s too old, an updated
time.
Since: 3.8
@@ -7304,7 +7257,7 @@ time is available. See gdk_frame_timings_get_complete()
<description>
Gets the natural interval between presentation times for
the display that this frame was displayed on. Frame presentation
-usually happens during the "vertical blanking interval".
+usually happens during the “vertical blanking interval”.
Since: 3.8
@@ -7371,8 +7324,8 @@ for the default display and screen.
<function name="gdk_get_display">
<description>
Gets the name of the display, which usually comes from the
-<envar>DISPLAY</envar> environment variable or the
-<option>--display</option> command line option.
+`DISPLAY` environment variable or the
+`--display` command line option.
Deprecated: 3.8: Call gdk_display_get_name (gdk_display_get_default ()))
instead.
@@ -7404,7 +7357,7 @@ this string is owned by GTK+ and must not be modified or freed.
<function name="gdk_get_program_class">
<description>
Gets the program class. Unless the program class has explicitly
-been set with gdk_set_program_class() or with the <option>--class</option>
+been set with gdk_set_program_class() or with the `--class`
commandline option, the default value is the program name (determined
with g_get_prgname()) with the first character converted to uppercase.
@@ -7432,7 +7385,7 @@ Gets whether event debugging output is enabled.
<description>
Initializes the GDK library and connects to the windowing system.
If initialization fails, a warning message is output and the application
-terminates with a call to <literal>exit(1)</literal>.
+terminates with a call to `exit(1)`.
Any arguments used by GDK are removed from the array and @argc and @argv
are updated accordingly.
@@ -7713,7 +7666,7 @@ Since: 2.2
<function name="gdk_keymap_get_modifier_mask">
<description>
-Returns the modifier mask the @keymap's windowing system backend
+Returns the modifier mask the @keymap’s windowing system backend
uses for a particular purpose.
Note that this function always returns real hardware modifiers, not
@@ -7856,55 +7809,49 @@ 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
+See [Groups][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)
+keyval, so this function isn’t as useful as you might think.
+
+ consumed_modifiers gives modifiers that should be masked outfrom @state
+when comparing this key press to a hot key. For instance, on a US keyboard,
+the `plus` symbol is shifted, so when comparing a key press to a
+`<Control>plus` accelerator `<Shift>` should be masked out.
+
+|[<!-- language="C" -->
+// 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>
+// Control was pressed
+]|
+
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 * /
+modifiers, by doing:
+|[<!-- language="C" -->
+// 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>
+// Accelerator was pressed
+]|
+
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 single modifier 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>
+used in the keymap, since, for instance, `<Control>` would be
+masked out even if only `<Control><Alt>` was used in the keymap.
+To support this usage as well as well as possible, all single
+modifier 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 `<Control>plus`, not `<Control><Shift>plus`,
</description>
@@ -7976,8 +7923,8 @@ Examples of keyvals are #GDK_KEY_a, #GDK_KEY_Enter, #GDK_KEY_F1, etc.
Converts a key name to a key value.
The names are the same as those in the
-<filename><gdk/gdkkeysyms.h></filename> header file
-but without the leading "GDK_KEY_".
+`gdk/gdkkeysyms.h` header file
+but without the leading “GDK_KEY_”.
</description>
@@ -8031,8 +7978,8 @@ case conversion.
Converts a key value into a symbolic name.
The names are the same as those in the
-<filename><gdk/gdkkeysyms.h></filename> header file
-but without the leading "GDK_KEY_".
+`gdk/gdkkeysyms.h` header file
+but without the leading “GDK_KEY_”.
</description>
@@ -8108,7 +8055,7 @@ 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.
+Call g_list_free() on the return value when you’re finished with it.
</description>
@@ -8123,7 +8070,7 @@ a list of visuals; the list must be freed, but not its contents
<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
+normally called after opening the application’s initial set of
windows.
GTK+ will call this function automatically after opening the first
@@ -8227,7 +8174,7 @@ Since: 2.18
<description>
Creates a #PangoContext for the default GDK screen.
-The context must be freed when you're finished with it.
+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
@@ -8237,7 +8184,7 @@ 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.
+changes to the screen’s font rendering settings.
</description>
@@ -8251,7 +8198,7 @@ changes to the screen's font rendering settings.
<description>
Creates a #PangoContext for @screen.
-The context must be freed when you're finished with it.
+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
@@ -8261,7 +8208,7 @@ 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.
+changes to the screen’s font rendering settings.
Since: 2.2
@@ -8282,7 +8229,7 @@ Since: 2.2
Obtains a clip region which contains the areas where the given ranges
of text would be drawn. @x_origin and @y_origin are the top left point
to center the layout. @index_ranges should contain
-ranges of bytes in the layout's text.
+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
@@ -8322,7 +8269,7 @@ of text, such as when text is selected.
Obtains a clip region which contains the areas where the given
ranges of text would be drawn. @x_origin and @y_origin are the top left
position of the layout. @index_ranges
-should contain ranges of bytes in the layout's text. The clip
+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
@@ -8372,7 +8319,7 @@ 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 explicitly if you are using
+You shouldn’t call this function explicitly if you are using
gtk_init(), gtk_init_check(), gdk_init(), or gdk_init_check().
Since: 2.2
@@ -9578,14 +9525,14 @@ If the window is off the screen, then there is no image data in the
obscured/offscreen regions to be placed in the pixbuf. The contents of
portions of the pixbuf corresponding to the offscreen region are undefined.
-If the window you're obtaining data from is partially obscured by
+If the window you’re obtaining data from is partially obscured by
other windows, then the contents of the pixbuf areas corresponding
to the obscured regions are undefined.
-If the window is not mapped (typically because it's iconified/minimized
+If the window is not mapped (typically because it’s iconified/minimized
or not on the current workspace), then %NULL will be returned.
-If memory can't be allocated for the return value, %NULL will be returned
+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
@@ -11623,7 +11570,7 @@ for @window is used for all other windows.
<parameter name="time_">
<parameter_description> the timestamp of the event which led to this pointer grab. This usually
comes from a #GdkEventButton struct, though %GDK_CURRENT_TIME can be used if
-the time isn't known.
+the time isn’t known.
</parameter_description>
</parameter>
</parameters>
@@ -11701,9 +11648,9 @@ with the current data.
</parameter_description>
</parameter>
<parameter name="data">
-<parameter_description> the data (a <literal>guchar *</literal>
-<literal>gushort *</literal>, or <literal>gulong *</literal>,
-depending on @format), cast to a <literal>guchar *</literal>.
+<parameter_description> the data (a `guchar *`
+`gushort *`, or `gulong *`,
+depending on @format), cast to a `guchar *`.
</parameter_description>
</parameter>
<parameter name="nelements">
@@ -11739,8 +11686,6 @@ Retrieves a portion of the contents of a property. If the
property does not exist, then the function returns %FALSE,
and %GDK_NONE will be stored in @actual_property_type.
-<note>
-<para>
The XGetWindowProperty() function that gdk_property_get()
uses has a very confusing and complicated set of semantics.
Unfortunately, gdk_property_get() makes the situation
@@ -11748,10 +11693,7 @@ worse instead of better (the semantics should be considered
undefined), and also prints warnings to stderr in cases where it
should return a useful error to the program. You are advised to use
XGetWindowProperty() directly until a replacement function for
-gdk_property_get()
-is provided.
-</para>
-</note>
+gdk_property_get() is provided.
</description>
@@ -11824,7 +11766,7 @@ in @data, otherwise %FALSE.
<function name="gdk_query_depths">
<description>
This function returns the available bit depths for the default
-screen. It's equivalent to listing the visuals
+screen. It’s equivalent to listing the visuals
(gdk_list_visuals()) and then looking at the depth field in each
visual, removing duplicates.
@@ -11848,7 +11790,7 @@ location for available depths
<function name="gdk_query_visual_types">
<description>
This function returns the available visual types for the default
-screen. It's equivalent to listing the visuals
+screen. It’s equivalent to listing the visuals
(gdk_list_visuals()) and then looking at the type field in each
visual, removing duplicates.
@@ -11873,7 +11815,7 @@ location for the available visual types
<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
+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.
@@ -12007,24 +11949,14 @@ Parses a textual representation of a color, filling in
the @red, @green, @blue and @alpha fields of the @rgba #GdkRGBA.
The string can be either one of:
-<itemizedlist>
-<listitem>
-A standard name (Taken from the X11 rgb.txt file).
-</listitem>
-<listitem>
-A hex value in the form '#rgb' '#rrggbb' '#rrrgggbbb'
-or '#rrrrggggbbbb'
-</listitem>
-<listitem>
-A RGB color in the form 'rgb(r,g,b)' (In this case the color will
+- A standard name (Taken from the X11 rgb.txt file).
+- A hexadecimal value in the form “\#rgb”, “\#rrggbb”,
+“\#rrrgggbbb” or ”\#rrrrggggbbbb”
+- A RGB color in the form “rgb(r,g,b)” (In this case the color will
have full opacity)
-</listitem>
-<listitem>
-A RGBA color in the form 'rgba(r,g,b,a)'
-</listitem>
-</itemizedlist>
+- A RGBA color in the form “rgba(r,g,b,a)”
-Where 'r', 'g', 'b' and 'a' are respectively the red, green, blue and
+Where “r”, “g”, “b” and “a” are respectively the red, green, blue and
alpha color values. In the last two cases, r g and b are either integers
in the range 0 to 255 or precentage values in the range 0% to 100%, and
a is a floating point value in the range 0 to 1.
@@ -12050,9 +11982,9 @@ Since: 3.0
<function name="gdk_rgba_to_string">
<description>
Returns a textual specification of @rgba in the form
-<literal>rgb (r, g, b)</literal> or
-<literal>rgba (r, g, b, a)</literal>,
-where 'r', 'g', 'b' and 'a' represent the red, green,
+`rgb (r, g, b)` or
+`rgba (r, g, b, a)`,
+where “r”, “g”, “b” and “a” represent the red, green,
blue and alpha values respectively. r, g, and b are
represented as integers in the range 0 to 255, and a
is represented as floating point value in the range 0 to 1.
@@ -12081,12 +12013,12 @@ Since: 3.0
<function name="gdk_screen_get_active_window">
<description>
-Returns the screen's currently active window.
+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
+on the root window, as described in the
+[Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec).
+If there is no currently currently active
window, or the window manager does not support the
_NET_ACTIVE_WINDOW hint, this function returns %NULL.
@@ -12337,7 +12269,7 @@ to the actual device pixels. On traditional systems this is 1, but
on very high density outputs this can be a higher value (often 2).
This can be used if you want to create pixel based data for a
-particula monitor, but most of the time you're drawing to a window
+particula monitor, but most of the time you’re drawing to a window
where it is better to use gdk_window_get_scale_factor() instead.
Since: 3.10
@@ -12382,7 +12314,7 @@ Since: 2.14
<function name="gdk_screen_get_monitor_workarea">
<description>
Retrieves the #GdkRectangle representing the size and position of
-the "work area" on a monitor within the entire screen area.
+the “work area” on a monitor within the entire screen area.
The work area should be considered when positioning menus and
similar popups, to avoid placing them below panels, docks or other
@@ -12452,7 +12384,7 @@ Since: 2.2
<function name="gdk_screen_get_primary_monitor">
<description>
Gets the primary monitor for @screen. The primary monitor
-is considered the monitor where the 'main desktop' lives.
+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.
@@ -12500,7 +12432,7 @@ Gets a visual to use for creating windows with an alpha channel.
The windowing system on which GTK+ is running
may not support this capability, in which case %NULL will
be returned. Even if a non-%NULL value is returned, its
-possible that the window's alpha channel won't be honored
+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.
@@ -12576,7 +12508,7 @@ in @value, %FALSE otherwise.
<function name="gdk_screen_get_system_visual">
<description>
-Get the system's default visual for @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.
@@ -12657,13 +12589,13 @@ Since: 2.2
<function name="gdk_screen_get_window_stack">
<description>
-Returns a #GList of #GdkWindow<!-- -->s representing the current
+Returns a #GList of #GdkWindows 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
+property on the root window, as described in the
+[Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec).
+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
@@ -12683,7 +12615,7 @@ Since: 2.10
</parameter>
</parameters>
<return>
-a list of #GdkWindow<!-- -->s for the current window stack,
+a list of #GdkWindows for the current window stack,
or %NULL.
</return>
@@ -12746,7 +12678,7 @@ 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.
+Call g_list_free() on the return value when you’re finished with it.
Since: 2.2
@@ -12785,7 +12717,7 @@ Since: 2.2
<function name="gdk_screen_set_font_options">
<description>
Sets the default font options for the screen. These
-options will be set on any #PangoContext's newly created
+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.
@@ -12823,7 +12755,7 @@ Since: 2.10
</parameter_description>
</parameter>
<parameter name="dpi">
-<parameter_description> the resolution in "dots per inch". (Physical inches aren't actually
+<parameter_description> the resolution in “dots per inch”. (Physical inches aren’t actually
involved; the terminology is conventional.)
</parameter_description>
</parameter>
@@ -13129,14 +13061,14 @@ work with certain GDK backends.
By default, GDK tries all included backends.
For example,
-<programlisting>
+|[<!-- language="C" -->
gdk_set_allowed_backends ("wayland,quartz,*");
-</programlisting>
+]|
instructs GDK to try the Wayland backend first,
followed by the Quartz backend, and then all
others.
-If the <envar>GDK_BACKEND</envar> environment variable
+If the `GDK_BACKEND` environment variable
is set, it determines what backends are tried in what
order, while still respecting the set of allowed backends
that are specified by this function.
@@ -13182,7 +13114,7 @@ global user-configured setting.
<function name="gdk_set_program_class">
<description>
Sets the program class. The X11 backend uses the program class to set
-the class name part of the <literal>WM_CLASS</literal> property on
+the class name part of the `WM_CLASS` property on
toplevel windows; see the ICCCM.
</description>
@@ -13199,7 +13131,7 @@ toplevel windows; see the ICCCM.
<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)
+configured using the `--enable-debug` option)
to use this option.
</description>
@@ -13436,18 +13368,18 @@ 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:
-|[
+|[<!-- language="C" -->
static gboolean
idle_callback (gpointer data)
{
-/ * gdk_threads_enter(); would be needed for g_idle_add() * /
+// gdk_threads_enter(); would be needed for g_idle_add()
SomeWidget *self = data;
-/ * do stuff with self * /
+// do stuff with self
self->idle_id = 0;
-/ * gdk_threads_leave(); would be needed for g_idle_add() * /
+// gdk_threads_leave(); would be needed for g_idle_add()
return FALSE;
}
@@ -13455,7 +13387,7 @@ 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 * /
+// using g_idle_add() here would require thread protection in the callback
}
static void
@@ -13538,17 +13470,17 @@ 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).
+(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:
-|[
+|[<!-- language="C" -->
static gboolean timeout_callback (gpointer data)
{
SomeWidget *self = data;
-/ * do stuff with self * /
+// do stuff with self
self->timeout_id = 0;
@@ -13636,7 +13568,7 @@ Since: 2.14
<description>
A variant of gdk_threads_add_timeout_full() with second-granularity.
See g_timeout_add_seconds_full() for a discussion of why it is
-a good idea to use this function if you don't need finer granularity.
+a good idea to use this function if you don’t need finer granularity.
Since: 2.14
@@ -13734,7 +13666,7 @@ 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.
+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.
@@ -13813,8 +13745,8 @@ GDK screen. The return value should not be freed.
<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
+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.
@@ -13918,8 +13850,8 @@ Since: 2.22
<function name="gdk_visual_get_blue_pixel_details">
<description>
Obtains values that are needed to calculate blue pixel values in TrueColor
-and DirectColor. The "mask" is the significant bits within the pixel.
-The "shift" is the number of bits left we must shift a primary for it
+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.
@@ -14004,8 +13936,8 @@ Since: 2.22
<function name="gdk_visual_get_green_pixel_details">
<description>
Obtains values that are needed to calculate green pixel values in TrueColor
-and DirectColor. The "mask" is the significant bits within the pixel.
-The "shift" is the number of bits left we must shift a primary for it
+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.
@@ -14036,8 +13968,8 @@ Since: 2.22
<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
+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.
@@ -14085,7 +14017,7 @@ Since: 2.2
<function name="gdk_visual_get_system">
<description>
-Get the system's default visual for the default GDK screen.
+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.
@@ -14176,10 +14108,9 @@ Sends a startup notification message of type @message_type to
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.
+not normally need to call it directly. See the
+[Startup Notification Protocol
specification](http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt)
+for definitions of the message types and keys that can be used.
Since: 2.12
@@ -14284,7 +14215,7 @@ some Wayland interface.
A good example would be writing a panel or on-screen-keyboard as an
out-of-process helper - as opposed to having those in the compositor
-process. In this case the underlying surface isn't an xdg_shell
+process. In this case the underlying surface isn’t an xdg_shell
surface and the panel or OSK client need to identify the wl_surface
as a panel or OSK to the compositor. The assumption is that the
compositor will expose a private interface to the special client
@@ -14293,8 +14224,7 @@ that lets the client identify the wl_surface as a panel or such.
This function should be called before a #GdkWindow is shown. This is
best done by connecting to the #GtkWidget::realize signal:
-<informalexample>
-<programlisting>
+|[<!-- language="C" -->
static void
widget_realize_cb (GtkWidget *widget)
{
@@ -14315,8 +14245,7 @@ setup_window (GtkWindow *window)
{
g_signal_connect (window, "realize", G_CALLBACK (widget_realize_cb), NULL);
}
-</programlisting>
-</informalexample>
+]|
Since: 3.10
@@ -14365,7 +14294,7 @@ XFreeEventData() must not be called within @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
+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
@@ -14444,11 +14373,10 @@ to begin a drag with a different device.
<function name="gdk_window_begin_move_drag_for_device">
<description>
Begins a window move operation (for a toplevel window).
-You might use this function to implement a "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.
+You might use this function to implement a “window move grip,” for
+example. The function works best with window managers that support the
+[Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec)
+but has a fallback implementation for other window managers.
Since: 3.4
@@ -14526,7 +14454,7 @@ 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
+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.
@@ -14600,10 +14528,11 @@ to begin a drag with a different device.
<function name="gdk_window_begin_resize_drag_for_device">
<description>
Begins a window resize operation (for a toplevel window).
-You might use this function to implement a "window resize grip," for
+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.
+with window managers that support the
+[Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec)
+but has a fallback implementation for other window managers.
Since: 3.4
@@ -14721,19 +14650,19 @@ Since: 2.22
</parameter_description>
</parameter>
<parameter name="parent_x">
-<parameter_description> X coordinate in parent's coordinate system
+<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> 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> 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> return location for Y coordinate in child’s coordinate system
</parameter_description>
</parameter>
</parameters>
@@ -14768,21 +14697,21 @@ Since: 2.22
</parameter_description>
</parameter>
<parameter name="x">
-<parameter_description> X coordinate in child's coordinate system
+<parameter_description> X coordinate in child’s coordinate system
</parameter_description>
</parameter>
<parameter name="y">
-<parameter_description> Y coordinate in child's coordinate system
+<parameter_description> Y coordinate in child’s coordinate system
</parameter_description>
</parameter>
<parameter name="parent_x">
<parameter_description> return location for X coordinate
-in parent's coordinate system, or %NULL
+in parent’s coordinate system, or %NULL
</parameter_description>
</parameter>
<parameter name="parent_y">
<parameter_description> return location for Y coordinate
-in parent's coordinate system, or %NULL
+in parent’s coordinate system, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -14827,7 +14756,7 @@ 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
+pointer to a “nil” surface if @other is already in an error state
or any other error occurs.
</return>
@@ -14871,7 +14800,7 @@ 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
+pointer to a “nil” surface if @other is already in an error state
or any other error occurs.
</return>
@@ -14900,7 +14829,7 @@ unminimizes it, and puts it on the current desktop.
<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.
+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.
@@ -14990,7 +14919,7 @@ window has been exposed.
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
+gdk drawing. For Gtk widgets that don’t use double buffering this
will be called automatically before sending the expose event.
Since: 2.18
@@ -15050,7 +14979,7 @@ for use by GTK+.
<function name="gdk_window_freeze_updates">
<description>
-Temporarily freezes a window such that it won't receive expose
+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
@@ -15077,7 +15006,7 @@ 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
+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.
@@ -15135,7 +15064,7 @@ Since: 2.22
<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.
+returned and you’ll have to query it yourself.
Since: 2.22
@@ -15147,7 +15076,7 @@ Since: 2.22
</parameter>
</parameters>
<return> The pattern to use for the background or
-%NULL to use the parent's background.
+%NULL to use the parent’s background.
</return>
</function>
@@ -15156,7 +15085,7 @@ Since: 2.22
<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;
+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
@@ -15463,7 +15392,7 @@ or %NULL if @window does not support Drag and Drop.
<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.
+window’s embedder for offscreen windows.
See also: gdk_offscreen_window_get_embedder()
@@ -15483,7 +15412,7 @@ Since: 2.22
<function name="gdk_window_get_effective_toplevel">
<description>
-Gets the toplevel window that's an ancestor of @window.
+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().
@@ -15621,7 +15550,7 @@ Since: 3.8
<function name="gdk_window_get_geometry">
<description>
Any of the return location arguments to this function may be %NULL,
-if you aren't interested in getting the value of that field.
+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
@@ -15634,14 +15563,12 @@ 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 much better
+Note: If @window is not a toplevel, it is much better
to call gdk_window_get_position(), gdk_window_get_width() and
gdk_window_get_height() instead, because it avoids the roundtrip to
the X server and because these functions support the full 32-bit
coordinate space, whereas gdk_window_get_geometry() is restricted to
the 16-bit coordinates of X11.
-</note>
</description>
<parameters>
@@ -15759,7 +15686,7 @@ relative to its parent window.)
<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
+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.
@@ -15813,7 +15740,7 @@ modifier mask
</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
+pointer isn’t known to GDK
</return>
</function>
@@ -15826,7 +15753,7 @@ 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.
+The position coordinates are relative to the window’s parent window.
</description>
@@ -16011,14 +15938,14 @@ Since: 3.0
<function name="gdk_window_get_toplevel">
<description>
-Gets the toplevel window that's an ancestor of @window.
+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
+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.
@@ -16059,7 +15986,7 @@ of the function. That is, after calling this function, @window will
no longer have an invalid/dirty region; the update area is removed
from @window and handed to you. If a window has no update area,
gdk_window_get_update_area() returns %NULL. You are responsible for
-calling cairo_region_destroy() on the returned region if it's non-%NULL.
+calling cairo_region_destroy() on the returned region if it’s non-%NULL.
</description>
@@ -16192,7 +16119,7 @@ Since: 2.22
<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
+they won’t be displayed. Normally done automatically as
part of gtk_widget_hide().
</description>
@@ -16235,7 +16162,7 @@ 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".
+“clickable”.
On the X11 platform, this requires version 1.1 of the
shape extension.
@@ -16270,7 +16197,7 @@ Since: 2.10
<function name="gdk_window_invalidate_maybe_recurse">
<description>
Adds @region to the update area for @window. The update area is the
-region that needs to be redrawn, or "dirty region." The call
+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
@@ -16278,7 +16205,7 @@ 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
+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
@@ -16337,7 +16264,7 @@ window
<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
+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
@@ -16345,7 +16272,7 @@ 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
+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
@@ -16472,7 +16399,7 @@ 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
+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>
@@ -16492,8 +16419,8 @@ this function does nothing.
On X11, asks the window manager to maximize @window, if the window
manager supports this operation. Not all window managers support
-this, and some deliberately ignore it or don't have a concept of
-"maximized"; so you can't rely on the maximization actually
+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.
@@ -16518,7 +16445,7 @@ for @window and its children will become the new input mask
for @window. See gdk_window_input_shape_combine_region().
This function is distinct from gdk_window_set_child_input_shapes()
-because it includes @window's input shape mask in the set of
+because it includes @window’s input shape mask in the set of
shapes to be merged.
Since: 2.10
@@ -16541,7 +16468,7 @@ for @window and its children will become the new mask
for @window. See gdk_window_shape_combine_region().
This function is distinct from gdk_window_set_child_shapes()
-because it includes @window's shape mask in the set of shapes to
+because it includes @window’s shape mask in the set of shapes to
be merged.
</description>
@@ -16562,7 +16489,7 @@ you should probably use gtk_window_move() on a #GtkWindow widget
anyway, instead of using GDK functions. For child windows,
the move will reliably succeed.
-If you're also planning to resize the window, use gdk_window_move_resize()
+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>
@@ -16572,11 +16499,11 @@ to both move and resize simultaneously, for a nicer visual effect.
</parameter_description>
</parameter>
<parameter name="x">
-<parameter_description> X coordinate relative to window's parent
+<parameter_description> X coordinate relative to window’s parent
</parameter_description>
</parameter>
<parameter name="y">
-<parameter_description> Y coordinate relative to window's parent
+<parameter_description> Y coordinate relative to window’s parent
</parameter_description>
</parameter>
</parameters>
@@ -16620,7 +16547,7 @@ Since: 2.8
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().)
+move, then resize, if you don’t use gdk_window_move_resize().)
</description>
<parameters>
@@ -16629,11 +16556,11 @@ move, then resize, if you don't use gdk_window_move_resize().)
</parameter_description>
</parameter>
<parameter name="x">
-<parameter_description> new X position relative to window's parent
+<parameter_description> new X position relative to window’s parent
</parameter_description>
</parameter>
<parameter name="y">
-<parameter_description> new Y position relative to window's parent
+<parameter_description> new Y position relative to window’s parent
</parameter_description>
</parameter>
<parameter name="width">
@@ -16712,7 +16639,7 @@ in the application.
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
+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
@@ -16825,7 +16752,7 @@ use gtk_window_resize() instead of this low-level GDK function.
Windows may not be resized below 1x1.
-If you're also planning to move the window, use gdk_window_move_resize()
+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>
@@ -16888,7 +16815,7 @@ invalidated. The invalidated region may be bigger than what would
strictly be necessary.
For X11, a minimum area will be invalidated if the window has no
-subwindows, or if the edges of the window's parent do not extend
+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.
@@ -16914,7 +16841,7 @@ artifacts and unnecessary invalidations.
<function name="gdk_window_set_accept_focus">
<description>
Setting @accept_focus to %FALSE hints the desktop environment that the
-window doesn't want to receive input focus.
+window doesn’t want to receive input focus.
On X, it is the responsibility of the window manager to interpret this
hint. ICCCM-compliant window manager usually respect it.
@@ -16939,7 +16866,7 @@ Since: 2.4
<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
+you’re an application - or gtk_style_set_background() - if you're
implementing a custom widget.)
See also gdk_window_set_background_pattern().
@@ -17046,7 +16973,7 @@ 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
+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.
@@ -17117,7 +17044,7 @@ 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.
+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
@@ -17138,7 +17065,7 @@ updates sometime after application startup time.
<function name="gdk_window_set_decorations">
<description>
-"Decorations" are the features the window manager adds to a toplevel #GdkWindow.
+“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
@@ -17277,8 +17204,8 @@ press events. The event mask is the bitwise OR of values from the
<function name="gdk_window_set_focus_on_map">
<description>
Setting @focus_on_map to %FALSE hints the desktop environment that the
-window doesn't want to receive input focus when it is mapped.
-focus_on_map should be turned off for windows that aren't triggered
+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
@@ -17317,7 +17244,7 @@ manager to span the @window over these monitors.
If the XINERAMA extension is not available or not usable, this function
has no effect.
-Not all window managers support this, so you can't rely on the fullscreen
+Not all window managers support this, so you can’t rely on the fullscreen
window to span over the multiple monitors when #GDK_FULLSCREEN_ON_ALL_MONITORS
is specified.
@@ -17350,7 +17277,7 @@ 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
+it doesn’t include #GDK_FUNC_ALL, it indicates which functions to
enable.
@@ -17387,7 +17314,7 @@ 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
+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.
@@ -17500,7 +17427,7 @@ is invalidated.
This can be used to record the invalidated region, which is
useful if you are keeping an offscreen copy of some region
and want to keep it up to date. You can also modify the
-invalidated region in case you're doing some effect where
+invalidated region in case you’re doing some effect where
e.g. a child widget appears in multiple places.
Since: 3.10
@@ -17526,8 +17453,8 @@ window was already above, then this function does nothing.
On X11, asks the window manager to keep @window above, if the window
manager supports this operation. Not all window managers support
-this, and some deliberately ignore it or don't have a concept of
-"keep above"; so you can't rely on the window being kept above.
+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.
@@ -17554,8 +17481,8 @@ 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.
+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.
@@ -17667,9 +17594,9 @@ Since: 3.10
<function name="gdk_window_set_override_redirect">
<description>
An override redirect window is not under the control of the window manager.
-This means it won't have a titlebar, won't be minimizable, etc. - it will
+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.
+can’t see the override redirect window at all.
Override redirect should only be used for short-lived temporary
windows, such as popup menus. #GtkMenu uses an override redirect
@@ -17695,13 +17622,13 @@ window in its implementation, for example.
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
+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
+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.
@@ -17726,7 +17653,7 @@ Newer GTK+ windows using client-side decorations use extra geometry
around their frames for effects like shadows and invisible borders.
Window managers that want to maximize windows or snap to edges need
to know where the extents of the actual frame lie, so that users
-don't feel like windows are snapping against random invisible edges.
+don’t feel like windows are snapping against random invisible edges.
Note that this property is automatically updated by GTK+, so this
function should only be used by applications which do not use GTK+
@@ -17765,7 +17692,7 @@ Since: 3.12
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()
+window’s semantic type as specified with gdk_window_set_type_hint()
already fully describes the window, this function should
not be called in addition, instead you should
allow the window to be treated according to standard policy for
@@ -17790,7 +17717,7 @@ Since: 2.2
<function name="gdk_window_set_skip_taskbar_hint">
<description>
Toggles whether a window should appear in a task list or window
-list. If a window's semantic type as specified with
+list. If a window’s semantic type as specified with
gdk_window_set_type_hint() already fully describes the window, this
function should not be called in addition,
instead you should allow the window to be treated according to
@@ -17866,7 +17793,7 @@ Since: 2.12
Set the bit gravity of the given window to static, and flag it so
all children get static subwindow gravity. This is used if you are
implementing scary features that involve deep knowledge of the
-windowing system. Don't worry about it unless you have to.
+windowing system. Don’t worry about it unless you have to.
</description>
@@ -17910,7 +17837,7 @@ Since: 3.0
<function name="gdk_window_set_title">
<description>
Sets the title of a toplevel window, to be displayed in the titlebar.
-If you haven't explicitly set the icon name for the window
+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.
@@ -17936,7 +17863,7 @@ associated with the application window @parent. This allows the
window manager to do things like center @window on @parent and
keep @window above @parent.
-See gtk_window_set_transient_for() if you're using #GtkWindow or
+See gtk_window_set_transient_for() if you’re using #GtkWindow or
#GtkDialog.
</description>
@@ -18067,11 +17994,11 @@ 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
+This function maps a window so it’s visible onscreen. Its opposite
is gdk_window_hide().
When implementing a #GtkWidget, you should call this function on the widget's
-#GdkWindow as part of the "map" method.
+#GdkWindow as part of the “map” method.
</description>
<parameters>
@@ -18091,7 +18018,7 @@ to the top of the window stack.
On the X11 platform, in Xlib terms, this function calls
XMapWindow() (it also updates some internal GDK state, which means
-that you can't really use XMapWindow() directly on a GDK window).
+that you can’t really use XMapWindow() directly on a GDK window).
</description>
<parameters>
@@ -18105,15 +18032,15 @@ that you can't really use XMapWindow() directly on a GDK window).
<function name="gdk_window_stick">
<description>
-"Pins" a window such that it's on all workspaces and does not scroll
+“Pins” a window such that it’s on all workspaces and does not scroll
with viewports, for window managers that have scrollable viewports.
(When using #GtkWindow, gtk_window_stick() may be more useful.)
On the X11 platform, this function depends on window manager
support, so may have no effect with many window managers. However,
GDK will do the best it can to convince the window manager to stick
-the window. For window managers that don't support this operation,
-there's nothing you can do to force it to happen.
+the window. For window managers that don’t support this operation,
+there’s nothing you can do to force it to happen.
</description>
@@ -18166,7 +18093,7 @@ 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
+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.
@@ -18185,13 +18112,13 @@ Since: 2.2
<function name="gdk_window_unmaximize">
<description>
-Unmaximizes the window. If the window wasn't maximized, then this
+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
+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.
@@ -18317,13 +18244,11 @@ Returns the display of a #GdkCursor.
<description>
Returns the device ID as seen by XInput2.
-<note>
-If gdk_disable_multidevice() has been called, this function
-will respectively return 2/3 for the core pointer and keyboard,
-(matching the IDs for the Virtual Core Pointer and Keyboard in
-XInput 2), but calling this function on any slave devices (i.e.
-those managed via XInput 1.x), will return 0.
-</note>
+> If gdk_disable_multidevice() has been called, this function
+> will respectively return 2/3 for the core pointer and keyboard,
+> (matching the IDs for the Virtual Core Pointer and Keyboard in
+> XInput 2), but calling this function on any slave devices (i.e.
+> those managed via XInput 1.x), will return 0.
Since: 3.2
@@ -18357,7 +18282,7 @@ Since: 3.2
</parameter>
</parameters>
<return> The #GdkDevice wrapping the device ID,
-or %NULL if the given ID doesn't currently represent a device.
+or %NULL if the given ID doesn’t currently represent a device.
</return>
</function>
@@ -18369,10 +18294,9 @@ Sends a startup notification message of type @message_type to
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.
+not normally need to call it directly. See the
+[Startup Notification Protocol
specification](http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt)
+for definitions of the message types and keys that can be used.
Since: 2.12
@@ -18404,7 +18328,7 @@ Will XSync() if necessary and will always block until
the error is known to have occurred or not occurred,
so the error code can be returned.
-If you don't need to use the return value,
+If you don’t need to use the return value,
gdk_x11_display_error_trap_pop_ignored() would be more efficient.
See gdk_error_trap_pop() for the all-displays-at-once
@@ -18853,8 +18777,8 @@ Gets the default GTK+ display.
<parameters>
</parameters>
<return> the Xlib Display* for
-the display specified in the <option>--display</option> command
-line option or the <envar>DISPLAY</envar> environment variable.
+the display specified in the `--display` command
+line option or the `DISPLAY` environment variable.
</return>
</function>
@@ -18879,7 +18803,7 @@ result.
<function name="gdk_x11_get_xatom_by_name">
<description>
-Returns the X atom for GDK's default display corresponding to @atom_name.
+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.
@@ -18891,7 +18815,7 @@ faster than XInternAtom(), which is a round trip to the server each time.
</parameter_description>
</parameter>
</parameters>
-<return> a X atom for GDK's default display.
+<return> a X atom for GDK’s default display.
</return>
</function>
@@ -18921,22 +18845,22 @@ Since: 2.2
<function name="gdk_x11_get_xatom_name">
<description>
-Returns the name of an X atom for GDK's default display. This
+Returns the name of an X atom for GDK’s default 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. Also, this function will never return %NULL,
+doesn’t need to be freed. Also, this function will never return %NULL,
even if @xatom is invalid.
</description>
<parameters>
<parameter name="xatom">
-<parameter_description> an X atom for GDK's default display
+<parameter_description> an X atom for GDK’s default display
</parameter_description>
</parameter>
</parameters>
<return> name of the X atom; this string is owned by GTK+,
-so it shouldn't be modifed or freed.
+so it shouldn’t be modifed or freed.
</return>
</function>
@@ -18944,7 +18868,7 @@ so it shouldn't be modifed or freed.
<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
+XAtomName() and gdk_atom_name(), the result doesn’t need to
be freed.
Since: 2.2
@@ -18961,7 +18885,7 @@ Since: 2.2
</parameter>
</parameters>
<return> name of the X atom; this string is owned by GDK,
-so it shouldn't be modifed or freed.
+so it shouldn’t be modifed or freed.
</return>
</function>
@@ -19006,7 +18930,7 @@ Since: 3.6
<function name="gdk_x11_keymap_key_is_modifier">
<description>
Determines whether a particular key code represents a key that
-is a modifier. That is, it's a key that normally just affects
+is a modifier. That is, it’s a key that normally just affects
the keyboard state and the behavior of other keys rather than
producing a direct effect itself. This is only needed for code
processing raw X events, since #GdkEventKey directly includes
@@ -19051,7 +18975,7 @@ Since: 2.2
<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>.
+between @event_base and `event_base + n_events - 1`.
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).
@@ -19087,8 +19011,8 @@ Since: 2.4
<description>
Returns the current workspace for @screen 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>.
+in the
+[Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec) specification.
Since: 3.10
@@ -19132,8 +19056,8 @@ Since: 2.14
<description>
Returns the number of workspaces for @screen 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>.
+in the
+[Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec) specification.
Since: 3.10
@@ -19224,7 +19148,7 @@ Since: 2.2
</parameter>
</parameters>
<return> the #GdkVisual (owned by the screen
-object), or %NULL if the visual ID wasn't found.
+object), or %NULL if the visual ID wasn’t found.
</return>
</function>
@@ -19233,12 +19157,10 @@ object), or %NULL if the visual ID wasn't found.
<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>.
+[Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec) specification.
When using this function, keep in mind that the window manager
-can change over time; so you shouldn't use this function in
+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
@@ -19266,8 +19188,8 @@ Since: 2.2
<function name="gdk_x11_set_sm_client_id">
<description>
-Sets the <literal>SM_CLIENT_ID</literal> property on the application's leader window so that
-the window manager can save the application's state using the X11R6 ICCCM
+Sets the `SM_CLIENT_ID` 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
@@ -19338,7 +19260,7 @@ Since: 2.24
</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.
+will be newly created, if one doesn’t exist already.
</return>
</function>
@@ -19373,7 +19295,7 @@ Returns the X resource (window) belonging to a #GdkWindow.
</parameter_description>
</parameter>
</parameters>
-<return> the ID of @drawable's X resource.
+<return> the ID of @drawable’s X resource.
</return>
</function>
@@ -19405,9 +19327,8 @@ window, or %NULL if there is none.
<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.
+in the [Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec) specification.
+Will not do anything if the window is already on all workspaces.
Since: 2.8
@@ -19425,8 +19346,7 @@ Since: 2.8
<description>
Moves the window to the given workspace when running unde 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>.
+in the [Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec) specification.
Since: 3.10
diff --git a/gtk/src/gtk_docs.xml b/gtk/src/gtk_docs.xml
index d3b11fb..447a005 100644
--- a/gtk/src/gtk_docs.xml
+++ b/gtk/src/gtk_docs.xml
@@ -109,7 +109,7 @@ their visual representation if the @accel_closure is theirs.
Notifies of a change in the global accelerator map.
The path is also used as the detail for the signal,
so it is possible to connect to
-changed::<replaceable>accel_path</replaceable>.
+changed::`accel_path`.
Since: 2.4
@@ -306,7 +306,7 @@ Emitted when the #GtkAdjustment:value property has been changed.
Controls how a widget deals with extra space in a single (x or y)
dimension.
-Alignment only matters if the widget receives a "too large" allocation,
+Alignment only matters if the widget receives a “too large” allocation,
for example if you packed the widget with the #GtkWidget:expand
flag inside a #GtkBox, then the widget might get extra space. If
you have for example a 16x16 icon inside a 32x32 space, the icon
@@ -650,7 +650,7 @@ Note that an assistant needs to end its page flow with a page of type
%GTK_ASSISTANT_PAGE_CONFIRM, %GTK_ASSISTANT_PAGE_SUMMARY or
%GTK_ASSISTANT_PAGE_PROGRESS to be correct.
-The Cancel button will only be shown if the page isn't "committed".
+The Cancel button will only be shown if the page isn’t “committed”.
See gtk_assistant_commit() for details.
</description>
@@ -799,13 +799,13 @@ Error codes that identify various errors that can occur while using
</description>
<parameters>
<parameter name="GTK_BUILDER_ERROR_INVALID_TYPE_FUNCTION">
-<parameter_description> A type-func attribute didn't name
+<parameter_description> A type-func attribute didn’t name
a function that returns a #GType.
</parameter_description>
</parameter>
<parameter name="GTK_BUILDER_ERROR_UNHANDLED_TAG">
<parameter_description> The input contained a tag that #GtkBuilder
-can't handle.
+can’t handle.
</parameter_description>
</parameter>
<parameter name="GTK_BUILDER_ERROR_MISSING_ATTRIBUTE">
@@ -815,12 +815,12 @@ can't handle.
</parameter>
<parameter name="GTK_BUILDER_ERROR_INVALID_ATTRIBUTE">
<parameter_description> #GtkBuilder found an attribute that
-it doesn't understand.
+it doesn’t understand.
</parameter_description>
</parameter>
<parameter name="GTK_BUILDER_ERROR_INVALID_TAG">
<parameter_description> #GtkBuilder found a tag that
-it doesn't understand.
+it doesn’t understand.
</parameter_description>
</parameter>
<parameter name="GTK_BUILDER_ERROR_MISSING_PROPERTY_VALUE">
@@ -829,7 +829,7 @@ missing.
</parameter_description>
</parameter>
<parameter name="GTK_BUILDER_ERROR_INVALID_VALUE">
-<parameter_description> #GtkBuilder couldn't parse
+<parameter_description> #GtkBuilder couldn’t parse
some attribute value.
</parameter_description>
</parameter>
@@ -848,7 +848,7 @@ derived from the type of the composite class being extended with builder XML.
</parameter_description>
</parameter>
<parameter name="GTK_BUILDER_ERROR_TEMPLATE_MISMATCH">
-<parameter_description> The wrong type was specified in a composite class's template XML
+<parameter_description> The wrong type was specified in a composite class’s template XML
</parameter_description>
</parameter>
</parameters>
@@ -1002,11 +1002,10 @@ contains. (See also: #GtkVButtonBox and #GtkHButtonBox).
Prebuilt sets of buttons for the dialog. If
none of these choices are appropriate, simply use %GTK_BUTTONS_NONE
then call gtk_dialog_add_buttons().
-<note>
-Please note that %GTK_BUTTONS_OK, %GTK_BUTTONS_YES_NO
-and %GTK_BUTTONS_OK_CANCEL are discouraged by the
-<ulink url="http://library.gnome.org/devel/hig-book/stable/">GNOME HIG</ulink>.
-</note>
+
+> Please note that %GTK_BUTTONS_OK, %GTK_BUTTONS_YES_NO
+> and %GTK_BUTTONS_OK_CANCEL are discouraged by the
+> [GNOME Human Interface Guidelines](http://library.gnome.org/devel/hig-book/stable/).
</description>
<parameters>
@@ -1366,7 +1365,7 @@ Note that GTK+ doesn't guarantee that cell renderers will
continue to use the same kind of widget for editing in future
releases, therefore you should check the type of @editable
before doing any specific setup, as in the following example:
-|[
+|[<!-- language="C" -->
static void
text_editing_started (GtkCellRenderer *cell,
GtkCellEditable *editable,
@@ -1377,7 +1376,7 @@ if (GTK_IS_ENTRY (editable))
{
GtkEntry *entry = GTK_ENTRY (editable);
-/ * ... create a GtkEntryCompletion * /
+// ... create a GtkEntryCompletion
gtk_entry_set_completion (entry, completion);
}
@@ -1520,8 +1519,8 @@ Identifies how the user can interact with a particular cell.
<parameters>
<parameter name="GTK_CELL_RENDERER_MODE_INERT">
<parameter_description> The cell is just for display
-and cannot be interacted with. Note that this doesn't mean that eg. the
-row being drawn can't be selected -- just that a particular element of
+and cannot be interacted with. Note that this doesn’t mean that eg. the
+row being drawn can’t be selected -- just that a particular element of
it cannot be individually modified.
</parameter_description>
</parameter>
@@ -1756,7 +1755,7 @@ model column.
Here's an example signal handler which fetches data from the model and
displays it in the entry.
-|[
+|[<!-- language="C" -->
static gchar*
format_entry_text_callback (GtkComboBox *combo,
const gchar *path,
@@ -1799,7 +1798,7 @@ for the current GtkComboBox model.
<signal name="GtkComboBox::move-active">
<description>
The ::move-active signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted to move the active selection.
Since: 2.12
@@ -1821,7 +1820,7 @@ Since: 2.12
<signal name="GtkComboBox::popdown">
<description>
The ::popdown signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted to popdown the combo box list.
The default bindings for this signal are Alt+Up and Escape.
@@ -1841,7 +1840,7 @@ Since: 2.12
<signal name="GtkComboBox::popup">
<description>
The ::popup signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted to popup the combo box list.
The default binding for this signal is Alt+Down.
@@ -1957,8 +1956,8 @@ Deprecated.
<enum name="GtkCssSectionType">
<description>
The different types of sections indicate parts of a CSS document as
-parsed by GTK's CSS parser. They are oriented towards the CSS grammar
-<ulink url="http://www.w3.org/TR/CSS21/grammar.html">CSS grammer</ulink>,
+parsed by GTK’s CSS parser. They are oriented towards the
+[CSS Grammar](http://www.w3.org/TR/CSS21/grammar.html),
but may contain extensions.
More types might be added in the future as the parser incorporates
@@ -2006,9 +2005,8 @@ a CSS variable.
</parameter_description>
</parameter>
<parameter name="GTK_CSS_SECTION_KEYFRAMES">
-<parameter_description> The section defines keyframes. See <ulink
-url="http://dev.w3.org/csswg/css3-animations/#keyframes">CSS
-animations</ulink> for details. Since 3.6
+<parameter_description> The section defines keyframes. See [CSS
+Animations](http://dev.w3.org/csswg/css3-animations/#keyframes) for details. Since 3.6
</parameter_description>
</parameter>
</parameters>
@@ -2026,7 +2024,7 @@ See also: #GtkEntry::delete-from-cursor.
</parameter>
<parameter name="GTK_DELETE_WORD_ENDS">
<parameter_description> Delete only the portion of the word to the
-left/right of cursor if we're in the middle of a word.
+left/right of cursor if we’re in the middle of a word.
</parameter_description>
</parameter>
<parameter name="GTK_DELETE_WORDS">
@@ -2071,7 +2069,7 @@ of the user for a drag destination site.
<parameters>
<parameter name="GTK_DEST_DEFAULT_MOTION">
<parameter_description> If set for a widget, GTK+, during a drag over this
-widget will check if the drag matches this widget's list of possible targets
+widget will check if the drag matches this widget’s list of possible targets
and actions.
GTK+ will then call gdk_drag_status() as appropriate.
</parameter_description>
@@ -2084,7 +2082,7 @@ and action are acceptable.
</parameter>
<parameter name="GTK_DEST_DEFAULT_DROP">
<parameter_description> If set for a widget, when a drop occurs, GTK+ will
-will check if the drag matches this widget's list of possible targets and
+will check if the drag matches this widget’s list of possible targets and
actions. If so, GTK+ will call gtk_drag_get_data() on behalf of the widget.
Whether or not the drop is successful, GTK+ will call gtk_drag_finish(). If
the action was a move, then if the drag was successful, then %TRUE will be
@@ -2102,7 +2100,7 @@ be taken.
<signal name="GtkDialog::close">
<description>
The ::close signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted when the user uses a keybinding to close
the dialog.
@@ -2322,7 +2320,7 @@ The ::activate signal is emitted when the user hits
the Enter key.
While this signal is used as a
-<link linkend="keybinding-signals">keybinding signal</link>,
+[keybinding signal][GtkBindingSignal],
it is also commonly used by applications to intercept
activation of entries.
@@ -2341,7 +2339,7 @@ The default bindings for this signal are all forms of the Enter key.
<signal name="GtkEntry::backspace">
<description>
The ::backspace signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted when the user asks for it.
The default bindings for this signal are
@@ -2360,7 +2358,7 @@ Backspace and Shift-Backspace.
<signal name="GtkEntry::copy-clipboard">
<description>
The ::copy-clipboard signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted to copy the selection to the clipboard.
The default bindings for this signal are
@@ -2379,7 +2377,7 @@ Ctrl-c and Ctrl-Insert.
<signal name="GtkEntry::cut-clipboard">
<description>
The ::cut-clipboard signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted to cut the selection to the clipboard.
The default bindings for this signal are
@@ -2398,7 +2396,7 @@ Ctrl-x and Shift-Delete.
<signal name="GtkEntry::delete-from-cursor">
<description>
The ::delete-from-cursor signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted when the user initiates a text deletion.
If the @type is %GTK_DELETE_CHARS, GTK+ deletes the selection
@@ -2480,7 +2478,7 @@ Since: 2.16
<signal name="GtkEntry::insert-at-cursor">
<description>
The ::insert-at-cursor signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted when the user initiates the insertion of a
fixed string at the cursor.
@@ -2503,7 +2501,7 @@ This signal has no default bindings.
<signal name="GtkEntry::move-cursor">
<description>
The ::move-cursor signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted when the user initiates a cursor movement.
If the cursor is not visible in @entry, this signal causes
the viewport to be moved instead.
@@ -2516,11 +2514,9 @@ The default bindings for this signal come in two variants,
the variant with the Shift modifier extends the selection,
the variant without the Shift modifer does not.
There are too many key combinations to list them all here.
-<itemizedlist>
-<listitem>Arrow keys move by individual characters/lines</listitem>
-<listitem>Ctrl-arrow key combinations move by words/paragraphs</listitem>
-<listitem>Home/End keys move to the ends of the buffer</listitem>
-</itemizedlist>
+- Arrow keys move by individual characters/lines
+- Ctrl-arrow key combinations move by words/paragraphs
+- Home/End keys move to the ends of the buffer
</description>
<parameters>
@@ -2547,7 +2543,7 @@ There are too many key combinations to list them all here.
<signal name="GtkEntry::paste-clipboard">
<description>
The ::paste-clipboard signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted to paste the contents of the clipboard
into the text view.
@@ -2630,7 +2626,7 @@ Since: 3.8
<signal name="GtkEntry::toggle-overwrite">
<description>
The ::toggle-overwrite signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted to toggle the overwrite mode of the entry.
The default bindings for this signal is Insert.
@@ -2880,9 +2876,10 @@ On the other hand, if it determines that the stock confirmation
dialog should be used, it should return
%GTK_FILE_CHOOSER_CONFIRMATION_CONFIRM. The following example
illustrates this.
-<example id="gtkfilechooser-confirmation">
-<title>Custom confirmation</title>
-<programlisting>
+
+## Custom confirmation ## {#gtkfilechooser-confirmation}
+
+|[<!-- language="C" -->
static GtkFileChooserConfirmation
confirm_overwrite_callback (GtkFileChooser *chooser, gpointer data)
{
@@ -2912,8 +2909,7 @@ if (gtk_dialog_run (chooser) == GTK_RESPONSE_ACCEPT)
save_to_file (gtk_file_chooser_get_filename (GTK_FILE_CHOOSER (chooser));
gtk_widget_destroy (chooser);
-</programlisting>
-</example>
+]|
Since: 2.8
@@ -2960,7 +2956,7 @@ gtk_file_chooser_get_current_folder_uri().
<description>
This signal is emitted when the user "activates" a file in the file
chooser. This can happen by double-clicking on a file in the file list, or
-by pressing <keycap>Enter</keycap>.
+by pressing `Enter`.
Normally you do not need to connect to this signal. It is used internally
by #GtkFileChooserDialog to know when to activate the default button in the
@@ -3023,7 +3019,8 @@ Your widget may not be able to preview all kinds of files; your callback
must call gtk_file_chooser_set_preview_widget_active() to inform the file
chooser about whether the preview was generated successfully or not.
-Please see the example code in <xref linkend="gtkfilechooser-preview"/>.
+Please see the example code in
+[Using a Preview Widget][gtkfilechooser-preview].
See also: gtk_file_chooser_set_preview_widget(),
gtk_file_chooser_set_preview_widget_active(),
@@ -3098,7 +3095,7 @@ Since: 2.12
Used as a return value of handlers for the
#GtkFileChooser::confirm-overwrite signal of a #GtkFileChooser. This
value determines whether the file chooser will present the stock
-confirmation dialog, accept the user's choice of a filename, or
+confirmation dialog, accept the user’s choice of a filename, or
let the user choose another filename.
Since: 2.8
@@ -3112,7 +3109,7 @@ its stock dialog to confirm about overwriting an existing file.
</parameter>
<parameter name="GTK_FILE_CHOOSER_CONFIRMATION_ACCEPT_FILENAME">
<parameter_description> The file chooser will
-terminate and accept the user's choice of a file name.
+terminate and accept the user’s choice of a file name.
</parameter_description>
</parameter>
<parameter name="GTK_FILE_CHOOSER_CONFIRMATION_SELECT_AGAIN">
@@ -3150,6 +3147,263 @@ adding a bookmark).
</parameters>
</enum>
+<signal name="GtkFileChooserWidget::desktop-folder">
+<description>
+The ::desktop-folder signal is a
+[keybinding signal][GtkBindingSignal]
+which gets emitted when the user asks for it.
+
+This is used to make the file chooser show the user's Desktop
+folder in the file list.
+
+The default binding for this signal is `Alt + D`.
+
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> the object which received the signal.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="GtkFileChooserWidget::down-folder">
+<description>
+The ::down-folder signal is a
+[keybinding signal][GtkBindingSignal]
+which gets emitted when the user asks for it.
+
+This is used to make the file chooser go to a child of the
+current folder in the file hierarchy. The subfolder that
+will be used is displayed in the path bar widget of the file
+chooser. For example, if the path bar is showing
+"/foo/bar/baz", with bar currently displayed, then this will cause
+the file chooser to switch to the "baz" subfolder.
+
+The default binding for this signal is `Alt + Down`.
+
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> the object which received the signal.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="GtkFileChooserWidget::home-folder">
+<description>
+The ::home-folder signal is a
+[keybinding signal][GtkBindingSignal]
+which gets emitted when the user asks for it.
+
+This is used to make the file chooser show the user's home
+folder in the file list.
+
+The default binding for this signal is `Alt + Home`.
+
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> the object which received the signal.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="GtkFileChooserWidget::location-popup">
+<description>
+The ::location-popup signal is a
+[keybinding signal][GtkBindingSignal]
+which gets emitted when the user asks for it.
+
+This is used to make the file chooser show a "Location"
+prompt which the user can use to manually type the name of
+the file he wishes to select.
+
+The default bindings for this signal are
+`Control + L`
+with a @path string of "" (the empty
+string). It is also bound to `/` with a
+ path string of "`/`"
+(a slash): this lets you type `/` and
+immediately type a path name. On Unix systems, this is bound to
+`~` (tilde) with a @path string
+of "~" itself for access to home directories.
+
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> the object which received the signal.
+</parameter_description>
+</parameter>
+<parameter name="path">
+<parameter_description> a string that gets put in the text entry for the file
+name.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="GtkFileChooserWidget::location-popup-on-paste">
+<description>
+The ::location-popup-on-paste signal is a
+[keybinding signal][GtkBindingSignal]
+which gets emitted when the user asks for it.
+
+This is used to make the file chooser show a "Location"
+prompt when the user pastes #GtkFileChooserWidget.
+
+The default binding for this signal is `Control + V`.
+
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> the object which received the signal.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="GtkFileChooserWidget::location-toggle-popup">
+<description>
+The ::location-toggle-popup signal is a
+[keybinding signal][GtkBindingSignal]
+which gets emitted when the user asks for it.
+
+This is used to toggle the visibility of a "Location"
+prompt which the user can use to manually type the name of
+the file he wishes to select.
+
+The default binding for this signal is `Control + L`.
+
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> the object which received the signal.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="GtkFileChooserWidget::quick-bookmark">
+<description>
+The ::quick-bookmark signal is a
+[keybinding signal][GtkBindingSignal]
+which gets emitted when the user asks for it.
+
+This is used to make the file chooser switch to the bookmark
+specified in the @bookmark_index parameter.
+For example, if you have three bookmarks, you can pass 0, 1, 2 to
+this signal to switch to each of them, respectively.
+
+The default binding for this signal is `Alt + 1`, `Alt + 2`,
+etc. until `Alt + 0`. Note that in the default binding, that
+`Alt + 1` is actually defined to switch to the bookmark at index
+0, and so on successively; `Alt + 0` is defined to switch to the
+bookmark at index 10.
+
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> the object which received the signal.
+</parameter_description>
+</parameter>
+<parameter name="bookmark_index">
+<parameter_description> the number of the bookmark to switch to
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="GtkFileChooserWidget::recent-shortcut">
+<description>
+The ::recent-shortcut signal is a
+[keybinding signal][GtkBindingSignal]
+which gets emitted when the user asks for it.
+
+This is used to make the file chooser show the Recent location.
+
+The default binding for this signal is `Alt + R`.
+
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> the object which received the signal.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="GtkFileChooserWidget::search-shortcut">
+<description>
+The ::search-shortcut signal is a
+[keybinding signal][GtkBindingSignal]
+which gets emitted when the user asks for it.
+
+This is used to make the file chooser show the search entry.
+
+The default binding for this signal is `Alt + S`.
+
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> the object which received the signal.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="GtkFileChooserWidget::show-hidden">
+<description>
+The ::show-hidden signal is a
+[keybinding signal][GtkBindingSignal]
+which gets emitted when the user asks for it.
+
+This is used to make the file chooser display hidden files.
+
+The default binding for this signal is `Control + H`.
+
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> the object which received the signal.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
+<signal name="GtkFileChooserWidget::up-folder">
+<description>
+The ::up-folder signal is a
+[keybinding signal][GtkBindingSignal]
+which gets emitted when the user asks for it.
+
+This is used to make the file chooser go to the parent of
+the current folder in the file hierarchy.
+
+The default binding for this signal is `Alt + Up`.
+
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> the object which received the signal.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</signal>
+
<enum name="GtkFileFilterFlags">
<description>
These flags indicate what parts of a #GtkFileFilterInfo struct
@@ -3180,7 +3434,7 @@ display the file in the file chooser
<signal name="GtkFlowBox::activate-cursor-child">
<description>
The ::activate-cursor-child signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted when the user activates the @box.
</description>
@@ -3215,7 +3469,7 @@ activated by the user.
<signal name="GtkFlowBox::move-cursor">
<description>
The ::move-cursor signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted when the user initiates a cursor movement.
If the cursor is not visible in @text_view, this signal causes
the viewport to be moved instead.
@@ -3228,11 +3482,9 @@ The default bindings for this signal come in two variants,
the variant with the Shift modifier extends the selection,
the variant without the Shift modifer does not.
There are too many key combinations to list them all here.
-<itemizedlist>
-<listitem>Arrow keys move by individual children</listitem>
-<listitem>Home/End keys move to the ends of the box</listitem>
-<listitem>PageUp/PageDown keys move vertically by pages</listitem>
-</itemizedlist>
+- Arrow keys move by individual children
+- Home/End keys move to the ends of the box
+- PageUp/PageDown keys move vertically by pages
</description>
<parameters>
@@ -3255,7 +3507,7 @@ There are too many key combinations to list them all here.
<signal name="GtkFlowBox::select-all">
<description>
The ::select-all signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted to select all children of the box, if
the selection mode permits it.
@@ -3293,7 +3545,7 @@ selected children.
<signal name="GtkFlowBox::toggle-cursor-child">
<description>
The ::toggle-cursor-child signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which toggles the selection of the child that has the focus.
The default binding for this signal is Ctrl-Space.
@@ -3311,7 +3563,7 @@ The default binding for this signal is Ctrl-Space.
<signal name="GtkFlowBox::unselect-all">
<description>
The ::unselect-all signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted to unselect all children of the box, if
the selection mode permits it.
@@ -3334,7 +3586,7 @@ a child widget in a #GtkFlowBox, either by clicking or
double-clicking, or by using the Space or Enter key.
While this signal is used as a
-<link linkend="keybinding-signals">keybinding signal</link>,
+[keybinding signal][GtkBindingSignal],
it can be used by applications for their own purposes.
</description>
@@ -3610,7 +3862,7 @@ supports them. Cannot be used together with %GTK_ICON_LOOKUP_FORCE_SVG.
</parameter>
<parameter name="GTK_ICON_LOOKUP_FORCE_SVG">
<parameter_description> Get SVG icons, even if gdk-pixbuf
-doesn't support them.
+doesn’t support them.
Cannot be used together with %GTK_ICON_LOOKUP_NO_SVG.
</parameter_description>
</parameter>
@@ -3707,7 +3959,7 @@ Error codes for GtkIconTheme operations.
<signal name="GtkIconView::activate-cursor-item">
<description>
-A <link linkend="keybinding-signals">keybinding signal</link>
+A [keybinding signal][GtkBindingSignal]
which gets emitted when the user activates the currently
focused item.
@@ -3754,7 +4006,7 @@ Space, Return or Enter is pressed.
<signal name="GtkIconView::move-cursor">
<description>
The ::move-cursor signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted when the user initiates a cursor movement.
Applications should not connect to it, but may emit it with
@@ -3762,12 +4014,9 @@ g_signal_emit_by_name() if they need to control the cursor
programmatically.
The default bindings for this signal include
-<itemizedlist>
-<listitem>Arrow keys which move by individual steps</listitem>
-<listitem>Home/End keys which move to the first/last item</listitem>
-<listitem>PageUp/PageDown which move by "pages"</listitem>
-</itemizedlist>
-
+- Arrow keys which move by individual steps
+- Home/End keys which move to the first/last item
+- PageUp/PageDown which move by "pages"
All of these will extend the selection when combined with
the Shift modifier.
@@ -3791,7 +4040,7 @@ the Shift modifier.
<signal name="GtkIconView::select-all">
<description>
-A <link linkend="keybinding-signals">keybinding signal</link>
+A [keybinding signal][GtkBindingSignal]
which gets emitted when the user selects all items.
Applications should not connect to it, but may emit it with
@@ -3812,7 +4061,7 @@ The default binding for this signal is Ctrl-a.
<signal name="GtkIconView::select-cursor-item">
<description>
-A <link linkend="keybinding-signals">keybinding signal</link>
+A [keybinding signal][GtkBindingSignal]
which gets emitted when the user selects the item that is currently
focused.
@@ -3849,7 +4098,7 @@ The ::selection-changed signal is emitted when the selection
<signal name="GtkIconView::toggle-cursor-item">
<description>
-A <link linkend="keybinding-signals">keybinding signal</link>
+A [keybinding signal][GtkBindingSignal]
which gets emitted when the user toggles whether the currently
focused item is selected or not. The exact effect of this
depend on the selection mode.
@@ -3872,7 +4121,7 @@ There is no default binding for this signal is Ctrl-Space.
<signal name="GtkIconView::unselect-all">
<description>
-A <link linkend="keybinding-signals">keybinding signal</link>
+A [keybinding signal][GtkBindingSignal]
which gets emitted when the user unselects all items.
Applications should not connect to it, but may emit it with
@@ -3945,8 +4194,7 @@ functions), but they will all return %NULL values.
</parameter_description>
</parameter>
<parameter name="GTK_IMAGE_STOCK">
-<parameter_description> the widget contains a stock icon name (see
-<xref linkend="gtk3-Stock-Items"/>)
+<parameter_description> the widget contains a [stock item name][gtkstock]
</parameter_description>
</parameter>
<parameter name="GTK_IMAGE_ICON_SET">
@@ -3978,7 +4226,7 @@ This image type was added in GTK+ 3.10
<signal name="GtkInfoBar::close">
<description>
The ::close signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted when the user uses a keybinding to dismiss
the info bar.
@@ -4088,10 +4336,10 @@ it specified a purpose.
The difference between @GTK_INPUT_PURPOSE_DIGITS and
@GTK_INPUT_PURPOSE_NUMBER is that the former accepts only digits
while the latter also some punctuation (like commas or points, plus,
-minus) and 'e' or 'E' as in 3.14E+000.
+minus) and “e” or “E” as in 3.14E+000.
This enumeration may be extended in the future; input methods should
-interpret unknown values as 'free form'.
+interpret unknown values as “free form”.
Since: 3.6
@@ -4213,7 +4461,7 @@ Used for justifying the text inside a #GtkLabel widget. (See also
<signal name="GtkLabel::activate-current-link">
<description>
-A <link linkend="keybinding-signals">keybinding signal</link>
+A [keybinding signal][GtkBindingSignal]
which gets emitted when the user activates a link in the label.
Applications may also emit the signal with g_signal_emit_by_name()
@@ -4260,7 +4508,7 @@ Since: 2.18
<signal name="GtkLabel::copy-clipboard">
<description>
The ::copy-clipboard signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted to copy the selection to the clipboard.
The default binding for this signal is Ctrl-c.
@@ -4278,7 +4526,7 @@ The default binding for this signal is Ctrl-c.
<signal name="GtkLabel::move-cursor">
<description>
The ::move-cursor signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted when the user initiates a cursor movement.
If the cursor is not visible in @entry, this signal causes
the viewport to be moved instead.
@@ -4291,11 +4539,9 @@ The default bindings for this signal come in two variants,
the variant with the Shift modifier extends the selection,
the variant without the Shift modifer does not.
There are too many key combinations to list them all here.
-<itemizedlist>
-<listitem>Arrow keys move by individual characters/lines</listitem>
-<listitem>Ctrl-arrow key combinations move by words/paragraphs</listitem>
-<listitem>Home/End keys move to the ends of the buffer</listitem>
-</itemizedlist>
+- Arrow keys move by individual characters/lines
+- Ctrl-arrow key combinations move by words/paragraphs
+- Home/End keys move to the ends of the buffer
</description>
<parameters>
@@ -4787,7 +5033,7 @@ The type of message being displayed in the dialog.
</parameter_description>
</parameter>
<parameter name="GTK_MESSAGE_OTHER">
-<parameter_description> None of the above, doesn't get an icon
+<parameter_description> None of the above, doesn’t get an icon
</parameter_description>
</parameter>
</parameters>
@@ -4984,35 +5230,35 @@ multiple pages per sheet.
</description>
<parameters>
<parameter name="GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_TOP_TO_BOTTOM">
-<parameter_description> <inlinegraphic valign="middle" fileref="layout-lrtb.png"
format="PNG"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_BOTTOM_TO_TOP">
-<parameter_description> <inlinegraphic valign="middle" fileref="layout-lrbt.png"
format="PNG"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GTK_NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_TOP_TO_BOTTOM">
-<parameter_description> <inlinegraphic valign="middle" fileref="layout-rltb.png"
format="PNG"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GTK_NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_BOTTOM_TO_TOP">
-<parameter_description> <inlinegraphic valign="middle" fileref="layout-rlbt.png"
format="PNG"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GTK_NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_LEFT_TO_RIGHT">
-<parameter_description> <inlinegraphic valign="middle" fileref="layout-tblr.png"
format="PNG"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GTK_NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_RIGHT_TO_LEFT">
-<parameter_description> <inlinegraphic valign="middle" fileref="layout-tbrl.png"
format="PNG"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GTK_NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_LEFT_TO_RIGHT">
-<parameter_description> <inlinegraphic valign="middle" fileref="layout-btlr.png"
format="PNG"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
<parameter name="GTK_NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_RIGHT_TO_LEFT">
-<parameter_description> <inlinegraphic valign="middle" fileref="layout-btrl.png"
format="PNG"></inlinegraphic>
+<parameter_description> 
</parameter_description>
</parameter>
</parameters>
@@ -5165,7 +5411,7 @@ See also gtk_print_job_set_page_set().
<signal name="GtkPaned::accept-position">
<description>
The ::accept-position signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted to accept the current position of the handle when
moving it using key bindings.
@@ -5186,7 +5432,7 @@ Since: 2.0
<signal name="GtkPaned::cancel-position">
<description>
The ::cancel-position signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted to cancel moving the position of the handle using key
bindings. The position of the handle will be reset to the value prior to
moving it.
@@ -5208,7 +5454,7 @@ Since: 2.0
<signal name="GtkPaned::cycle-child-focus">
<description>
The ::cycle-child-focus signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted to cycle the focus between the children of the paned.
The default binding is f6.
@@ -5232,7 +5478,7 @@ Since: 2.0
<signal name="GtkPaned::cycle-handle-focus">
<description>
The ::cycle-handle-focus signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted to cycle whether the paned should grab focus to allow
the user to change position of the handle by using key bindings.
@@ -5257,7 +5503,7 @@ Since: 2.0
<signal name="GtkPaned::move-handle">
<description>
The ::move-handle signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted to move the handle when the user is using key bindings
to move it.
@@ -5280,7 +5526,7 @@ Since: 2.0
<signal name="GtkPaned::toggle-handle-focus">
<description>
The ::toggle-handle-focus is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted to accept the current position of the handle and then
move focus to the next widget in the focus chain.
@@ -5908,7 +6154,7 @@ Since: 2.10
Emitted for every page that is printed. The signal handler
must render the @page_nr's page onto the cairo context obtained
from @context using gtk_print_context_get_cairo_context().
-|[
+|[<!-- language="C" -->
static void
draw_page (GtkPrintOperation *operation,
GtkPrintContext *context,
@@ -6390,7 +6636,7 @@ Flags that affect the operation of queueing a widget for resize.
<parameter name="GTK_QUEUE_RESIZE_INVALIDATE_ONLY">
<parameter_description> invalidate all cached sizes
as we would normally do when a widget is queued for resize,
-but don't actually add the toplevel resize container to the
+but don’t actually add the toplevel resize container to the
resize queue. Useful if we want to change the size of a widget
see how that would affect the overall layout, then restore
the old size.
@@ -6740,7 +6986,7 @@ Deprecated: 3.0: Use #GtkCssProvider instead.
This signal is emitted when the user "activates" a recent item
in the recent chooser. This can happen by double-clicking on an item
in the recently used resources list, or by pressing
-<keycap>Enter</keycap>.
+`Enter`.
Since: 2.10
@@ -7096,12 +7342,12 @@ Connect a signal handler which returns an allocated string representing
Here's an example signal handler which displays a value 1.0 as
with "-->1.0<--".
-|[
+|[<!-- language="C" -->
static gchar*
format_value_callback (GtkScale *scale,
gdouble value)
{
-return g_strdup_printf ("-->%0.*g<--",
+return g_strdup_printf ("-->\%0.*g<--",
gtk_scale_get_digits (scale), value);
}
]|
@@ -7125,7 +7371,7 @@ gtk_scale_get_digits (scale), value);
<signal name="GtkScaleButton::popdown">
<description>
The ::popdown signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted to popdown the scale widget.
The default binding for this signal is Escape.
@@ -7145,7 +7391,7 @@ Since: 2.12
<signal name="GtkScaleButton::popup">
<description>
The ::popup signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted to popup the scale widget.
The default bindings for this signal are Space, Enter and Return.
@@ -7309,15 +7555,12 @@ the scrolled window adjustments in a given orientation.
<signal name="GtkScrolledWindow::move-focus-out">
<description>
The ::move-focus-out signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
-which gets emitted when focus is moved away from the scrolled
-window by a keybinding.
-The #GtkWidget::move-focus signal is emitted with @direction_type
-on this scrolled windows toplevel parent in the container hierarchy.
-The default bindings for this signal are
-<keycombo><keycap>Tab</keycap><keycap>Ctrl</keycap></keycombo>
-and
-<keycombo><keycap>Tab</keycap><keycap>Ctrl</keycap><keycap>Shift</keycap></keycombo>.
+[keybinding signal][GtkBindingSignal] which gets
+emitted when focus is moved away from the scrolled window by a
+keybinding. The #GtkWidget::move-focus signal is emitted with
+ direction_type on this scrolled windows toplevel parent in the
+container hierarchy. The default bindings for this signal are
+`Tab + Ctrl` and `Tab + Ctrl + Shift`.
</description>
<parameters>
@@ -7337,7 +7580,7 @@ and
<signal name="GtkScrolledWindow::scroll-child">
<description>
The ::scroll-child signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted when a keybinding that scrolls is pressed.
The horizontal or vertical adjustment is updated which triggers a
signal that the scrolled windows child may listen to and scroll itself.
@@ -7395,9 +7638,9 @@ Used to control what selections users are allowed to make.
<parameter name="GTK_SELECTION_BROWSE">
<parameter_description> Exactly one element is selected.
In some circumstances, such as initially or during a search
-operation, it's possible for no element to be selected with
+operation, it’s possible for no element to be selected with
%GTK_SELECTION_BROWSE. What is really enforced is that the user
-can't deselect a currently selected element except by selecting
+can’t deselect a currently selected element except by selecting
another element.
</parameter_description>
</parameter>
@@ -7531,7 +7774,7 @@ width-for-height geometry management.
</parameter_description>
</parameter>
<parameter name="GTK_SIZE_REQUEST_CONSTANT_SIZE">
-<parameter_description> Don't trade height-for-width or width-for-height
+<parameter_description> Don’t trade height-for-width or width-for-height
</parameter_description>
</parameter>
</parameters>
@@ -7617,8 +7860,8 @@ was not handled, and %GTK_INPUT_ERROR if the conversion failed.
<description>
The ::output signal can be used to change to formatting
of the value that is displayed in the spin buttons entry.
-|[
-/ * show leading zeros * /
+|[<!-- language="C" -->
+// show leading zeros
static gboolean
on_output (GtkSpinButton *spin,
gpointer data)
@@ -7898,7 +8141,7 @@ unresponsive to user actions.
</parameter>
<parameter name="GTK_STATE_INCONSISTENT">
<parameter_description> The widget is inconsistent, such as checkbuttons
-or radiobuttons that aren't either set to %TRUE nor %FALSE,
+or radiobuttons that aren’t either set to %TRUE nor %FALSE,
or buttons requiring the user attention.
</parameter_description>
</parameter>
@@ -8623,11 +8866,11 @@ gtk_text_buffer_remove_tag().
<enum name="GtkTextBufferTargetInfo">
<description>
-These values are used as "info" for the targets contained in the
+These values are used as “info” for the targets contained in the
lists returned by gtk_text_buffer_get_copy_target_list() and
gtk_text_buffer_get_paste_target_list().
-The values counts down from <literal>-1</literal> to avoid clashes
+The values counts down from `-1` to avoid clashes
with application added drag destinations which usually start at 0.
</description>
@@ -8784,7 +9027,7 @@ event. %FALSE to propagate the event further.
<signal name="GtkTextView::backspace">
<description>
The ::backspace signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted when the user asks for it.
The default bindings for this signal are
@@ -8803,7 +9046,7 @@ Backspace and Shift-Backspace.
<signal name="GtkTextView::copy-clipboard">
<description>
The ::copy-clipboard signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted to copy the selection to the clipboard.
The default bindings for this signal are
@@ -8822,7 +9065,7 @@ Ctrl-c and Ctrl-Insert.
<signal name="GtkTextView::cut-clipboard">
<description>
The ::cut-clipboard signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted to cut the selection to the clipboard.
The default bindings for this signal are
@@ -8841,7 +9084,7 @@ Ctrl-x and Shift-Delete.
<signal name="GtkTextView::delete-from-cursor">
<description>
The ::delete-from-cursor signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted when the user initiates a text deletion.
If the @type is %GTK_DELETE_CHARS, GTK+ deletes the selection
@@ -8874,7 +9117,7 @@ backwords.
<signal name="GtkTextView::insert-at-cursor">
<description>
The ::insert-at-cursor signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted when the user initiates the insertion of a
fixed string at the cursor.
@@ -8897,7 +9140,7 @@ This signal has no default bindings.
<signal name="GtkTextView::move-cursor">
<description>
The ::move-cursor signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted when the user initiates a cursor movement.
If the cursor is not visible in @text_view, this signal causes
the viewport to be moved instead.
@@ -8910,13 +9153,11 @@ The default bindings for this signal come in two variants,
the variant with the Shift modifier extends the selection,
the variant without the Shift modifer does not.
There are too many key combinations to list them all here.
-<itemizedlist>
-<listitem>Arrow keys move by individual characters/lines</listitem>
-<listitem>Ctrl-arrow key combinations move by words/paragraphs</listitem>
-<listitem>Home/End keys move to the ends of the buffer</listitem>
-<listitem>PageUp/PageDown keys move vertically by pages</listitem>
-<listitem>Ctrl-PageUp/PageDown keys move horizontally by pages</listitem>
-</itemizedlist>
+- Arrow keys move by individual characters/lines
+- Ctrl-arrow key combinations move by words/paragraphs
+- Home/End keys move to the ends of the buffer
+- PageUp/PageDown keys move vertically by pages
+- Ctrl-PageUp/PageDown keys move horizontally by pages
</description>
<parameters>
@@ -8943,7 +9184,7 @@ There are too many key combinations to list them all here.
<signal name="GtkTextView::move-viewport">
<description>
The ::move-viewport signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which can be bound to key combinations to allow the user
to move the viewport, i.e. change what part of the text view
is visible in a containing scrolled window.
@@ -8971,7 +9212,7 @@ There are no default bindings for this signal.
<signal name="GtkTextView::paste-clipboard">
<description>
The ::paste-clipboard signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted to paste the contents of the clipboard
into the text view.
@@ -9047,7 +9288,7 @@ Since: 2.20
<signal name="GtkTextView::select-all">
<description>
The ::select-all signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted to select or unselect the complete
contents of the text view.
@@ -9071,7 +9312,7 @@ for selecting and Shift-Ctrl-a and Ctrl-\ for unselecting.
<signal name="GtkTextView::set-anchor">
<description>
The ::set-anchor signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted when the user initiates setting the "anchor"
mark. The "anchor" mark gets placed at the same position as the
"insert" mark.
@@ -9091,7 +9332,7 @@ This signal has no default bindings.
<signal name="GtkTextView::toggle-cursor-visible">
<description>
The ::toggle-cursor-visible signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted to toggle the visibility of the cursor.
The default binding for this signal is F7.
@@ -9109,7 +9350,7 @@ The default binding for this signal is F7.
<signal name="GtkTextView::toggle-overwrite">
<description>
The ::toggle-overwrite signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted to toggle the overwrite mode of the text view.
The default bindings for this signal is Insert.
@@ -9223,20 +9464,17 @@ or activated with the keyboard.
This signal is emitted when the toolbar needs information from @tool_item
about whether the item should appear in the toolbar overflow menu. In
response the tool item should either
-<itemizedlist>
-<listitem>call gtk_tool_item_set_proxy_menu_item() with a %NULL
+
+- call gtk_tool_item_set_proxy_menu_item() with a %NULL
pointer and return %TRUE to indicate that the item should not appear
in the overflow menu
-</listitem>
-<listitem> call gtk_tool_item_set_proxy_menu_item() with a new menu
+
+- call gtk_tool_item_set_proxy_menu_item() with a new menu
item and return %TRUE, or
-</listitem>
-<listitem> return %FALSE to indicate that the signal was not
-handled by the item. This means that
-the item will not appear in the overflow menu unless a later handler
-installs a menu item.
-</listitem>
-</itemizedlist>
+
+- return %FALSE to indicate that the signal was not handled by the item.
+This means that the item will not appear in the overflow menu unless
+a later handler installs a menu item.
The toolbar may cache the result of this signal. When the tool item changes
how it will respond to this signal it must call gtk_tool_item_rebuild_menu()
@@ -9260,12 +9498,10 @@ menu.
This signal is emitted when some property of the toolbar that the
item is a child of changes. For custom subclasses of #GtkToolItem,
the default handler of this signal use the functions
-<itemizedlist>
-<listitem>gtk_tool_shell_get_orientation()</listitem>
-<listitem>gtk_tool_shell_get_style()</listitem>
-<listitem>gtk_tool_shell_get_icon_size()</listitem>
-<listitem>gtk_tool_shell_get_relief_style()</listitem>
-</itemizedlist>
+- gtk_tool_shell_get_orientation()
+- gtk_tool_shell_get_style()
+- gtk_tool_shell_get_icon_size()
+- gtk_tool_shell_get_relief_style()
to find out what the toolbar should look like and change
themselves accordingly.
@@ -9408,7 +9644,7 @@ Whether spacers are vertical lines or just blank.
<enum name="GtkToolbarStyle">
<description>
Used to customize the appearance of a #GtkToolbar. Note that
-setting the toolbar style overrides the user's preferences
+setting the toolbar style overrides the user’s preferences
for the default toolbar style. Note that if the button has only
a label set and GTK_TOOLBAR_ICONS is used, the label will be
visible, and vice versa.
@@ -9560,7 +9796,7 @@ have been reordered, or %NULL if the depth of @path is 0
<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>
+i.e. @new_order`[newpos] = oldpos`
</parameter_description>
</parameter>
</parameters>
@@ -9652,6 +9888,45 @@ The position of the cursor (focused cell) has changed.
<return></return>
</signal>
+<signal name="GtkTreeView::move-cursor">
+<description>
+The #GtkTreeView::move-cursor signal is a [keybinding
+signal][GtkBindingSignal] which gets emitted when the user
+presses one of the cursor keys.
+
+Applications should not connect to it, but may emit it with
+g_signal_emit_by_name() if they need to control the cursor
+programmatically. In contrast to gtk_tree_view_set_cursor() and
+gtk_tree_view_set_cursor_on_cell() when moving horizontally
+#GtkTreeView::move-cursor does not reset the current selection.
+
+
+</description>
+<parameters>
+<parameter name="tree_view">
+<parameter_description> the object on which the signal is emitted.
+</parameter_description>
+</parameter>
+<parameter name="step">
+<parameter_description> the granularity of the move, as a
+#GtkMovementStep. %GTK_MOVEMENT_LOGICAL_POSITIONS,
+%GTK_MOVEMENT_VISUAL_POSITIONS, %GTK_MOVEMENT_DISPLAY_LINES,
+%GTK_MOVEMENT_PAGES and %GTK_MOVEMENT_BUFFER_ENDS are
+supported. %GTK_MOVEMENT_LOGICAL_POSITIONS and
+%GTK_MOVEMENT_VISUAL_POSITIONS are treated identically.
+</parameter_description>
+</parameter>
+<parameter name="direction">
+<parameter_description> the direction to move: +1 to move forwards;
+-1 to move backwards. The resulting movement is
+undefined for all other values.
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if @step is supported, %FALSE otherwise.
+</return>
+</signal>
+
<signal name="GtkTreeView::row-activated">
<description>
The "row-activated" signal is emitted when the method
@@ -9662,8 +9937,9 @@ the "activate-on-single-click" property set to %TRUE. It is also
emitted when a non-editable row is selected and one of the keys:
Space, Shift+Space, Return or Enter is pressed.
-For selection handling refer to the <link linkend="TreeWidget">tree
-widget conceptual overview</link> as well as #GtkTreeSelection.
+For selection handling refer to the
+[tree widget conceptual overview][TreeWidget]
+as well as #GtkTreeSelection.
</description>
<parameters>
@@ -10054,7 +10330,7 @@ Deprecated: 3.10
</parameter>
<parameter name="GTK_UI_MANAGER_POPUP_WITH_ACCELS">
<parameter_description> Same as %GTK_UI_MANAGER_POPUP, but the
-actions' accelerators are shown.
+actions’ accelerators are shown.
</parameter_description>
</parameter>
</parameters>
@@ -10181,7 +10457,7 @@ for determining whether an accelerator can be activated.
<signal name="GtkWidget::child-notify">
<description>
The ::child-notify signal is emitted for each
-<link linkend="child-properties">child property</link> that has
+[child property][child-properties] that has
changed on an object. The signal's detail holds the property name.
</description>
@@ -10201,7 +10477,7 @@ changed on an object. The signal's detail holds the property name.
<signal name="GtkWidget::composited-changed">
<description>
The ::composited-changed signal is emitted when the composited
-status of @widget<!-- -->s screen changes.
+status of @widgets screen changes.
See gdk_screen_is_composited().
</description>
@@ -10453,7 +10729,7 @@ The handler may inspect the selected action with
gdk_drag_context_get_selected_action() before calling
gtk_drag_finish(), e.g. to implement %GDK_ACTION_ASK as
shown in the following example:
-|[
+|[<!-- language="C" -->
void
drag_data_received (GtkWidget *widget,
GdkDragContext *context,
@@ -10467,7 +10743,7 @@ if ((data->length >= 0) && (data->format == 8))
{
GdkDragAction action;
-/ * handle data here * /
+// handle data here
action = gdk_drag_context_get_selected_action (context);
if (action == GDK_ACTION_ASK)
@@ -10676,7 +10952,7 @@ keep track of whether he has received any drag-motion signals since the
last #GtkWidget::drag-leave and if not, treat the drag-motion signal as
an "enter" signal. Upon an "enter", the handler will typically highlight
the drop site with gtk_drag_highlight().
-|[
+|[<!-- language="C" -->
static void
drag_motion (GtkWidget *widget,
GdkDragContext *context,
@@ -10699,7 +10975,8 @@ if (target == GDK_NONE)
gdk_drag_status (context, 0, time);
else
{
-private_data->pending_status = gdk_drag_context_get_suggested_action (context);
+private_data->pending_status
+= gdk_drag_context_get_suggested_action (context);
gtk_drag_get_data (widget, context, target, time);
}
@@ -10721,20 +10998,22 @@ if (private_data->suggested_action)
{
private_data->suggested_action = 0;
-/ * We are getting this data due to a request in drag_motion,
-* rather than due to a request in drag_drop, so we are just
-* supposed to call gdk_drag_status(), not actually paste in
-* the data.
-* /
+// We are getting this data due to a request in drag_motion,
+// rather than due to a request in drag_drop, so we are just
+// supposed to call gdk_drag_status(), not actually paste in
+// the data.
+
str = gtk_selection_data_get_text (selection_data);
if (!data_is_acceptable (str))
gdk_drag_status (context, 0, time);
else
-gdk_drag_status (context, private_data->suggested_action, time);
+gdk_drag_status (context,
+private_data->suggested_action,
+time);
}
else
{
-/ * accept the drop * /
+// accept the drop
}
}
]|
@@ -11039,7 +11318,7 @@ gtk_widget_hide().
<description>
The ::hierarchy-changed signal is emitted when the
anchored state of a widget changes. A widget is
-<firstterm>anchored</firstterm> when its toplevel
+“anchored” when its toplevel
ancestor is a #GtkWindow. This signal is emitted when
a widget changes from un-anchored to anchored or vice-versa.
@@ -11302,7 +11581,8 @@ This signal gets emitted whenever a widget should pop up a context
menu. This usually happens through the standard key binding mechanism;
by pressing a certain key while a widget is focused, the user can cause
the widget to pop up a menu. For example, the #GtkEntry widget creates
-a menu with clipboard commands. See <xref linkend="checklist-popup-menu"/>
+a menu with clipboard commands. See the
+[Popup Menu Migration Checklist][checklist-popup-menu]
for an example of how to use this signal.
@@ -11818,12 +12098,16 @@ hidden).
<signal name="GtkWidget::visibility-notify-event">
<description>
-The ::visibility-notify-event will be emitted when the @widget's window
-is obscured or unobscured.
+The ::visibility-notify-event will be emitted when the @widget's
+window is obscured or unobscured.
To receive this signal the #GdkWindow associated to the widget needs
to enable the #GDK_VISIBILITY_NOTIFY_MASK mask.
+Deprecated: 3.12: Modern composited windowing systems with pervasive
+transparency make it impossible to track the visibility of a window
+reliably, so this signal can not be guaranteed to provide useful
+information.
</description>
<parameters>
@@ -11839,6 +12123,7 @@ triggered this signal.
</parameters>
<return> %TRUE to stop other handlers from being invoked for the event.
%FALSE to propagate the event further.
+
</return>
</signal>
@@ -11880,7 +12165,7 @@ Kinds of widget-specific help. Used by the ::show-help signal.
</parameter_description>
</parameter>
<parameter name="GTK_WIDGET_HELP_WHATS_THIS">
-<parameter_description> What's this.
+<parameter_description> What’s this.
</parameter_description>
</parameter>
</parameters>
@@ -11889,7 +12174,7 @@ Kinds of widget-specific help. Used by the ::show-help signal.
<signal name="GtkWindow::activate-default">
<description>
The ::activate-default signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted when the user activates the default widget
of @window.
@@ -11906,7 +12191,7 @@ of @window.
<signal name="GtkWindow::activate-focus">
<description>
The ::activate-focus signal is a
-<link linkend="keybinding-signals">keybinding signal</link>
+[keybinding signal][GtkBindingSignal]
which gets emitted when the user activates the currently
focused widget of @window.
@@ -11939,7 +12224,7 @@ or mnemonics that are associated with @window changes.
<description>
Window placement can be influenced using this enumeration. Note that
using #GTK_WIN_POS_CENTER_ALWAYS is almost always a bad idea.
-It won't necessarily work well with all window managers or on all windowing systems.
+It won’t necessarily work well with all window managers or on all windowing systems.
</description>
<parameters>
@@ -11969,16 +12254,16 @@ parent (see gtk_window_set_transient_for()).
<enum name="GtkWindowType">
<description>
-A #GtkWindow can be one of these types. Most things you'd consider a
-"window" should have type #GTK_WINDOW_TOPLEVEL; windows with this type
+A #GtkWindow can be one of these types. Most things you’d consider a
+“window” should have type #GTK_WINDOW_TOPLEVEL; windows with this type
are managed by the window manager and have a frame by default (call
gtk_window_set_decorated() to toggle the frame). Windows with type
#GTK_WINDOW_POPUP are ignored by the window manager; window manager
-keybindings won't work on them, the window manager won't decorate the
+keybindings won’t work on them, the window manager won’t decorate the
window with a frame, many GTK+ features that rely on the window
manager will not work (e.g. resize grips and
maximization/minimization). #GTK_WINDOW_POPUP is used to implement
-widgets such as #GtkMenu or tooltips that you normally don't think of
+widgets such as #GtkMenu or tooltips that you normally don’t think of
as windows per se. Nearly all windows should be #GTK_WINDOW_TOPLEVEL.
In particular, do not use #GTK_WINDOW_POPUP just to turn off
the window borders; use gtk_window_set_decorated() for that.
@@ -12620,12 +12905,13 @@ 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"));
+|[<!-- language="C" -->
+gtk_about_dialog_set_translator_credits (about,
+_("translator-credits"));
]|
-It is a good idea to use the customary msgid "translator-credits" for this
+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
+since #GtkAboutDialog will detect if “translator-credits” is untranslated
and hide the tab.
Since: 2.6
@@ -13292,7 +13578,7 @@ 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
+menus, but don’t want them to be saved into the applications accelerator
map dump.
</description>
@@ -13345,7 +13631,7 @@ g_intern_static_string().
<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(),
+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
@@ -13393,7 +13679,7 @@ map entry
<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
+map via the ::changed signal; it isn’t a parameter to the
other accelerator map functions.
Since: 2.4
@@ -13454,7 +13740,7 @@ Note that the file descriptor will not be closed by this function.
<function name="gtk_accel_map_lock_path">
<description>
-Locks the given accelerator path. If the accelerator map doesn't yet contain
+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
@@ -13627,10 +13913,9 @@ Since: 3.4
<function name="gtk_accelerator_name">
<description>
-Converts an accelerator keyval and modifier mask
-into a string parseable by gtk_accelerator_parse().
-For example, if you pass in #GDK_KEY_q and #GDK_CONTROL_MASK,
-this function returns "<Control>q".
+Converts an accelerator keyval and modifier mask into a string
+parseable by gtk_accelerator_parse(). For example, if you pass in
+#GDK_KEY_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().
@@ -13687,15 +13972,15 @@ Since: 3.4
<function name="gtk_accelerator_parse">
<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).
+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>-".
+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>-”.
If the parse fails, @accelerator_key and @accelerator_mods will
be set to 0 (zero).
@@ -13791,7 +14076,7 @@ before using any accelerator groups.
<description>
Determines whether a given keyval and modifier mask constitute
a valid keyboard accelerator. For example, the #GDK_KEY_a keyval
-plus #GDK_CONTROL_MASK is valid - this is a "Ctrl+a" accelerator.
+plus #GDK_CONTROL_MASK is valid - this is a “Ctrl+a” accelerator.
But, you can't, for instance, use the #GDK_KEY_Control_L keyval
as an accelerator.
@@ -13853,10 +14138,11 @@ corresponding to the #GtkAccessible, or %NULL.
<description>
Sets the #GtkWidget corresponding to the #GtkAccessible.
-<note><para>@accessible will not hold a reference to @widget.
-It is the caller's responsibility to ensure that when @widget
+ accessible will not hold a reference to @widget.
+It is the caller’s responsibility to ensure that when @widget
is destroyed, the widget is unset by calling this function
-again with @widget set to %NULL.</para></note>
+again with @widget set to %NULL.
+
Since: 2.22
</description>
@@ -13875,7 +14161,7 @@ Since: 2.22
<function name="gtk_action_activate">
<description>
-Emits the "activate" signal on the specified action, if it isn't
+Emits the “activate” signal on the specified action, if it isn't
insensitive. This gets called by the proxy widgets when they get
activated.
@@ -13897,18 +14183,18 @@ Deprecated: 3.10: Use g_action_group_activate_action() on a #GAction instead
<function name="gtk_action_bar_get_center_widget">
<description>
-Retrieves the center box widget of the bar.
+Retrieves the center bar widget of the bar.
Since: 3.12
</description>
<parameters>
-<parameter name="bar">
+<parameter name="action_bar">
<parameter_description> a #GtkActionBar
</parameter_description>
</parameter>
</parameters>
-<return> the center #GtkBox.
+<return> the center #GtkWidget.
</return>
</function>
@@ -13929,19 +14215,19 @@ Since: 3.12
<function name="gtk_action_bar_pack_end">
<description>
-Adds @child to @box, packed with reference to the
-end of the @box.
+Adds @child to @action_bar, packed with reference to the
+end of the @action_bar.
Since: 3.12
</description>
<parameters>
-<parameter name="bar">
+<parameter name="action_bar">
<parameter_description> A #GtkActionBar
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> the #GtkWidget to be added to @bar
+<parameter_description> the #GtkWidget to be added to @action_bar
</parameter_description>
</parameter>
</parameters>
@@ -13950,19 +14236,19 @@ Since: 3.12
<function name="gtk_action_bar_pack_start">
<description>
-Adds @child to @box, packed with reference to the
-start of the @box.
+Adds @child to @action_bar, packed with reference to the
+start of the @action_bar.
Since: 3.12
</description>
<parameters>
-<parameter name="bar">
+<parameter name="action_bar">
<parameter_description> A #GtkActionBar
</parameter_description>
</parameter>
<parameter name="child">
-<parameter_description> the #GtkWidget to be added to @bar
+<parameter_description> the #GtkWidget to be added to @action_bar
</parameter_description>
</parameter>
</parameters>
@@ -13977,7 +14263,7 @@ Since: 3.12
</description>
<parameters>
-<parameter name="bar">
+<parameter name="action_bar">
<parameter_description> a #GtkActionBar
</parameter_description>
</parameter>
@@ -14021,7 +14307,7 @@ gtk_action_set_accel_group()
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
+function has been called and doesn’t remove the accelerator until
gtk_action_disconnect_accelerator() has been called as many times.
Since: 2.4
@@ -14198,7 +14484,7 @@ and must not be freed or modified.
<function name="gtk_action_get_always_show_image">
<description>
-Returns whether @action<!-- -->'s menu item proxies will always
+Returns whether @action<!-- -->’s menu item proxies will always
show their image, if available.
Since: 2.20
@@ -14235,7 +14521,7 @@ associated with a #GAction
</parameter_description>
</parameter>
</parameters>
-<return> The action's #GIcon if one is set.
+<return> The action’s #GIcon if one is set.
</return>
</function>
@@ -14350,7 +14636,7 @@ and must not be modified.
<function name="gtk_action_get_sensitive">
<description>
-Returns whether the action itself is sensitive. Note that this doesn't
+Returns whether the action itself is sensitive. Note that this doesn’t
necessarily mean effective sensitivity. See gtk_action_is_sensitive()
for that.
@@ -14436,7 +14722,7 @@ Deprecated: 3.10: Use #GAction instead, and get tooltips from associated
<function name="gtk_action_get_visible">
<description>
-Returns whether the action itself is visible. Note that this doesn't
+Returns whether the action itself is visible. Note that this doesn’t
necessarily mean effective visibility. See gtk_action_is_sensitive()
for that.
@@ -14506,7 +14792,7 @@ 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>.
+`gtk_action_group_add_action_with_accel (..., NULL)`.
Since: 2.4
@@ -14533,8 +14819,7 @@ 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>.
+Accel paths are set to `<Actions>/group-name/action-name`.
Since: 2.4
@@ -14565,9 +14850,8 @@ the format understood by gtk_accelerator_parse(), or "" for no acceler
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>.
+The “activate” signals of the actions are connected to the callbacks
+and their accel paths are set to `<Actions>/group-name/action-name`.
Since: 2.4
@@ -14635,9 +14919,9 @@ Deprecated: 3.10
This is a convenience routine to create a group of radio actions and
add them to the action group.
-The "changed" signal of the first radio action is connected to the
+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>.
+`<Actions>/group-name/action-name`.
Since: 2.4
@@ -14723,9 +15007,8 @@ no action should be activated
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>.
+The “activate” signals of the actions are connected to the callbacks
+and their accel paths are set to `<Actions>/group-name/action-name`.
Since: 2.4
@@ -14922,7 +15205,7 @@ Deprecated: 3.10
<function name="gtk_action_group_new">
<description>
Creates a new #GtkActionGroup object. The name of the action group
-is used when associating <link linkend="Action-Accel">keybindings</link>
+is used when associating [keybindings][Action-Accel]
with the actions.
Since: 2.4
@@ -15012,7 +15295,7 @@ Deprecated: 3.10
Sets a function to be used for translating the @label and @tooltip of
#GtkActionEntry<!-- -->s added by gtk_action_group_add_actions().
-If you're using gettext(), it is enough to set the translation domain
+If you’re using gettext(), it is enough to set the translation domain
with gtk_action_group_set_translation_domain().
Since: 2.4
@@ -15048,7 +15331,7 @@ Sets the translation domain and uses g_dgettext() for translating the
@label and @tooltip of #GtkActionEntry<!-- -->s added by
gtk_action_group_add_actions().
-If you're not using gettext() for localization, see
+If you’re not using gettext() for localization, see
gtk_action_group_set_translate_func().
Since: 2.4
@@ -15167,7 +15450,7 @@ are both visible.
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
+See the [UI Definition section][XML-UI] for information on allowed action
names.
Since: 2.4
@@ -15305,7 +15588,7 @@ Deprecated: 3.10: Use #GAction and the accelerator path on an associated
<function name="gtk_action_set_always_show_image">
<description>
-Sets whether @action<!-- -->'s menu item proxies will ignore the
+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
@@ -15430,7 +15713,7 @@ API to set a label
<function name="gtk_action_set_sensitive">
<description>
Sets the :sensitive property of the action to @sensitive. Note that
-this doesn't necessarily mean effective sensitivity. See
+this doesn’t necessarily mean effective sensitivity. See
gtk_action_is_sensitive()
for that.
@@ -15525,7 +15808,7 @@ Deprecated: 3.10: Use #GAction instead, and set tooltips on associated
<function name="gtk_action_set_visible">
<description>
Sets the :visible property of the action to @visible. Note that
-this doesn't necessarily mean effective visibility. See
+this doesn’t necessarily mean effective visibility. See
gtk_action_is_visible()
for that.
@@ -15662,7 +15945,7 @@ unassociated from any previous action.
Usually this function is used when the widget is located (or will be
located) within the hierarchy of a #GtkApplicationWindow.
-Names are of the form "win.save" or "app.quit" for actions on the
+Names are of the form “win.save” or “app.quit” for actions on the
containing #GtkApplicationWindow or its associated #GtkApplication,
respectively. This is the same form used for actions in the #GMenu
associated with the window.
@@ -15724,15 +16007,15 @@ If @target_value is %NULL then the target value is unset.
The target value has two purposes. First, it is used as the
parameter to activation of the action associated with the
#GtkActionable widget. Second, it is used to determine if the widget
-should be rendered as "active" - the widget is active if the state
+should be rendered as “active” - the widget is active if the state
is equal to the given target.
Consider the example of associating a set of buttons with a #GAction
-with string state in a typical "radio button" situation. Each button
+with string state in a typical “radio button” situation. Each button
will be associated with the same action, but with a different target
value for that action. Clicking on a particular button will activate
the action with the target of that button, which will typically cause
-the action's state to change to that value. Since the action's state
+the action’s state to change to that value. Since the action’s state
is now equal to the target value of the button, the button will now
be rendered as active (and the other buttons, with different targets,
rendered inactive).
@@ -15763,8 +16046,8 @@ and gtk_actionable_set_action_target_value() in the common case that
the target is string-valued.
@detailed_action_name is a string of the form
-<literal>"action::target"</literal> where <literal>action</literal>
-is the action name and <literal>target</literal> is the string to use
+`"action::target"` where `action`
+is the action name and `target` is the string to use
as the target.
Since: 3.4
@@ -15794,12 +16077,12 @@ 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.
+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_related_action() to retrieve the
-previous action</para></note>
+> Be careful to call this before setting the local
+> copy of the #GtkAction property, since this function uses
+> gtk_activatable_get_related_action() to retrieve the
+> previous action.
Since: 2.16
@@ -15865,8 +16148,8 @@ Deprecated: 3.10
<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>
+> #GtkActivatable implementors need to handle the #GtkActivatable:related-action
+> property and call gtk_activatable_do_set_related_action() when it changes.
Since: 2.16
@@ -15891,10 +16174,10 @@ Deprecated: 3.10
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>
+> #GtkActivatable implementors need to handle the
+> #GtkActivatable:use-action-appearance property and call
+> gtk_activatable_sync_action_properties() to update @activatable
+> if needed.
Since: 2.16
@@ -16194,7 +16477,7 @@ Sets the minimum value of the adjustment.
When setting multiple adjustment properties via their individual
setters, multiple #GtkAdjustment::changed signals will be emitted. However, since
the emission of the #GtkAdjustment::changed signal is tied to the emission of the
-#GObject::notify signals of the changed properties, it's possible
+#GObject::notify signals of the changed properties, it’s possible
to compress the #GtkAdjustment::changed signals into one by calling
g_object_freeze_notify() and g_object_thaw_notify() around the
calls to the individual setters.
@@ -16296,7 +16579,7 @@ Since: 2.14
Sets the maximum value of the adjustment.
Note that values will be restricted by
-<literal>upper - page-size</literal> if the page-size
+`upper - page-size` if the page-size
property is nonzero.
See gtk_adjustment_set_lower() about how to compress multiple
@@ -17162,16 +17445,15 @@ Installs an accelerator that will cause the named action
to be activated when the key combination specificed by @accelerator
is pressed.
- accelerator must be a string that can be parsed by
-gtk_accelerator_parse(), e.g. "<Primary>q" or
-"<Control><Alt>p".
+ accelerator must be a string that can be parsed by gtk_accelerator_parse(),
+e.g. "<Primary>q" or “<Control><Alt>p”.
@action_name must be the name of an action as it would be used
in the app menu, i.e. actions that have been added to the application
-are referred to with an "app." prefix, and window-specific actions
-with a "win." prefix.
+are referred to with an “app.” prefix, and window-specific actions
+with a “win.” prefix.
-GtkApplication also extracts accelerators out of 'accel' attributes
+GtkApplication also extracts accelerators out of “accel” attributes
in the #GMenuModels passed to gtk_application_set_app_menu() and
gtk_application_set_menubar(), which is usually more convenient
than calling this function for each accelerator.
@@ -17258,7 +17540,7 @@ a %NULL-terminated array. Free with g_strfreev() when no longer needed
<function name="gtk_application_get_active_window">
<description>
-Gets the "active" window for the application.
+Gets the “active” window for the application.
The active window is the one that was most recently focused (within
the application). This window may not have the focus at the moment
@@ -17478,7 +17760,7 @@ chain up in their #GApplication::startup handler before using any GTK+ API.
Note that commandline arguments are not passed to gtk_init().
All GTK+ functionality that is available via commandline arguments
can also be achieved by setting suitable environment variables
-such as <envar>G_DEBUG</envar>, so this should not be a big
+such as `G_DEBUG`, so this should not be a big
problem. If you absolutely must support GTK+ commandline arguments,
you can explicitly call gtk_init() before creating the application
instance.
@@ -17600,8 +17882,8 @@ to call this.
The application menu is a single menu containing items that typically
impact the application as a whole, rather than acting on a specific
window or document. For example, you would expect to see
-"Preferences" or "Quit" in an application menu, but not "Save" or
-"Print".
+“Preferences” or “Quit” in an application menu, but not “Save” or
+“Print”.
If supported, the application menu will be rendered by the desktop
environment.
@@ -17686,7 +17968,7 @@ Since: 3.4
<function name="gtk_application_window_get_id">
<description>
Returns the unique ID of the window. If the window has not yet been added to
-a #GtkApplication, returns <literal>0</literal>.
+a #GtkApplication, returns `0`.
Since: 3.6
@@ -17697,7 +17979,7 @@ Since: 3.6
</parameter_description>
</parameter>
</parameters>
-<return> the unique ID for @window, or <literal>0</literal> if the window
+<return> the unique ID for @window, or `0` if the window
has not yet been added to a #GtkApplication
</return>
@@ -18046,7 +18328,7 @@ add your header decoration to the page content instead.
</parameter>
</parameters>
<return> the header image for @page,
-or %NULL if there's no header image for the page
+or %NULL if there’s no header image for the page
</return>
</function>
@@ -18072,7 +18354,7 @@ shown anymore.
</parameter>
</parameters>
<return> the side image for @page,
-or %NULL if there's no side image for the page
+or %NULL if there’s no side image for the page
</return>
</function>
@@ -18250,7 +18532,7 @@ Since: 2.10
<function name="gtk_assistant_remove_page">
<description>
-Removes the @page_num's page from @assistant.
+Removes the @page_num’s page from @assistant.
Since: 3.2
@@ -18554,17 +18836,17 @@ it into @binding_set.
Signal descriptions may either bind a key combination to
one or more signals:
-<informalexample><programlisting>
+|[
bind "key" {
"signalname" (param, ...)
...
}
-</programlisting></informalexample>
+]|
Or they may also unbind a key combination:
-<informalexample><programlisting>
+|[
unbind "key"
-</programlisting></informalexample>
+]|
Key combinations must be in a format that can be parsed by
gtk_accelerator_parse().
@@ -18894,6 +19176,24 @@ Since: 3.10
</return>
</function>
+<function name="gtk_box_get_center_widget">
+<description>
+Retrieves the center widget of the box.
+
+Since: 3.12
+
+</description>
+<parameters>
+<parameter name="box">
+<parameter_description> a #GtkBox
+</parameter_description>
+</parameter>
+</parameters>
+<return> the center widget
+
+</return>
+</function>
+
<function name="gtk_box_get_homogeneous">
<description>
Returns whether the box is homogeneous (all children are the
@@ -18936,7 +19236,7 @@ Since: 3.0
</description>
<parameters>
<parameter name="orientation">
-<parameter_description> the box's orientation.
+<parameter_description> the box’s orientation.
</parameter_description>
</parameter>
<parameter name="spacing">
@@ -19078,7 +19378,7 @@ The list contains widgets packed #GTK_PACK_START
as well as widgets packed #GTK_PACK_END, in the order that these
widgets were added to @box.
-A widget's position in the @box children list determines where
+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.
@@ -19128,6 +19428,29 @@ Since: 3.10
<return></return>
</function>
+<function name="gtk_box_set_center_widget">
+<description>
+Sets a center widget; that is a child widget that will be
+centered with respect to the full width of the box, even
+if the children at either side take up different amounts
+of space.
+
+Since: 3.12
+
+</description>
+<parameters>
+<parameter name="box">
+<parameter_description> a #GtkBox
+</parameter_description>
+</parameter>
+<parameter name="widget">
+<parameter_description> the widget to center
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="gtk_box_set_child_packing">
<description>
Sets the way @child is packed into @box.
@@ -19235,7 +19558,7 @@ Since: 2.12
<description>
Constructs a child of @buildable with the name @name.
-#GtkBuilder calls this function if a "constructor" has been
+#GtkBuilder calls this function if a “constructor” has been
specified in the UI definition.
Since: 2.12
@@ -19397,7 +19720,7 @@ Since: 2.12
Gets the name of the @buildable object.
#GtkBuilder sets the name based on the
-<link linkend="BUILDER-UI">GtkBuilder UI definition</link>
+[GtkBuilder UI definition][BUILDER-UI]
used to construct the @buildable.
Since: 2.12
@@ -19417,7 +19740,7 @@ Since: 2.12
<function name="gtk_buildable_parser_finished">
<description>
Called when the builder finishes the parsing of a
-<link linkend="BUILDER-UI">GtkBuilder UI definition</link>.
+[GtkBuilder UI definition][BUILDER-UI].
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.
@@ -19546,8 +19869,8 @@ Since: 3.10
<function name="gtk_builder_add_from_file">
<description>
-Parses a file containing a <link linkend="BUILDER-UI">GtkBuilder
-UI definition</link> and merges it with the current contents of @builder.
+Parses a file containing a [GtkBuilder UI definition][BUILDER-UI]
+and merges it with the current contents of @builder.
Most users will probably want to use gtk_builder_new_from_file().
@@ -19555,10 +19878,10 @@ 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.
-It's not really reasonable to attempt to handle failures of this
+It’s not really reasonable to attempt to handle failures of this
call. You should not use this function with untrusted files (ie:
files that are not part of your application). Broken #GtkBuilder
-files can easily crash your program, and it's possible that memory
+files can easily crash your program, and it’s possible that memory
was leaked leading up to the reported failure. The only reasonable
thing to do when an error is detected is to call g_error().
@@ -19586,8 +19909,8 @@ Since: 2.12
<function name="gtk_builder_add_from_resource">
<description>
-Parses a resource file containing a <link linkend="BUILDER-UI">GtkBuilder
-UI definition</link> and merges it with the current contents of @builder.
+Parses a resource file containing a [GtkBuilder UI definition][BUILDER-UI]
+and merges it with the current contents of @builder.
Most users will probably want to use gtk_builder_new_from_resource().
@@ -19595,7 +19918,7 @@ Upon errors 0 will be returned and @error will be assigned a
#GError from the #GTK_BUILDER_ERROR, #G_MARKUP_ERROR or #G_RESOURCE_ERROR
domain.
-It's not really reasonable to attempt to handle failures of this
+It’s not really reasonable to attempt to handle failures of this
call. The only reasonable thing to do when an error is detected is
to call g_error().
@@ -19623,15 +19946,15 @@ Since: 3.4
<function name="gtk_builder_add_from_string">
<description>
-Parses a string containing a <link linkend="BUILDER-UI">GtkBuilder
-UI definition</link> and merges it with the current contents of @builder.
+Parses a string containing a [GtkBuilder UI definition][BUILDER-UI]
+and merges it with the current contents of @builder.
Most users will probably want to use gtk_builder_new_from_string().
Upon errors 0 will be returned and @error will be assigned a
#GError from the #GTK_BUILDER_ERROR or #G_MARKUP_ERROR domain.
-It's not really reasonable to attempt to handle failures of this
+It’s not really reasonable to attempt to handle failures of this
call. The only reasonable thing to do when an error is detected is
to call g_error().
@@ -19663,19 +19986,17 @@ Since: 2.12
<function name="gtk_builder_add_objects_from_file">
<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.
+Parses a file containing a [GtkBuilder UI definition][BUILDER-UI]
+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 explicitly list all of them in @object_ids.
-</para></note>
Since: 2.14
@@ -19705,19 +20026,17 @@ Since: 2.14
<function name="gtk_builder_add_objects_from_resource">
<description>
-Parses a resource file containing a <link linkend="BUILDER-UI">GtkBuilder
-UI definition</link> building only the requested objects and merges
+Parses a resource file containing a [GtkBuilder UI definition][BUILDER-UI]
+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_RESOURCE_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 explicitly list all of them in @object_ids.
-</para></note>
Since: 3.4
@@ -19747,18 +20066,16 @@ Since: 3.4
<function name="gtk_builder_add_objects_from_string">
<description>
-Parses a string containing a <link linkend="BUILDER-UI">GtkBuilder
-UI definition</link> building only the requested objects and merges
+Parses a string containing a [GtkBuilder UI definition][BUILDER-UI]
+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 explicitly list all of them in @object_ids.
-</para></note>
Since: 2.14
@@ -19795,8 +20112,8 @@ Since: 2.14
This method is a simpler variation of gtk_builder_connect_signals_full().
It uses symbols explicitly added to @builder with prior calls to
gtk_builder_add_callback_symbol(). In the case that symbols are not
-explicitly added; 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
+explicitly added; 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 can only be called once, subsequent calls will do nothing.
@@ -20048,7 +20365,7 @@ Since: 2.12
<function name="gtk_builder_new_from_file">
<description>
-Builds the <link linkend="BUILDER-UI">GtkBuilder UI definition</link>
+Builds the [GtkBuilder UI definition][BUILDER-UI]
in the file @filename.
If there is an error opening the file or parsing the description then
@@ -20071,7 +20388,7 @@ Since: 3.10
<function name="gtk_builder_new_from_resource">
<description>
-Builds the <link linkend="BUILDER-UI">GtkBuilder UI definition</link>
+Builds the [GtkBuilder UI definition][BUILDER-UI]
at @resource_path.
If there is an error locating the resurce or parsing the description
@@ -20093,8 +20410,8 @@ Since: 3.10
<function name="gtk_builder_new_from_string">
<description>
-Builds the user interface described by @string (in the <link
-linkend="BUILDER-UI">GtkBuilder UI definition</link> format).
+Builds the user interface described by @string (in the
+[GtkBuilder UI definition][BUILDER-UI] format).
If @string is %NULL-terminated then @length should be -1. If @length
is not -1 then it is the length of @string.
@@ -20479,7 +20796,7 @@ Since: 3.6
<function name="gtk_button_get_event_window">
<description>
-Returns the button's event window if it is realized, %NULL otherwise.
+Returns the button’s event window if it is realized, %NULL otherwise.
This function should be rarely needed.
Since: 2.22
@@ -20491,7 +20808,7 @@ Since: 2.22
</parameter_description>
</parameter>
</parameters>
-<return> @button's event window.
+<return> @button’s event window.
</return>
</function>
@@ -20663,7 +20980,7 @@ use gtk_container_add().
<description>
Creates a new button containing an icon from the current icon theme.
-If the icon name isn't known, a "broken image" icon will be
+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.
@@ -20732,7 +21049,7 @@ text.
<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
+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.
@@ -20837,7 +21154,7 @@ Since: 3.6
<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
+you don’t want the keyboard focus removed from the main area of the
application.
Since: 2.4
@@ -20860,7 +21177,7 @@ Since: 2.4
<description>
Set the image of @button to the given widget. The image will be
displayed if the label text is %NULL or if
-#GtkButton:always-show-image is %TRUE. You don't have to call
+#GtkButton:always-show-image is %TRUE. You don’t have to call
gtk_widget_show() on @image yourself.
Since: 2.6
@@ -20994,7 +21311,7 @@ This function will return %TRUE if the contents of the given
that when the drawing was not initiated by the windowing
system this function will return %TRUE for all windows, so
you need to draw the bottommost window first. Also, do not
-use "else if" statements to check which window should be drawn.
+use “else if” statements to check which window should be drawn.
Since: 3.0
@@ -21019,7 +21336,7 @@ window.
<description>
Transforms the given cairo context @cr that from @widget-relative
coordinates to @window-relative coordinates.
-If the @widget's window is not an ancestor of @window, no
+If the @widget’s window is not an ancestor of @window, no
modification will be applied.
This is the inverse to the transformation GTK applies when
@@ -21380,7 +21697,7 @@ Since: 3.0
</parameter_description>
</parameter>
<parameter name="cell_area">
-<parameter_description> the size and location of @area relative to @widget's allocation
+<parameter_description> the size and location of @area relative to @widget’s allocation
</parameter_description>
</parameter>
<parameter name="flags">
@@ -21462,7 +21779,7 @@ Since: 3.0
<function name="gtk_cell_area_add_focus_sibling">
<description>
-Adds @sibling to @renderer's focusable area, focus will be drawn
+Adds @sibling to @renderer’s focusable area, focus will be drawn
around @renderer and all of its siblings if @renderer can
focus for a given row.
@@ -21482,7 +21799,7 @@ Since: 3.0
</parameter_description>
</parameter>
<parameter name="sibling">
-<parameter_description> the #GtkCellRenderer to add to @renderer's focus area
+<parameter_description> the #GtkCellRenderer to add to @renderer’s focus area
</parameter_description>
</parameter>
</parameters>
@@ -22047,7 +22364,7 @@ it is important for the context implementation itself to
fetch information about the area it is being used for.
For instance at #GtkCellAreaContextClass.allocate() time
-it's important to know details about any cell spacing
+it’s important to know details about any cell spacing
that the #GtkCellArea is configured with in order to
compute a proper allocation.
@@ -22385,7 +22702,7 @@ Since: 3.0
<function name="gtk_cell_area_focus">
<description>
-This should be called by the @area's owning layout widget
+This should be called by the @area’s owning layout widget
when focus is to be passed to @area, or moved within @area
for a given @direction and row data.
@@ -22693,10 +23010,10 @@ The returned list is internal and should not be freed.
<function name="gtk_cell_area_get_preferred_height">
<description>
-Retrieves a cell area's initial minimum and natural height.
+Retrieves a cell area’s initial minimum and natural height.
@area will store some geometrical information in @context along the way;
-when requesting sizes over an arbitrary number of rows, it's not important
+when requesting sizes over an arbitrary number of rows, it’s not important
to check the @minimum_height and @natural_height of this call but rather to
consult gtk_cell_area_context_get_preferred_height() after a series of
requests.
@@ -22731,11 +23048,11 @@ Since: 3.0
<function name="gtk_cell_area_get_preferred_height_for_width">
<description>
-Retrieves a cell area's minimum and natural height if it would be given
+Retrieves a cell area’s minimum and natural height if it would be given
the specified @width.
@area stores some geometrical information in @context along the way
-while calling gtk_cell_area_get_preferred_width(). It's important to
+while calling gtk_cell_area_get_preferred_width(). It’s important to
perform a series of gtk_cell_area_get_preferred_width() requests with
@context first and then call gtk_cell_area_get_preferred_height_for_width()
on each cell area individually to get the height for width of each
@@ -22780,10 +23097,10 @@ Since: 3.0
<function name="gtk_cell_area_get_preferred_width">
<description>
-Retrieves a cell area's initial minimum and natural width.
+Retrieves a cell area’s initial minimum and natural width.
@area will store some geometrical information in @context along the way;
-when requesting sizes over an arbitrary number of rows, it's not important
+when requesting sizes over an arbitrary number of rows, it’s not important
to check the @minimum_width and @natural_width of this call but rather to
consult gtk_cell_area_context_get_preferred_width() after a series of
requests.
@@ -22818,11 +23135,11 @@ Since: 3.0
<function name="gtk_cell_area_get_preferred_width_for_height">
<description>
-Retrieves a cell area's minimum and natural width if it would be given
+Retrieves a cell area’s minimum and natural width if it would be given
the specified @height.
@area stores some geometrical information in @context along the way
-while calling gtk_cell_area_get_preferred_height(). It's important to
+while calling gtk_cell_area_get_preferred_height(). It’s important to
perform a series of gtk_cell_area_get_preferred_height() requests with
@context first and then call gtk_cell_area_get_preferred_width_for_height()
on each cell area individually to get the height for width of each
@@ -22925,7 +23242,7 @@ Since: 3.0
</parameter_description>
</parameter>
<parameter name="cell_area">
-<parameter_description> the @widget relative coordinates where one of @area's cells
+<parameter_description> the @widget relative coordinates where one of @area’s cells
is to be placed
</parameter_description>
</parameter>
@@ -22958,7 +23275,7 @@ Since: 3.0
<function name="gtk_cell_area_is_focus_sibling">
<description>
-Returns whether @sibling is one of @renderer's focus siblings
+Returns whether @sibling is one of @renderer’s focus siblings
(see gtk_cell_area_add_focus_sibling()).
Since: 3.0
@@ -22974,7 +23291,7 @@ Since: 3.0
</parameter_description>
</parameter>
<parameter name="sibling">
-<parameter_description> the #GtkCellRenderer to check against @renderer's sibling list
+<parameter_description> the #GtkCellRenderer to check against @renderer’s sibling list
</parameter_description>
</parameter>
</parameters>
@@ -23005,7 +23322,7 @@ Since: 3.0
<function name="gtk_cell_area_remove_focus_sibling">
<description>
-Removes @sibling from @renderer's focus sibling list
+Removes @sibling from @renderer’s focus sibling list
(see gtk_cell_area_add_focus_sibling()).
Since: 3.0
@@ -23021,7 +23338,7 @@ Since: 3.0
</parameter_description>
</parameter>
<parameter name="sibling">
-<parameter_description> the #GtkCellRenderer to remove from @renderer's focus area
+<parameter_description> the #GtkCellRenderer to remove from @renderer’s focus area
</parameter_description>
</parameter>
</parameters>
@@ -23030,7 +23347,7 @@ Since: 3.0
<function name="gtk_cell_area_render">
<description>
-Renders @area's cells according to @area's layout onto @widget at
+Renders @area’s cells according to @area’s layout onto @widget at
the given coordinates.
Since: 3.0
@@ -23054,7 +23371,7 @@ Since: 3.0
</parameter_description>
</parameter>
<parameter name="background_area">
-<parameter_description> the @widget relative coordinates for @area's background
+<parameter_description> the @widget relative coordinates for @area’s background
</parameter_description>
</parameter>
<parameter name="cell_area">
@@ -23076,7 +23393,7 @@ Since: 3.0
<function name="gtk_cell_area_request_renderer">
<description>
This is a convenience function for #GtkCellArea implementations
-to request size for cell renderers. It's important to use this
+to request size for cell renderers. It’s important to use this
function to request size and then use gtk_cell_area_inner_cell_area()
at render and event time since this function will add padding
around the cell for focus painting.
@@ -23225,7 +23542,7 @@ 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.
+“text” attribute of a #GtkCellRendererText get its values from column 2.
Since: 2.4
@@ -23446,7 +23763,7 @@ Since: 2.4
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
+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 a previously set function.
@@ -23566,7 +23883,7 @@ 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
+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.
@@ -23686,7 +24003,7 @@ Since: 2.18
<function name="gtk_cell_renderer_get_preferred_height">
<description>
-Retreives a renderer's natural size when rendered to @widget.
+Retreives a renderer’s natural size when rendered to @widget.
Since: 3.0
@@ -23714,7 +24031,7 @@ Since: 3.0
<function name="gtk_cell_renderer_get_preferred_height_for_width">
<description>
-Retreives a cell renderers's minimum and natural height if it were rendered to
+Retreives a cell renderers’s minimum and natural height if it were rendered to
@widget with the specified @width.
Since: 3.0
@@ -23748,7 +24065,7 @@ Since: 3.0
<function name="gtk_cell_renderer_get_preferred_size">
<description>
Retrieves the minimum and natural size of a cell taking
-into account the widget's preference for height-for-width management.
+into account the widget’s preference for height-for-width management.
Since: 3.0
@@ -23776,7 +24093,7 @@ Since: 3.0
<function name="gtk_cell_renderer_get_preferred_width">
<description>
-Retreives a renderer's natural size when rendered to @widget.
+Retreives a renderer’s natural size when rendered to @widget.
Since: 3.0
@@ -23804,7 +24121,7 @@ Since: 3.0
<function name="gtk_cell_renderer_get_preferred_width_for_height">
<description>
-Retreives a cell renderers's minimum and natural width if it were rendered to
+Retreives a cell renderers’s minimum and natural width if it were rendered to
@widget with the specified @height.
Since: 3.0
@@ -23856,7 +24173,7 @@ Since: 3.0
<function name="gtk_cell_renderer_get_sensitive">
<description>
-Returns the cell renderer's sensitivity.
+Returns the cell renderer’s sensitivity.
Since: 2.18
@@ -23949,7 +24266,7 @@ Since: 3.0
<function name="gtk_cell_renderer_get_visible">
<description>
-Returns the cell renderer's visibility.
+Returns the cell renderer’s visibility.
Since: 2.18
@@ -23989,7 +24306,7 @@ 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
+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.
@@ -24058,7 +24375,7 @@ padding on the sides)
<function name="gtk_cell_renderer_set_alignment">
<description>
-Sets the renderer's alignment within its available space.
+Sets the renderer’s alignment within its available space.
Since: 2.18
@@ -24104,7 +24421,7 @@ Sets the renderer size to be explicit, independent of the properties set.
<function name="gtk_cell_renderer_set_padding">
<description>
-Sets the renderer's padding.
+Sets the renderer’s padding.
Since: 2.18
@@ -24128,7 +24445,7 @@ Since: 2.18
<function name="gtk_cell_renderer_set_sensitive">
<description>
-Sets the cell renderer's sensitivity.
+Sets the cell renderer’s sensitivity.
Since: 2.18
@@ -24148,7 +24465,7 @@ Since: 2.18
<function name="gtk_cell_renderer_set_visible">
<description>
-Sets the cell renderer's visibility.
+Sets the cell renderer’s visibility.
Since: 2.18
@@ -24268,7 +24585,7 @@ 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
+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
@@ -24282,8 +24599,8 @@ of the #GtkTreeView
<function name="gtk_cell_renderer_text_set_fixed_height_from_font">
<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
+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
@@ -24342,7 +24659,7 @@ gtk_cell_renderer_toggle_set_active().
<function name="gtk_cell_renderer_toggle_get_radio">
<description>
-Returns whether we're rendering radio toggles rather than checkboxes.
+Returns whether we’re rendering radio toggles rather than checkboxes.
</description>
@@ -24352,7 +24669,7 @@ Returns whether we're rendering radio toggles rather than checkboxes.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if we're rendering radio toggles rather than checkboxes
+<return> %TRUE if we’re rendering radio toggles rather than checkboxes
</return>
</function>
@@ -24362,7 +24679,7 @@ 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
+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.
@@ -24593,8 +24910,7 @@ Since: 2.6
<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>.
+marked up with the [Pango text markup language][PangoMarkupFormat].
Since: 2.6
@@ -24694,7 +25010,7 @@ Since: 3.0
<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;
+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.
@@ -24743,7 +25059,7 @@ Since: 3.0
Sets whether @cell_view should request space to fit the entire #GtkTreeModel.
This is used by #GtkComboBox to ensure that the cell view displayed on
-the combo box's button always gets enough space and does not resize
+the combo box’s button always gets enough space and does not resize
when selection changes.
Since: 3.0
@@ -24960,7 +25276,7 @@ character
<function name="gtk_check_menu_item_set_active">
<description>
-Sets the active state of the menu item's check box.
+Sets the active state of the menu item’s check box.
</description>
<parameters>
@@ -25001,11 +25317,11 @@ Since: 2.4
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
+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.
+visual appearance, it doesn’t affect the semantics of the widget.
</description>
@@ -25015,7 +25331,7 @@ visual appearance, it doesn't affect the semantics of the widget.
</parameter_description>
</parameter>
<parameter name="setting">
-<parameter_description> %TRUE to display an "inconsistent" third state check
+<parameter_description> %TRUE to display an “inconsistent” third state check
</parameter_description>
</parameter>
</parameters>
@@ -25054,9 +25370,9 @@ 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
+can call this function to check that it wasn’t loaded
into an incompatible version of GTK+. However, such a
-check isn't completely reliable, since the module may be
+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+.
@@ -25153,20 +25469,21 @@ 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"
+(Passing #GDK_NONE is the same as using `gdk_atom_intern
+("CLIPBOARD", FALSE)`.
+
+See the
+[FreeDesktop Clipboard Specification](http://www.freedesktop.org/Standards/clipboards-spec)
+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
+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".
+if your application called “Foo” has a special-purpose
+clipboard, you might call it “_FOO_SPECIAL_CLIPBOARD”.
Since: 2.2
@@ -25280,7 +25597,7 @@ text is later received, @callback will be called.
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
+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.
@@ -25560,7 +25877,7 @@ called
</parameter_description>
</parameter>
<parameter name="owner">
-<parameter_description> an object that "owns" the data. This object will be passed
+<parameter_description> an object that “owns” the data. This object will be passed
to the callbacks when called
</parameter_description>
</parameter>
@@ -25681,7 +25998,7 @@ converted into text form.)
<function name="gtk_clipboard_wait_for_targets">
<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
+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.
@@ -25770,7 +26087,7 @@ 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_image() since it doesn't need to retrieve
+gtk_clipboard_wait_for_image() since it doesn’t need to retrieve
the actual image data.
Since: 2.6
@@ -25796,7 +26113,7 @@ 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
+gtk_clipboard_wait_for_rich_text() since it doesn’t need to retrieve
the actual text.
Since: 2.10
@@ -25820,10 +26137,10 @@ Since: 2.10
<function name="gtk_clipboard_wait_is_target_available">
<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
+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
+If you want to see if there’s text available on the clipboard, use
gtk_clipboard_wait_is_text_available () instead.
Since: 2.6
@@ -25853,7 +26170,7 @@ 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
+gtk_clipboard_wait_for_text() since it doesn’t need to retrieve
the actual text.
@@ -25877,7 +26194,7 @@ 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_uris() since it doesn't need to retrieve
+gtk_clipboard_wait_for_uris() since it doesn’t need to retrieve
the actual URI data.
Since: 2.14
@@ -26730,7 +27047,7 @@ Sets the palette located at @index to have @color as its color.
<function name="gtk_color_selection_set_previous_alpha">
<description>
-Sets the 'previous' alpha to be @alpha.
+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.
@@ -26751,7 +27068,7 @@ as it might seem confusing to have that alpha change.
<function name="gtk_color_selection_set_previous_color">
<description>
-Sets the 'previous' color to be @color.
+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.
@@ -26776,7 +27093,7 @@ Deprecated: 3.4: Use gtk_color_selection_set_previous_rgba() instead.
<function name="gtk_color_selection_set_previous_rgba">
<description>
-Sets the 'previous' color to be @rgba.
+Sets the “previous” color to be @rgba.
This function should be called with some hesitations,
as it might seem confusing to have that color change.
@@ -26801,11 +27118,11 @@ Since: 3.0
<function name="gtk_combo_box_get_active">
<description>
-Returns the index of the currently active item, or -1 if there's no
+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.
+`gtk_tree_path_get_indices (path)[0]`, where
+`path` is the #GtkTreePath of the active item.
Since: 2.4
@@ -26817,7 +27134,7 @@ Since: 2.4
</parameter>
</parameters>
<return> An integer which is the index of the currently active item,
-or -1 if there's no active item.
+or -1 if there’s no active item.
</return>
</function>
@@ -27028,7 +27345,7 @@ during construction.
<function name="gtk_combo_box_get_popup_accessible">
<description>
-Gets the accessible object corresponding to the combo box's popup.
+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.
@@ -27043,7 +27360,7 @@ Since: 2.6
</parameter>
</parameters>
<return> the accessible object corresponding
-to the combo box's popup.
+to the combo box’s popup.
</return>
</function>
@@ -27119,7 +27436,7 @@ Deprecated: 3.10
</parameter_description>
</parameter>
</parameters>
-<return> the menu's title in tearoff mode. This is an internal copy of the
+<return> the menu’s title in tearoff mode. This is an internal copy of the
string which must not be freed.
</return>
@@ -27286,7 +27603,7 @@ Since: 2.4
<description>
Pops up the menu or dropdown list of @combo_box, the popup window
will be grabbed so only @device and its associated pointer/keyboard
-are the only #GdkDevice<!-- -->s able to send events to it.
+are the only #GdkDevices able to send events to it.
Since: 3.0
@@ -27472,7 +27789,7 @@ the internal entry
<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
+like toolbars where you don’t want the keyboard focus removed from
the main area of the application.
Since: 2.6
@@ -27541,7 +27858,7 @@ Since: 2.4
<function name="gtk_combo_box_set_popup_fixed_width">
<description>
-Specifies whether the popup's width should be a fixed width
+Specifies whether the popup’s width should be a fixed width
matching the allocated width of the combo box.
Since: 3.0
@@ -27614,7 +27931,7 @@ Since: 2.4
<function name="gtk_combo_box_set_title">
<description>
-Sets the menu's title in tearoff mode.
+Sets the menu’s title in tearoff mode.
Since: 2.10
@@ -27916,7 +28233,7 @@ pick default packing parameters that may not be correct. So
consider functions such as gtk_box_pack_start() and
gtk_grid_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.
+you can’t place the same widget inside two different containers.
Note that some containers, such as #GtkScrolledWindow or #GtkListBox,
may add intermediate children between the added widget and the
@@ -28047,7 +28364,7 @@ optionally by more name/return location pairs, followed by %NULL
<function name="gtk_container_child_notify">
<description>
Emits a #GtkWidget::child-notify signal for the
-<link linkend="child-properties">child property</link>
+[child property][child-properties]
@child_property on widget.
This is an analogue of g_object_notify() for child properties.
@@ -28206,7 +28523,7 @@ in its class_init function.
gtk_container_class_handle_border_width() is necessary because it
would break API too badly to make this behavior the default. So
-subclasses must "opt in" to the parent class handling border_width
+subclasses must “opt in” to the parent class handling border_width
for them.
</description>
@@ -28287,14 +28604,14 @@ have to be direct children)
<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_*,
+(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> a copy of @children, sorted in correct focusing order,
-with children that aren't suitable for focusing in this direction
+with children that aren’t suitable for focusing in this direction
removed.
</return>
</function>
@@ -28302,8 +28619,8 @@ removed.
<function name="gtk_container_forall">
<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
+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().
@@ -28330,7 +28647,7 @@ rather than gtk_container_forall().
<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
+“internal” child. Most applications should use
gtk_container_foreach(), rather than gtk_container_forall().
</description>
@@ -28370,7 +28687,7 @@ gtk_container_set_border_width().
<function name="gtk_container_get_children">
<description>
-Returns the container's non-internal children. See
+Returns the container’s non-internal children. See
gtk_container_forall() for details on what constitutes an "internal" child.
@@ -28381,7 +28698,7 @@ gtk_container_forall() for details on what constitutes an "internal" c
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated list of the container's non-internal children.
+<return> a newly-allocated list of the container’s non-internal children.
</return>
</function>
@@ -28499,7 +28816,7 @@ from the toplevel down to and including @child.
Returns the resize mode for the container. See
gtk_container_set_resize_mode ().
-Deprecated: 3.12: Resize modes are deprecated. They aren't necessary
+Deprecated: 3.12: Resize modes are deprecated. They aren’t necessary
anymore since frame clocks and might introduce obscure bugs if
used.
@@ -28518,7 +28835,7 @@ used.
<function name="gtk_container_propagate_draw">
<description>
When a container receives a call to the draw function, it must send
-synthetic #GtkWidget::draw calls to all children that don't have their
+synthetic #GtkWidget::draw calls to all children that don’t have their
own #GdkWindows. This function provides a convenient way of doing this.
A container, when it receives a call to its #GtkWidget::draw function,
calls gtk_container_propagate_draw() once for each child, passing in
@@ -28545,7 +28862,7 @@ and then chain to the ::draw implementation from #GtkContainer.
</parameter>
<parameter name="cr">
<parameter_description> Cairo context as passed to the container. If you want to use @cr
-in container's draw function, consider using cairo_save() and
+in container’s draw function, consider using cairo_save() and
cairo_restore() before calling this function.
</parameter_description>
</parameter>
@@ -28559,9 +28876,9 @@ 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
+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.
@@ -28599,7 +28916,7 @@ Sets the border width of the container.
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,
+#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()
@@ -28626,9 +28943,9 @@ the container. Valid values are in the range 0-65535 pixels.
Sets a focus chain, overriding the one computed automatically by GTK+.
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
+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
+in the chain that isn’t always packed. The necessary checks are done
when the focus chain is actually traversed.
</description>
@@ -28739,7 +29056,7 @@ redrawn if any of their children changed allocation.
</parameter_description>
</parameter>
<parameter name="needs_redraws">
-<parameter_description> the new value for the container's @reallocate_redraws flag
+<parameter_description> the new value for the container’s @reallocate_redraws flag
</parameter_description>
</parameter>
</parameters>
@@ -28751,10 +29068,10 @@ redrawn if any of their children changed allocation.
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
+will be passed to the container’s parent, queued for later execution
or executed immediately.
-Deprecated: 3.12: Resize modes are deprecated. They aren't necessary
+Deprecated: 3.12: Resize modes are deprecated. They aren’t necessary
anymore since frame clocks and might introduce obscure bugs if
used.
@@ -28926,12 +29243,12 @@ Returns a newly created #GtkCssProvider.
<function name="gtk_css_provider_to_string">
<description>
-Convertes the @provider into a string representation in CSS
+Converts the @provider into a string representation in CSS
format.
Using gtk_css_provider_load_from_data() with the return value
from this function on a new provider created with
-gtk_css_provider_new() will basicallu create a duplicate of
+gtk_css_provider_new() will basically create a duplicate of
this @provider.
Since: 3.2
@@ -29213,7 +29530,7 @@ Since: 3.0
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
+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.
@@ -29240,8 +29557,8 @@ of the #GtkDialog struct.
Adds a button with the given text and sets things up so that
clicking the button will emit the #GtkDialog::response signal with
the given @response_id. The button is appended to the end of the
-dialog's action area. The button widget is returned, but usually
-you don't need it.
+dialog’s action area. The button widget is returned, but usually
+you don’t need it.
</description>
@@ -29366,7 +29683,7 @@ Since: 2.8
</parameter>
</parameters>
<return> the response id of @widget, or %GTK_RESPONSE_NONE
-if @widget doesn't have a response id set.
+if @widget doesn’t have a response id set.
</return>
</function>
@@ -29430,11 +29747,13 @@ 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",
+Here’s a simple example:
+|[<!-- language="C" -->
+GtkWidget *dialog;
+GtkDialogFlags flags = GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT;
+dialog = gtk_dialog_new_with_buttons ("My dialog",
main_app_window,
-GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT,
+flags,
_("_OK"),
GTK_RESPONSE_ACCEPT,
_("_Cancel"),
@@ -29510,13 +29829,13 @@ destroyed as windows usually are, and gtk_dialog_run() will return
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.
+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:
-|[
+|[<!-- language="C" -->
gint result = gtk_dialog_run (GTK_DIALOG (dialog));
switch (result)
{
@@ -29555,16 +29874,17 @@ Sets an alternative button order. If the
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://library.gnome.org/devel/hig-book/stable/">Human
-Interface Guidelines</ulink> with the affirmative button at the far
+By default, GTK+ dialogs use the button order advocated by the
+[GNOME Human Interface Guidelines](http://library.gnome.org/devel/hig-book/stable/)
+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,
+and #GtkMessageDialogs 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:
-|[
+
+|[<!-- language="C" -->
cancel_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
_("_Cancel"),
GTK_RESPONSE_CANCEL);
@@ -29596,11 +29916,11 @@ Deprecated: 3.10: Deprecated
</parameter_description>
</parameter>
<parameter name="first_response_id">
-<parameter_description> a response id used by one @dialog's buttons
+<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> a list of more response ids of @dialog’s buttons, terminated by -1
</parameter_description>
</parameter>
</parameters>
@@ -29633,7 +29953,7 @@ Deprecated: 3.10: Deprecated
</parameter>
<parameter name="new_order">
<parameter_description> an array of response ids of
- dialog's buttons
+ dialog’s buttons
</parameter_description>
</parameter>
</parameters>
@@ -29642,8 +29962,8 @@ Deprecated: 3.10: Deprecated
<function name="gtk_dialog_set_default_response">
<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
+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>
@@ -29662,8 +29982,8 @@ the default widget.
<function name="gtk_dialog_set_response_sensitive">
<description>
-Calls <literal>gtk_widget_set_sensitive (widget, @setting)</literal>
-for each widget in the dialog's action area with the given @response_id.
+Calls `gtk_widget_set_sensitive (widget, @setting)`
+for each widget in the dialog’s action area with the given @response_id.
A convenient way to sensitize/desensitize dialog buttons.
</description>
@@ -29688,9 +30008,9 @@ A convenient way to sensitize/desensitize dialog buttons.
<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
+calling `setlocale (LC_ALL, "")`. 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
+your program to something other than the user’s locale, or if
you wanted to set different values for different locale categories.
Most programs should not need to call this function.
@@ -29869,7 +30189,7 @@ the current pointer position.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget that's a drag destination
+<parameter_description> a #GtkWidget that’s a drag destination
</parameter_description>
</parameter>
</parameters>
@@ -29882,7 +30202,7 @@ the current pointer position.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget that's a drag destination
+<parameter_description> a #GtkWidget that’s a drag destination
</parameter_description>
</parameter>
</parameters>
@@ -29895,7 +30215,7 @@ the current pointer position.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget that's a drag destination
+<parameter_description> a #GtkWidget that’s a drag destination
</parameter_description>
</parameter>
</parameters>
@@ -29943,7 +30263,7 @@ gtk_drag_dest_get_target_list (@widget).
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget that's a drag destination
+<parameter_description> a #GtkWidget that’s a drag destination
</parameter_description>
</parameter>
</parameters>
@@ -29964,7 +30284,7 @@ gtk_drag_dest_get_target_list (@widget).
</parameter_description>
</parameter>
<parameter name="targets">
-<parameter_description> a pointer to an array of #GtkTargetEntry<!-- -->s
+<parameter_description> a pointer to an array of #GtkTargetEntrys
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().
@@ -30016,7 +30336,7 @@ subwindow.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget that's a drag destination
+<parameter_description> a #GtkWidget that’s a drag destination
</parameter_description>
</parameter>
<parameter name="target_list">
@@ -30033,7 +30353,7 @@ subwindow.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget that's a drag destination
+<parameter_description> a #GtkWidget that’s a drag destination
</parameter_description>
</parameter>
<parameter name="track_motion">
@@ -30300,8 +30620,8 @@ with a context for the source side of a drag)
<function name="gtk_drag_set_icon_widget">
<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"
+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>
@@ -30333,7 +30653,7 @@ signal and destroy it yourself.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget that's is a drag source
+<parameter_description> a #GtkWidget that’s is a drag source
</parameter_description>
</parameter>
</parameters>
@@ -30353,7 +30673,7 @@ Since: 2.6
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget that's is a drag source
+<parameter_description> a #GtkWidget that’s is a drag source
</parameter_description>
</parameter>
</parameters>
@@ -30366,7 +30686,7 @@ Since: 2.6
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget that's is a drag source
+<parameter_description> a #GtkWidget that’s is a drag source
</parameter_description>
</parameter>
</parameters>
@@ -30500,7 +30820,7 @@ to a stock icon.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget that's a drag source
+<parameter_description> a #GtkWidget that’s a drag source
</parameter_description>
</parameter>
<parameter name="target_list">
@@ -30653,7 +30973,7 @@ puts it on the clipboard.
<function name="gtk_editable_delete_selection">
<description>
Deletes the currently selected text of the editable.
-This call doesn't do anything if there is no selected text.
+This call doesn’t do anything if there is no selected text.
</description>
<parameters>
@@ -31231,7 +31551,7 @@ or %NULL if no row matches @key.
<function name="gtk_entry_completion_delete_action">
<description>
-Deletes the action at @index_ from @completion's action list.
+Deletes the action at @index_ from @completion’s action list.
Since: 2.4
@@ -31252,7 +31572,7 @@ Since: 2.4
<function name="gtk_entry_completion_get_completion_prefix">
<description>
Get the original text entered by the user that triggered
-the completion or %NULL if there's no completion ongoing.
+the completion or %NULL if there’s no completion ongoing.
Since: 2.12
@@ -31439,7 +31759,7 @@ Since: 2.6
<function name="gtk_entry_completion_insert_action_markup">
<description>
-Inserts an action in @completion's action item list at position @index_
+Inserts an action in @completion’s action item list at position @index_
with markup @markup.
Since: 2.4
@@ -31464,7 +31784,7 @@ Since: 2.4
<function name="gtk_entry_completion_insert_action_text">
<description>
-Inserts an action in @completion's action item list at position @index_
+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().
@@ -31700,8 +32020,7 @@ Since: 2.8
<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>.
+are using [inline completion][GtkEntryCompletion--inline-completion].
Since: 2.8
@@ -31727,15 +32046,10 @@ 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.
-The cell renderer added by this function is managed internally. Do
-not access or modify it.
-
-Any cell renderers that were added to @completion before calling this
-function will be removed.
-
-Conversely, the cell renderer created by this function will be
-removed when new renderers are added to @completion with
-gtk_cell_layout_pack_start() or gtk_cell_layout_pack_end().
+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 #GtkEntryCompletion:text-column
+property directly.
Since: 2.4
@@ -31928,7 +32242,7 @@ Since: 2.16
<function name="gtk_entry_get_icon_area">
<description>
-Gets the area where entry's icon at @icon_pos is drawn.
+Gets the area where entry’s icon at @icon_pos is drawn.
This function is useful when drawing something to the
entry in a draw callback.
@@ -31950,7 +32264,7 @@ Since: 3.0
</parameter_description>
</parameter>
<parameter name="icon_area">
-<parameter_description> Return location for the icon's area
+<parameter_description> Return location for the icon’s area
</parameter_description>
</parameter>
</parameters>
@@ -31960,8 +32274,8 @@ Since: 3.0
<function name="gtk_entry_get_icon_at_pos">
<description>
Finds the icon at the given position and return its index. The
-position's coordinates are relative to the @entry's top left corner.
-If @x, @y doesn't lie inside an icon, -1 is returned.
+position’s coordinates are relative to the @entry’s top left corner.
+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.
@@ -32032,7 +32346,7 @@ Since: 2.16
</parameter>
</parameters>
<return> An icon name, or %NULL if no icon is set or if the icon
-wasn't set from an icon name
+wasn’t set from an icon name
</return>
</function>
@@ -32108,7 +32422,7 @@ Deprecated: 3.10: Use gtk_entry_get_icon_name() instead.
</parameter>
</parameters>
<return> A stock id, or %NULL if no icon is set or if the icon
-wasn't set from a stock id
+wasn’t set from a stock id
</return>
</function>
@@ -32187,7 +32501,7 @@ with g_free() when done.
<function name="gtk_entry_get_inner_border">
<description>
-This function returns the entry's #GtkEntry:inner-border property. See
+This function returns the entry’s #GtkEntry:inner-border property. See
gtk_entry_set_inner_border() for more information.
Since: 2.10
@@ -32203,7 +32517,7 @@ this function is ignored by #GtkEntry.
</parameter_description>
</parameter>
</parameters>
-<return> the entry's #GtkBorder, or %NULL if none was set.
+<return> the entry’s #GtkBorder, or %NULL if none was set.
</return>
</function>
@@ -32295,7 +32609,7 @@ Also useful to convert mouse events into coordinates inside the
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"
+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.
@@ -32330,9 +32644,11 @@ Retrieves the maximum allowed length of the text in
This is equivalent to:
-<informalexample><programlisting>
-gtk_entry_buffer_get_max_length (gtk_entry_get_buffer (entry));
-</programlisting></informalexample>
+|[<!-- language="C" -->
+GtkEntryBuffer *buffer;
+buffer = gtk_entry_get_buffer (entry);
+gtk_entry_buffer_get_max_length (buffer);
+]|
</description>
@@ -32347,6 +32663,25 @@ in #GtkEntry, or 0 if there is no maximum.
</return>
</function>
+<function name="gtk_entry_get_max_width_chars">
+<description>
+Retrieves the desired maximum width of @entry, in characters.
+See gtk_entry_set_max_width_chars().
+
+Since: 3.12
+
+</description>
+<parameters>
+<parameter name="entry">
+<parameter_description> a #GtkEntry
+</parameter_description>
+</parameter>
+</parameters>
+<return> the maximum width of the entry, in characters
+
+</return>
+</function>
+
<function name="gtk_entry_get_overwrite_mode">
<description>
Gets the value set by gtk_entry_set_overwrite_mode().
@@ -32386,7 +32721,7 @@ storage in the widget and must not be freed, modified or stored.
<function name="gtk_entry_get_progress_fraction">
<description>
-Returns the current fraction of the task that's been completed.
+Returns the current fraction of the task that’s been completed.
See gtk_entry_set_progress_fraction().
Since: 2.16
@@ -32447,9 +32782,11 @@ See also gtk_editable_get_chars().
This is equivalent to:
-<informalexample><programlisting>
-gtk_entry_buffer_get_text (gtk_entry_get_buffer (entry));
-</programlisting></informalexample>
+|[<!-- language="C" -->
+GtkEntryBuffer *buffer;
+buffer = gtk_entry_get_buffer (entry);
+gtk_entry_buffer_get_text (buffer);
+]|
</description>
@@ -32468,7 +32805,7 @@ stored.
<function name="gtk_entry_get_text_area">
<description>
-Gets the area where the entry's text is drawn. This function is
+Gets the area where the entry’s text is drawn. This function is
useful when drawing something to the entry in a draw callback.
If the entry is not realized, @text_area is filled with zeros.
@@ -32498,9 +32835,11 @@ Retrieves the current length of the text in
This is equivalent to:
-<informalexample><programlisting>
-gtk_entry_buffer_get_length (gtk_entry_get_buffer (entry));
-</programlisting></informalexample>
+|[<!-- language="C" -->
+GtkEntryBuffer *buffer;
+buffer = gtk_entry_get_buffer (entry);
+gtk_entry_buffer_get_length (buffer);
+]|
Since: 2.14
@@ -32585,7 +32924,7 @@ Since: 2.22
<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(),
+entry’s #PangoLayout (returned by gtk_entry_get_layout(),
with text retrieved via pango_layout_get_text()).
@@ -32636,8 +32975,8 @@ Since: 2.18
<function name="gtk_entry_progress_pulse">
<description>
-Indicates that some progress is made, but you don't know how much.
-Causes the entry's progress indicator to enter "activity mode,"
+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
@@ -32692,7 +33031,7 @@ the default handler for the #GtkEntry::activate signal.)
</parameter_description>
</parameter>
<parameter name="setting">
-<parameter_description> %TRUE to activate window's default widget on Enter keypress
+<parameter_description> %TRUE to activate window’s default widget on Enter keypress
</parameter_description>
</parameter>
</parameters>
@@ -32900,7 +33239,7 @@ Since: 2.16
<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
+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.
@@ -32930,7 +33269,7 @@ Since: 2.16
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
+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.
@@ -33039,7 +33378,7 @@ sensitive or insensitive
<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>.
+the [Pango text markup language][PangoMarkupFormat].
Use %NULL for @tooltip to remove an existing tooltip.
@@ -33098,8 +33437,8 @@ Since: 2.16
<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
+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.
@@ -33174,7 +33513,7 @@ Since: 3.6
<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
+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
@@ -33202,9 +33541,11 @@ will be truncated to fit.
This is equivalent to:
-<informalexample><programlisting>
-gtk_entry_buffer_set_max_length (gtk_entry_get_buffer (entry), max);
-</programlisting></informalexample>
+|[<!-- language="C" -->
+GtkEntryBuffer *buffer;
+buffer = gtk_entry_get_buffer (entry);
+gtk_entry_buffer_set_max_length (buffer, max);
+]|
</description>
<parameters>
@@ -33222,6 +33563,26 @@ be clamped to the range 0-65536.
<return></return>
</function>
+<function name="gtk_entry_set_max_width_chars">
+<description>
+Sets the desired maximum width in characters of @entry.
+
+Since: 3.12
+
+</description>
+<parameters>
+<parameter name="entry">
+<parameter_description> a #GtkEntry
+</parameter_description>
+</parameter>
+<parameter name="n_chars">
+<parameter_description> the new desired maximum width, in characters
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="gtk_entry_set_overwrite_mode">
<description>
Sets whether the text is overwritten when typing in the #GtkEntry.
@@ -33272,7 +33633,7 @@ Since: 3.2
<function name="gtk_entry_set_progress_fraction">
<description>
-Causes the entry's progress indicator to "fill in" the given
+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.
@@ -33285,7 +33646,7 @@ Since: 2.16
</parameter_description>
</parameter>
<parameter name="fraction">
-<parameter_description> fraction of the task that's been completed
+<parameter_description> fraction of the task that’s been completed
</parameter_description>
</parameter>
</parameters>
@@ -33410,7 +33771,7 @@ size reverts to the default entry size.
<function name="gtk_entry_text_index_to_layout_index">
<description>
-Converts from a position in the entry's #PangoLayout (returned by
+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()).
@@ -33450,7 +33811,7 @@ Since: 2.16
<function name="gtk_enumerate_printers">
<description>
-Calls a function for all #GtkPrinter<!-- -->s.
+Calls a function for all #GtkPrinters.
If @func returns %TRUE, the enumeration is stopped.
Since: 2.10
@@ -33579,20 +33940,18 @@ 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
+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
+it won’t be received by the event box.
+
+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
@@ -33617,17 +33976,16 @@ Checks if any events are pending.
This can be used to update the UI and invoke timeouts etc.
while doing some time intensive computation.
-<example>
-<title>Updating the UI during a long computation</title>
-<programlisting>
-/ * computation going on... * /
+## Updating the UI during a long computation
+
+|[<!-- language="C" -->
+// computation going on...
while (gtk_events_pending ())
gtk_main_iteration ();
-/ * ...computation continued * /
-</programlisting>
-</example>
+// ...computation continued
+]|
</description>
@@ -33741,7 +34099,7 @@ Since: 3.2
</parameter_description>
</parameter>
</parameters>
-<return> the "resize toplevel" setting.
+<return> the “resize toplevel” setting.
</return>
</function>
@@ -33766,9 +34124,9 @@ Since: 2.4
<function name="gtk_expander_get_use_markup">
<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().
+Returns whether the label’s text is interpreted as marked up with
+the [Pango text markup language][PangoMarkupFormat].
+See gtk_expander_set_use_markup().
Since: 2.4
@@ -33779,7 +34137,7 @@ Since: 2.4
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the label's text will be parsed for markup
+<return> %TRUE if the label’s text will be parsed for markup
</return>
</function>
@@ -33826,7 +34184,7 @@ Since: 2.4
<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
+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.
@@ -33977,9 +34335,9 @@ Since: 2.4
<function name="gtk_expander_set_use_markup">
<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 whether the text of the label contains markup in
+[Pango’s text markup language][PangoMarkupFormat].
+See gtk_label_set_markup().
Since: 2.4
@@ -33990,7 +34348,7 @@ Since: 2.4
</parameter_description>
</parameter>
<parameter name="use_markup">
-<parameter_description> %TRUE if the label's text should be parsed for markup
+<parameter_description> %TRUE if the label’s text should be parsed for markup
</parameter_description>
</parameter>
</parameters>
@@ -34061,7 +34419,7 @@ Since: 2.4
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.
+“/usr/share/mydrawprogram/Clipart” folder to the volume list.
Since: 2.4
@@ -34091,7 +34449,7 @@ otherwise. In the latter case, the @error will be set as appropriate.
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.
+“file:///usr/share/mydrawprogram/Clipart” folder to the volume list.
Since: 2.4
@@ -34150,14 +34508,14 @@ Since: 2.6
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the browse dialog's title.
+<return> a pointer to the browse dialog’s title.
</return>
</function>
<function name="gtk_file_chooser_button_get_width_chars">
<description>
-Retrieves the width in characters of the @button widget's entry and/or label.
+Retrieves the width in characters of the @button widget’s entry and/or label.
Since: 2.6
@@ -34226,7 +34584,7 @@ Since: 2.6
<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
+you don’t want the keyboard focus removed from the main area of the
application.
Since: 2.10
@@ -34456,13 +34814,13 @@ gtk_file_chooser_set_current_folder_uri() on a nonexistent folder.
<function name="gtk_file_chooser_get_current_name">
<description>
Gets the current name in the file selector, as entered by the user in the
-text entry for "Name".
+text entry for “Name”.
This is meant to be used in save dialogs, to get the currently typed filename
when the file itself does not exist yet. For example, an application that
-adds a custom extra widget to the file chooser for "file format" may want to
+adds a custom extra widget to the file chooser for “file format” may want to
change the extension of the typed filename based on the chosen format, say,
-from ".jpg" to ".png".
+from “.jpg” to “.png”.
Since: 3.10
@@ -34473,10 +34831,10 @@ Since: 3.10
</parameter_description>
</parameter>
</parameters>
-<return> The raw text from the file chooser's "Name" entry. Free this with
+<return> The raw text from the file chooser’s “Name” entry. Free this with
g_free(). Note that this string is not a full pathname or URI; it is
whatever the contents of the entry are. Note also that this string is in
-UTF-8 encoding, which is not necessarily the system's encoding for filenames.
+UTF-8 encoding, which is not necessarily the system’s encoding for filenames.
</return>
</function>
@@ -34943,7 +35301,7 @@ Since: 2.4
<function name="gtk_file_chooser_remove_shortcut_folder">
<description>
-Removes a folder from a file chooser's list of shortcut folders.
+Removes a folder from a file chooser’s list of shortcut folders.
Since: 2.4
@@ -34972,7 +35330,7 @@ See also: gtk_file_chooser_add_shortcut_folder()
<function name="gtk_file_chooser_remove_shortcut_folder_uri">
<description>
-Removes a folder URI from a file chooser's list of shortcut folders.
+Removes a folder URI from a file chooser’s list of shortcut folders.
Since: 2.4
@@ -35044,7 +35402,7 @@ Since: 2.14
<function name="gtk_file_chooser_select_filename">
<description>
-Selects a filename. If the file name isn't in the current
+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.
@@ -35070,7 +35428,7 @@ See also: gtk_file_chooser_set_filename()
<function name="gtk_file_chooser_select_uri">
<description>
-Selects the file to by @uri. If the URI doesn't refer to a
+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.
@@ -35144,9 +35502,9 @@ 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.
-In general, you should not use this function. See the <link
-linkend="gtkfilechooserdialog-setting-up">section on setting up a file
-chooser dialog</link> for the rationale behind this.
+In general, you should not use this function. See the
+[section on setting up a file chooser dialog][gtkfilechooserdialog-setting-up]
+for the rationale behind this.
Since: 2.4
@@ -35200,9 +35558,9 @@ 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.
-In general, you should not use this function. See the <link
-linkend="gtkfilechooserdialog-setting-up">section on setting up a file
-chooser dialog</link> for the rationale behind this.
+In general, you should not use this function. See the
+[section on setting up a file chooser dialog][gtkfilechooserdialog-setting-up]
+for the rationale behind this.
Since: 2.4
@@ -35228,8 +35586,8 @@ otherwise.
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. You can
-pass "Untitled.doc" or a similarly suitable suggestion for the @name.
+such uses as a suggested name in a “Save As...” dialog. You can
+pass “Untitled.doc” or a similarly suitable suggestion for the @name.
If you want to preselect a particular existing file, you should use
gtk_file_chooser_set_filename() or gtk_file_chooser_set_uri() instead.
@@ -35305,11 +35663,11 @@ Since: 2.4
<function name="gtk_file_chooser_set_file">
<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.
+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
+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().
@@ -35320,20 +35678,20 @@ for the directory change.
If you are implementing a save 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 Save As... If you don't have
+does Save As... 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:
-|[
+|[<!-- language="C" -->
if (document_is_new)
{
-/ * the user just created a new document * /
+// 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 * /
+// the user edited an existing document
gtk_file_chooser_set_file (chooser, existing_file);
}
]|
@@ -35363,10 +35721,10 @@ Since: 2.14
<function name="gtk_file_chooser_set_filename">
<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; all other
+the file’s parent folder and actually selecting the file in list; all other
files will be unselected. 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.
+%GTK_FILE_CHOOSER_ACTION_SAVE mode, the file’s base name will also appear in
+the dialog’s file name entry.
Note that the file must exist, or nothing will be done except
for the directory change.
@@ -35375,24 +35733,24 @@ You should use this function only when implementing a save
dialog for which you already have a file name to which
the user may save. For example, when the user opens an existing file and
then does Save As... to save a copy or
-a modified version. If you don't have a file name already — for
+a modified version. 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:
-|[
+|[<!-- language="C" -->
if (document_is_new)
{
-/ * the user just created a new document * /
+// the user just created a new document
gtk_file_chooser_set_current_name (chooser, "Untitled document");
}
else
{
-/ * the user edited an existing document * /
+// the user edited an existing document
gtk_file_chooser_set_filename (chooser, existing_filename);
}
]|
In the first case, the file chooser will present the user with useful suggestions
-as to where to save his new file. In the second case, the file's existing location
+as to where to save his new file. In the second case, the file’s existing location
is already known, so the file chooser will use it.
Since: 2.4
@@ -35571,9 +35929,9 @@ Since: 2.6
<function name="gtk_file_chooser_set_uri">
<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.
+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.
Note that the URI must exist, or nothing will be done except for the
directory change.
@@ -35582,25 +35940,25 @@ You should use this function only when implementing a save
dialog for which you already have a file name to which
the user may save. For example, when the user opens an existing file and then
does Save As... to save a copy or a
-modified version. If you don't have a file name already — for example,
+modified version. 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:
-|[
+|[<!-- language="C" -->
if (document_is_new)
{
-/ * the user just created a new document * /
+// the user just created a new document
gtk_file_chooser_set_current_name (chooser, "Untitled document");
}
else
{
-/ * the user edited an existing document * /
+// the user edited an existing document
gtk_file_chooser_set_uri (chooser, existing_uri);
}
]|
In the first case, the file chooser will present the user with useful suggestions
-as to where to save his new file. In the second case, the file's existing location
+as to where to save his new file. In the second case, the file’s existing location
is already known, so the file chooser will use it.
Since: 2.4
@@ -35753,7 +36111,7 @@ 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.
+it isn’t needed by the filter.
Since: 2.4
@@ -35918,12 +36276,12 @@ calling gtk_file_filter_filter()
<function name="gtk_file_filter_new">
<description>
Creates a new #GtkFileFilter with no rules added to it.
-Such a filter doesn't accept any files, so is not
+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:
-|[
+|[<!-- language="C" -->
GtkFileFilter *filter = gtk_file_filter_new ();
gtk_file_filter_add_pattern (filter, "*");
]|
@@ -36038,7 +36396,7 @@ gtk_flow_box_child_changed() on the first child, the sort function
must only read the new data for the first of the two changed
children, otherwise the resorting of the children will be wrong.
-This generally means that if you don't fully control the data
+This generally means that if you don’t fully control the data
model, you have to duplicate the data that affects the sorting
and filtering functions into the widgets themselves. Another
alternative is to call gtk_flow_box_invalidate_sort() on any
@@ -36479,7 +36837,7 @@ By setting a filter function on the @box one can decide dynamically
which of the children to show. For instance, to implement a search
function that only shows the children matching the search terms.
-The @filter_func will be called for ach child after the call, and
+The @filter_func will be called for each child after the call, and
it will continue to be called each time a child changes (via
gtk_flow_box_child_changed()) or when gtk_flow_box_invalidate_filter()
is called.
@@ -36565,7 +36923,7 @@ Since: 3.12
<function name="gtk_flow_box_set_max_children_per_line">
<description>
Sets the maximum number of children to request and
-allocate space for in @box's orientation.
+allocate space for in @box’s orientation.
Setting the maximum number of children per line
limits the overall natural size request to be no more
@@ -36590,7 +36948,7 @@ Since: 3.12
<function name="gtk_flow_box_set_min_children_per_line">
<description>
Sets the minimum number of children to line up
-in @box's orientation before flowing.
+in @box’s orientation before flowing.
Since: 3.12
@@ -36758,7 +37116,7 @@ Since: 3.12
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,
+If you’re interested in peeking certain values (family name,
style, size, weight) just query these properties from the
#PangoFontDescription object.
@@ -37049,8 +37407,8 @@ Gets the currently-selected font name.
Note that this can be a different string than what you set with
gtk_font_chooser_set_font(), as the font chooser 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".
+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.
@@ -37078,8 +37436,8 @@ Gets the currently-selected font.
Note that this can be a different string than what you set with
gtk_font_chooser_set_font(), as the font chooser 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".
+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.
@@ -37244,7 +37602,7 @@ Since: 3.2
</parameter_description>
</parameter>
<parameter name="fontname">
-<parameter_description> a font name like "Helvetica 12" or "Times Bold 18"
+<parameter_description> a font name like “Helvetica 12” or “Times Bold 18”
</parameter_description>
</parameter>
</parameters>
@@ -37328,7 +37686,7 @@ Since: 3.2
<function name="gtk_font_selection_dialog_get_cancel_button">
<description>
-Gets the 'Cancel' button.
+Gets the “Cancel” button.
Since: 2.14
@@ -37342,7 +37700,7 @@ Deprecated: 3.2: Use #GtkFontChooserDialog
</parameter>
</parameters>
<return> the #GtkWidget used in the dialog
-for the 'Cancel' button.
+for the “Cancel” button.
</return>
</function>
@@ -37354,8 +37712,8 @@ 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()
+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.
Deprecated: 3.2: Use #GtkFontChooserDialog
@@ -37395,7 +37753,7 @@ Deprecated: 3.2: Use #GtkFontChooserDialog
<function name="gtk_font_selection_dialog_get_ok_button">
<description>
-Gets the 'OK' button.
+Gets the “OK” button.
Since: 2.14
@@ -37409,7 +37767,7 @@ Deprecated: 3.2: Use #GtkFontChooserDialog
</parameter>
</parameters>
<return> the #GtkWidget used in the dialog
-for the 'OK' button.
+for the “OK” button.
</return>
</function>
@@ -37465,7 +37823,7 @@ Deprecated: 3.2: Use #GtkFontChooserDialog
</parameter_description>
</parameter>
<parameter name="fontname">
-<parameter_description> a font name like "Helvetica 12" or "Times Bold 18"
+<parameter_description> a font name like “Helvetica 12” or “Times Bold 18”
</parameter_description>
</parameter>
</parameters>
@@ -37521,7 +37879,7 @@ selected font group details. The returned object is owned by
<function name="gtk_font_selection_get_face_list">
<description>
This returns the #GtkTreeView which lists all styles available for
-the selected font. For example, 'Regular', 'Bold', etc.
+the selected font. For example, “Regular”, “Bold”, etc.
Since: 2.14
@@ -37565,7 +37923,7 @@ be modified or freed.
<function name="gtk_font_selection_get_family_list">
<description>
This returns the #GtkTreeView that lists font families, for
-example, 'Sans', 'Serif', etc.
+example, “Sans”, “Serif”, etc.
Since: 2.14
@@ -37590,8 +37948,8 @@ 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()
+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.
Deprecated: 3.2: Use #GtkFontChooser
@@ -37742,12 +38100,12 @@ Deprecated: 3.2: Use #GtkFontChooser
</parameter_description>
</parameter>
<parameter name="fontname">
-<parameter_description> a font name like "Helvetica 12" or "Times Bold 18"
+<parameter_description> a font name like “Helvetica 12” or “Times Bold 18”
</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
+such font exists or if the @fontsel doesn’t belong to a particular
screen yet.
</return>
@@ -37776,7 +38134,7 @@ Deprecated: 3.2: Use #GtkFontChooser
<function name="gtk_frame_get_label">
<description>
-If the frame's label widget is a #GtkLabel, returns the
+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().)
@@ -37798,7 +38156,7 @@ must not be modified or freed.
<function name="gtk_frame_get_label_align">
<description>
-Retrieves the X and Y alignment of the frame's label. See
+Retrieves the X and Y alignment of the frame’s label. See
gtk_frame_set_label_align().
</description>
@@ -37809,12 +38167,12 @@ gtk_frame_set_label_align().
</parameter>
<parameter name="xalign">
<parameter_description> location to store X alignment of
-frame's label, or %NULL
+frame’s label, or %NULL
</parameter_description>
</parameter>
<parameter name="yalign">
<parameter_description> location to store X alignment of
-frame's label, or %NULL
+frame’s label, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -37893,7 +38251,7 @@ the current label is removed.
<function name="gtk_frame_set_label_align">
<description>
-Sets the alignment of the frame widget's label. The
+Sets the alignment of the frame widget’s label. The
default values for a newly created frame are 0.0 and 0.5.
</description>
@@ -37911,7 +38269,7 @@ of the widget. A value of 0.0 represents left alignment;
<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
+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>
@@ -37959,9 +38317,9 @@ Sets the shadow type for @frame.
<function name="gtk_get_binary_age">
<description>
-Returns the binary age as passed to <application>libtool</application>
+Returns the binary age as passed to `libtool`
when building the GTK+ library the process is running against.
-If <application>libtool</application> means nothing to you, don't
+If `libtool` means nothing to you, don't
worry about it.
Since: 3.0
@@ -38094,9 +38452,9 @@ received @event, or %NULL
<function name="gtk_get_interface_age">
<description>
-Returns the interface age as passed to <application>libtool</application>
+Returns the interface age as passed to `libtool`
when building the GTK+ library the process is running against.
-If <application>libtool</application> means nothing to you, don't
+If `libtool` means nothing to you, don't
worry about it.
Since: 3.0
@@ -38127,7 +38485,7 @@ This function is only needed rare cases when the locale is
changed after GTK+ has already been initialized. In this case,
you can use it to update the default text direction as follows:
-|[
+|[<!-- language="C" -->
setlocale (LC_ALL, new_locale);
direction = gtk_get_locale_direction ();
gtk_widget_set_default_direction (direction);
@@ -38405,7 +38763,7 @@ Deprecated: 3.8: #GtkGradient is deprecated.
<description>
If @gradient is resolvable, @resolved_gradient will be filled in
with the resolved gradient as a cairo_pattern_t, and %TRUE will
-be returned. Generally, if @gradient can't be resolved, it is
+be returned. Generally, if @gradient can’t be resolved, it is
due to it being defined on top of a named color that doesn't
exist in @props.
@@ -38476,7 +38834,7 @@ Deprecated: 3.8: #GtkGradient is deprecated.
Adds a widget to the grid.
The position of @child is determined by @left and @top. The
-number of 'cells' that @child will occupy is determined by
+number of “cells” that @child will occupy is determined by
@width and @height.
</description>
@@ -38949,7 +39307,7 @@ Sets the amount of space between rows of @grid.
<function name="gtk_handle_box_get_child_detached">
<description>
-Whether the handlebox's child is currently detached.
+Whether the handlebox’s child is currently detached.
Since: 2.14
@@ -39085,7 +39443,7 @@ Deprecated: 3.4: #GtkHandleBox has been deprecated.
<description>
Sets the snap edge of a handlebox. The snap edge is
the edge of the detached child that must be aligned
-with the corresponding edge of the "ghost" left
+with the corresponding edge of the “ghost” left
behind when the child was detached to reattach
the torn-off window. Usually, the snap edge should
be chosen so that it stays in the same place on
@@ -39122,7 +39480,7 @@ Creates a new #GtkHBox.
Deprecated: 3.2: You can use gtk_box_new() with %GTK_ORIENTATION_HORIZONTAL instead,
which is a quick and easy change. But the recommendation is to switch to
#GtkGrid, since #GtkBox is going to go away eventually.
-See <xref linkend="gtk-migrating-GtkGrid"/>.
+See [Migrating from other containers to GtkGrid][gtk-migrating-GtkGrid].
</description>
<parameters>
@@ -39195,6 +39553,9 @@ Since: 3.12
<function name="gtk_header_bar_get_has_subtitle">
<description>
+Retrieves whether the header bar reserves space for
+a subtitle, regardless if one is currently set or not.
+
Since: 3.12
</description>
@@ -39205,7 +39566,7 @@ Since: 3.12
</parameter>
</parameters>
<return> %TRUE if the header bar reserves space
-for a subtitle.
+for a subtitle
</return>
</function>
@@ -39332,7 +39693,7 @@ Sets a custom title for the #GtkHeaderBar.
The title should help a user identify the current view. This
supersedes any title set by gtk_header_bar_set_title() or
gtk_header_bar_set_subtitle(). To achieve the same style as
-the builtin title and subtitle, use the "title" and "subtitle"
+the builtin title and subtitle, use the “title” and “subtitle”
style classes.
You should set the custom title to %NULL, for the header title
@@ -39371,7 +39732,7 @@ from those on the right. Recognized button names are minimize,
maximize, close, icon (the window icon) and menu (a menu button
for the fallback app menu).
-For example, "menu:minimize,maximize,close" specifies a menu
+For example, “menu:minimize,maximize,close” specifies a menu
on the left, and minimize, maximize and close buttons on the right.
Since: 3.12
@@ -39516,7 +39877,7 @@ Deprecated: 3.2: Use gtk_scale_new() with %GTK_ORIENTATION_HORIZONTAL instead
<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
+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
@@ -39763,12 +40124,12 @@ Since: 2.14
<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
+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
+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.
@@ -39870,7 +40231,7 @@ 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
+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
@@ -40062,7 +40423,7 @@ Since: 2.4
</parameter>
</parameters>
<return> the display name for the icon or %NULL, if
-the icon doesn't have a specified display name. This value
+the icon doesn’t have a specified display name. This value
is owned @icon_info and must not be modified or free.
</return>
@@ -40292,11 +40653,11 @@ Unless you are implementing a widget, you will want to use
g_themed_icon_new_with_default_fallbacks() to load the icon.
As implementation details, the icon loaded needs to be of SVG type,
-contain the "symbolic" term as the last component of the icon name,
-and use the 'fg', 'success', 'warning' and 'error' CSS styles in the
+contain the “symbolic” term as the last component of the icon name,
+and use the “fg”, “success”, “warning” and “error” CSS styles in the
SVG file itself.
-See the <ulink url="http://www.freedesktop.org/wiki/SymbolicIcons">Symbolic Icons
spec</ulink>
+See the [Symbolic Icons Specification](http://www.freedesktop.org/wiki/SymbolicIcons)
for more information about symbolic icons.
Since: 3.0
@@ -40438,7 +40799,7 @@ Loads an icon, modifying it to match the system colors for the foreground,
success, warning and error colors provided. If the icon is not a symbolic
one, the function will return the result from gtk_icon_info_load_icon().
This function uses the regular foreground color and the symbolic colors
-with the names "success_color", "warning_color" and "error_color" from
+with the names “success_color”, “warning_color” and “error_color” from
the context.
This allows loading symbolic icons that will match the system theme.
@@ -40627,7 +40988,7 @@ 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'.
+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.
@@ -40662,14 +41023,14 @@ 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
+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
+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
@@ -40746,7 +41107,7 @@ 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_pixbuf() instead of
-using #GtkIconSet directly. The one case where you'd use
+using #GtkIconSet directly. The one case where you’d use
#GtkIconSet is to create application-specific icon sets to place in
a #GtkIconFactory.
@@ -40763,7 +41124,7 @@ Deprecated: 3.10: Use #GtkIconTheme instead.
<function name="gtk_icon_set_new_from_pixbuf">
<description>
Creates a new #GtkIconSet with @pixbuf as the default/fallback
-source image. If you don't add any additional #GtkIconSource to the
+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.
@@ -40805,7 +41166,7 @@ Deprecated: 3.10: Use #GtkIconTheme instead.
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
+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.
@@ -40831,7 +41192,7 @@ Deprecated: 3.0: Use gtk_icon_set_render_icon_pixbuf() instead
</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.
+means render at the size of the source and don’t scale.
</parameter_description>
</parameter>
<parameter name="widget">
@@ -40857,7 +41218,7 @@ will disable caching.
Renders an icon using gtk_render_icon_pixbuf(). In most cases,
gtk_widget_render_icon_pixbuf() 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
+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.
@@ -40877,7 +41238,7 @@ Deprecated: 3.10: Use #GtkIconTheme instead.
</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.
+means render at the size of the source and don’t scale.
</parameter_description>
</parameter>
</parameters>
@@ -40891,7 +41252,7 @@ means render at the size of the source and don't scale.
Renders an icon using gtk_render_icon_pixbuf() and converts it to a
cairo surface.
-This function never returns %NULL; if the icon can't be rendered
+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.
@@ -40911,7 +41272,7 @@ Deprecated: 3.10: Use #GtkIconTheme instead.
</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.
+means render at the size of the source and don’t scale.
</parameter_description>
</parameter>
<parameter name="scale">
@@ -40986,7 +41347,7 @@ Deprecated: 3.10: Use #GtkIconTheme instead.
<description>
Obtains the pixel size of a semantic icon size @size:
#GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc. This function
-isn't normally needed, gtk_icon_theme_load_icon() is the usual
+isn’t normally needed, gtk_icon_theme_load_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
@@ -41019,7 +41380,7 @@ 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_pixbuf() is the usual
+isn’t normally needed, gtk_widget_render_icon_pixbuf() 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
@@ -41323,10 +41684,10 @@ 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,
+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
+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
@@ -41341,7 +41702,7 @@ 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
+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,
@@ -41596,7 +41957,7 @@ 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
+images for all of GTK+’s stock icons are registered
as built-icons.
In general, if you use gtk_icon_theme_add_builtin_icon()
@@ -41685,7 +42046,7 @@ icon names to lookup
</parameter>
</parameters>
<return> a #GtkIconInfo object containing information
-about the icon, or %NULL if the icon wasn't found.
+about the icon, or %NULL if the icon wasn’t found.
</return>
</function>
@@ -41729,7 +42090,7 @@ icon names to lookup
</parameter>
</parameters>
<return> a #GtkIconInfo object containing information
-about the icon, or %NULL if the icon wasn't found.
+about the icon, or %NULL if the icon wasn’t found.
</return>
</function>
@@ -41905,8 +42266,8 @@ itself with g_list_free().
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".
+but will typically include such values as “Applications” and
+“MimeTypes”.
Since: 2.4
@@ -41975,7 +42336,7 @@ or %NULL.
<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.
+your reference to the icon. %NULL if the icon isn’t found.
</return>
</function>
@@ -42030,7 +42391,7 @@ or %NULL.
<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.
+your reference to the icon. %NULL if the icon isn’t found.
</return>
</function>
@@ -42085,7 +42446,7 @@ or %NULL.
<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 cairo_surface_destroy() to release
-your reference to the icon. %NULL if the icon isn't found.
+your reference to the icon. %NULL if the icon isn’t found.
</return>
</function>
@@ -42120,7 +42481,7 @@ Since: 2.14
</parameters>
<return> a #GtkIconInfo containing
information about the icon, or %NULL if the icon
-wasn't found. Unref with g_object_unref()
+wasn’t found. Unref with g_object_unref()
</return>
</function>
@@ -42159,7 +42520,7 @@ Since: 3.10
</parameters>
<return> a #GtkIconInfo containing
information about the icon, or %NULL if the icon
-wasn't found. Unref with g_object_unref()
+wasn’t found. Unref with g_object_unref()
</return>
</function>
@@ -42194,7 +42555,7 @@ Since: 2.4
</parameter>
</parameters>
<return> a #GtkIconInfo object containing information
-about the icon, or %NULL if the icon wasn't found.
+about the icon, or %NULL if the icon wasn’t found.
</return>
</function>
@@ -42233,7 +42594,7 @@ Since: 3.10
</parameter>
</parameters>
<return> a #GtkIconInfo object containing
-information about the icon, or %NULL if the icon wasn't found.
+information about the icon, or %NULL if the icon wasn’t found.
</return>
</function>
@@ -42242,7 +42603,7 @@ information about the icon, or %NULL if the icon wasn't found.
<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()
+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.
@@ -42325,7 +42686,7 @@ configured theme, or %NULL to unset a previously set custom theme
<function name="gtk_icon_theme_set_screen">
<description>
Sets the screen for an icon theme; the screen is used
-to track the user's currently configured icon theme,
+to track the user’s currently configured icon theme,
which might be different for different screens.
Since: 2.4
@@ -42351,9 +42712,9 @@ 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 the user’s home directory.)
-In addition if an icon found isn't found either in the current
+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.
@@ -42594,7 +42955,7 @@ Since: 2.6
<function name="gtk_icon_view_get_cursor">
<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 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().
@@ -42855,7 +43216,7 @@ Since: 2.6
</parameter_description>
</parameter>
</parameters>
-<return> the markup column, or -1 if it's unset.
+<return> the markup column, or -1 if it’s unset.
</return>
</function>
@@ -42924,7 +43285,7 @@ Since: 2.6
</parameter_description>
</parameter>
</parameters>
-<return> the pixbuf column, or -1 if it's unset.
+<return> the pixbuf column, or -1 if it’s unset.
</return>
</function>
@@ -42970,11 +43331,11 @@ Since: 2.6
<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.
+want to convert the returned list into a list of #GtkTreeRowReferences.
To do this, you can use gtk_tree_row_reference_new().
To free the return value, use:
-|[
+|[<!-- language="C" -->
g_list_free_full (list, (GDestroyNotify) gtk_tree_path_free);
]|
@@ -43041,15 +43402,15 @@ Since: 2.6
</parameter_description>
</parameter>
</parameters>
-<return> the text column, or -1 if it's unset.
+<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.
+Returns the column of @icon_view’s model which is being used for
+displaying tooltips on @icon_view’s rows.
Since: 2.12
@@ -43078,7 +43439,7 @@ 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.
+to be relative to @icon_view’s bin_window if @keyboard_tooltip is %FALSE.
Since: 2.12
@@ -43418,13 +43779,13 @@ Since: 2.6
<function name="gtk_icon_view_set_cursor">
<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.
+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.
+This function is often followed by `gtk_widget_grab_focus
+(icon_view)` in order to give keyboard focus to the widget.
Please note that editing can only happen when the widget is realized.
Since: 2.8
@@ -43499,7 +43860,7 @@ Since: 2.6
<function name="gtk_icon_view_set_item_padding">
<description>
Sets the #GtkIconView:item-padding property which specifies the padding
-around each of the icon view's items.
+around each of the icon view’s items.
Since: 2.18
@@ -43778,7 +44139,7 @@ Since: 2.12
<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
+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
@@ -43796,7 +44157,7 @@ Since: 2.12
</parameter_description>
</parameter>
<parameter name="column">
-<parameter_description> an integer, which is a valid column number for @icon_view's model
+<parameter_description> an integer, which is a valid column number for @icon_view’s model
</parameter_description>
</parameter>
</parameters>
@@ -44800,8 +45161,8 @@ is not busy with something that has a higher priority.
<function name="gtk_image_new_from_file">
<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,
+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
@@ -44831,7 +45192,7 @@ displaying the file.
<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
+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.
@@ -44856,7 +45217,7 @@ Since: 2.14
<function name="gtk_image_new_from_icon_name">
<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
+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.
@@ -44882,7 +45243,7 @@ Since: 2.6
<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
+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
@@ -44936,8 +45297,8 @@ you should use gtk_image_new_from_icon_name().
<function name="gtk_image_new_from_resource">
<description>
Creates a new #GtkImage displaying the resource file @resource_path. 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,
+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
@@ -44971,7 +45332,7 @@ Since: 3.4
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.
+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().
@@ -45253,7 +45614,7 @@ Since: 2.18
<function name="gtk_info_bar_add_button">
<description>
Adds a button with the given text and sets things up so that
-clicking the button will emit the "response" signal with the given
+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.
@@ -45402,7 +45763,7 @@ 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.
+the “response” signal with the corresponding response ID.
</description>
@@ -45423,7 +45784,7 @@ with %NULL
<function name="gtk_info_bar_response">
<description>
-Emits the 'response' signal with the given @response_id.
+Emits the “response” signal with the given @response_id.
Since: 2.18
@@ -45443,9 +45804,9 @@ Since: 2.18
<function name="gtk_info_bar_set_default_response">
<description>
-Sets the last widget in the info bar's action area with
+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.
+Pressing “Enter” normally activates the default widget.
Note that this function currently requires @info_bar to
be added to a widget hierarchy.
@@ -45491,7 +45852,7 @@ Since: 2.18
<function name="gtk_info_bar_set_response_sensitive">
<description>
Calls gtk_widget_set_sensitive (widget, setting) for each
-widget in the info bars's action area with the given response_id.
+widget in the info bars’s action area with the given response_id.
A convenient way to sensitize/desensitize dialog buttons.
Since: 2.18
@@ -45552,35 +45913,31 @@ 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 don't have to call gtk_init().
+you don’t 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>
+Since 2.18, GTK+ calls `signal (SIGPIPE, SIG_IGN)`
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="argc">
-<parameter_description> Address of the <parameter>argc</parameter> parameter of
+<parameter_description> Address of the `argc` parameter of
your main() function (or 0 if @argv is %NULL). This will be changed if
any arguments were handled.
</parameter_description>
</parameter>
<parameter name="argv">
<parameter_description> Address of the
-<parameter>argv</parameter> parameter of main(), or %NULL. Any options
+`argv` parameter of main(), or %NULL. Any options
understood by GTK+ are stripped before return.
</parameter_description>
</parameter>
@@ -45592,7 +45949,7 @@ understood by GTK+ are stripped before return.
<description>
This function does the same work as gtk_init() with only a single
change: It does not terminate the program if the windowing system
-can't be initialized. Instead it returns %FALSE on failure.
+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
@@ -45602,14 +45959,14 @@ interface.
</description>
<parameters>
<parameter name="argc">
-<parameter_description> Address of the <parameter>argc</parameter> parameter of
+<parameter_description> Address of the `argc` parameter of
your main() function (or 0 if @argv is %NULL). This will be changed if
any arguments were handled.
</parameter_description>
</parameter>
<parameter name="argv">
<parameter_description> Address of the
-<parameter>argv</parameter> parameter of main(), or %NULL. Any options
+`argv` parameter of main(), or %NULL. Any options
understood by GTK+ are stripped before return.
</parameter_description>
</parameter>
@@ -45624,7 +45981,7 @@ initialized, %FALSE otherwise
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
+`--help` output. Note that your program will
be terminated after writing out the help output.
Since: 2.6
@@ -45632,21 +45989,21 @@ Since: 2.6
</description>
<parameters>
<parameter name="argc">
-<parameter_description> Address of the <parameter>argc</parameter> parameter of
+<parameter_description> Address of the `argc` parameter of
your main() function (or 0 if @argv is %NULL). This will be changed if
any arguments were handled.
</parameter_description>
</parameter>
<parameter name="argv">
<parameter_description> Address of the
-<parameter>argv</parameter> parameter of main(), or %NULL. Any options
+`argv` parameter of main(), or %NULL. Any options
understood by GTK+ are stripped before return.
</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>
+the first line of `--help` output, after
+`programname [OPTION...]`
</parameter_description>
</parameter>
<parameter name="entries">
@@ -45656,7 +46013,7 @@ of #GOptionEntrys describing the options of your program
</parameter>
<parameter name="translation_domain">
<parameter_description> a translation domain to use for translating
-the <option>--help</option> output for the options in @entries
+the `--help` output for the options in @entries
and the @parameter_string with gettext(), or %NULL
</parameter_description>
</parameter>
@@ -46041,8 +46398,8 @@ Since: 2.6
<function name="gtk_label_get_measuring_layout">
<description>
Gets a layout that can be used for measuring sizes. The returned
-layout will be identical to the label's layout except for the
-layout's width, which will be set to @width. Do not modify the returned
+layout will be identical to the label’s layout except for the
+layout’s width, which will be set to @width. Do not modify the returned
layout.
@@ -46096,7 +46453,7 @@ label. See gtk_label_set_mnemonic_widget().
</parameter_description>
</parameter>
</parameters>
-<return> the target of the label's mnemonic,
+<return> the target of the label’s mnemonic,
or %NULL if none has been set and the default algorithm will be used.
</return>
</function>
@@ -46120,7 +46477,7 @@ Gets the value set by gtk_label_set_selectable().
<function name="gtk_label_get_selection_bounds">
<description>
Gets the selected range of characters in the label, returning %TRUE
-if there's a selection.
+if there’s a selection.
</description>
@@ -46200,9 +46557,9 @@ Since: 2.18
<function name="gtk_label_get_use_markup">
<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 ().
+Returns whether the label’s text is interpreted as marked up with
+the [Pango text markup language][PangoMarkupFormat].
+See gtk_label_set_use_markup ().
</description>
@@ -46212,7 +46569,7 @@ language</link>. See gtk_label_set_use_markup ().
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the label's text will be parsed for markup.
+<return> %TRUE if the label’s text will be parsed for markup.
</return>
</function>
@@ -46354,12 +46711,12 @@ the horizontal, in degrees, measured counterclockwise
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
+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>
+to the label after the markup string is parsed.
</description>
<parameters>
@@ -46443,14 +46800,14 @@ on the values of the #GtkLabel:use-underline" and
<function name="gtk_label_set_line_wrap">
<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
+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.
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().
+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>
@@ -46492,7 +46849,7 @@ Since: 2.10
<description>
Sets the number of lines to which an ellipsized, wrapping label
should be limited. This has no effect if the label is not wrapping
-or ellipsized. Set this to -1 if you don't want to limit the
+or ellipsized. Set this to -1 if you don’t want to limit the
number of lines.
Since: 3.10
@@ -46513,15 +46870,16 @@ Since: 3.10
<function name="gtk_label_set_markup">
<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
+Parses @str which is marked up with the
+[Pango text markup language][PangoMarkupFormat], 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()<!-- -->:
-|[
+g_markup_printf_escaped():
+|[<!-- language="C" -->
+const char *format = "<span style=\"italic\">\%s</span>";
char *markup;
-markup = g_markup_printf_escaped ("<span style=\"italic\">%s</span>", str);
+markup = g_markup_printf_escaped (format, str);
gtk_label_set_markup (GTK_LABEL (label), markup);
g_free (markup);
]|
@@ -46533,7 +46891,7 @@ g_free (markup);
</parameter_description>
</parameter>
<parameter name="str">
-<parameter_description> a markup string (see <link linkend="PangoMarkupFormat">Pango markup
format</link>)
+<parameter_description> a markup string (see [Pango markup format][PangoMarkupFormat])
</parameter_description>
</parameter>
</parameters>
@@ -46543,8 +46901,8 @@ g_free (markup);
<function name="gtk_label_set_markup_with_mnemonic">
<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.
+[Pango text markup language][PangoMarkupFormat],
+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.
@@ -46559,7 +46917,7 @@ automatically, or explicitly using gtk_label_set_mnemonic_widget().
</parameter>
<parameter name="str">
<parameter_description> a markup string (see
-<link linkend="PangoMarkupFormat">Pango markup format</link>)
+[Pango markup format][PangoMarkupFormat])
</parameter_description>
</parameter>
</parameters>
@@ -46591,7 +46949,7 @@ Since: 2.6
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
+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
@@ -46621,8 +46979,8 @@ and toggle focus between the colliding widgets otherwise.
<description>
The pattern of underlines you want under the existing text within the
#GtkLabel widget. For example if the current text of the label says
-"FooBarBaz" passing a pattern of "___ ___" will underline
-"Foo" and "Baz" but not "Bar".
+“FooBarBaz” passing a pattern of “___ ___” will underline
+“Foo” and “Baz” but not “Bar”.
</description>
<parameters>
@@ -46700,7 +47058,7 @@ This will also clear any previously set mnemonic accelerators.
<function name="gtk_label_set_text_with_mnemonic">
<description>
-Sets the label's text from the string @str.
+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
@@ -46743,9 +47101,9 @@ Since: 2.18
<function name="gtk_label_set_use_markup">
<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 whether the text of the label contains markup in
+[Pango’s text markup language][PangoMarkupFormat].
+See gtk_label_set_markup().
</description>
<parameters>
@@ -46754,7 +47112,7 @@ language</link>. See gtk_label_set_markup().
</parameter_description>
</parameter>
<parameter name="setting">
-<parameter_description> %TRUE if the label's text should be parsed for markup.
+<parameter_description> %TRUE if the label’s text should be parsed for markup.
</parameter_description>
</parameter>
</parameters>
@@ -46844,7 +47202,7 @@ Deprecated: 3.0: Use gtk_scrollable_get_hadjustment()
<function name="gtk_layout_get_size">
<description>
Gets the size that has been set on the layout, and that determines
-the total extents of the layout's scrollbar area. See
+the total extents of the layout’s scrollbar area. See
gtk_layout_set_size ().
</description>
@@ -46920,7 +47278,7 @@ Moves a current child of @layout to a new position.
<function name="gtk_layout_new">
<description>
Creates a new #GtkLayout. Unless you have a specific adjustment
-you'd like the layout to use for scrolling, pass %NULL for
+you’d like the layout to use for scrolling, pass %NULL for
@hadjustment and @vadjustment.
@@ -47039,7 +47397,7 @@ Deprecated: 3.0: Use gtk_scrollable_set_vadjustment()
Adds a new offset marker on @self at the position specified by @value.
When the bar value is in the interval topped by @value (or between @value
and #GtkLevelBar:max-value in case the offset is the last one on the bar)
-a style class named <literal>level-</literal>@name will be applied
+a style class named `level-` name will be applied
when rendering the level bar fill.
If another offset marker named @name exists, its value will be
replaced by @value.
@@ -47362,9 +47720,9 @@ and should not be modified or freed.
<function name="gtk_link_button_get_visited">
<description>
-Retrieves the 'visited' state of the URI where the #GtkLinkButton
+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.
+is changed on the button, the “visited” state is unset again.
The state may also be changed using gtk_link_button_set_visited().
@@ -47425,7 +47783,7 @@ Since: 2.10
<function name="gtk_link_button_set_uri">
<description>
Sets @uri as the URI where the #GtkLinkButton points. As a side-effect
-this unsets the 'visited' state of the button.
+this unsets the “visited” state of the button.
Since: 2.10
@@ -47445,7 +47803,7 @@ Since: 2.10
<function name="gtk_link_button_set_visited">
<description>
-Sets the 'visited' state of the URI where the #GtkLinkButton
+Sets the “visited” state of the URI where the #GtkLinkButton
points. See gtk_link_button_get_visited() for more details.
Since: 2.14
@@ -47457,7 +47815,7 @@ Since: 2.14
</parameter_description>
</parameter>
<parameter name="visited">
-<parameter_description> the new 'visited' state
+<parameter_description> the new “visited” state
</parameter_description>
</parameter>
</parameters>
@@ -47757,7 +48115,7 @@ on the first row the sort function must only read the new data
for the first of the two changed rows, otherwise the resorting
of the rows will be wrong.
-This generally means that if you don't fully control the data
+This generally means that if you don’t fully control the data
model you have to duplicate the data that affects the listbox
row functions into the row widgets themselves. Another alternative
is to call gtk_list_box_invalidate_sort() on any model change,
@@ -47963,7 +48321,7 @@ and either update the state of the widget as needed, or set a new one using
gtk_list_box_row_set_header(). If no header is needed, set the header to %NULL.
Note that you may get many calls @update_header to this for a particular row when e.g.
-changing things that don't affect the header. In this case it is important for performance
+changing things that don’t affect the header. In this case it is important for performance
to not blindly replace an exisiting header widh an identical one.
The @update_header function will be called for each row after the call, and it will
@@ -47999,7 +48357,7 @@ Since: 3.10
<function name="gtk_list_box_set_placeholder">
<description>
Sets the placeholder widget that is shown in the list when
-it doesn't display any visible children.
+it doesn’t display any visible children.
Since: 3.10
@@ -48196,9 +48554,9 @@ 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>
+`gtk_list_store_insert_with_values (list_store, iter, position...)`
has the same effect as calling
-|[
+|[<!-- language="C" -->
gtk_list_store_insert (list_store, iter, position);
gtk_list_store_set (list_store, iter, ...);
]|
@@ -48275,8 +48633,8 @@ Since: 2.6
<function name="gtk_list_store_iter_is_valid">
<description>
-<warning>This function is slow. Only use it for debugging and/or testing
-purposes.</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 #GtkListStore.
@@ -48356,8 +48714,8 @@ 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_list_store_new (3, G_TYPE_INT, G_TYPE_STRING,
-GDK_TYPE_PIXBUF);</literal> will create a new #GtkListStore with three columns, of type
+As an example, `gtk_list_store_new (3, G_TYPE_INT, G_TYPE_STRING,
+GDK_TYPE_PIXBUF);` will create a new #GtkListStore with three columns, of type
int, string and #GdkPixbuf respectively.
@@ -48455,8 +48813,8 @@ Since: 2.2
<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>. It must have
-exactly as many items as the list store's length.
+i.e. @new_order`[newpos] = oldpos`. It must have
+exactly as many items as the list store’s length.
</parameter_description>
</parameter>
</parameters>
@@ -48469,8 +48827,8 @@ 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>.
+%G_TYPE_STRING to “Foo”, you would write `gtk_list_store_set (store, iter,
+0, "Foo", -1)`.
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.
@@ -48712,51 +49070,33 @@ While you should not call this function directly, you might want to
know how exactly events are handled. So here is what this function
does with the event:
-<orderedlist>
-<listitem><para>
-Compress enter/leave notify events. If the event passed build an
+1. Compress enter/leave notify events. If the event passed build an
enter/leave pair together with the next event (peeked from GDK), both
events are thrown away. This is to avoid a backlog of (de-)highlighting
widgets crossed by the pointer.
-</para></listitem>
-<listitem><para>
-Find the widget which got the event. If the widget can't be determined
+
+2. Find the widget which got the event. If the widget can’t be determined
the event is thrown away unless it belongs to a INCR transaction.
-</para></listitem>
-<listitem><para>
-Then the event is pushed onto a stack so you can query the currently
+
+3. Then the event is pushed onto a stack so you can query the currently
handled event with gtk_get_current_event().
-</para></listitem>
-<listitem><para>
-The event is sent to a widget. If a grab is active all events for widgets
+
+4. The event is sent to a widget. If a grab is active all events for widgets
that are not in the contained in the grab widget are sent to the latter
with a few exceptions:
-<itemizedlist>
-<listitem><para>
-Deletion and destruction events are still sent to the event widget for
+- Deletion and destruction events are still sent to the event widget for
obvious reasons.
-</para></listitem>
-<listitem><para>
-Events which directly relate to the visual representation of the event
+- Events which directly relate to the visual representation of the event
widget.
-</para></listitem>
-<listitem><para>
-Leave events are delivered to the event widget if there was an enter
+- Leave events are delivered to the event widget if there was an enter
event delivered to it before without the paired leave event.
-</para></listitem>
-<listitem><para>
-Drag events are not redirected because it is unclear what the semantics
+- Drag events are not redirected because it is unclear what the semantics
of that would be.
-</para></listitem>
-</itemizedlist>
Another point of interest might be that all key events are first passed
through the key snooper functions if there are any. Read the description
of gtk_key_snooper_install() if you need this feature.
-</para></listitem>
-<listitem><para>
-After finishing the delivery the event is popped from the event stack.
-</para></listitem>
-</orderedlist>
+
+5. After finishing the delivery the event is popped from the event stack.
</description>
<parameters>
@@ -48773,7 +49113,7 @@ After finishing the delivery the event is popped from the event stack.
Runs a single iteration of the mainloop.
If no events are waiting to be processed GTK+ will block
-until the next event is noticed. If you don't want to block
+until the next event is noticed. If you don’t want to block
look at gtk_main_iteration_do() or check if any events are
pending with gtk_events_pending() first.
@@ -48831,7 +49171,7 @@ when it regains control.
<function name="gtk_menu_attach">
<description>
-Adds a new #GtkMenuItem to a (table) menu. The number of 'cells' that
+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.
@@ -49028,14 +49368,14 @@ Since: 3.6
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkWidget value or %NULL.
+<return> a #GtkWidget value or %NULL
</return>
</function>
<function name="gtk_menu_button_get_direction">
<description>
-Returns the direction the menu will be pointing at when popped up.
+Returns the direction the popup will be pointing at when popped up.
Since: 3.6
@@ -49046,14 +49386,14 @@ Since: 3.6
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkArrowType value.
+<return> a #GtkArrowType value
</return>
</function>
<function name="gtk_menu_button_get_menu_model">
<description>
-Returns the #GMenuModel used to generate the menu.
+Returns the #GMenuModel used to generate the popup.
Since: 3.6
@@ -49064,7 +49404,27 @@ Since: 3.6
</parameter_description>
</parameter>
</parameters>
-<return> a #GMenuModel or %NULL.
+<return> a #GMenuModel or %NULL
+
+</return>
+</function>
+
+<function name="gtk_menu_button_get_popover">
+<description>
+Returns the #GtkPopover that pops out of the button.
+If the button is not using a #GtkPopover, this function
+returns %NULL.
+
+Since: 3.12
+
+</description>
+<parameters>
+<parameter name="menu_button">
+<parameter_description> a #GtkMenuButton
+</parameter_description>
+</parameter>
+</parameters>
+<return> a #GtkPopover or %NULL
</return>
</function>
@@ -49072,6 +49432,8 @@ Since: 3.6
<function name="gtk_menu_button_get_popup">
<description>
Returns the #GtkMenu that pops out of the button.
+If the button does not use a #GtkMenu, this function
+returns %NULL.
Since: 3.6
@@ -49082,7 +49444,26 @@ Since: 3.6
</parameter_description>
</parameter>
</parameters>
-<return> a #GtkMenu or %NULL.
+<return> a #GtkMenu or %NULL
+
+</return>
+</function>
+
+<function name="gtk_menu_button_get_use_popover">
+<description>
+Returns whether a #GtkPopover or a #GtkMenu will be constructed
+from the menu model.
+
+Since: 3.12
+
+</description>
+<parameters>
+<parameter name="menu_button">
+<parameter_description> a #GtkMenuButton
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if using a #GtkPopover
</return>
</function>
@@ -49098,19 +49479,22 @@ Since: 3.6
</description>
<parameters>
</parameters>
-<return> The newly created #GtkMenuButton widget.
+<return> The newly created #GtkMenuButton widget
</return>
</function>
<function name="gtk_menu_button_set_align_widget">
<description>
-Sets the #GtkWidget to use to line the menu with when popped up. Note that
-the @align_widget must contain the #GtkMenuButton itself.
+Sets the #GtkWidget to use to line the menu with when popped up.
+Note that the @align_widget must contain the #GtkMenuButton itself.
-Setting it to %NULL means that the popup menu will be aligned with the
+Setting it to %NULL means that the menu will be aligned with the
button itself.
+Note that this property is only used with menus currently,
+and not for popovers.
+
Since: 3.6
</description>
@@ -49129,15 +49513,15 @@ Since: 3.6
<function name="gtk_menu_button_set_direction">
<description>
-Sets the direction in which the menu will be popped up, as
-well as changing the arrow's direction. The child will not
+Sets the direction in which the popup will be popped up, as
+well as changing the arrow’s direction. The child will not
be changed to an arrow if it was customized.
-If the menu when popped out would have collided with screen edges,
-we will do our best to keep it inside the screen and fully visible.
+If the does not fit in the available space in the given direction,
+GTK+ will its best to keep it inside the screen and fully visible.
-If you pass %GTK_ARROW_NONE for a @direction, the menu will behave
-as if you passed %GTK_ARROW_DOWN (although you won't see any arrows).
+If you pass %GTK_ARROW_NONE for a @direction, the popup will behave
+as if you passed %GTK_ARROW_DOWN (although you won’t see any arrows).
Since: 3.6
@@ -49157,14 +49541,16 @@ Since: 3.6
<function name="gtk_menu_button_set_menu_model">
<description>
-Sets the #GMenuModel from which the #GtkMenuButton:popup property will be
-filled in, or %NULL to disable the button.
+Sets the #GMenuModel from which the popup will be constructed,
+or %NULL to disable the button.
-The #GtkMenu will be created with gtk_menu_new_from_model(), so actions
-will be connected as documented there.
+Depending on the value of #GtkMenuButton:use-popover, either a
+#GtkMenu will be created with gtk_menu_new_from_model(), or a
+#GtkPopover with gtk_popover_new_from_model(). In either case,
+actions will be connected as documented for these functions.
-If #GtkMenuButton:popup is already set, then its content will be lost
-and replaced by our newly created #GtkMenu.
+If #GtkMenuButton:popup or #GtkMenuButton:popover are already set,
+their content will be lost and replaced by the newly created popup.
Since: 3.6
@@ -49182,11 +49568,33 @@ Since: 3.6
<return></return>
</function>
+<function name="gtk_menu_button_set_popover">
+<description>
+Sets the #GtkPopover that will be popped up when the button is
+clicked, or %NULL to disable the button. If #GtkMenuButton:menu-model
+or #GtkMenuButton:popup are set, they will be set to %NULL.
+
+Since: 3.12
+
+</description>
+<parameters>
+<parameter name="menu_button">
+<parameter_description> a #GtkMenuButton
+</parameter_description>
+</parameter>
+<parameter name="popover">
+<parameter_description> a #GtkPopover
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="gtk_menu_button_set_popup">
<description>
Sets the #GtkMenu that will be popped up when the button is clicked,
-or %NULL to disable the button. If #GtkMenuButton:menu-model is set,
-it will be set to %NULL.
+or %NULL to disable the button. If #GtkMenuButton:menu-model or
+#GtkMenuButton:popover are set, they will be set to %NULL.
Since: 3.6
@@ -49196,7 +49604,7 @@ Since: 3.6
<parameter_description> a #GtkMenuButton
</parameter_description>
</parameter>
-<parameter name="popup">
+<parameter name="menu">
<parameter_description> a #GtkMenu
</parameter_description>
</parameter>
@@ -49204,6 +49612,28 @@ Since: 3.6
<return></return>
</function>
+<function name="gtk_menu_button_set_use_popover">
+<description>
+Sets whether to construct a #GtkPopover instead of #GtkMenu
+when gtk_menu_button_set_menu_model() is called. Note that
+this property is only consulted when a new menu model is set.
+
+Since: 3.12
+
+</description>
+<parameters>
+<parameter name="menu_button">
+<parameter_description> a #GtkMenuButton
+</parameter_description>
+</parameter>
+<parameter name="use_popover">
+<parameter_description> %TRUE to construct a popover from the menu model
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="gtk_menu_detach">
<description>
Detaches the menu from the widget to which it had been attached.
@@ -49431,7 +49861,7 @@ Since: 2.14
</parameter>
</parameters>
<return> the accelerator path corresponding to this menu
-item's functionality, or %NULL if not set
+item’s functionality, or %NULL if not set
</return>
</function>
@@ -49598,7 +50028,7 @@ Emits the #GtkMenuItem::select signal on the given item.
<function name="gtk_menu_item_set_accel_path">
<description>
Set the accelerator path on @menu_item, through which runtime
-changes of the menu item's accelerator caused by the user can be
+changes of the menu item’s accelerator caused by the user can be
identified and saved to persistent storage (see gtk_accel_map_save()
on this). To set up a default accelerator for this menu item, call
gtk_accel_map_add_entry() with the same @accel_path. See also
@@ -49625,7 +50055,7 @@ by interning it first with g_intern_static_string().
</parameter>
<parameter name="accel_path">
<parameter_description> accelerator path, corresponding to this menu
-item's functionality, or %NULL to unset the current path.
+item’s functionality, or %NULL to unset the current path.
</parameter_description>
</parameter>
</parameters>
@@ -49680,7 +50110,7 @@ Since: 3.0
<function name="gtk_menu_item_set_right_justified">
<description>
Sets whether the menu item appears justified at the right
-side of a menu bar. This was traditionally done for "Help"
+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.)
@@ -49705,7 +50135,7 @@ far right if added to a menu bar
<function name="gtk_menu_item_set_submenu">
<description>
-Sets or replaces the menu item's submenu, or removes it when a %NULL
+Sets or replaces the menu item’s submenu, or removes it when a %NULL
submenu is passed.
</description>
@@ -50032,10 +50462,10 @@ 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>.
+For example, a menu containing menu items “New” and “Exit”, will, after
+`gtk_menu_set_accel_path (menu, "<Gnumeric-Sheet>/File");` has been
+called, assign its items the accel paths: `"<Gnumeric-Sheet>/File/New"`
+and `"<Gnumeric-Sheet>/File/Exit"`.
Assigning accel paths to menu items then enables the user to change
their accelerators at runtime. More details about accelerator paths
@@ -50086,7 +50516,7 @@ 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
+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.
@@ -50180,7 +50610,7 @@ 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.
+text as that menu item’s label.
Deprecated: 3.10
@@ -50253,22 +50683,22 @@ all children are removed.
@with_separators determines if toplevel items (eg: sections) have
separators inserted between them. This is typically desired for
-menus but doesn't make sense for menubars.
+menus but doesn’t make sense for menubars.
If @action_namespace is non-%NULL then the effect is as if all
actions mentioned in the @model have their names prefixed with the
-namespace, plus a dot. For example, if the action "quit" is
-mentioned and @action_namespace is "app" then the effective action
-name is "app.quit".
+namespace, plus a dot. For example, if the action “quit” is
+mentioned and @action_namespace is “app” then the effective action
+name is “app.quit”.
This function uses #GtkActionable to define the action name and
target values on the created menu items. If you want to use an
-action group other than "app" and "win", or if you want to use a
+action group other than “app” and “win”, or if you want to use a
#GtkMenuShell outside of a #GtkApplicationWindow, then you will need
to attach your own action group to the widget hierarchy using
gtk_widget_insert_action_group(). As an example, if you created a
-group with a "quit" action and inserted it with the name "mygroup"
-then you would use the action name "mygroup.quit" in your
+group with a “quit” action and inserted it with the name “mygroup”
+then you would use the action name “mygroup.quit” in your
#GMenuModel.
For most cases you are probably better off using
@@ -50409,7 +50839,7 @@ Since: 2.8
<function name="gtk_menu_shell_insert">
<description>
-Adds a new #GtkMenuItem to the menu shell's item list
+Adds a new #GtkMenuItem to the menu shell’s item list
at the position indicated by @position.
</description>
@@ -50453,7 +50883,7 @@ item list.
<function name="gtk_menu_shell_select_first">
<description>
Select the first visible or selectable child of the menu shell;
-don't select tearoff items unless the only item is a tearoff
+don’t select tearoff items unless the only item is a tearoff
item.
Since: 2.2
@@ -50467,7 +50897,7 @@ Since: 2.2
<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
+the first item isn’t sensitive. This
should be %FALSE if the menu is being
popped up initially.
</parameter_description>
@@ -50506,7 +50936,7 @@ 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
+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 explicitly.
@@ -50514,7 +50944,7 @@ needs to be set explicitly.
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
+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
@@ -50619,7 +51049,7 @@ Since: 2.12
</parameter_description>
</parameter>
<parameter name="markup">
-<parameter_description> markup text to be used as tooltip text for button's arrow button
+<parameter_description> markup text to be used as tooltip text for button’s arrow button
</parameter_description>
</parameter>
</parameters>
@@ -50641,7 +51071,7 @@ Since: 2.12
</parameter_description>
</parameter>
<parameter name="text">
-<parameter_description> text to be used as tooltip text for button's arrow button
+<parameter_description> text to be used as tooltip text for button’s arrow button
</parameter_description>
</parameter>
</parameters>
@@ -50673,20 +51103,21 @@ Since: 2.6
<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>.
+[Pango text markup language][PangoMarkupFormat].
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.
-<informalexample><programlisting>
+|[<!-- language="C" -->
gchar *msg;
msg = g_markup_printf_escaped (message_format, ...);
-gtk_message_dialog_format_secondary_markup (message_dialog, "%s", msg);
+gtk_message_dialog_format_secondary_markup (message_dialog,
+"%s", msg);
g_free (msg);
-</programlisting></informalexample>
+]|
Since: 2.6
@@ -50698,7 +51129,7 @@ Since: 2.6
</parameter>
<parameter name="message_format">
<parameter_description> printf()-style markup string (see
- <link linkend="PangoMarkupFormat">Pango markup format</link>), or %NULL
+ [Pango markup format][PangoMarkupFormat]), or %NULL
</parameter_description>
</parameter>
<parameter name="Varargs">
@@ -50736,9 +51167,10 @@ Since: 2.6
<function name="gtk_message_dialog_get_image">
<description>
-Gets the dialog's image.
+Gets the dialog’s image.
Since: 2.14
+Deprecated: 3.12: Use #GtkDialog for dialogs with images
</description>
<parameters>
@@ -50747,7 +51179,7 @@ Since: 2.14
</parameter_description>
</parameter>
</parameters>
-<return> the dialog's image
+<return> the dialog’s image
</return>
</function>
@@ -50755,10 +51187,9 @@ Since: 2.14
<function name="gtk_message_dialog_get_message_area">
<description>
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
+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.
+See gtk_dialog_get_content_area() for the corresponding
function in the parent #GtkDialog.
Since: 2.22
@@ -50771,7 +51202,7 @@ Since: 2.22
</parameter>
</parameters>
<return> A #GtkVBox corresponding to the
-"message area" in the @message_dialog.
+“message area” in the @message_dialog.
</return>
</function>
@@ -50780,7 +51211,7 @@ Since: 2.22
<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"
+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.
@@ -50820,8 +51251,8 @@ signal is emitted with response IDs from #GtkResponseType. See
<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
+is marked up with the [Pango text markup language][PangoMarkupFormat].
+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
@@ -50830,13 +51261,14 @@ function will automatically be escaped as necessary.
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
+instead, since you can’t pass the markup string either
+as the format (it might contain “%” characters) or as a string
argument.
-|[
+|[<!-- language="C" -->
GtkWidget *dialog;
-dialog = gtk_message_dialog_new (main_application_window,
-GTK_DIALOG_DESTROY_WITH_PARENT,
+GtkDialogFlags flags = GTK_DIALOG_DESTROY_WITH_PARENT;
+dialog = gtk_message_dialog_new (parent_window,
+flags,
GTK_MESSAGE_ERROR,
GTK_BUTTONS_CLOSE,
NULL);
@@ -50880,9 +51312,10 @@ Since: 2.4
<function name="gtk_message_dialog_set_image">
<description>
-Sets the dialog's image to @image.
+Sets the dialog’s image to @image.
Since: 2.10
+Deprecated: 3.12: Use #GtkDialog to create dialogs with images
</description>
<parameters>
@@ -50901,8 +51334,7 @@ Since: 2.10
<function name="gtk_message_dialog_set_markup">
<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>.
+up with the [Pango text markup language][PangoMarkupFormat].
Since: 2.4
@@ -50913,7 +51345,7 @@ Since: 2.4
</parameter_description>
</parameter>
<parameter name="str">
-<parameter_description> markup string (see <link linkend="PangoMarkupFormat">Pango markup
format</link>)
+<parameter_description> markup string (see [Pango markup format][PangoMarkupFormat])
</parameter_description>
</parameter>
</parameters>
@@ -51146,7 +51578,7 @@ Appends a page to @notebook.
</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'
+for the page, or %NULL to use the default label, “page N”
</parameter_description>
</parameter>
</parameters>
@@ -51173,7 +51605,7 @@ label in the popup menu.
</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'
+for the page, or %NULL to use the default label, “page N”
</parameter_description>
</parameter>
<parameter name="menu_label">
@@ -51551,7 +51983,7 @@ Insert a page into @notebook at the given position.
</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'
+for the page, or %NULL to use the default label, “page N”
</parameter_description>
</parameter>
<parameter name="position">
@@ -51583,7 +52015,7 @@ the widget to use as the label in the popup menu.
</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'
+for the page, or %NULL to use the default label, “page N”
</parameter_description>
</parameter>
<parameter name="menu_label">
@@ -51702,7 +52134,7 @@ Prepends a page to @notebook.
</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'
+for the page, or %NULL to use the default label, “page N”
</parameter_description>
</parameter>
</parameters>
@@ -51729,7 +52161,7 @@ label in the popup menu.
</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'
+for the page, or %NULL to use the default label, “page N”
</parameter_description>
</parameter>
<parameter name="menu_label">
@@ -51813,7 +52245,7 @@ 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
+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
@@ -51999,28 +52431,30 @@ 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
+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.
-|[
+|[<!-- language="C" -->
static void
-on_drop_zone_drag_data_received (GtkWidget *widget,
+on_drag_data_received (GtkWidget *widget,
GdkDragContext *context,
gint x,
gint y,
-GtkSelectionData *selection_data,
+GtkSelectionData *data,
guint info,
guint time,
gpointer user_data)
{
GtkWidget *notebook;
GtkWidget **child;
+GtkContainer *container;
notebook = gtk_drag_get_source_widget (context);
-child = (void*) gtk_selection_data_get_data (selection_data);
+child = (void*) gtk_selection_data_get_data (data);
process_widget (*child);
-gtk_container_remove (GTK_CONTAINER (notebook), *child);
+container = GTK_CONTAINER (notebook);
+gtk_container_remove (container, *child);
}
]|
@@ -52051,7 +52485,7 @@ Since: 2.10
<description>
Changes the tab label for @child.
If %NULL is specified for @tab_label, then the page will
-have the label 'page N'.
+have the label “page N”.
</description>
<parameters>
@@ -52142,7 +52576,7 @@ Since: 2.10
<function name="gtk_numerable_icon_get_background_gicon">
<description>
Returns the #GIcon that was set as the base background image, or
-%NULL if there's none. The caller of this function does not own
+%NULL if there’s none. The caller of this function does not own
a reference to the returned #GIcon.
Since: 3.0
@@ -52162,7 +52596,7 @@ Since: 3.0
<function name="gtk_numerable_icon_get_background_icon_name">
<description>
Returns the icon name used as the base background image,
-or %NULL if there's none.
+or %NULL if there’s none.
Since: 3.0
@@ -52217,7 +52651,7 @@ Since: 3.0
<function name="gtk_numerable_icon_get_style_context">
<description>
Returns the #GtkStyleContext used by the icon for theming,
-or %NULL if there's none.
+or %NULL if there’s none.
Since: 3.0
@@ -52500,7 +52934,7 @@ Since: 2.16
</parameter_description>
</parameter>
<parameter name="orientation">
-<parameter_description> the orientable's new orientation.
+<parameter_description> the orientable’s new orientation.
</parameter_description>
</parameter>
</parameters>
@@ -52839,7 +53273,7 @@ Since: 2.14
</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"
+to use the default name “Page Setup”
</parameter_description>
</parameter>
<parameter name="error">
@@ -52906,7 +53340,7 @@ Since: 2.12
</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"
+to use the default name “Page Setup”
</parameter_description>
</parameter>
<parameter name="error">
@@ -53122,7 +53556,7 @@ Since: 2.12
</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"
+or %NULL to use the default name “Page Setup”
</parameter_description>
</parameter>
</parameters>
@@ -53517,8 +53951,8 @@ Deprecated:3.0: Use cairo instead
<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
+“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
@@ -54310,7 +54744,7 @@ Deprecated:3.0: Use gtk_render_line() instead
<description>
Adds a child to the top or left pane with default parameters. This is
equivalent to
-<literal>gtk_paned_pack1 (paned, child, FALSE, TRUE)</literal>.
+`gtk_paned_pack1 (paned, child, FALSE, TRUE)`.
</description>
<parameters>
@@ -54330,7 +54764,7 @@ equivalent to
<description>
Adds a child to the bottom or right pane with default parameters. This
is equivalent to
-<literal>gtk_paned_pack2 (paned, child, TRUE, TRUE)</literal>.
+`gtk_paned_pack2 (paned, child, TRUE, TRUE)`.
</description>
<parameters>
@@ -54398,7 +54832,7 @@ Since: 2.20
</parameter_description>
</parameter>
</parameters>
-<return> the paned's handle window.
+<return> the paned’s handle window.
</return>
</function>
@@ -54428,7 +54862,7 @@ Since: 3.0
</description>
<parameters>
<parameter name="orientation">
-<parameter_description> the paned's orientation.
+<parameter_description> the paned’s orientation.
</parameter_description>
</parameter>
</parameters>
@@ -54809,7 +55243,7 @@ represent the same paper size
<function name="gtk_paper_size_new">
<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>
+[PWG 5101.1-2002](ftp://ftp.pwg.org/pub/pwg/candidates/cs-pwgmsn10-20020226-5101.1.pdf)
paper name.
If @name is %NULL, the default paper size is returned,
@@ -55016,14 +55450,14 @@ command line arguments
<description>
Applications may want to present some folders in the places sidebar if
they could be immediately useful to users. For example, a drawing
-program could add a "/usr/share/clipart" location when the sidebar is
-being used in an "Insert Clipart" dialog box.
+program could add a “/usr/share/clipart” location when the sidebar is
+being used in an “Insert Clipart” dialog box.
This function adds the specified @location to a special place for immutable
shortcuts. The shortcuts are application-specific; they are not shared
across applications, and they are not persistent. If this function
is called multiple times with different locations, then they are added
-to the sidebar's list in the same order as the function is called.
+to the sidebar’s list in the same order as the function is called.
Since: 3.10
@@ -55063,7 +55497,7 @@ Since: 3.12
<description>
Gets the currently-selected location in the @sidebar. This can be #NULL when
nothing is selected, for example, when gtk_places_sidebar_set_location() has
-been called with a location that is not among the sidebar's list of places to
+been called with a location that is not among the sidebar’s list of places to
show.
You can use this function to get the selection in the @sidebar. Also, if you
@@ -55090,7 +55524,7 @@ selected.
<description>
This function queries the bookmarks added by the user to the places sidebar,
and returns one of them. This function is used by #GtkFileChooser to implement
-the "Alt-1", "Alt-2", etc. shortcuts, which activate the cooresponding bookmark.
+the “Alt-1”, “Alt-2”, etc. shortcuts, which activate the cooresponding bookmark.
Since: 3.10
@@ -55107,7 +55541,7 @@ Since: 3.10
</parameters>
<return> The bookmark specified by the index @n, or
#NULL if no such index exist. Note that the indices start at 0, even though
-the file chooser starts them with the keyboard shortcut "Alt-1".
+the file chooser starts them with the keyboard shortcut “Alt-1”.
</return>
</function>
@@ -55143,7 +55577,7 @@ Since: 3.10
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the sidebar will display a "Connect to Server" item.
+<return> %TRUE if the sidebar will display a “Connect to Server” item.
</return>
</function>
@@ -55183,7 +55617,7 @@ Since: 3.10
A #GSList of #GFile of the locations that have been added as
application-specific shortcuts with gtk_places_sidebar_add_shortcut().
To free this list, you can use
-|[
+|[<!-- language="C" -->
g_slist_free_full (list, (GDestroyNotify) g_object_unref);
]|
@@ -55278,19 +55712,19 @@ Since: 3.10
<description>
Sets the way in which the calling application can open new locations from
the places sidebar. For example, some applications only open locations
-"directly" into their main view, while others may support opening locations
+“directly” into their main view, while others may support opening locations
in a new notebook tab or a new window.
This function is used to tell the places @sidebar about the ways in which the
application can open new locations, so that the sidebar can display (or not)
-the "Open in new tab" and "Open in new window" menu items as appropriate.
+the “Open in new tab” and “Open in new window” menu items as appropriate.
When the #GtkPlacesSidebar::open-location signal is emitted, its flags
argument will be set to one of the @flags that was passed in
gtk_places_sidebar_set_open_flags().
Passing 0 for @flags will cause #GTK_PLACES_OPEN_NORMAL to always be sent
-to callbacks for the "open-location" signal.
+to callbacks for the “open-location” signal.
Since: 3.10
@@ -55334,7 +55768,7 @@ Since: 3.10
<description>
Sets whether the @sidebar should show an item for the Desktop folder.
The default value for this option is determined by the desktop
-environment and the user's configuration, but this function can be
+environment and the user’s configuration, but this function can be
used to override it on a per-application basis.
Since: 3.10
@@ -55365,7 +55799,7 @@ Finish the initialization of @plug for a given #GtkSocket identified by
</parameter_description>
</parameter>
<parameter name="socket_id">
-<parameter_description> the XID of the socket's window.
+<parameter_description> the XID of the socket’s window.
</parameter_description>
</parameter>
</parameters>
@@ -55387,12 +55821,12 @@ Since: 2.2
</parameter_description>
</parameter>
<parameter name="display">
-<parameter_description> the #GdkDisplay associated with @socket_id's
+<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> the XID of the socket’s window.
</parameter_description>
</parameter>
</parameters>
@@ -55505,7 +55939,7 @@ told the plug that it modality has toggled on.
<function name="gtk_plug_new">
<description>
Creates a new plug widget inside the #GtkSocket identified
-by @socket_id. If @socket_id is 0, the plug is left "unplugged" and
+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().
@@ -55533,7 +55967,7 @@ Since: 2.2
</parameter_description>
</parameter>
<parameter name="socket_id">
-<parameter_description> the XID of the socket's window.
+<parameter_description> the XID of the socket’s window.
</parameter_description>
</parameter>
</parameters>
@@ -55542,6 +55976,54 @@ Since: 2.2
</return>
</function>
+<function name="gtk_popover_bind_model">
+<description>
+Establishes a binding between a #GtkPopover and a #GMenuModel.
+
+The contents of @popover are removed and then refilled with menu items
+according to @model. When @model changes, @popover is updated.
+Calling this function twice on @popover with different @model will
+cause the first binding to be replaced with a binding to the new
+model. If @model is %NULL then any previous binding is undone and
+all children are removed.
+
+If @action_namespace is non-%NULL then the effect is as if all
+actions mentioned in the @model have their names prefixed with the
+namespace, plus a dot. For example, if the action “quit” is
+mentioned and @action_namespace is “app” then the effective action
+name is “app.quit”.
+
+This function uses #GtkActionable to define the action name and
+target values on the created menu items. If you want to use an
+action group other than “app” and “win”, or if you want to use a
+#GtkMenuShell outside of a #GtkApplicationWindow, then you will need
+to attach your own action group to the widget hierarchy using
+gtk_widget_insert_action_group(). As an example, if you created a
+group with a “quit” action and inserted it with the name “mygroup”
+then you would use the action name “mygroup.quit” in your
+#GMenuModel.
+
+Since: 3.12
+
+</description>
+<parameters>
+<parameter name="popover">
+<parameter_description> a #GtkPopover
+</parameter_description>
+</parameter>
+<parameter name="model">
+<parameter_description> the #GMenuModel to bind to or %NULL to remove
+binding
+</parameter_description>
+</parameter>
+<parameter name="action_namespace">
+<parameter_description> the namespace for actions in @model
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="gtk_popover_get_modal">
<description>
Returns whether the popover is modal, see gtk_popover_set_modal to
@@ -55602,7 +56084,7 @@ Returns the preferred position of @popover.
<function name="gtk_popover_get_relative_to">
<description>
-Returns the wigdet @popover is currently attached to
+Returns the widget @popover is currently attached to
Since: 3.12
@@ -55620,18 +56102,47 @@ Since: 3.12
<function name="gtk_popover_new">
<description>
+ relative_to (allow-none): #GtkWidget the popover is related to
+
Creates a new popover to point to @relative_to
Since: 3.12
</description>
<parameters>
+</parameters>
+<return> a new #GtkPopover
+
+</return>
+</function>
+
+<function name="gtk_popover_new_from_model">
+<description>
+Creates a #GtkPopover and populates it according to
+ model The popover is pointed to the @relative_to widget.
+
+The created buttons are connected to actions found in the
+#GtkApplicationWindow to which the popover belongs - typically
+by means of being attached to a widget that is contained within
+the #GtkApplicationWindows widget hierarchy.
+
+Actions can also be added using gtk_widget_insert_action_group()
+on the menus attach widget or on any of its parent widgets.
+
+Since: 3.12
+
+</description>
+<parameters>
<parameter name="relative_to">
<parameter_description> #GtkWidget the popover is related to
</parameter_description>
</parameter>
+<parameter name="model">
+<parameter_description> a #GMenuModel
+</parameter_description>
+</parameter>
</parameters>
-<return> a new #GtkPopover
+<return> the new #GtkPopover
</return>
</function>
@@ -55661,9 +56172,9 @@ Since: 3.12
<function name="gtk_popover_set_pointing_to">
<description>
-Sets the rectangle that @popover will point to, in the coordinate
-space of the widget @popover is attached to, see
-gtk_popover_set_relative_to()
+Sets the rectangle that @popover will point to, in the
+coordinate space of the widget @popover is attached to,
+see gtk_popover_set_relative_to().
Since: 3.12
@@ -55686,11 +56197,9 @@ Since: 3.12
Sets the preferred position for @popover to appear. If the @popover
is currently visible, it will be immediately updated.
-<note>
This preference will be respected where possible, although
on lack of space (eg. if close to the window edges), the
#GtkPopover may choose to appear on the opposite side
-</note>
Since: 3.12
@@ -55713,16 +56222,18 @@ Since: 3.12
Sets a new widget to be attached to @popover. If @popover is
visible, the position will be updated.
+Note: the ownership of popovers is always given to their @relative_to
+widget, so if @relative_to is set to %NULL on an attached @popover, it
+will be detached from its previous widget, and consequently destroyed
+unless extra references are kept.
+
Since: 3.12
</description>
<parameters>
<parameter name="popover">
<parameter_description> a #GtkPopover
-</parameter_description>
-</parameter>
-<parameter name="relative_to">
-<parameter_description> a #GtkWidget
+ relative_to (allow-none): a #GtkWidget
</parameter_description>
</parameter>
</parameters>
@@ -56629,7 +57140,7 @@ Since: 2.10
<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,
+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
@@ -57004,7 +57515,7 @@ 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).
-|[
+|[<!-- language="C" -->
if (settings != NULL)
gtk_print_operation_set_print_settings (print, settings);
@@ -57175,7 +57686,7 @@ 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.
+This function must be called in the callback of “draw-page” signal.
Since: 2.16
@@ -57214,11 +57725,11 @@ Since: 2.18
<description>
Sets up the #GtkPrintOperation to generate a file instead
of showing the print dialog. The indended use of this function
-is for implementing "Export to PDF" actions. Currently, PDF
+is for implementing “Export to PDF” actions. Currently, PDF
is the only supported format.
-"Print to PDF" support is independent of this and is done
-by letting the user pick the "Print to PDF" item from the list
+“Print to PDF” support is independent of this and is done
+by letting the user pick the “Print to PDF” item from the list
of printers in the print dialog.
Since: 2.10
@@ -57266,7 +57777,7 @@ Since: 2.18
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
+If you don’t set a job name, GTK+ picks a default one by
numbering successive print jobs.
Since: 2.10
@@ -57382,7 +57893,7 @@ Since: 2.18
<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,
+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
@@ -57590,7 +58101,7 @@ Since: 2.10
Returns the boolean represented by the value
that is associated with @key.
-The string "true" represents %TRUE, any other
+The string “true” represents %TRUE, any other
string %FALSE.
Since: 2.10
@@ -57617,8 +58128,8 @@ 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.
+The string “true” represents %TRUE, the string
+“false” represents %FALSE.
Since: 2.10
@@ -57990,7 +58501,7 @@ Since: 2.10
</parameter>
</parameters>
<return> an array
-of #GtkPageRange<!-- -->s. Use g_free() to free the array when
+of #GtkPageRanges. Use g_free() to free the array when
it is no longer needed.
</return>
@@ -58330,7 +58841,7 @@ Since: 2.14
</parameter>
<parameter name="group_name">
<parameter_description> the name of the group to use, or %NULL to use the default
-"Print Settings"
+“Print Settings”
</parameter_description>
</parameter>
<parameter name="error">
@@ -58399,7 +58910,7 @@ Since: 2.12
</parameter>
<parameter name="group_name">
<parameter_description> the name of the group to use, or %NULL to use
-the default "Print Settings"
+the default “Print Settings”
</parameter_description>
</parameter>
<parameter name="error">
@@ -58772,7 +59283,7 @@ Since: 2.10
</parameter_description>
</parameter>
<parameter name="page_ranges">
-<parameter_description> an array of #GtkPageRange<!-- -->s
+<parameter_description> an array of #GtkPageRanges
</parameter_description>
</parameter>
<parameter name="num_ranges">
@@ -59108,7 +59619,7 @@ Since: 2.12
</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"
+%NULL to use the default “Print Settings”
</parameter_description>
</parameter>
</parameters>
@@ -59291,7 +59802,7 @@ Since: 2.10
Gets a new #GtkPrintSettings object that represents the
current values in the print dialog. Note that this creates a
new object, and you need to unref it
-if don't want to keep it.
+if don’t want to keep it.
Since: 2.10
@@ -59412,7 +59923,7 @@ Since: 2.18
<description>
This lets you specify the printing capabilities your application
supports. For instance, if you can handle scaling the output then
-you pass #GTK_PRINT_CAPABILITY_SCALE. If you don't pass that, then
+you pass #GTK_PRINT_CAPABILITY_SCALE. If you don’t pass that, then
the dialog will only let you select the scale if the printing
system automatically handles scaling.
@@ -59575,13 +60086,13 @@ Since: 2.10
<function name="gtk_printer_get_capabilities">
<description>
-Returns the printer's capabilities.
+Returns the printer’s capabilities.
-This is useful when you're using #GtkPrintUnixDialog's manual-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
+This will return 0 unless the printer’s details are available, see
gtk_printer_has_details() and gtk_printer_request_details().
Since: 2.12
@@ -59593,7 +60104,7 @@ Since: 2.12
</parameter_description>
</parameter>
</parameters>
-<return> the printer's capabilities
+<return> the printer’s capabilities
</return>
</function>
@@ -59639,7 +60150,7 @@ Since: 2.10
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,
+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
@@ -59879,7 +60390,7 @@ Since: 2.10
<function name="gtk_printer_list_papers">
<description>
Lists all the paper sizes @printer supports.
-This will return and empty list unless the printer's details are
+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
@@ -59970,7 +60481,7 @@ Since: 2.6
<function name="gtk_progress_bar_get_fraction">
<description>
-Returns the current fraction of the task that's been completed.
+Returns the current fraction of the task that’s been completed.
</description>
@@ -60069,8 +60580,8 @@ Creates a new #GtkProgressBar.
<function name="gtk_progress_bar_pulse">
<description>
-Indicates that some progress has been made, but you don't know how much.
-Causes the progress bar to enter "activity mode," where a block
+Indicates that some progress has been 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()).
@@ -60108,7 +60619,7 @@ Since: 2.6
<function name="gtk_progress_bar_set_fraction">
<description>
-Causes the progress bar to "fill in" the given fraction
+Causes the progress bar to “fill in” the given fraction
of the bar. The fraction should be between 0.0 and 1.0,
inclusive.
@@ -60119,7 +60630,7 @@ inclusive.
</parameter_description>
</parameter>
<parameter name="fraction">
-<parameter_description> fraction of the task that's been completed
+<parameter_description> fraction of the task that’s been completed
</parameter_description>
</parameter>
</parameters>
@@ -60232,7 +60743,7 @@ function; it simply emits the #GtkWidget::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.
-All that said, you most likely don't want to use any of these
+All that said, you most likely don’t want to use any of these
functions; synthesizing events is rarely needed. There are almost
certainly better ways to achieve your goals. For example, use
gdk_window_invalidate_rect() or gtk_widget_queue_draw() instead
@@ -60280,11 +60791,11 @@ 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:
-|[
+|[<!-- language="C" -->
GSList *group = NULL;
GtkRadioAction *action;
-while (/ * more actions to add * /)
+while ( ...more actions to add... /)
{
action = gtk_radio_action_new (...);
@@ -60317,11 +60828,11 @@ Use this in language bindings instead of the gtk_radio_action_get_group()
and gtk_radio_action_set_group() methods
A common way to set up a group of radio actions is the following:
-|[
+|[<!-- language="C" -->
GtkRadioAction *action;
GtkRadioAction *last_action;
-while (/ * more actions to add * /)
+while ( ...more actions to add... /)
{
action = gtk_radio_action_new (...);
@@ -60462,11 +60973,11 @@ Use this in language bindings instead of the gtk_radio_button_get_group()
and gtk_radio_button_set_group() methods
A common way to set up a group of radio buttons is the following:
-|[
+|[<!-- language="C" -->
GtkRadioButton *radio_button;
GtkRadioButton *last_button;
-while (/ * more buttons to add * /)
+while ( ...more buttons to add... )
{
radio_button = gtk_radio_button_new (...);
@@ -60620,7 +61131,7 @@ mnemonic character
<function name="gtk_radio_button_set_group">
<description>
-Sets a #GtkRadioButton's group. It should be noted that this does not change
+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.
@@ -60936,7 +61447,7 @@ Since: 2.4
<function name="gtk_range_get_adjustment">
<description>
-Get the #GtkAdjustment which is the "model" object for #GtkRange.
+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.
@@ -61008,7 +61519,7 @@ Gets the value set by gtk_range_set_inverted().
<function name="gtk_range_get_lower_stepper_sensitivity">
<description>
Gets the sensitivity policy for the stepper that points to the
-'lower' end of the GtkRange's adjustment.
+'lower' end of the GtkRange’s adjustment.
Since: 2.10
@@ -61019,7 +61530,7 @@ Since: 2.10
</parameter_description>
</parameter>
</parameters>
-<return> The lower stepper's sensitivity policy.
+<return> The lower stepper’s sensitivity policy.
</return>
</function>
@@ -61039,14 +61550,14 @@ Since: 2.20
</parameter_description>
</parameter>
</parameters>
-<return> The minimum size of the range's slider.
+<return> The minimum size of the range’s slider.
</return>
</function>
<function name="gtk_range_get_range_rect">
<description>
-This function returns the area that contains the range's trough
+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.
@@ -61166,7 +61677,7 @@ Since: 2.20
</parameter_description>
</parameter>
</parameters>
-<return> whether the range's slider has a fixed size.
+<return> whether the range’s slider has a fixed size.
</return>
</function>
@@ -61174,7 +61685,7 @@ Since: 2.20
<function name="gtk_range_get_upper_stepper_sensitivity">
<description>
Gets the sensitivity policy for the stepper that points to the
-'upper' end of the GtkRange's adjustment.
+'upper' end of the GtkRange’s adjustment.
Since: 2.10
@@ -61185,7 +61696,7 @@ Since: 2.10
</parameter_description>
</parameter>
</parameters>
-<return> The upper stepper's sensitivity policy.
+<return> The upper stepper’s sensitivity policy.
</return>
</function>
@@ -61208,7 +61719,7 @@ Gets the current value of the range.
<function name="gtk_range_set_adjustment">
<description>
-Sets the adjustment to be used as the "model" object for this range
+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
@@ -61234,18 +61745,18 @@ The page size affects the size of the scrollbar slider.
<description>
Set the new position of the fill level indicator.
-The "fill level" is probably best described by its most prominent
+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
+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
+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.
@@ -61338,7 +61849,7 @@ on the bottom or left.
<function name="gtk_range_set_lower_stepper_sensitivity">
<description>
Sets the sensitivity policy for the stepper that points to the
-'lower' end of the GtkRange's adjustment.
+'lower' end of the GtkRange’s adjustment.
Since: 2.10
@@ -61349,7 +61860,7 @@ Since: 2.10
</parameter_description>
</parameter>
<parameter name="sensitivity">
-<parameter_description> the lower stepper's sensitivity policy.
+<parameter_description> the lower stepper’s sensitivity policy.
</parameter_description>
</parameter>
</parameters>
@@ -61358,7 +61869,7 @@ Since: 2.10
<function name="gtk_range_set_min_slider_size">
<description>
-Sets the minimum size of the range's slider.
+Sets the minimum size of the range’s slider.
This function is useful mainly for #GtkRange subclasses.
@@ -61371,7 +61882,7 @@ Since: 2.20
</parameter_description>
</parameter>
<parameter name="min_size">
-<parameter_description> The slider's minimum size
+<parameter_description> The slider’s minimum size
</parameter_description>
</parameter>
</parameters>
@@ -61469,8 +61980,8 @@ Since: 2.12
<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 its adjustment's page size.
+Sets whether the range’s slider has a fixed size, or a size that
+depends on its adjustment’s page size.
This function is useful mainly for #GtkRange subclasses.
@@ -61493,7 +62004,7 @@ Since: 2.20
<function name="gtk_range_set_upper_stepper_sensitivity">
<description>
Sets the sensitivity policy for the stepper that points to the
-'upper' end of the GtkRange's adjustment.
+'upper' end of the GtkRange’s adjustment.
Since: 2.10
@@ -61504,7 +62015,7 @@ Since: 2.10
</parameter_description>
</parameter>
<parameter name="sensitivity">
-<parameter_description> the upper stepper's sensitivity policy.
+<parameter_description> the upper stepper’s sensitivity policy.
</parameter_description>
</parameter>
</parameters>
@@ -61620,7 +62131,7 @@ to store this information, you should make a copy.
<function name="gtk_rc_get_im_module_file">
<description>
Obtains the path to the IM modules file. See the documentation
-of the <envar>GTK_IM_MODULE_FILE</envar>
+of the `GTK_IM_MODULE_FILE`
environment variable for more details.
Deprecated: 3.0: Use #GtkCssProvider instead.
@@ -61637,7 +62148,7 @@ name of the file listing the IM modules available for loading
<function name="gtk_rc_get_im_module_path">
<description>
Obtains the path in which to look for IM modules. See the documentation
-of the <envar>GTK_PATH</envar>
+of the `GTK_PATH`
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.
@@ -61657,8 +62168,7 @@ path in which to look for IM modules.
<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"/>.
+see the docs for `GTK_PATH` in [Running GTK+ Applications][gtk-running].
Deprecated: 3.0: Use #GtkCssProvider instead.
@@ -61700,11 +62210,11 @@ you should add a reference yourself.
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
+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:
-|[
+|[<!-- language="C" -->
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),
@@ -61909,7 +62419,7 @@ Deprecated: 3.0: Use #GtkCssProvider instead.
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, bottom }"` for integers
left, right, top and bottom.
@@ -61938,7 +62448,7 @@ has been set to the resulting #GtkBorder.
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
+`{ red, green, blue }` where red, green and
blue are integers between 0 and 65535 or floating-point numbers
between 0 and 1.
@@ -62001,7 +62511,7 @@ or gtk_widget_class_install_style_property_parser() which parses flags.
Flags can be specified by their name, their nickname or
numerically. Multiple flags can be specified in the form
-<literal>"( flag1 | flag2 | ... )"</literal>.
+`"( flag1 | flag2 | ... )"`.
</description>
@@ -62029,7 +62539,7 @@ has been set to the resulting flags value.
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.
+`"{ width, height }"` for integers %width and %height.
</description>
@@ -62102,7 +62612,7 @@ 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 explicitly on them
+doesn’t affect widgets that have a style set explicitly on them
with gtk_widget_set_style().
Since: 2.4
@@ -62457,8 +62967,8 @@ Since: 2.10
<description>
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.
+The return value of this function is affected by the “sort-type” and
+“limit” properties of @chooser.
Since: 2.10
@@ -62634,7 +63144,7 @@ Since: 2.10
<description>
Gets the URI of the recently used resources.
-The return value of this function is affected by the "sort-type" and "limit"
+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.
@@ -62751,7 +63261,7 @@ Since: 2.10
<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
+be used inside ten menu item’s label. Only the first the items
get a number to avoid clashes.
Since: 2.10
@@ -62968,7 +63478,7 @@ Since: 2.10
<function name="gtk_recent_chooser_set_show_not_found">
<description>
Sets whether @chooser should display the recently used resources that
-it didn't find. This only applies to local resources.
+it didn’t find. This only applies to local resources.
Since: 2.10
@@ -62979,7 +63489,7 @@ Since: 2.10
</parameter_description>
</parameter>
<parameter name="show_not_found">
-<parameter_description> whether to show the local items we didn't find
+<parameter_description> whether to show the local items we didn’t find
</parameter_description>
</parameter>
</parameters>
@@ -63203,7 +63713,7 @@ 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.
+it isn’t needed by the filter.
Since: 2.10
@@ -63395,7 +63905,7 @@ 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:
-|[
+|[<!-- language="C" -->
GtkRecentFilter *filter = gtk_recent_filter_new ();
gtk_recent_filter_add_pattern (filter, "*");
]|
@@ -63481,7 +63991,7 @@ Since: 2.10
<function name="gtk_recent_info_get_added">
<description>
-Gets the timestamp (seconds from system's Epoch) when the resource
+Gets the timestamp (seconds from system’s Epoch) when the resource
was added to the recently used resources list.
Since: 2.10
@@ -63493,7 +64003,7 @@ Since: 2.10
</parameter_description>
</parameter>
</parameters>
-<return> the number of seconds elapsed from system's Epoch when
+<return> the number of seconds elapsed from system’s Epoch when
the resource was added to the list, or -1 on failure.
</return>
@@ -63713,7 +64223,7 @@ is owned by the recent manager, and should not be freed.
<function name="gtk_recent_info_get_modified">
<description>
-Gets the timestamp (seconds from system's Epoch) when the meta-data
+Gets the timestamp (seconds from system’s Epoch) when the meta-data
for the resource was last modified.
Since: 2.10
@@ -63725,7 +64235,7 @@ Since: 2.10
</parameter_description>
</parameter>
</parameters>
-<return> the number of seconds elapsed from system's Epoch when
+<return> the number of seconds elapsed from system’s Epoch when
the resource was last modified, or -1 on failure.
</return>
@@ -63733,7 +64243,7 @@ the resource was last modified, or -1 on failure.
<function name="gtk_recent_info_get_private_hint">
<description>
-Gets the value of the "private" flag. Resources in the recently used
+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.
@@ -63755,7 +64265,7 @@ Since: 2.10
<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".
+“file:///foo/bar.txt” will yield “bar.txt”.
Since: 2.10
@@ -63793,7 +64303,7 @@ owned by the recent manager, and should not be freed.
<function name="gtk_recent_info_get_uri_display">
<description>
-Gets a displayable version of the resource's URI. If the resource
+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().
@@ -63807,14 +64317,14 @@ Since: 2.10
</parameter>
</parameters>
<return> a newly allocated UTF-8 string containing the
-resource's URI or %NULL. Use g_free() when done using it.
+resource’s URI or %NULL. Use g_free() when done using it.
</return>
</function>
<function name="gtk_recent_info_get_visited">
<description>
-Gets the timestamp (seconds from system's Epoch) when the meta-data
+Gets the timestamp (seconds from system’s Epoch) when the meta-data
for the resource was last visited.
Since: 2.10
@@ -63826,7 +64336,7 @@ Since: 2.10
</parameter_description>
</parameter>
</parameters>
-<return> the number of seconds elapsed from system's Epoch when
+<return> the number of seconds elapsed from system’s Epoch when
the resource was last visited, or -1 on failure.
</return>
@@ -64180,7 +64690,7 @@ remove the item pointed by @uri in the list
<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
+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
@@ -64289,10 +64799,9 @@ Since: 3.0
<description>
Renders an arrow pointing to @angle.
-<example>
-<title>Typical arrow rendering at 0, 1/2 ∏, ∏ and 3/2 ∏</title>
-<inlinegraphic fileref="arrows.png" format="PNG"/>
-</example>
+Typical arrow rendering at 0, 1/2 ∏, ∏ and 3/2 ∏:
+
+
Since: 3.0
@@ -64330,13 +64839,10 @@ Since: 3.0
<description>
Renders the background of an element.
-<example>
-<title>Typical background rendering, showing the effect of
-<parameter>background-image</parameter>,
-<parameter>border-width</parameter> and
-<parameter>border-radius</parameter></title>
-<inlinegraphic fileref="background.png" format="PNG"/>
-</example>
+Typical background rendering, showing the effect of
+`background-image`, `border-width` and `border-radius`:
+
+
Since: 3.0.
@@ -64378,10 +64884,9 @@ The %GTK_STATE_FLAG_ACTIVE state determines whether the check is
on or off, and %GTK_STATE_FLAG_INCONSISTENT determines whether it
should be marked as undefined.
-<example>
-<title>Typical checkmark rendering</title>
-<inlinegraphic fileref="checks.png" format="PNG"/>
-</example>
+Typical checkmark rendering:
+
+
Since: 3.0
@@ -64421,10 +64926,9 @@ Renders an expander (as used in #GtkTreeView and #GtkExpander) in the area
defined by @x, @y, @width, @height. The state %GTK_STATE_FLAG_ACTIVE
determines whether the expander is collapsed or expanded.
-<example>
-<title>Typical expander rendering</title>
-<inlinegraphic fileref="expanders.png" format="PNG"/>
-</example>
+Typical expander rendering:
+
+
Since: 3.0
@@ -64464,10 +64968,9 @@ Renders a extension (as in a #GtkNotebook tab) in the rectangle
defined by @x, @y, @width, @height. The side where the extension
connects to is defined by @gap_side.
-<example>
-<title>Typical extension rendering</title>
-<inlinegraphic fileref="extensions.png" format="PNG"/>
-</example>
+Typical extension rendering:
+
+
Since: 3.0
@@ -64508,10 +65011,10 @@ Since: 3.0
<function name="gtk_render_focus">
<description>
Renders a focus indicator on the rectangle determined by @x, @y, @width, @height.
-<example>
-<title>Typical focus rendering</title>
-<inlinegraphic fileref="focus.png" format="PNG"/>
-</example>
+
+Typical focus rendering:
+
+
Since: 3.0
@@ -64549,15 +65052,10 @@ Since: 3.0
<description>
Renders a frame around the rectangle defined by @x, @y, @width, @height.
-<example>
-<title>Examples of frame rendering, showing the effect of
-<parameter>border-image</parameter>,
-<parameter>border-color</parameter>,
-<parameter>border-width</parameter>,
-<parameter>border-radius</parameter> and
-junctions</title>
-<inlinegraphic fileref="frames.png" format="PNG"/>
-</example>
+Examples of frame rendering, showing the effect of `border-image`,
+`border-color`, `border-width`, `border-radius` and junctions:
+
+
Since: 3.0
@@ -64598,10 +65096,9 @@ leaving a gap on one side. @xy0_gap and @xy1_gap will mean X coordinates
for %GTK_POS_TOP and %GTK_POS_BOTTOM gap sides, and Y coordinates for
%GTK_POS_LEFT and %GTK_POS_RIGHT.
-<example>
-<title>Typical rendering of a frame with a gap</title>
-<inlinegraphic fileref="frame-gap.png" format="PNG"/>
-</example>
+Typical rendering of a frame with a gap:
+
+
Since: 3.0
@@ -64650,13 +65147,12 @@ Since: 3.0
<function name="gtk_render_handle">
<description>
Renders a handle (as in #GtkHandleBox, #GtkPaned and
-#GtkWindow<!-- -->'s resize grip), in the rectangle
+#GtkWindow’s resize grip), in the rectangle
determined by @x, @y, @width, @height.
-<example>
-<title>Handles rendered for the paned and grip classes</title>
-<inlinegraphic fileref="handles.png" format="PNG"/>
-</example>
+Handles rendered for the paned and grip classes:
+
+
Since: 3.0
@@ -64743,7 +65239,7 @@ Deprecated: 3.10: Use gtk_icon_theme_load_icon() instead.
</parameter>
<parameter name="size">
<parameter_description> the size to render the icon at. A size of (GtkIconSize) -1
-means render at the size of the source and don't scale.
+means render at the size of the source and don’t scale.
</parameter_description>
</parameter>
</parameters>
@@ -64898,10 +65394,9 @@ Renders an option mark (as in a #GtkRadioButton), the %GTK_STATE_FLAG_ACTIVE
state will determine whether the option is on or off, and
%GTK_STATE_FLAG_INCONSISTENT whether it should be marked as undefined.
-<example>
-<title>Typical option mark rendering</title>
-<inlinegraphic fileref="options.png" format="PNG"/>
-</example>
+Typical option mark rendering:
+
+
Since: 3.0
@@ -64941,10 +65436,9 @@ Renders a slider (as in #GtkScale) in the rectangle defined by @x, @y,
@width, @height. @orientation defines whether the slider is vertical
or horizontal.
-<example>
-<title>Typical slider rendering</title>
-<inlinegraphic fileref="sliders.png" format="PNG"/>
-</example>
+Typical slider rendering:
+
+
Since: 3.0
@@ -65248,7 +65742,7 @@ Since: 2.16
</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
+the lower and upper limits of the scales’ adjustment
</parameter_description>
</parameter>
<parameter name="position">
@@ -65259,7 +65753,7 @@ 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> Text to be shown at the mark, using [Pango markup][PangoMarkupFormat], or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -65268,7 +65762,7 @@ the left of the scale, anything else to the right.
<function name="gtk_scale_button_get_adjustment">
<description>
-Gets the #GtkAdjustment associated with the #GtkScaleButton's scale.
+Gets the #GtkAdjustment associated with the #GtkScaleButton’s scale.
See gtk_range_get_adjustment() for details.
Since: 2.12
@@ -65398,7 +65892,7 @@ later with gtk_scale_button_set_icons()
<function name="gtk_scale_button_set_adjustment">
<description>
Sets the #GtkAdjustment to be used as a model
-for the #GtkScaleButton's scale.
+for the #GtkScaleButton’s scale.
See gtk_range_set_adjustment() for details.
Since: 2.12
@@ -65604,7 +66098,7 @@ Since: 3.0
</description>
<parameters>
<parameter name="orientation">
-<parameter_description> the scale's orientation.
+<parameter_description> the scale’s orientation.
</parameter_description>
</parameter>
<parameter name="adjustment">
@@ -65622,7 +66116,7 @@ of the scale, or %NULL to create a new adjustment.
<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
+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.
@@ -65635,7 +66129,7 @@ Since: 3.0
</description>
<parameters>
<parameter name="orientation">
-<parameter_description> the scale's orientation.
+<parameter_description> the scale’s orientation.
</parameter_description>
</parameter>
<parameter name="min">
@@ -65902,7 +66396,7 @@ Since: 3.0
</description>
<parameters>
<parameter name="orientation">
-<parameter_description> the scrollbar's orientation.
+<parameter_description> the scrollbar’s orientation.
</parameter_description>
</parameter>
<parameter name="adjustment">
@@ -65935,7 +66429,7 @@ A widget supports scrolling natively if it implements the
#GtkScrollable interface.
Deprecated: 3.8: gtk_container_add() will now automatically add
-a #GtkViewport if the child doesn't implement #GtkScrollable.
+a #GtkViewport if the child doesn’t implement #GtkScrollable.
</description>
<parameters>
@@ -65972,8 +66466,8 @@ Since: 3.4
<function name="gtk_scrolled_window_get_hadjustment">
<description>
-Returns the horizontal scrollbar's adjustment, used to connect the
-horizontal scrollbar to the child widget's horizontal scroll
+Returns the horizontal scrollbar’s adjustment, used to connect the
+horizontal scrollbar to the child widget’s horizontal scroll
functionality.
@@ -66125,8 +66619,8 @@ gtk_scrolled_window_set_shadow_type().
<function name="gtk_scrolled_window_get_vadjustment">
<description>
-Returns the vertical scrollbar's adjustment, used to connect the
-vertical scrollbar to the child widget's vertical scroll functionality.
+Returns the vertical scrollbar’s adjustment, used to connect the
+vertical scrollbar to the child widget’s vertical scroll functionality.
</description>
@@ -66163,7 +66657,7 @@ or %NULL if it does not have one.
<description>
Creates a new scrolled window.
-The two arguments are the scrolled window's adjustments; these will be
+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.
@@ -66417,7 +66911,7 @@ Since: 2.10
<description>
Connects the #GtkEntry widget passed as the one to be used in
this search bar. The entry should be a descendant of the search bar.
-This is only required if the entry isn't the direct child of the
+This is only required if the entry isn’t the direct child of the
search bar (as in our main example).
Since: 3.10
@@ -66486,21 +66980,23 @@ If no entry has been connected to the search bar, using
gtk_search_bar_connect_entry(), this function will return
immediately with a warning.
-<example>
-<title>Showing the search bar on key presses</title>
-<programlisting><![CDATA[
+## Showing the search bar on key presses
+
+|[<!-- language="C" -->
static gboolean
-window_key_press_event_cb (GtkWidget *widget,
+on_key_press_event (GtkWidget *widget,
GdkEvent *event,
gpointer user_data)
{
-return gtk_search_bar_handle_event (GTK_SEARCH_BAR (user_data), event);
+GtkSearchBar *bar = GTK_SEARCH_BAR (user_data);
+return gtk_search_bar_handle_event (bar, event);
}
-g_signal_connect (window, "key-press-event",
-G_CALLBACK (window_key_press_event_cb), search_bar);
-]]></programlisting>
-</example>
+g_signal_connect (window,
+"key-press-event",
+G_CALLBACK (on_key_press_event),
+search_bar);
+]|
Since: 3.10
@@ -66561,7 +67057,7 @@ Since: 3.10
<function name="gtk_search_bar_set_show_close_button">
<description>
Shows or hides the close button. Applications that
-already have a "search" toggle button should not show a close
+already have a “search” toggle button should not show a close
button in their search bar, as it duplicates the role of the
toggle button.
@@ -66672,7 +67168,7 @@ widget.
<function name="gtk_selection_convert">
<description>
Requests the contents of a selection. When received,
-a "selection-received" signal will be generated.
+a “selection-received” signal will be generated.
</description>
@@ -67268,7 +67764,7 @@ Since: 3.0
</description>
<parameters>
<parameter name="orientation">
-<parameter_description> the separator's orientation.
+<parameter_description> the separator’s orientation.
</parameter_description>
</parameter>
</parameters>
@@ -67393,7 +67889,7 @@ Since: 2.2
<function name="gtk_show_about_dialog">
<description>
-This is a convenience function for showing an application's about box.
+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.
@@ -67424,11 +67920,9 @@ 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>
+- `file:///home/gnome/pict.jpg`
+- `http://www.gnome.org`
+- `mailto:me\ gnome org`
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.
@@ -67646,7 +68140,7 @@ Adds an XEMBED client, such as a #GtkPlug, to the #GtkSocket. The
client may be in the same process or in a different process.
To embed a #GtkPlug in a #GtkSocket, you can either create the
-#GtkPlug with <literal>gtk_plug_new (0)</literal>, call
+#GtkPlug with `gtk_plug_new (0)`, 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
@@ -67684,7 +68178,7 @@ Adds a window to a GtkSocket.
</parameter_description>
</parameter>
<parameter name="need_reparent">
-<parameter_description> whether the socket's plug's window needs to be
+<parameter_description> whether the socket’s plug’s window needs to be
reparented to the socket
</parameter_description>
</parameter>
@@ -68037,7 +68531,7 @@ Get the value @spin_button represented as an integer.
<function name="gtk_spin_button_get_wrap">
<description>
-Returns whether the spin button's value wraps around to the
+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().
@@ -68141,7 +68635,7 @@ is allowed.
</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_description> the number of digits after the decimal point to be displayed for the spin button’s
value
</parameter_description>
</parameter>
</parameters>
@@ -68151,7 +68645,7 @@ is allowed.
<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.
+quickly the value changes when the spin button’s arrows are activated.
</description>
<parameters>
@@ -68295,7 +68789,7 @@ of the range is exceeded.
<function name="gtk_spin_button_spin">
<description>
-Increment or decrement a spin button's value in a specified
+Increment or decrement a spin button’s value in a specified
direction by a specified amount.
</description>
@@ -69483,7 +69977,7 @@ Since: 2.18
<function name="gtk_status_icon_set_tooltip_markup">
<description>
Sets @markup as the contents of the tooltip, which is marked up with
-the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
+the [Pango text markup language][PangoMarkupFormat].
This function will take care of setting #GtkStatusIcon:has-tooltip to %TRUE
and of the default handler for the #GtkStatusIcon::query-tooltip signal.
@@ -69609,7 +70103,7 @@ Creates a new #GtkStatusbar ready for messages.
<function name="gtk_statusbar_pop">
<description>
-Removes the first message in the #GtkStatusbar's stack
+Removes the first message in the #GtkStatusbar’s stack
with the given context id.
Note that this may not change the displayed message, if
@@ -69632,7 +70126,7 @@ context id.
<function name="gtk_statusbar_push">
<description>
-Pushes a new message onto a statusbar's stack.
+Pushes a new message onto a statusbar’s stack.
</description>
@@ -69642,7 +70136,7 @@ Pushes a new message onto a statusbar's stack.
</parameter_description>
</parameter>
<parameter name="context_id">
-<parameter_description> the message's context id, as returned by
+<parameter_description> the message’s context id, as returned by
gtk_statusbar_get_context_id()
</parameter_description>
</parameter>
@@ -69658,7 +70152,7 @@ gtk_statusbar_remove().
<function name="gtk_statusbar_remove">
<description>
-Forces the removal of a message from a statusbar's stack.
+Forces the removal of a message from a statusbar’s stack.
The exact @context_id and @message_id must be specified.
</description>
@@ -69727,7 +70221,7 @@ Deprecated: 3.10
<function name="gtk_stock_add_static">
<description>
-Same as gtk_stock_add(), but doesn't copy @items, so
+Same as gtk_stock_add(), but doesn’t copy @items, so
@items must persist until application exit.
Deprecated: 3.10
@@ -69836,7 +70330,7 @@ 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:
-|[
+|[<!-- language="C" -->
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" },
@@ -69851,7 +70345,7 @@ 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");
@@ -69930,14 +70424,14 @@ Deprecated:3.0: Use #GtkStyleContext instead
<function name="gtk_style_attach">
<description>
Attaches a style to a window; this process allocates the
-colors and creates the GC's for the style - it specializes
+colors and creates the GC’s for the style - it specializes
it to a particular visual. 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 visual.
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>
+`style = gtk_style_attach (style, window)`
Deprecated:3.0: Use gtk_widget_style_attach() instead
@@ -69966,18 +70460,18 @@ Adds a style class to @context, so posterior calls to
gtk_style_context_get() or any of the gtk_render_*()
functions will make use of this new class for styling.
-In the CSS file format, a #GtkEntry defining an "entry"
+In the CSS file format, a #GtkEntry defining an “entry”
class, would be matched by:
-<programlisting>
+|[
GtkEntry.entry { ... }
-</programlisting>
+]|
-While any widget defining an "entry" class would be
+While any widget defining an “entry” class would be
matched by:
-<programlisting>
+|[
.entry { ... }
-</programlisting>
+]|
Since: 3.0
@@ -70003,9 +70497,9 @@ the style of the widget to which @context belongs. If you want
to affect the style of all widgets, use
gtk_style_context_add_provider_for_screen().
-<note><para>If both priorities are the same, A #GtkStyleProvider
+Note: If both priorities are the same, a #GtkStyleProvider
added through this function takes precedence over another added
-through gtk_style_context_add_provider_for_screen().</para></note>
+through gtk_style_context_add_provider_for_screen().
Since: 3.0
@@ -70039,9 +70533,9 @@ in style construction for all #GtkStyleContexts under @screen.
GTK+ uses this to make styling information from #GtkSettings
available.
-<note><para>If both priorities are the same, A #GtkStyleProvider
+Note: If both priorities are the same, A #GtkStyleProvider
added through gtk_style_context_add_provider() takes precedence
-over another added through this function.</para></note>
+over another added through this function.
Since: 3.0
@@ -70073,24 +70567,24 @@ Adds a region to @context, so posterior calls to
gtk_style_context_get() or any of the gtk_render_*()
functions will make use of this new region for styling.
-In the CSS file format, a #GtkTreeView defining a "row"
+In the CSS file format, a #GtkTreeView defining a “row”
region, would be matched by:
-<programlisting>
+|[
GtkTreeView row { ... }
-</programlisting>
+]|
Pseudo-classes are used for matching @flags, so the two
following rules:
-<programlisting>
+|[
GtkTreeView row:nth-child(even) { ... }
GtkTreeView row:nth-child(odd) { ... }
-</programlisting>
+]|
would apply to even and odd rows, respectively.
-<note><para>Region names must only contain lowercase letters
-and '-', starting always with a lowercase letter.</para></note>
+Region names must only contain lowercase letters
+and “-”, starting always with a lowercase letter.
Since: 3.0
@@ -70809,15 +71303,13 @@ Deprecated: 3.10: Use gtk_icon_theme_lookup_icon() instead.
<function name="gtk_style_context_new">
<description>
Creates a standalone #GtkStyleContext, this style context
-won't be attached to any widget, so you may want
+won’t be attached to any widget, so you may want
to call gtk_style_context_set_path() yourself.
-<note>
This function is only useful when using the theming layer
separated from GTK+, if you are using #GtkStyleContext to
-theme #GtkWidget<!-- -->s, use gtk_widget_get_style_context()
+theme #GtkWidgets, use gtk_widget_get_style_context()
in order to get a style context ready to theme the widget.
-</note>
</description>
@@ -70843,25 +71335,25 @@ affected by this state transition.
As a practical example, a #GtkButton notifying a state transition on
the prelight state:
-<programlisting>
+|[<!-- language="C" -->
gtk_style_context_notify_state_change (context,
gtk_widget_get_window (widget),
NULL,
GTK_STATE_PRELIGHT,
button->in_button);
-</programlisting>
+]|
Can be handled in the CSS file like this:
-<programlisting>
+|[
GtkButton {
-background-color: #f00
+background-color: #f00
}
GtkButton:hover {
-background-color: #fff;
+background-color: #fff;
transition: 200ms linear
}
-</programlisting>
+]|
This combination will animate the button background from red to white
if a pointer enters the button, and back to red if the pointer leaves
@@ -71231,7 +71723,7 @@ other elements
<description>
Sets the parent style context for @context. The parent style
context is used to implement
-<ulink url="http://www.w3.org/TR/css3-cascade/#inheritance">inheritance</ulink>
+[inheritance](http://www.w3.org/TR/css3-cascade/#inheritance)
of properties.
If you are using a #GtkStyleContext returned from
@@ -71303,7 +71795,7 @@ Since: 3.10
<description>
Attaches @context to the given screen.
-The screen is used to add style information from 'global' style
+The screen is used to add style information from “global” style
providers, such as the screens #GtkSettings instance.
If you are using a #GtkStyleContext returned from
@@ -71354,9 +71846,9 @@ current region (see gtk_style_context_push_animatable_region()).
If @progress is not %NULL, the animation progress will be returned
there, 0.0 means the state is closest to being unset, while 1.0 means
-it's closest to being set. This means transition animation will
+it’s closest to being set. This means transition animation will
run from 0 to 1 when @state is being set and from 1 to 0 when
-it's being unset.
+it’s being unset.
Since: 3.0
@@ -71529,7 +72021,7 @@ Since: 3.0
<function name="gtk_style_lookup_color">
<description>
-Looks up @color_name in the style's logical color mappings,
+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
@@ -71966,7 +72458,7 @@ Deprecated: 3.8: Will always return %NULL for all GTK-provided style providers.
<function name="gtk_style_provider_get_style">
<description>
Returns the style settings affecting a widget defined by @path, or %NULL if
- provider doesn't contemplate styling @path.
+ provider doesn’t contemplate styling @path.
Since: 3.0
@@ -72054,7 +72546,7 @@ Deprecated:3.0: Use gtk_render_icon_pixbuf() instead
<parameter name="size">
<parameter_description> the size to render the icon at. A size of
(GtkIconSize)-1 means render at the size of the source and
-don't scale.
+don’t scale.
</parameter_description>
</parameter>
<parameter name="widget">
@@ -72099,7 +72591,7 @@ Deprecated:3.0: Use gtk_style_context_set_background() instead
<function name="gtk_switch_get_active">
<description>
-Gets whether the #GtkSwitch is in its "on" or "off" state.
+Gets whether the #GtkSwitch is in its “on” or “off” state.
Since: 3.0
@@ -72328,8 +72820,8 @@ Deprecated: 3.8: #GtkSymbolicColor is deprecated.
<description>
If @color is resolvable, @resolved_color will be filled in
with the resolved color, and %TRUE will be returned. Generally,
-if @color can't be resolved, it is due to it being defined on
-top of a named color that doesn't exist in @props.
+if @color can’t be resolved, it is due to it being defined on
+top of a named color that doesn’t exist in @props.
When @props is %NULL, resolving of named colors will fail, so if
your @color is or references such a color, this function will
@@ -72403,19 +72895,19 @@ Deprecated: 3.8: #GtkSymbolicColor is deprecated.
<function name="gtk_table_attach">
<description>
-Adds a widget to a table. The number of 'cells' that a widget will occupy is
+Adds a widget to a table. The number of “cells” that a widget will occupy is
specified by @left_attach, @right_attach, @top_attach and @bottom_attach.
These each represent the leftmost, rightmost, uppermost and lowest column
and row numbers of the table. (Columns and rows are indexed from zero).
To make a button occupy the lower right cell of a 2x2 table, use
-<informalexample><programlisting>
+|[
gtk_table_attach (table, button,
1, 2, // left, right attach
1, 2, // top, bottom attach
xoptions, yoptions,
xpadding, ypadding);
-</programlisting></informalexample>
+]|
If you want to make the button span the entire bottom row, use @left_attach == 0 and @right_attach = 2
instead.
Deprecated: 3.4: Use gtk_grid_attach() with #GtkGrid. Note that the attach
@@ -72472,7 +72964,7 @@ arguments differ between those two functions.
As there are many options associated with gtk_table_attach(), this convenience
function provides the programmer with a means to add children to a table with
identical padding and expansion options. The values used for the #GtkAttachOptions
-are <literal>GTK_EXPAND | GTK_FILL</literal>, and the padding is set to 0.
+are `GTK_EXPAND | GTK_FILL`, and the padding is set to 0.
Deprecated: 3.4: Use gtk_grid_attach() with #GtkGrid. Note that the attach
arguments differ between those two functions.
@@ -72677,7 +73169,7 @@ the cell containing the largest widget.
<function name="gtk_table_resize">
<description>
-If you need to change a table's size after
+If you need to change a table’s size after
it has been created, this function allows you to do so.
Deprecated: 3.4: #GtkGrid resizes automatically.
@@ -73172,7 +73664,7 @@ Since: 2.10
</description>
<parameters>
<parameter name="targets">
-<parameter_description> an array of #GdkAtom<!-- -->s
+<parameter_description> an array of #GdkAtoms
</parameter_description>
</parameter>
<parameter name="n_targets">
@@ -73201,7 +73693,7 @@ Since: 2.10
</description>
<parameters>
<parameter name="targets">
-<parameter_description> an array of #GdkAtom<!-- -->s
+<parameter_description> an array of #GdkAtoms
</parameter_description>
</parameter>
<parameter name="n_targets">
@@ -73229,7 +73721,7 @@ Since: 2.10
</description>
<parameters>
<parameter name="targets">
-<parameter_description> an array of #GdkAtom<!-- -->s
+<parameter_description> an array of #GdkAtoms
</parameter_description>
</parameter>
<parameter name="n_targets">
@@ -73253,7 +73745,7 @@ Since: 2.10
</description>
<parameters>
<parameter name="targets">
-<parameter_description> an array of #GdkAtom<!-- -->s
+<parameter_description> an array of #GdkAtoms
</parameter_description>
</parameter>
<parameter name="n_targets">
@@ -73310,7 +73802,7 @@ Since: 2.14
<function name="gtk_test_create_widget">
<description>
This function wraps g_object_new() for widget types.
-It'll automatically show all created non window widgets, also
+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.
@@ -73376,9 +73868,9 @@ Since: 2.14
<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
+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,
+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.
@@ -73406,7 +73898,7 @@ 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"
+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 its corresponding label widget.
@@ -73433,7 +73925,7 @@ Since: 2.14
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.
+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.
@@ -73465,8 +73957,8 @@ Since: 2.14
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
+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.
@@ -73478,13 +73970,13 @@ Since: 2.14
</description>
<parameters>
<parameter name="argcp">
-<parameter_description> Address of the <parameter>argc</parameter> parameter of the
+<parameter_description> Address of the `argc` 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().
+`argv` parameter of main().
Any parameters understood by g_test_init() or gtk_init() are
stripped before return.
</parameter_description>
@@ -73556,7 +74048,7 @@ Since: 2.14
<function name="gtk_test_slider_set_perc">
<description>
This function will adjust the slider position of all GtkRange
-based widgets, such as scrollbars or scales, it'll also adjust
+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.
@@ -73581,7 +74073,7 @@ Since: 2.14
<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.
+spin button’s value.
Since: 2.14
@@ -73712,7 +74204,7 @@ Since: 2.14
<function name="gtk_test_widget_wait_for_draw">
<description>
-Enters the main loop and waits for @widget to be "drawn". In this
+Enters the main loop and waits for @widget to be “drawn”. In this
context that means it waits for the frame clock of @widget to have
run a full styling, layout and drawing cycle.
@@ -73864,7 +74356,7 @@ the #GtkClipboard of type %GDK_SELECTION_PRIMARY for a view of @buffer.
<function name="gtk_text_buffer_apply_tag">
<description>
-Emits the "apply-tag" signal on @buffer. The default
+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.
@@ -73892,7 +74384,7 @@ handler for the signal applies @tag to the given range.
<function name="gtk_text_buffer_apply_tag_by_name">
<description>
-Calls gtk_text_tag_table_lookup() on the buffer's tag table to
+Calls gtk_text_tag_table_lookup() on the buffer’s tag table to
get a #GtkTextTag, then calls gtk_text_buffer_apply_tag().
</description>
@@ -73966,11 +74458,11 @@ 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
+“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.
-The "interactive" buffer mutation functions, such as
+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
@@ -74033,12 +74525,12 @@ the caller of gtk_text_buffer_create_child_anchor().
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
+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).
+side of the text you’re typing).
The caller of this function does not own a
reference to the returned #GtkTextMark, so you can ignore the
@@ -74076,8 +74568,8 @@ initial placement.
<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.
+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.
@@ -74114,7 +74606,7 @@ of properties to set on the tag, as with g_object_set().
<function name="gtk_text_buffer_cut_clipboard">
<description>
Copies the currently-selected text to a clipboard, then deletes
-said text if it's editable.
+said text if it’s editable.
</description>
<parameters>
@@ -74138,7 +74630,7 @@ said text if it's editable.
<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
+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
@@ -74196,10 +74688,10 @@ no text was deleted.
<function name="gtk_text_buffer_delete_mark">
<description>
-Deletes @mark, so that it's no longer located anywhere in the
+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
+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.
@@ -74241,9 +74733,9 @@ gtk_text_buffer_delete_mark() for details.
<function name="gtk_text_buffer_delete_selection">
<description>
-Deletes the range between the "insert" and "selection_bound" marks,
+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
+the editability of the selection will be considered (users can’t delete
uneditable text).
@@ -74271,7 +74763,7 @@ uneditable text).
This function deserializes rich text in format @format and inserts
it at @iter.
- format<!-- -->s to be used must be registered using
+ formats to be used must be registered using
gtk_text_buffer_register_deserialize_format() or
gtk_text_buffer_register_deserialize_tagset() beforehand.
@@ -74352,7 +74844,7 @@ 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
+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.
@@ -74417,7 +74909,7 @@ entire buffer lies within the range [ start,@end).
<function name="gtk_text_buffer_get_char_count">
<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
+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.
@@ -74475,17 +74967,17 @@ Since: 2.10
</parameter>
</parameters>
<return> an array of
-#GdkAtom<!-- -->s representing the registered formats.
+#GdkAtoms representing the registered formats.
</return>
</function>
<function name="gtk_text_buffer_get_end_iter">
<description>
-Initializes @iter with the "end iterator," one past the last valid
+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
+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.
@@ -74525,7 +75017,7 @@ Since: 2.10
<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
+named “insert”, but very slightly more efficient, and involves less
typing.
@@ -74732,7 +75224,7 @@ mark exists in the buffer.
<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
+%FALSE. Used for example to enable a “save” function in a text
editor.
@@ -74773,14 +75265,14 @@ Since: 2.10
<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
+“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.
+“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
+for handling the selection, if you just want to know whether there’s a
selection and what its bounds are.
@@ -74844,7 +75336,7 @@ Since: 2.10
</parameter>
</parameters>
<return> an array of
-#GdkAtom<!-- -->s representing the registered formats.
+#GdkAtoms representing the registered formats.
</return>
</function>
@@ -74918,7 +75410,7 @@ Get the #GtkTextTagTable associated with this buffer.
</parameter_description>
</parameter>
</parameters>
-<return> the buffer's tag table
+<return> the buffer’s tag table
</return>
</function>
@@ -74960,7 +75452,7 @@ gtk_text_buffer_get_slice().
<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
+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
@@ -75016,9 +75508,9 @@ cursor position as the insertion point.
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
+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
@@ -75120,9 +75612,9 @@ result of gtk_text_view_get_editable() is appropriate here.
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"
+“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
+this character for pixbufs, but the “text” variants do
not. e.g. see gtk_text_buffer_get_slice() and
gtk_text_buffer_get_text().
@@ -75147,7 +75639,7 @@ gtk_text_buffer_get_text().
<function name="gtk_text_buffer_insert_range">
<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.
+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.
@@ -75180,7 +75672,7 @@ so expect those.
<function name="gtk_text_buffer_insert_range_interactive">
<description>
Same as gtk_text_buffer_insert_range(), but does nothing if the
-insertion point isn't editable. The @default_editable parameter
+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.
@@ -75354,7 +75846,7 @@ Pastes the contents of a clipboard. If @override_location is %NULL, the
pasted text will be inserted at the cursor position, or the buffer selection
will be replaced if the selection is non-empty.
-Note: pasting is asynchronous, that is, we'll ask for the paste data and
+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.
@@ -75382,7 +75874,7 @@ be inserted.
<function name="gtk_text_buffer_place_cursor">
<description>
-This function moves the "insert" and "selection_bound" marks
+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
@@ -75418,7 +75910,7 @@ Since: 2.10
</parameter_description>
</parameter>
<parameter name="mime_type">
-<parameter_description> the format's mime-type
+<parameter_description> the format’s mime-type
</parameter_description>
</parameter>
<parameter name="function">
@@ -75426,7 +75918,7 @@ Since: 2.10
</parameter_description>
</parameter>
<parameter name="user_data">
-<parameter_description> @function's user_data
+<parameter_description> @function’s user_data
</parameter_description>
</parameter>
<parameter name="user_data_destroy">
@@ -75435,14 +75927,14 @@ Since: 2.10
</parameter>
</parameters>
<return> the #GdkAtom that corresponds to the
-newly registered format's mime-type.
+newly registered format’s mime-type.
</return>
</function>
<function name="gtk_text_buffer_register_deserialize_tagset">
<description>
-This function registers GTK+'s internal rich text serialization
+This function registers GTK+’s internal rich text serialization
format with the passed @buffer. See
gtk_text_buffer_register_serialize_tagset() for details.
@@ -75460,7 +75952,7 @@ Since: 2.10
</parameter>
</parameters>
<return> the #GdkAtom that corresponds to the
-newly registered format's mime-type.
+newly registered format’s mime-type.
</return>
</function>
@@ -75479,7 +75971,7 @@ Since: 2.10
</parameter_description>
</parameter>
<parameter name="mime_type">
-<parameter_description> the format's mime-type
+<parameter_description> the format’s mime-type
</parameter_description>
</parameter>
<parameter name="function">
@@ -75487,7 +75979,7 @@ Since: 2.10
</parameter_description>
</parameter>
<parameter name="user_data">
-<parameter_description> @function's user_data
+<parameter_description> @function’s user_data
</parameter_description>
</parameter>
<parameter name="user_data_destroy">
@@ -75496,23 +75988,23 @@ Since: 2.10
</parameter>
</parameters>
<return> the #GdkAtom that corresponds to the
-newly registered format's mime-type.
+newly registered format’s mime-type.
</return>
</function>
<function name="gtk_text_buffer_register_serialize_tagset">
<description>
-This function registers GTK+'s internal rich text serialization
+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
+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
+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
@@ -75535,7 +76027,7 @@ Since: 2.10
</parameter>
</parameters>
<return> the #GdkAtom that corresponds to the
-newly registered format's mime-type.
+newly registered format’s mime-type.
</return>
</function>
@@ -75544,7 +76036,7 @@ newly registered format's mime-type.
<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
+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.
@@ -75588,9 +76080,9 @@ gtk_text_buffer_add_selection_clipboard()
<function name="gtk_text_buffer_remove_tag">
<description>
-Emits the "remove-tag" signal. The default handler for the signal
+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.
+ end don’t have to be in order.
</description>
<parameters>
@@ -75616,7 +76108,7 @@ removes all occurrences of @tag from the given range. @start and
<function name="gtk_text_buffer_remove_tag_by_name">
<description>
-Calls gtk_text_tag_table_lookup() on the buffer's tag table to
+Calls gtk_text_tag_table_lookup() on the buffer’s tag table to
get a #GtkTextTag, then calls gtk_text_buffer_remove_tag().
</description>
@@ -75643,7 +76135,7 @@ get a #GtkTextTag, then calls gtk_text_buffer_remove_tag().
<function name="gtk_text_buffer_select_range">
<description>
-This function moves the "insert" and "selection_bound" marks
+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
@@ -75660,11 +76152,11 @@ Since: 2.4
</parameter_description>
</parameter>
<parameter name="ins">
-<parameter_description> where to put the "insert" mark
+<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> where to put the “selection_bound” mark
</parameter_description>
</parameter>
</parameters>
@@ -75676,7 +76168,7 @@ Since: 2.4
This function serializes the portion of text between @start
and @end in the rich text format represented by @format.
- format<!-- -->s to be used must be registered using
+ formats to be used must be registered using
gtk_text_buffer_register_serialize_format() or
gtk_text_buffer_register_serialize_tagset() beforehand.
@@ -75897,7 +76389,7 @@ convenience function gtk_text_buffer_create_child_anchor().
<description>
Assigns the value of @other to @iter. This function
is not useful in applications, because iterators can be assigned
-with <literal>GtkTextIter i = j;</literal>. The
+with `GtkTextIter i = j;`. The
function is used by language bindings.
Since: 3.2
@@ -75940,7 +76432,7 @@ writing loops.
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
+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.
@@ -76053,7 +76545,7 @@ every iteration, if your first iteration is on line 0.)
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
+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.
@@ -76275,7 +76767,7 @@ Since: 2.8
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
+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.
@@ -76438,7 +76930,7 @@ whether insertions are allowed at a given position.
<function name="gtk_text_iter_compare">
<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.
+ 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.
@@ -76462,7 +76954,7 @@ is less than the second character in the buffer.
<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
+simple assignment (`GtkTextIter i = j;`). The
function is used by language bindings.
@@ -76480,13 +76972,13 @@ function is used by language bindings.
<function name="gtk_text_iter_editable">
<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
+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
+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
@@ -76601,7 +77093,7 @@ algorithms).
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
+comparing the offsets yourself. Also, it’s a bit faster than
gtk_text_iter_compare().
@@ -76674,9 +77166,9 @@ 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
+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
+mark" that causes the accent to be rendered; so the cursor can’t go
between those two characters. See also the #PangoLogAttr-struct and
pango_break() function.
@@ -76768,7 +77260,7 @@ dereferencable, returns %FALSE. Otherwise, returns %TRUE.
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
+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.
@@ -76900,7 +77392,7 @@ gtk_text_iter_get_slice ().
<function name="gtk_text_iter_forward_to_end">
<description>
-Moves @iter forward to the "end iterator," which points one past the last
+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.
@@ -77031,7 +77523,7 @@ Since: 2.8
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
+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.
@@ -77159,7 +77651,7 @@ simply be allocated on the stack.
<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
+settings you wish to use if no tags are in effect. You’d typically
obtain the defaults from gtk_text_view_get_default_attributes().
gtk_text_iter_get_attributes () will modify @values, applying the
@@ -77220,7 +77712,7 @@ including the paragraph delimiters.
The Unicode character at this iterator is returned. (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
+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.
@@ -77350,7 +77842,7 @@ The first character on the line has offset 0.
<function name="gtk_text_iter_get_marks">
<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,
+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.
@@ -77407,8 +77899,8 @@ If the element at @iter is a pixbuf, the pixbuf is returned
<function name="gtk_text_iter_get_slice">
<description>
-Returns the text in the given range. A "slice" is an array of
-characters encoded in UTF-8 format, including the Unicode "unknown"
+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
@@ -77436,7 +77928,7 @@ widget is in the buffer.
<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
+list don’t have a reference added, but you have to free the list
itself.
@@ -77504,7 +77996,7 @@ does not have the tag applied to it.
<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
+are invisible due to tags with the “invisible” flag
toggled on.
@@ -77523,7 +78015,7 @@ toggled on.
<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
+are invisible due to tags with the “invisible” flag
toggled on.
@@ -77542,7 +78034,7 @@ toggled on.
<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.
+“invisible” attribute turned on has been applied to it.
</description>
@@ -77564,7 +78056,7 @@ Invisible text is usually invisible because a #GtkTextTag with the
<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.
+“invisible” attribute turned on has been applied to it.
</description>
@@ -77725,7 +78217,7 @@ if @iter has a character offset of 0.
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
+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.
@@ -77769,7 +78261,7 @@ buffer, moves @iter to the start of the last line in the buffer.
<description>
Same as gtk_text_iter_set_line_offset(), but works with a
byte index. The given byte index must be at
-the start of a character, it can't be in the middle of a UTF-8
+the start of a character, it can’t be in the middle of a UTF-8
encoded character.
@@ -77780,7 +78272,7 @@ encoded character.
</parameter_description>
</parameter>
<parameter name="byte_on_line">
-<parameter_description> a byte index relative to the start of @iter's current line
+<parameter_description> a byte index relative to the start of @iter’s current line
</parameter_description>
</parameter>
</parameters>
@@ -77804,7 +78296,7 @@ a character offset.
</parameter_description>
</parameter>
<parameter name="char_on_line">
-<parameter_description> a character offset relative to the start of @iter's current line
+<parameter_description> a character offset relative to the start of @iter’s current line
</parameter_description>
</parameter>
</parameters>
@@ -77875,8 +78367,8 @@ counted in the offset.
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.
+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>
@@ -78113,7 +78605,7 @@ or %NULL.
<function name="gtk_text_layout_is_valid">
<description>
-Check if there are any invalid regions in a #GtkTextLayout's buffer
+Check if there are any invalid regions in a #GtkTextLayout’s buffer
</description>
@@ -78441,7 +78933,7 @@ or %NULL if the mark is deleted.
</parameter_description>
</parameter>
</parameters>
-<return> the mark's #GtkTextBuffer
+<return> the mark’s #GtkTextBuffer
</return>
</function>
@@ -78517,12 +79009,12 @@ for it).
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
+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).
+side of the text you’re typing).
Since: 2.12
@@ -78567,7 +79059,7 @@ Marks are not visible by default.
<function name="gtk_text_tag_event">
<description>
-Emits the "event" signal on the #GtkTextTag.
+Emits the “event” signal on the #GtkTextTag.
</description>
@@ -78605,7 +79097,7 @@ Get the tag priority.
</parameter_description>
</parameter>
</parameters>
-<return> The tag's priority.
+<return> The tag’s priority.
</return>
</function>
@@ -78633,11 +79125,11 @@ 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
+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
+gtk_text_buffer_create_tag(), which adds the tag to the buffer’s table
automatically.
</description>
@@ -78680,7 +79172,7 @@ the same name as an already-added tag.
<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).
+over it (you can’t add/remove tags).
</description>
<parameters>
@@ -78752,8 +79244,8 @@ default.
<function name="gtk_text_tag_table_remove">
<description>
Remove a tag from the table. If a #GtkTextBuffer has @table as its tag table,
-the tag is removed from the buffer. The table's reference to the tag is
-removed, so the tag will end up destroyed if you don't have a reference to
+the tag is removed from the buffer. The table’s reference to the tag is
+removed, so the tag will end up destroyed if you don’t have a reference to
it.
</description>
@@ -78839,7 +79331,7 @@ 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
+they depend on the view’s width; paragraphs are the same in all
views, since they depend on the contents of the #GtkTextBuffer.
@@ -78866,7 +79358,7 @@ 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
+they depend on the view’s width; paragraphs are the same in all
views, since they depend on the contents of the #GtkTextBuffer.
@@ -78890,7 +79382,7 @@ views, since they depend on the contents of the #GtkTextBuffer.
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
+Note that you can’t convert coordinates for a nonexisting window (see
gtk_text_view_set_border_window_size()).
</description>
@@ -78931,7 +79423,7 @@ 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
+they depend on the view’s width; paragraphs are the same in all
views, since they depend on the contents of the #GtkTextBuffer.
@@ -78958,7 +79450,7 @@ 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
+they depend on the view’s width; paragraphs are the same in all
views, since they depend on the contents of the #GtkTextBuffer.
@@ -79022,7 +79514,7 @@ gtk_text_view_set_border_window_size().
<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.
+of this function won’t own a new reference.
</description>
@@ -79052,7 +79544,7 @@ If @iter is %NULL, the actual cursor position is used.
Note that if @iter happens to be the actual cursor position, and
there is currently an IM preedit sequence being entered, the
returned locations will be adjusted to account for the preedit
-cursor's offset within the preedit sequence.
+cursor’s offset within the preedit sequence.
The rectangle position is in buffer coordinates; use
gtk_text_view_buffer_to_window_coords() to convert these
@@ -79104,7 +79596,7 @@ Find out whether the cursor is being displayed.
<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
+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.
@@ -79163,7 +79655,7 @@ Deprecated: 3.0: Use gtk_scrollable_get_hadjustment()
<function name="gtk_text_view_get_indent">
<description>
Gets the default indentation of paragraphs in @text_view.
-Tags in the view's buffer may override the default.
+Tags in the view’s buffer may override the default.
The indentation may be negative.
@@ -79488,7 +79980,7 @@ in the buffer may override the default.
<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
+“standard” (8-space) tabs are used. Free the return value
with pango_tab_array_free().
@@ -79499,7 +79991,7 @@ with pango_tab_array_free().
</parameter_description>
</parameter>
</parameters>
-<return> copy of default tab array, or %NULL if "standard"
+<return> copy of default tab array, or %NULL if “standard”
tabs are used; must be freed with pango_tab_array_free().
</return>
</function>
@@ -79573,7 +80065,7 @@ realized.
<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
+should be called on `event->window` to
see which window it was.
@@ -79620,7 +80112,7 @@ 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.
-|[
+|[<!-- language="C" -->
static gboolean
gtk_foo_bar_key_press_event (GtkWidget *widget,
GdkEventKey *event)
@@ -79631,7 +80123,7 @@ if (gtk_text_view_im_context_filter_keypress (GTK_TEXT_VIEW (view), event))
return TRUE;
}
-/ * Do some stuff * /
+// Do some stuff
return GTK_WIDGET_CLASS (gtk_foo_bar_parent_class)->key_press_event (widget, event);
}
@@ -79698,7 +80190,7 @@ located within the currently-visible text area.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the mark moved (wasn't already onscreen)
+<return> %TRUE if the mark moved (wasn’t already onscreen)
</return>
</function>
@@ -79739,7 +80231,7 @@ positive moves right)
<function name="gtk_text_view_new">
<description>
-Creates a new #GtkTextView. If you don't call gtk_text_view_set_buffer()
+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().
@@ -79776,7 +80268,7 @@ take over an existing reference.
<function name="gtk_text_view_place_cursor_onscreen">
<description>
Moves the cursor to the currently visible region of the
-buffer, it it isn't there already.
+buffer, it it isn’t there already.
</description>
@@ -79840,7 +80332,7 @@ screen for purposes of this function is reduced by a margin of size
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
+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.
@@ -79950,7 +80442,7 @@ 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
+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.
@@ -79978,7 +80470,7 @@ 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.
+will not “adopt” it.
</description>
<parameters>
@@ -79997,7 +80489,7 @@ will not "adopt" it.
<function name="gtk_text_view_set_cursor_visible">
<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
+text probably shouldn’t have a visible cursor, so you may want to turn
the cursor off.
</description>
@@ -80017,7 +80509,7 @@ the cursor off.
<function name="gtk_text_view_set_editable">
<description>
Sets the default editability of the #GtkTextView. You can override
-this default setting with tags in the buffer, using the "editable"
+this default setting with tags in the buffer, using the “editable”
attribute of tags.
</description>
@@ -80027,7 +80519,7 @@ attribute of tags.
</parameter_description>
</parameter>
<parameter name="setting">
-<parameter_description> whether it's editable
+<parameter_description> whether it’s editable
</parameter_description>
</parameter>
</parameters>
@@ -80099,7 +80591,7 @@ Since: 3.6
<function name="gtk_text_view_set_justification">
<description>
Sets the default justification of text in @text_view.
-Tags in the view's buffer may override the default.
+Tags in the view’s buffer may override the default.
</description>
@@ -80178,7 +80670,7 @@ Tags in the buffer for @text_view may override the defaults.
<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.
+by tags applied to @text_view’s buffer.
</description>
<parameters>
@@ -80198,7 +80690,7 @@ by tags applied to @text_view's buffer.
<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.
+tags in @text_view’s buffer.
</description>
<parameters>
@@ -80297,7 +80789,7 @@ display lines vs. paragraphs.
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
+Note that you can’t convert coordinates for a nonexisting window (see
gtk_text_view_set_border_window_size()).
</description>
@@ -80651,7 +81143,7 @@ Since: 3.0
<function name="gtk_theming_engine_get_style">
<description>
Retrieves several widget style properties from @engine according
-to the currently rendered content's style.
+to the currently rendered content’s style.
Since: 3.0
@@ -80697,7 +81189,7 @@ g_value_unset() after use.
<function name="gtk_theming_engine_get_style_valist">
<description>
Retrieves several widget style properties from @engine according to the
-currently rendered content's style.
+currently rendered content’s style.
Since: 3.0
@@ -80805,13 +81297,13 @@ standard directories.
</parameter>
</parameters>
<return> A theming engine, or %NULL if
-the engine @name doesn't exist.
+the engine @name doesn’t exist.
</return>
</function>
<function name="gtk_theming_engine_lookup_color">
<description>
-Looks up and resolves a color name in the current style's color map.
+Looks up and resolves a color name in the current style’s color map.
</description>
@@ -80842,30 +81334,26 @@ ${property_name} the given to @pspec. @name_space will usually
be the theme engine name.
For any type a @parse_func may be provided, being this function
-used for turning any property value (between ':' and ';') in
+used for turning any property value (between “:” and “;”) in
CSS to the #GValue needed. For basic types there is already
builtin parsing support, so %NULL may be provided for these
cases.
-<note>
Engines must ensure property registration happens exactly once,
usually GTK+ deals with theming engines as singletons, so this
should be guaranteed to happen once, but bear this in mind
-when creating #GtkThemeEngine<!-- -->s yourself.
-</note>
+when creating #GtkThemeEngines yourself.
-<note>
In order to make use of the custom registered properties in
the CSS file, make sure the engine is loaded first by specifying
the engine property, either in a previous rule or within the same
one.
-<programlisting>
+|[
* {
engine: someengine;
-SomeEngine-custom-property: 2;
}
-</programlisting>
-</note>
+]|
Since: 3.0
@@ -80896,9 +81384,9 @@ current region (see gtk_style_context_push_animatable_region()).
If @progress is not %NULL, the animation progress will be returned
there, 0.0 means the state is closest to being %FALSE, while 1.0 means
-it's closest to being %TRUE. This means transition animations will
+it’s closest to being %TRUE. This means transition animations will
run from 0 to 1 when @state is being set to %TRUE and from 1 to 0 when
-it's being set to %FALSE.
+it’s being set to %FALSE.
Since: 3.0
@@ -81047,7 +81535,7 @@ action
<function name="gtk_toggle_action_toggled">
<description>
-Emits the "toggled" signal on the toggle action.
+Emits the “toggled” signal on the toggle action.
Since: 2.4
@@ -81164,7 +81652,7 @@ mnemonic character
<function name="gtk_toggle_button_set_active">
<description>
Sets the status of the toggle button. Set to %TRUE if you want the
-GtkToggleButton to be 'pressed in', and %FALSE to raise it.
+GtkToggleButton to be “pressed in”, and %FALSE to raise it.
This action causes the #GtkToggleButton::toggled signal and the
#GtkButton::clicked signal to be emitted.
@@ -81187,11 +81675,11 @@ This action causes the #GtkToggleButton::toggled signal and the
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
+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.
+visual appearance, it doesn’t affect the semantics of the button.
</description>
@@ -81309,7 +81797,7 @@ Deprecated: 3.10: Use gtk_toggle_tool_button_new() instead.
<function name="gtk_toggle_tool_button_set_active">
<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.
+want the GtkToggleButton to be “pressed in”, and %FALSE to raise it.
This action causes the toggled signal to be emitted.
Since: 2.4
@@ -81371,7 +81859,7 @@ on @button, or %NULL.
<function name="gtk_tool_button_get_label">
<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
+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.4
@@ -81500,8 +81988,8 @@ Deprecated: 3.10: Use gtk_tool_button_new() instead.
<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"
+The “icon_name” property only has an effect if not
+overridden by non-%NULL “label”, “icon_widget” and “stock_id”
properties.
Since: 2.8
@@ -81523,8 +82011,8 @@ Since: 2.8
<function name="gtk_tool_button_set_icon_widget">
<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.
+%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
@@ -81544,10 +82032,10 @@ Since: 2.4
<function name="gtk_tool_button_set_label">
<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
+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
@@ -81569,10 +82057,10 @@ Since: 2.4
<function name="gtk_tool_button_set_label_widget">
<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.
+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.
Since: 2.4
@@ -81594,7 +82082,7 @@ Since: 2.4
<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.
+overridden by non-%NULL “label” and “icon_widget” properties.
Since: 2.4
@@ -81618,9 +82106,9 @@ Deprecated: 3.10: Use gtk_tool_button_set_icon_name() instead.
<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'.
+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.
@@ -81634,7 +82122,7 @@ Since: 2.4
</parameter_description>
</parameter>
<parameter name="use_underline">
-<parameter_description> whether the button label has the form "_Open"
+<parameter_description> whether the button label has the form “_Open”
</parameter_description>
</parameter>
</parameters>
@@ -81769,7 +82257,7 @@ 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
+ menu_item_ids must match ensures that a #GtkToolItem
will not inadvertently change a menu item that they did not create.
Since: 2.4
@@ -81786,7 +82274,7 @@ Since: 2.4
</parameter>
</parameters>
<return> The #GtkMenuItem passed to
-gtk_tool_item_set_proxy_menu_item(), if the @menu_item_id<!-- -->s
+gtk_tool_item_set_proxy_menu_item(), if the @menu_item_ids
match.
</return>
@@ -81884,16 +82372,12 @@ 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</listitem>
-</itemizedlist>
+- %GTK_TOOLBAR_BOTH, meaning the tool item should show
+both an icon and a label, stacked vertically
+- %GTK_TOOLBAR_ICONS, meaning the toolbar shows only icons
+- %GTK_TOOLBAR_TEXT, meaning the tool item should only show text
+- %GTK_TOOLBAR_BOTH_HORIZ, meaning the tool item should show
+both an icon and a label, arranged horizontally
Since: 2.4
@@ -82429,8 +82913,8 @@ Since: 2.4
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"
+only tool buttons with the “is_important” property set have labels, an
+effect known as “priority text”
Since: 2.4
@@ -82630,7 +83114,7 @@ should support
</parameter_description>
</parameter>
<parameter name="actions">
-<parameter_description> the #GdkDragAction<!-- -->s which the widget should suppport
+<parameter_description> the #GdkDragActions which the widget should suppport
</parameter_description>
</parameter>
</parameters>
@@ -83345,8 +83829,8 @@ Since: 2.4
<function name="gtk_toolbar_get_nth_item">
<description>
-Returns the @n<!-- -->'th item on @toolbar, or %NULL if the
-toolbar does not contain an @n<!-- -->'th item.
+Returns the @n'th item on @toolbar, or %NULL if the
+toolbar does not contain an @n'th item.
Since: 2.4
@@ -83361,8 +83845,8 @@ Since: 2.4
</parameter_description>
</parameter>
</parameters>
-<return> The @n<!-- -->'th #GtkToolItem on @toolbar,
-or %NULL if there isn't an @n<!-- -->'th item.
+<return> The @n'th #GtkToolItem on @toolbar,
+or %NULL if there isn’t an @n'th item.
</return>
</function>
@@ -83495,7 +83979,7 @@ Since: 2.4
<function name="gtk_toolbar_set_icon_size">
<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
+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.
@@ -83520,7 +84004,7 @@ size of icons.
<function name="gtk_toolbar_set_show_arrow">
<description>
Sets whether to show an overflow menu when
- toolbar doesn't have room for all items on it. If %TRUE,
+ toolbar doesn’t have room for all items on it. If %TRUE,
items that there are not room are available through an
overflow menu.
@@ -83718,8 +84202,7 @@ Deprecated: 3.10: Use gtk_tooltip_set_icon_from_icon_name() instead.
<function name="gtk_tooltip_set_markup">
<description>
Sets the text of the tooltip to be @markup, which is marked up
-with the <link
-linkend="PangoMarkupFormat">Pango text markup language</link>.
+with the [Pango text markup language][PangoMarkupFormat].
If @markup is %NULL, the label will be hidden.
Since: 2.12
@@ -83731,7 +84214,7 @@ Since: 2.12
</parameter_description>
</parameter>
<parameter name="markup">
-<parameter_description> a markup string (see <link linkend="PangoMarkupFormat">Pango markup
format</link>) or %NULL
+<parameter_description> a markup string (see [Pango markup format][PangoMarkupFormat]) or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -83840,7 +84323,7 @@ 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.
+parent of @dest_path doesn’t exist, though.
</description>
@@ -83917,7 +84400,7 @@ from the dragged row
<function name="gtk_tree_drag_source_row_draggable">
<description>
Asks the #GtkTreeDragSource whether a particular row can be used as
-the source of a DND operation. If the source doesn't implement
+the source of a DND operation. If the source doesn’t implement
this interface, the row is assumed draggable.
@@ -83941,8 +84424,8 @@ this interface, the row is assumed draggable.
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
+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
@@ -83975,7 +84458,7 @@ 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>).
+(`GtkTreeIter new_iter = iter;`).
You must free this iter with gtk_tree_iter_free().
@@ -84009,9 +84492,9 @@ This function is mainly used for language bindings.
<function name="gtk_tree_model_filter_clear_cache">
<description>
This function should almost never be called. It clears the @filter
-of any cached iterators that haven't been reffed with
+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
+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.
@@ -84060,7 +84543,7 @@ valid iterator pointing to a visible row in child model.
<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
+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.
@@ -84212,7 +84695,7 @@ Since: 2.4
</parameter_description>
</parameter>
<parameter name="types">
-<parameter_description> The #GType<!-- -->s of the columns.
+<parameter_description> The #GTypes of the columns.
</parameter_description>
</parameter>
<parameter name="func">
@@ -84269,13 +84752,13 @@ 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>
+|[<!-- language="C" -->
static gboolean
visible_func (GtkTreeModel *model,
GtkTreeIter *iter,
gpointer data)
{
-/ * Visible if row is non-empty and first column is "HI" * /
+// Visible if row is non-empty and first column is “HI”
gchar *str;
gboolean visible = FALSE;
@@ -84286,7 +84769,7 @@ g_free (str);
return visible;
}
-</programlisting></informalexample>
+]|
Since: 2.4
@@ -84344,8 +84827,8 @@ The variable argument list should contain integer column numbers,
each column number followed by a place to store the value being
retrieved. The list is terminated by a -1. For example, to get a
value from column 0 with type %G_TYPE_STRING, you would
-write: <literal>gtk_tree_model_get (model, iter, 0, &place_string_here, -1)</literal>,
-where <literal>place_string_here</literal> is a #gchararray
+write: `gtk_tree_model_get (model, iter, 0, &place_string_here, -1)`,
+where `place_string_here` is a #gchararray
to be filled with the string.
Returned values with type %G_TYPE_OBJECT have to be unreferenced,
@@ -84525,8 +85008,8 @@ This path should be freed with gtk_tree_path_free().
<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
+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.2
@@ -84609,7 +85092,7 @@ 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>
+`gtk_tree_model_get_iter_first (tree_model, iter);`
</description>
@@ -84704,7 +85187,7 @@ 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
+special case, if @parent is %NULL, then the @n-th root node
is set.
@@ -84727,7 +85210,7 @@ is set.
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE, if @parent has an @n<!-- -->th child
+<return> %TRUE, if @parent has an @n-th child
</return>
</function>
@@ -84735,7 +85218,7 @@ is set.
<description>
Sets @iter to be the parent of @child.
-If @child is at the toplevel, and doesn't have a parent, then
+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.
@@ -84939,7 +85422,7 @@ have been reordered, or %NULL if the depth of @path is 0
<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>
+i.e. @new_order`[newpos] = oldpos`
</parameter_description>
</parameter>
</parameters>
@@ -84976,7 +85459,7 @@ of @path is 0
<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>
+i.e. @new_order`[newpos] = oldpos`
</parameter_description>
</parameter>
<parameter name="length">
@@ -84990,9 +85473,9 @@ i.e. @new_order<literal>[newpos] = oldpos</literal>
<function name="gtk_tree_model_sort_clear_cache">
<description>
This function should almost never be called. It clears the @tree_model_sort
-of any cached iterators that haven't been reffed with
+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
+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.
@@ -85037,7 +85520,7 @@ valid iterator pointer to a visible row in the child model.
<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
+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.
@@ -85120,9 +85603,8 @@ Returns the model the #GtkTreeModelSort is sorting.
<function name="gtk_tree_model_sort_iter_is_valid">
<description>
-<warning><para>
-This function is slow. Only use it for debugging and/or testing purposes.
-</para></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 #GtkTreeModelSort.
@@ -85162,10 +85644,10 @@ Creates a new #GtkTreeModel, with @child_model as the child model.
<function name="gtk_tree_model_sort_reset_default_sort_func">
<description>
-This resets the default sort function to be in the 'unsorted' state. That
+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.
+is in “unsorted” state.
</description>
<parameters>
@@ -85433,7 +85915,7 @@ This refers to a row.
<description>
Creates a new #GtkTreePath-struct.
-The string representation of this path is "0".
+The string representation of this path is “0”.
</description>
@@ -85492,7 +85974,7 @@ Since: 3.12
Creates a new #GtkTreePath-struct 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
+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.
@@ -85565,8 +86047,8 @@ the move was made
<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
+This string is a “:” separated list of numbers.
+For example, “4:10:0:3” would be an acceptable
return value for this string.
@@ -85638,7 +86120,7 @@ model emitted the #GtkTreeModel::row-deleted signal.
<function name="gtk_tree_row_reference_free">
<description>
-Free's @reference. @reference may be %NULL
+Free’s @reference. @reference may be %NULL
</description>
<parameters>
@@ -85712,7 +86194,7 @@ Creates a row reference based on @path.
This reference will keep pointing to the node pointed to
by @path, so long as it exists. Any changes that occur on @model are
propagated, and the path is updated appropriately. If
- path isn't a valid path in @model, then %NULL is returned.
+ path isn’t a valid path in @model, then %NULL is returned.
</description>
@@ -85737,7 +86219,7 @@ 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
+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
@@ -85751,7 +86233,7 @@ 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.
+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
@@ -85907,11 +86389,11 @@ use @selection is #GTK_SELECTION_MULTIPLE.
<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.
+want to convert the returned list into a list of #GtkTreeRowReferences.
To do this, you can use gtk_tree_row_reference_new().
To free the return value, use:
-|[
+|[<!-- language="C" -->
g_list_free_full (list, (GDestroyNotify) gtk_tree_path_free);
]|
@@ -86144,7 +86626,7 @@ if the state of the node should be left unchanged.
</parameter_description>
</parameter>
<parameter name="data">
-<parameter_description> The selection function's data. May be %NULL
+<parameter_description> The selection function’s data. May be %NULL
</parameter_description>
</parameter>
<parameter name="destroy">
@@ -86309,7 +86791,7 @@ If the current sort column id of @sortable is
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
+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.
@@ -86341,16 +86823,11 @@ 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>
+
+- %GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID: the default sort function
+will be used, if it is set
+
+- %GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID: no sorting will occur
</description>
<parameters>
@@ -86492,7 +86969,7 @@ gtk_tree_store_set_value().
<function name="gtk_tree_store_insert_after">
<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
+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.
@@ -86527,7 +87004,7 @@ gtk_tree_store_set() or gtk_tree_store_set_value().
<function name="gtk_tree_store_insert_before">
<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
+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.
@@ -86567,9 +87044,9 @@ 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>
+`gtk_tree_store_insert_with_values (tree_store, iter, position, ...)`
has the same effect as calling
-|[
+|[<!-- language="C" -->
gtk_tree_store_insert (tree_store, iter, position);
gtk_tree_store_set (tree_store, iter, ...);
]|
@@ -86781,8 +87258,8 @@ 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
+As an example, `gtk_tree_store_new (3, G_TYPE_INT, G_TYPE_STRING,
+GDK_TYPE_PIXBUF);` will create a new #GtkTreeStore with three columns, of type
#gint, #gchararray, and #GdkPixbuf respectively.
@@ -86890,7 +87367,7 @@ Since: 2.2
<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>.
+i.e. @new_order`[newpos] = oldpos`.
</parameter_description>
</parameter>
</parameters>
@@ -86903,8 +87380,8 @@ 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>.
+%G_TYPE_STRING to “Foo”, you would write
+`gtk_tree_store_set (store, iter, 0, "Foo", -1)`.
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.
@@ -87093,8 +87570,8 @@ Since: 2.2
<function name="gtk_tree_view_append_column">
<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
+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.
@@ -87153,7 +87630,7 @@ 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
+“text” attribute of a #GtkCellRendererText get its values from
column 2.
</description>
@@ -87312,7 +87789,7 @@ renderer. This is used primarily by the #GtkTreeView.
</parameter_description>
</parameter>
<parameter name="iter">
-<parameter_description> The #GtkTreeIter to to get the cell renderer's attributes from.
+<parameter_description> The #GtkTreeIter to to get the cell renderer’s attributes from.
</parameter_description>
</parameter>
<parameter name="is_expander">
@@ -87362,7 +87839,7 @@ gtk_tree_view_column_set_attributes().
<function name="gtk_tree_view_column_clicked">
<description>
-Emits the "clicked" signal on the column. This function will only work if
+Emits the “clicked” signal on the column. This function will only work if
@tree_column is clickable.
</description>
@@ -87579,7 +88056,7 @@ See gtk_tree_view_column_set_sort_column_id().
</parameter>
</parameters>
<return> the current @sort_column_id for this column, or -1 if
-this column can't be used for sorting.
+this column can’t be used for sorting.
</return>
</function>
@@ -87775,8 +88252,8 @@ 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:
-|[
+Here’s a simple example:
+|[<!-- language="C" -->
enum { TEXT_COLUMN, COLOR_COLUMN, N_COLUMNS };
...
{
@@ -87910,7 +88387,7 @@ are removed, and replaced with the new attributes.
</parameter_description>
</parameter>
<parameter name="cell_renderer">
-<parameter_description> the #GtkCellRenderer we're setting the attributes of
+<parameter_description> the #GtkCellRenderer we’re setting the attributes of
</parameter_description>
</parameter>
<parameter name="Varargs">
@@ -87981,7 +88458,7 @@ 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.
-Along with "fixed-width", the "expand" property changes when the column is
+Along with “fixed-width”, the “expand” property changes when the column is
resized by the user.
Since: 2.4
@@ -88005,13 +88482,13 @@ Since: 2.4
If @fixed_width is not -1, sets the fixed width of @tree_column; otherwise
unsets it. The effective value of @fixed_width is clamped between the
minumum and maximum width of the column; however, the value stored in the
-"fixed-width" property is not clamped. If the column sizing is
+“fixed-width” property is not clamped. If the column sizing is
#GTK_TREE_VIEW_COLUMN_GROW_ONLY or #GTK_TREE_VIEW_COLUMN_AUTOSIZE, setting a
fixed width overrides the automatically calculated width. Note that
@fixed_width is only a hint to GTK+; the width actually allocated to the
column may be greater or less than requested.
-Along with "expand", the "fixed-width" property changes when the column is
+Along with “expand”, the “fixed-width” property changes when the column is
resized by the user.
</description>
@@ -88032,7 +88509,7 @@ resized by the user.
<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
+width if it’s the last column in a view. In this case, the column expands to
fill any extra space.
</description>
@@ -88680,7 +89157,7 @@ itself, excluding surrounding borders and the tree expander area.
<function name="gtk_tree_view_get_bin_window">
<description>
Returns the window that @tree_view renders to.
-This is used primarily to compare to <literal>event->window</literal>
+This is used primarily to compare to `event->window`
to confirm that the event on @tree_view is on the right window.
@@ -88692,7 +89169,7 @@ to confirm that the event on @tree_view is on the right window.
</parameter>
</parameters>
<return> A #GdkWindow, or %NULL when @tree_view
-hasn't been realized yet
+hasn’t been realized yet
</return>
</function>
@@ -88771,7 +89248,7 @@ The returned list must be freed with g_list_free ().
<function name="gtk_tree_view_get_cursor">
<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
+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
@@ -89092,8 +89569,8 @@ Since: 3.4
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
+come from an event on the @tree_view only where `event->window ==
+gtk_tree_view_get_bin_window ()`. 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
@@ -89321,8 +89798,8 @@ otherwise.
<function name="gtk_tree_view_get_tooltip_column">
<description>
-Returns the column of @tree_view's model which is being used for
-displaying tooltips on @tree_view's rows.
+Returns the column of @tree_view’s model which is being used for
+displaying tooltips on @tree_view’s rows.
Since: 2.12
@@ -89351,7 +89828,7 @@ 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.
+to be relative to @tree_view’s bin_window if @keyboard_tooltip is %FALSE.
Since: 2.12
@@ -89467,7 +89944,7 @@ scrollable area of the tree.
<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
+“fixed_height” mode enabled, then @column must have its “sizing” property
set to be GTK_TREE_VIEW_COLUMN_FIXED.
@@ -89495,7 +89972,7 @@ set to be GTK_TREE_VIEW_COLUMN_FIXED.
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
+has “fixed_height” mode enabled, then the new column will have its sizing
property set to be GTK_TREE_VIEW_COLUMN_FIXED.
@@ -89532,8 +90009,8 @@ Convenience function that inserts a new column into the #GtkTreeView
with the given cell renderer and a #GtkTreeCellDataFunc 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.
+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.
</description>
@@ -89581,7 +90058,7 @@ selection, having a custom context menu or starting rubber banding.
The @x and @y coordinate that are provided must be relative to bin_window
coordinates. That is, @x and @y must come from an event on @tree_view
-where <literal>event->window == gtk_tree_view_get_bin_window (<!-- -->)</literal>.
+where `event->window == gtk_tree_view_get_bin_window ()`.
For converting widget coordinates (eg. the ones you get from
GtkWidget::query-tooltip), please see
@@ -89842,7 +90319,7 @@ 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.
+If either @tree_x or @tree_y are -1, then that direction isn’t scrolled.
</description>
<parameters>
@@ -89920,7 +90397,7 @@ dropped everywhere.
<function name="gtk_tree_view_set_cursor">
<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
+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.
@@ -89956,7 +90433,7 @@ and the function will return without failing.
<function name="gtk_tree_view_set_cursor_on_cell">
<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
+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. If @focus_column and @focus_cell are not %NULL, and @focus_column
contains 2 or more editable or activatable cells, then focus is given to
@@ -90057,7 +90534,7 @@ 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.
+using the “start-interactive-search” key binding.
</description>
<parameters>
@@ -90314,10 +90791,11 @@ 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 tree view as a drag source and destination. Therefore, drag and
-drop can not be used in a reorderable view for any other purpose.
+these changes by connecting to the model’s #GtkTreeModel::row-inserted
+and #GtkTreeModel::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
@@ -90395,7 +90873,7 @@ 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 not use it
-just because you prefer the appearance of the ruled tree; that's a
+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
@@ -90424,7 +90902,7 @@ generally).
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"
+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.
@@ -90598,7 +91076,7 @@ Since: 2.12
<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
+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
@@ -90616,7 +91094,7 @@ Since: 2.12
</parameter_description>
</parameter>
<parameter name="column">
-<parameter_description> an integer, which is a valid column number for @tree_view's model
+<parameter_description> an integer, which is a valid column number for @tree_view’s model
</parameter_description>
</parameter>
</parameters>
@@ -90709,27 +91187,32 @@ This can be useful for example if you want to inhibit the deletion
of a window. Of course you should not do this as the user expects
a reaction from clicking the close icon of the window...
-<example>
-<title>A persistent window</title>
-<programlisting>
-#include <gtk/gtk.h><
+## A persistent window
+
+|[<!-- language="C" -->
+#include <gtk/gtk.h>
int
main (int argc, char **argv)
{
GtkWidget *win, *but;
+const char *text = "Close yourself. I mean it!";
gtk_init (&argc, &argv);
win = gtk_window_new (GTK_WINDOW_TOPLEVEL);
-g_signal_connect (win, "delete-event",
-G_CALLBACK (gtk_true), NULL);
+g_signal_connect (win,
+"delete-event",
+G_CALLBACK (gtk_true),
+NULL);
g_signal_connect (win, "destroy",
-G_CALLBACK (gtk_main_quit), NULL);
+G_CALLBACK (gtk_main_quit),
+NULL);
-but = gtk_button_new_with_label ("Close yourself. I mean it!");
+but = gtk_button_new_with_label (text);
g_signal_connect_swapped (but, "clicked",
-G_CALLBACK (gtk_object_destroy), win);
+G_CALLBACK (gtk_object_destroy),
+win);
gtk_container_add (GTK_CONTAINER (win), but);
gtk_widget_show_all (win);
@@ -90738,8 +91221,7 @@ gtk_main ();
return 0;
}
-</programlisting>
-</example>
+]|
</description>
@@ -90802,7 +91284,7 @@ is added after its siblings.
<function name="gtk_ui_manager_add_ui_from_file">
<description>
-Parses a file containing a <link linkend="XML-UI">UI definition</link> and
+Parses a file containing a [UI definition][XML-UI] and
merges it with the current contents of @manager.
Since: 2.4
@@ -90833,7 +91315,7 @@ the return value is 0.
<function name="gtk_ui_manager_add_ui_from_resource">
<description>
-Parses a resource file containing a <link linkend="XML-UI">UI definition</link> and
+Parses a resource file containing a [UI definition][XML-UI] and
merges it with the current contents of @manager.
Since: 3.4
@@ -90864,9 +91346,9 @@ the return value is 0.
<function name="gtk_ui_manager_add_ui_from_string">
<description>
-Parses a string containing a <link linkend="XML-UI">UI definition</link> and
-merges it with the current contents of @manager. An enclosing <ui>
-element is added if it is missing.
+Parses a string containing a [UI definition][XML-UI] and merges it with
+the current contents of @manager. An enclosing <ui> element is added if
+it is missing.
Since: 2.4
@@ -90906,7 +91388,7 @@ 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:
-|[
+|[<!-- language="C" -->
gtk_container_add (GTK_CONTAINER (window), vbox);
g_signal_connect (merge, "add-widget",
G_CALLBACK (add_widget), vbox);
@@ -91049,7 +91531,7 @@ all toplevel widgets of the requested types. Free the returned list with g_slis
<function name="gtk_ui_manager_get_ui">
<description>
-Creates a <link linkend="XML-UI">UI definition</link> of the merged UI.
+Creates a [UI definition][XML-UI] of the merged UI.
Since: 2.4
@@ -91072,12 +91554,13 @@ the merged UI.
<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
+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 itmanager.
+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 it
+manages.
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
@@ -91099,8 +91582,8 @@ Deprecated: 3.10
</parameter_description>
</parameter>
</parameters>
-<return> the widget found by following the path, or %NULL if no widget
-was found.
+<return> the widget found by following the path,
+or %NULL if no widget was found
</return>
</function>
@@ -91221,7 +91704,7 @@ Deprecated: 3.10
<function name="gtk_ui_manager_set_add_tearoffs">
<description>
-Sets the "add_tearoffs" property, which controls whether menus
+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
@@ -91253,7 +91736,7 @@ Creates a new #GtkVBox.
Deprecated: 3.2: You can use gtk_box_new() with %GTK_ORIENTATION_VERTICAL instead,
which is a quick and easy change. But the recommendation is to switch to
#GtkGrid, since #GtkBox is going to go away eventually.
-See <xref linkend="gtk-migrating-GtkGrid"/>.
+See [Migrating from other containers to GtkGrid][gtk-migrating-GtkGrid].
</description>
<parameters>
@@ -91505,7 +91988,7 @@ Deprecated: 3.2: Use gtk_scale_new() with %GTK_ORIENTATION_VERTICAL instead
<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
+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
@@ -91568,7 +92051,7 @@ Deprecated: 3.2: Use gtk_separator_new() with %GTK_ORIENTATION_VERTICAL instead
<function name="gtk_widget_activate">
<description>
-For widgets that can be "activated" (buttons, menu items, etc.)
+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.
@@ -91577,7 +92060,7 @@ activatable, the function returns %FALSE.
</description>
<parameters>
<parameter name="widget">
-<parameter_description> a #GtkWidget that's activatable
+<parameter_description> a #GtkWidget that’s activatable
</parameter_description>
</parameter>
</parameters>
@@ -91589,7 +92072,7 @@ activatable, the function returns %FALSE.
<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
+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_SIGNAL_ACTION.
Accelerators added through this function are not user changeable during
runtime. If you want to support accelerators that can be changed by the
@@ -91704,7 +92187,7 @@ or as quickly as the application can be repainted, whichever is
slower). For this reason, is most suitable for handling graphics
that change every frame or every few frames. The tick callback does
not automatically imply a relayout or repaint. If you want a
-repaint or relayout, and aren't changing widget properties that
+repaint or relayout, and aren’t changing widget properties that
would trigger that (for example, changing the text of a #GtkLabel),
then you will have to call gtk_widget_queue_resize() or
gtk_widget_queue_draw_area() yourself.
@@ -91750,7 +92233,7 @@ by passing it to gtk_widget_remove_tick_callback()
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
+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.
@@ -91776,7 +92259,7 @@ Since: 2.4
<function name="gtk_widget_child_focus">
<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
+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.
@@ -91793,7 +92276,7 @@ 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.
+if returning %FALSE, they don’t modify the current focus location.
</description>
@@ -91814,7 +92297,7 @@ if returning %FALSE, they don't modify the current focus location.
<function name="gtk_widget_child_notify">
<description>
Emits a #GtkWidget::child-notify signal for the
-<link linkend="child-properties">child property</link> @child_property
+[child property][child-properties] @child_property
on @widget.
This is the analogue of g_object_notify() for child properties.
@@ -91829,7 +92312,7 @@ Also see gtk_container_child_notify().
</parameter>
<parameter name="child_property">
<parameter_description> the name of a child property installed on the
-class of @widget<!-- -->'s parent
+class of @widget’s parent
</parameter_description>
</parameter>
</parameters>
@@ -91864,8 +92347,8 @@ Since: 3.10
Declares a @callback_symbol to handle @callback_name from the template XML
defined for @widget_type. See gtk_builder_add_callback_symbol().
-<note><para>This must be called from a composite widget classes class
-initializer after calling gtk_widget_class_set_template()</para></note>
+Note that this must be called from a composite widget classes class
+initializer after calling gtk_widget_class_set_template().
Since: 3.10
@@ -91920,13 +92403,13 @@ Since: 3.10
<function name="gtk_widget_class_bind_template_child_full">
<description>
Automatically assign an object declared in the class template XML to be set to a location
-on a freshly built instance's private data, or alternatively accessible via gtk_widget_get_template_child().
+on a freshly built instance’s private data, or alternatively accessible via gtk_widget_get_template_child().
The struct can point either into the public instance, then you should use G_STRUCT_OFFSET(WidgetType, member)
for @struct_offset, or in the private struct, then you should use G_PRIVATE_OFFSET(WidgetType, member).
An explicit strong reference will be held automatically for the duration of your
-instance's life cycle, it will be released automatically when #GObjectClass.dispose() runs
+instance’s life cycle, it will be released automatically when #GObjectClass.dispose() runs
on your instance and if a @struct_offset that is != 0 is specified, then the automatic location
in your instance public or private data will be set to %NULL. You can however access an automated child
pointer the first time your classes #GObjectClass.dispose() runs, or alternatively in
@@ -91939,8 +92422,8 @@ The wrapper macros gtk_widget_class_bind_template_child(), gtk_widget_class_bind
gtk_widget_class_bind_template_child_private() and gtk_widget_class_bind_template_child_internal_private()
might be more convenient to use.
-<note><para>This must be called from a composite widget classes class
-initializer after calling gtk_widget_class_set_template()</para></note>
+Note that this must be called from a composite widget classes class
+initializer after calling gtk_widget_class_set_template().
Since: 3.10
@@ -91951,16 +92434,16 @@ Since: 3.10
</parameter_description>
</parameter>
<parameter name="name">
-<parameter_description> The "id" of the child defined in the template XML
+<parameter_description> The “id” of the child defined in the template XML
</parameter_description>
</parameter>
<parameter name="internal_child">
-<parameter_description> Whether the child should be accessible as an "internal-child"
+<parameter_description> Whether the child should be accessible as an “internal-child”
when this class is used in GtkBuilder XML
</parameter_description>
</parameter>
<parameter name="struct_offset">
-<parameter_description> The structure offset into the composite widget's instance public or private structure
+<parameter_description> The structure offset into the composite widget’s instance public or private structure
where the automated child pointer should be set, or 0 to not assign the pointer.
</parameter_description>
</parameter>
@@ -92153,7 +92636,7 @@ freed with g_free().
<function name="gtk_widget_class_path">
<description>
-Same as gtk_widget_path(), but always uses the name of a widget's type,
+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:3.0: Use gtk_widget_get_path() instead
@@ -92196,7 +92679,7 @@ accessible type and use gtk_widget_class_set_accessible_type()
instead.
If @role is #ATK_ROLE_INVALID, the default role will not be changed
-and the accessible's default role will be used instead.
+and the accessible’s default role will be used instead.
This function should only be called from class init functions of widgets.
@@ -92243,10 +92726,10 @@ Since: 3.2
<function name="gtk_widget_class_set_connect_func">
<description>
For use in lanuage bindings, this will override the default #GtkBuilderConnectFunc to be
-used when parsing GtkBuilder xml from this class's template data.
+used when parsing GtkBuilder xml from this class’s template data.
-<note><para>This must be called from a composite widget classes class
-initializer after calling gtk_widget_class_set_template()</para></note>
+Note that this must be called from a composite widget classes class
+initializer after calling gtk_widget_class_set_template().
Since: 3.10
@@ -92280,8 +92763,8 @@ the GtkBuilder XML to be used to extend a widget.
For convenience, gtk_widget_class_set_template_from_resource() is also provided.
-<note><para>Any class that installs templates must call gtk_widget_init_template()
-in the widget's instance initializer</para></note>
+Note that any class that installs templates must call gtk_widget_init_template()
+in the widget’s instance initializer.
Since: 3.10
@@ -92303,8 +92786,8 @@ Since: 3.10
<description>
A convenience function to call gtk_widget_class_set_template().
-<note><para>Any class that installs templates must call gtk_widget_init_template()
-in the widget's instance initializer</para></note>
+Note that any class that installs templates must call gtk_widget_init_template()
+in the widget’s instance initializer.
Since: 3.10
@@ -92431,7 +92914,7 @@ 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
+widget being finalized, unless you’ve added additional references
to the widget with g_object_ref().
In most cases, only toplevel widgets (windows) require explicit
@@ -92451,8 +92934,8 @@ be destroyed as well.
<function name="gtk_widget_destroyed">
<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()
+%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
@@ -92509,15 +92992,15 @@ original state. Otherwise the resulting drawing is undefined. For
example changing the operator using cairo_set_operator() or the
line width using cairo_set_line_width() might have unwanted side
effects.
-You may however change the context's transform matrix - like with
+You may however change the context’s transform matrix - like with
cairo_scale(), cairo_translate() or cairo_set_matrix() and clip
region with cairo_clip() prior to calling this function. Also, it
is fine to modify the context with cairo_save() and
cairo_push_group() prior to calling this function.
-<note><para>Special purpose widgets may contain special code for
+Note that special-purpose widgets may contain special code for
rendering to the screen and might appear differently on screen
-and when rendered using gtk_widget_draw().</para></note>
+and when rendered using gtk_widget_draw().
Since: 3.0
@@ -92583,9 +93066,9 @@ Since: 2.12
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;
+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,
+it were in the event queue. Don’t synthesize expose events; instead,
use gdk_window_invalidate_rect() to invalidate a region of the
window.
@@ -92636,7 +93119,7 @@ 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/atk/stable/">ATK</ulink>
+[ATK](http://developer.gnome.org/atk/stable/)
library contains more information about accessible objects and their uses.
@@ -92710,10 +93193,10 @@ for the #GtkWidget::draw function.
<function name="gtk_widget_get_allocation">
<description>
-Retrieves the widget's allocation.
+Retrieves the widget’s allocation.
-Note, when implementing a #GtkContainer: a widget's allocation will
-be its "adjusted" allocation, that is, the widget's parent
+Note, when implementing a #GtkContainer: a widget’s allocation will
+be its “adjusted” allocation, that is, the widget’s parent
container typically calls gtk_widget_size_allocate() with an
allocation, and that allocation is then adjusted (to handle margin
and alignment for example) before assignment to the widget.
@@ -92724,7 +93207,7 @@ gtk_widget_size_allocate() allocation, however. So a #GtkContainer
is guaranteed that its children stay inside the assigned bounds,
but not that they have exactly the bounds the container assigned.
There is no way to get the original allocation assigned by
-gtk_widget_size_allocate(), since it isn't stored; if a container
+gtk_widget_size_allocate(), since it isn’t stored; if a container
implementation needs that information it will have to track it itself.
Since: 2.18
@@ -92746,8 +93229,8 @@ Since: 2.18
<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
+`gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)` 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().
@@ -92844,7 +93327,7 @@ while gtk_widget_size_request() actually calls the "size_request" meth
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
+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
@@ -92925,7 +93408,7 @@ been created, it is persistent for all time.
<description>
Obtains the composite name of a widget.
-Deprecated: 3.10: Use gtk_widget_class_set_template(), or don't use this API at all.
+Deprecated: 3.10: Use gtk_widget_class_set_template(), or don’t use this API at all.
</description>
<parameters>
@@ -93099,7 +93582,7 @@ will receive.
<function name="gtk_widget_get_frame_clock">
<description>
Obtains the frame clock for a widget. The frame clock is a global
-"ticker" that can be used to drive animations and repaints. The
+“ticker” that can be used to drive animations and repaints. The
most common reason to get the frame clock is to call
gdk_frame_clock_get_frame_time(), in order to get a time to use for
animating. For example you might record the start of the animation
@@ -93108,15 +93591,15 @@ then update the animation by calling
gdk_frame_clock_get_frame_time() again during each repaint.
gdk_frame_clock_request_phase() will result in a new frame on the
-clock, but won't necessarily repaint any widgets. To repaint a
+clock, but won’t necessarily repaint any widgets. To repaint a
widget, you have to use gtk_widget_queue_draw() which invalidates
the widget (thus scheduling it to receive a draw on the next
frame). gtk_widget_queue_draw() will also end up requesting a frame
on the appropriate frame clock.
-A widget's frame clock will not change while the widget is
+A widget’s frame clock will not change while the widget is
mapped. Reparenting a widget (which implies a temporary unmap) can
-change the widget's frame clock.
+change the widget’s frame clock.
Unrealized widgets do not have a frame clock.
@@ -93206,7 +93689,7 @@ this function, to see whether a widget, or any of its children,
has the expand flag set. If any child of a widget wants to
expand, the parent may ask to expand also.
-This function only looks at the widget's own hexpand flag, rather
+This function only looks at the widget’s own hexpand flag, rather
than computing whether the entire widget tree rooted at this widget
wants to expand.
@@ -93232,7 +93715,7 @@ expand value based on child widgets. If hexpand is not
set, then the expand value depends on whether any
children of the widget would like to expand.
-There are few reasons to use this function, but it's here
+There are few reasons to use this function, but it’s here
for completeness and consistency.
@@ -93379,7 +93862,7 @@ Since: 3.0
<function name="gtk_widget_get_modifier_mask">
<description>
-Returns the modifier mask the @widget's windowing system backend
+Returns the modifier mask the @widget’s windowing system backend
uses for a particular purpose.
See gdk_keymap_get_modifier_mask().
@@ -93467,7 +93950,7 @@ Since: 2.4
</parameter_description>
</parameter>
</parameters>
-<return> the current value of the "no-show-all" property.
+<return> the current value of the “no-show-all” property.
</return>
</function>
@@ -93498,7 +93981,7 @@ 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. This can be tracked
+match any changes to the widget’s attributes. This can be tracked
by using the #GtkWidget::screen-changed signal on the widget.
@@ -93531,7 +94014,7 @@ Returns the parent container of @widget.
<function name="gtk_widget_get_parent_window">
<description>
-Gets @widget's parent window.
+Gets @widget’s parent window.
</description>
@@ -93593,13 +94076,13 @@ Deprecated: 3.4: Use gdk_window_get_device_position() instead.
<function name="gtk_widget_get_preferred_height">
<description>
-Retrieves a widget's initial minimum and natural height.
+Retrieves a widget’s initial minimum and natural height.
-<note><para>This call is specific to width-for-height requests.</para></note>
+This call is specific to width-for-height requests.
The returned request will be modified by the
GtkWidgetClass::adjust_size_request virtual method and by any
-#GtkSizeGroup<!-- -->s that have been applied. That is, the returned request
+#GtkSizeGroups that have been applied. That is, the returned request
is the one that should be used for layout, not necessarily the one
returned by the widget itself.
@@ -93625,13 +94108,13 @@ Since: 3.0
<function name="gtk_widget_get_preferred_height_and_baseline_for_width">
<description>
-Retrieves a widget's minimum and natural height and the corresponding baselines if it would be given
+Retrieves a widget’s minimum and natural height and the corresponding baselines if it would be given
the specified @width, or the default height if @width is -1. The baselines may be -1 which means
that no baseline is requested for this widget.
The returned request will be modified by the
GtkWidgetClass::adjust_size_request and GtkWidgetClass::adjust_baseline_request virtual methods
-and by any #GtkSizeGroup<!-- -->s that have been applied. That is, the returned request
+and by any #GtkSizeGroups that have been applied. That is, the returned request
is the one that should be used for layout, not necessarily the one
returned by the widget itself.
@@ -93669,12 +94152,12 @@ Since: 3.10
<function name="gtk_widget_get_preferred_height_for_width">
<description>
-Retrieves a widget's minimum and natural height if it would be given
+Retrieves a widget’s minimum and natural height if it would be given
the specified @width.
The returned request will be modified by the
GtkWidgetClass::adjust_size_request virtual method and by any
-#GtkSizeGroup<!-- -->s that have been applied. That is, the returned request
+#GtkSizeGroups that have been applied. That is, the returned request
is the one that should be used for layout, not necessarily the one
returned by the widget itself.
@@ -93705,17 +94188,17 @@ Since: 3.0
<function name="gtk_widget_get_preferred_size">
<description>
Retrieves the minimum and natural size of a widget, taking
-into account the widget's preference for height-for-width management.
+into account the widget’s preference for height-for-width management.
This is used to retrieve a suitable size by container widgets which do
not impose any restrictions on the child placement. It can be used
to deduce toplevel window and menu sizes as well as child widgets in
free-form containers such as GtkLayout.
-<note><para>Handle with care. Note that the natural height of a height-for-width
+Handle with care. Note that the natural height of a height-for-width
widget will generally be a smaller size than the minimum height, since the required
height for the natural width is generally smaller than the required height for
-the minimum width.</para></note>
+the minimum width.
Use gtk_widget_get_preferred_height_and_baseline_for_width() if you want to support
baseline alignment.
@@ -93742,14 +94225,13 @@ Since: 3.0
<function name="gtk_widget_get_preferred_width">
<description>
-Retrieves a widget's initial minimum and natural width.
+Retrieves a widget’s initial minimum and natural width.
-<note><para>This call is specific to height-for-width
-requests.</para></note>
+This call is specific to height-for-width requests.
The returned request will be modified by the
GtkWidgetClass::adjust_size_request virtual method and by any
-#GtkSizeGroup<!-- -->s that have been applied. That is, the returned request
+#GtkSizeGroups that have been applied. That is, the returned request
is the one that should be used for layout, not necessarily the one
returned by the widget itself.
@@ -93775,12 +94257,12 @@ Since: 3.0
<function name="gtk_widget_get_preferred_width_for_height">
<description>
-Retrieves a widget's minimum and natural width if it would be given
+Retrieves a widget’s minimum and natural width if it would be given
the specified @height.
The returned request will be modified by the
GtkWidgetClass::adjust_size_request virtual method and by any
-#GtkSizeGroup<!-- -->s that have been applied. That is, the returned request
+#GtkSizeGroups that have been applied. That is, the returned request
is the one that should be used for layout, not necessarily the one
returned by the widget itself.
@@ -93854,10 +94336,10 @@ Since: 2.18
Gets whether the widget prefers a height-for-width layout
or a width-for-height layout.
-<note><para>#GtkBin widgets generally propagate the preference of
+#GtkBin widgets generally propagate the preference of
their child, container widgets need to request something either in
context of their children or in context of their allocation
-capabilities.</para></note>
+capabilities.
Since: 3.0
@@ -93875,10 +94357,10 @@ Since: 3.0
<function name="gtk_widget_get_requisition">
<description>
-Retrieves the widget's requisition.
+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
+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()).
@@ -93931,6 +94413,28 @@ Deprecated: 3.12: Use gdk_screen_get_root_window() instead
</return>
</function>
+<function name="gtk_widget_get_scale_factor">
+<description>
+Retrieves the internal scale factor that maps from window coordinates
+to the actual device pixels. On traditional systems this is 1, on
+high density outputs, it can be a higher value (typically 2).
+
+See gdk_window_get_scale_factor().
+
+Since: 3.10
+
+</description>
+<parameters>
+<parameter name="widget">
+<parameter_description> a #GtkWidget
+</parameter_description>
+</parameter>
+</parameters>
+<return> the scale factor for @widget
+
+</return>
+</function>
+
<function name="gtk_widget_get_screen">
<description>
Get the #GdkScreen from the toplevel window associated with
@@ -93958,11 +94462,11 @@ Since: 2.2
<function name="gtk_widget_get_sensitive">
<description>
-Returns the widget's sensitivity (in the sense of returning
+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().
+own and its parent widget’s sensitivity. See gtk_widget_is_sensitive().
Since: 2.18
@@ -94028,7 +94532,7 @@ this function.
<function name="gtk_widget_get_state">
<description>
-Returns the widget's state. See gtk_widget_set_state().
+Returns the widget’s state. See gtk_widget_set_state().
Since: 2.18
@@ -94080,7 +94584,7 @@ Deprecated:3.0: Use #GtkStyleContext instead
</parameter_description>
</parameter>
</parameters>
-<return> the widget's #GtkStyle
+<return> the widget’s #GtkStyle
</return>
</function>
@@ -94143,7 +94647,7 @@ of the GObject structure offsets.
</parameter_description>
</parameter>
<parameter name="name">
-<parameter_description> The "id" of the child defined in the template XML
+<parameter_description> The “id” of the child defined in the template XML
</parameter_description>
</parameter>
</parameters>
@@ -94217,10 +94721,10 @@ 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>
+`gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW)`
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
+%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.
@@ -94228,11 +94732,11 @@ inside a #GtkSocket within the same application.
To reliably find the toplevel #GtkWindow, use
gtk_widget_get_toplevel() and call gtk_widget_is_toplevel()
on the result.
-|[
+|[<!-- language="C" -->
GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
if (gtk_widget_is_toplevel (toplevel))
{
-/ * Perform action on toplevel. * /
+// Perform action on toplevel.
}
]|
@@ -94245,7 +94749,7 @@ if (gtk_widget_is_toplevel (toplevel))
</parameter>
</parameters>
<return> the topmost ancestor of @widget, or @widget itself
-if there's no ancestor.
+if there’s no ancestor.
</return>
</function>
@@ -94330,7 +94834,7 @@ See gtk_widget_get_hexpand_set() for more detail.
<function name="gtk_widget_get_visible">
<description>
Determines whether the widget is visible. If you want to
-take into account whether the widget's parent is also marked as
+take into account whether the widget’s parent is also marked as
visible, use gtk_widget_is_visible() instead.
This function does not check if the widget is obscured in any way.
@@ -94369,7 +94873,7 @@ Gets the visual that will be used to render @widget.
<function name="gtk_widget_get_window">
<description>
-Returns the widget's window if it is realized, %NULL otherwise
+Returns the widget’s window if it is realized, %NULL otherwise
Since: 2.14
@@ -94380,7 +94884,7 @@ Since: 2.14
</parameter_description>
</parameter>
</parameters>
-<return> @widget's window.
+<return> @widget’s window.
</return>
</function>
@@ -94393,7 +94897,7 @@ by calling gtk_widget_set_can_default() with a %TRUE value.
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. Note
-that #GtkEntry widgets require the "activates-default" property
+that #GtkEntry widgets require the “activates-default” property
set to %TRUE before they activate the default widget when Enter
is pressed and the #GtkEntry is focused.
@@ -94411,7 +94915,7 @@ is pressed and the #GtkEntry is focused.
<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.
+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.
@@ -94555,7 +95059,7 @@ Since: 3.2
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the widget should display a 'focus rectangle'
+<return> %TRUE if the widget should display a “focus rectangle”
</return>
</function>
@@ -94630,7 +95134,7 @@ class composite widgets have been created in their instance
initializers.
Another reason is that when calling g_object_new() on a widget with
-composite templates, it's important to build the composite widgets
+composite templates, it’s important to build the composite widgets
before the construct properties are set. Properties passed to g_object_new()
should take precedence over properties set in the private template XML.
@@ -94648,7 +95152,7 @@ Since: 3.10
<function name="gtk_widget_input_shape_combine_region">
<description>
-Sets an input shape for this widget's GDK window. This allows for
+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_region() for more information.
@@ -94672,8 +95176,8 @@ Since: 3.0
<description>
Inserts @group into @widget. Children of @widget that implement
#GtkActionable can then be associated with actions in @group by
-setting their 'action-name' to
- prefix <replaceable>action-name</replaceable>.
+setting their “action-name” to
+ prefix `action-name`
If @group is %NULL, a previously inserted group for @name is removed
from @widget.
@@ -94700,9 +95204,9 @@ Since: 3.6
<function name="gtk_widget_intersect">
<description>
-Computes the intersection of a @widget's area and @area, storing
+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
+an intersection. @intersection may be %NULL if you’re only
interested in whether there was an intersection.
@@ -94751,7 +95255,7 @@ grandchild, great grandchild, etc.
<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.
+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
@@ -94812,7 +95316,7 @@ toplevel widget additionally has the global input focus.)
<function name="gtk_widget_is_sensitive">
<description>
-Returns the widget's effective sensitivity, which means
+Returns the widget’s effective sensitivity, which means
it is sensitive itself and also its parent widget is sensitive
Since: 2.18
@@ -94888,7 +95392,7 @@ 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.
+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
@@ -94955,8 +95459,8 @@ gtk_label_set_mnemonic_widget()).
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
-must call <literal>g_list_foreach (result,
-(GFunc)g_object_ref, NULL)</literal> first, and then unref all the
+must call `g_list_foreach (result,
+(GFunc)g_object_ref, NULL)` first, and then unref all the
widgets afterwards.
Since: 2.4
@@ -94978,7 +95482,7 @@ with g_list_free() when you are done with it.
<function name="gtk_widget_map">
<description>
This function is only for use in widget implementations. Causes
-a widget to be mapped if it isn't already.
+a widget to be mapped if it isn’t already.
</description>
<parameters>
@@ -95022,17 +95526,15 @@ 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><para>
-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.
-</para><para>
-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.
-</para></note>
+> 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.
Deprecated:3.0: Use gtk_widget_override_background_color() instead
@@ -95063,17 +95565,15 @@ 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><para>
-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.
-</para><para>
-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.
-</para></note>
+> 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.
Deprecated:3.0: Use gtk_widget_override_background_color() instead
@@ -95258,9 +95758,9 @@ calls to of gtk_widget_modify_text().
<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
+`gtk_widget_new (GTK_TYPE_LABEL, "label", "Hello World", "xalign",
+0.0, NULL)` 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.
@@ -95320,29 +95820,26 @@ All other style values are left untouched.
This function does not act recursively. Setting the color of a
container does not affect its children. Note that some widgets that
-you may not think of as containers, for instance #GtkButton<!-- -->s,
+you may not think of as containers, for instance #GtkButtons,
are actually containers.
-<note><para>
This API is mostly meant as a quick way for applications to
change a widget appearance. If you are developing a widgets
library and intend this change to be themeable, it is better
done by setting meaningful CSS classes and regions in your
widget/container implementation through gtk_style_context_add_class()
and gtk_style_context_add_region().
-</para><para>
+
This way, your widget library can install a #GtkCssProvider
with the %GTK_STYLE_PROVIDER_PRIORITY_FALLBACK priority in order
to provide a default styling for those widgets that need so, and
-this theming may fully overridden by the user's theme.
-</para></note>
-<note><para>
+this theming may fully overridden by the user’s theme.
+
Note that for complex widgets this may bring in undesired
results (such as uniform background color everywhere), in
these cases it is better to fully style such widgets through a
#GtkCssProvider with the %GTK_STYLE_PROVIDER_PRIORITY_APPLICATION
priority.
-</para></note>
Since: 3.0
@@ -95458,13 +95955,13 @@ 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
+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.
+i.e. starting with @widget’s name instead of starting with the name
+of @widget’s outermost ancestor.
Deprecated:3.0: Use gtk_widget_get_path() instead
@@ -95707,8 +96204,8 @@ Adds the region @name to the widget at position @pos in
the hierarchy defined in @path. See
gtk_style_context_add_region().
-<note><para>Region names must only contain lowercase letters
-and '-', starting always with a lowercase letter.</para></note>
+Region names must only contain lowercase letters
+and “-”, starting always with a lowercase letter.
Since: 3.0
@@ -95922,7 +96419,7 @@ Since: 3.0
<function name="gtk_widget_path_iter_has_qclass">
<description>
See gtk_widget_path_iter_has_class(). This is a version that operates
-with GQuark<!-- -->s.
+with GQuarks.
Since: 3.0
@@ -95949,7 +96446,7 @@ Since: 3.0
<function name="gtk_widget_path_iter_has_qname">
<description>
See gtk_widget_path_iter_has_name(). This is a version
-that operates on #GQuark<!-- -->s.
+that operates on #GQuarks.
Since: 3.0
@@ -95976,7 +96473,7 @@ Since: 3.0
<function name="gtk_widget_path_iter_has_qregion">
<description>
See gtk_widget_path_iter_has_region(). This is a version that operates
-with GQuark<!-- -->s.
+with GQuarks.
Since: 3.0
@@ -96302,7 +96799,7 @@ Since: 3.2
<description>
Cancels the effect of a previous call to gtk_widget_push_composite_child().
-Deprecated: 3.10: Use gtk_widget_class_set_template(), or don't use this API at all.
+Deprecated: 3.10: Use gtk_widget_class_set_template(), or don’t use this API at all.
</description>
<parameters>
@@ -96315,23 +96812,12 @@ Deprecated: 3.10: Use gtk_widget_class_set_template(), or don't use this API at
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
+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_scrollbar_new (GTK_ORIENTATION_HORIZONTAL, 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);
-]|
-
Deprecated: 3.10: This API never really worked well and was mostly unused, now
we have a more complete mechanism for composite children, see gtk_widget_class_set_template().
@@ -96414,7 +96900,7 @@ defined as @widget->window coordinates for widgets that are not
<function name="gtk_widget_queue_draw_region">
<description>
Invalidates the area of @widget defined by @region by calling
-gdk_window_invalidate_region() on the widget's window and all its
+gdk_window_invalidate_region() 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
@@ -96446,12 +96932,12 @@ 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.
+queues a resize to ensure there’s enough space for the new text.
-<note><para>You cannot call gtk_widget_queue_resize() on a widget
+Note that you cannot call gtk_widget_queue_resize() on a widget
from inside its implementation of the GtkWidgetClass::size_allocate
virtual method. Calls to gtk_widget_queue_resize() from inside
-GtkWidgetClass::size_allocate will be silently ignored.</para></note>
+GtkWidgetClass::size_allocate will be silently ignored.
</description>
<parameters>
@@ -96489,13 +96975,13 @@ a widget and all its parent containers, then the widget will be
realized and mapped automatically.
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
+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
+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::draw. Or simply g_signal_connect () to the
@@ -96513,7 +96999,7 @@ called after the widget is realized automatically, such as
<function name="gtk_widget_region_intersect">
<description>
-Computes the intersection of a @widget's area and @region, returning
+Computes the intersection of a @widget’s area and @region, returning
the intersection. The result may be empty, use cairo_region_is_empty() to
check.
@@ -96668,7 +97154,7 @@ Deprecated: 3.0: Use gtk_widget_render_icon_pixbuf() instead.
</parameter>
<parameter name="size">
<parameter_description> a stock size. A size of (GtkIconSize)-1 means
-render at the size of the source and don't scale (if there are
+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>
@@ -96678,7 +97164,7 @@ multiple source sizes, GTK+ picks one of the available sizes).
</parameter>
</parameters>
<return> a new pixbuf, or %NULL if the
-stock ID wasn't known
+stock ID wasn’t known
</return>
</function>
@@ -96711,13 +97197,13 @@ Deprecated: 3.10: Use gtk_icon_theme_load_icon() instead.
</parameter>
<parameter name="size">
<parameter_description> a stock size. A size of (GtkIconSize)-1 means
-render at the size of the source and don't scale (if there are
+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>
</parameters>
<return> a new pixbuf, or %NULL if the
-stock ID wasn't known
+stock ID wasn’t known
</return>
</function>
@@ -96764,7 +97250,7 @@ Deprecated:3.0: Use #GtkStyleContext instead, and gtk_widget_reset_style()
<function name="gtk_widget_reset_style">
<description>
Updates the style context of @widget and all descendents
-by updating its widget path. #GtkContainer<!-- -->s may want
+by updating its widget path. #GtkContainers may want
to use this on a child when reordering it in a way that a different
style might apply to it. See also gtk_container_get_path_for_child().
@@ -96817,12 +97303,12 @@ 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
+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:
-|[
+|[<!-- language="C" -->
GdkEvent *fevent = gdk_event_new (GDK_FOCUS_CHANGE);
fevent->focus_change.type = GDK_FOCUS_CHANGE;
@@ -96871,7 +97357,7 @@ 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
+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.
@@ -96899,11 +97385,11 @@ g_intern_static_string().
<function name="gtk_widget_set_allocation">
<description>
-Sets the widget's allocation. This should not be used
-directly, but from within a widget's size_allocate method.
+Sets the widget’s allocation. This should not be used
+directly, but from within a widget’s size_allocate method.
-The allocation set should be the "adjusted" or actual
-allocation. If you're implementing a #GtkContainer, you want to use
+The allocation set should be the “adjusted” or actual
+allocation. If you’re implementing a #GtkContainer, you want to use
gtk_widget_size_allocate() instead of gtk_widget_set_allocation().
The GtkWidgetClass::adjust_size_allocation virtual method adjusts the
allocation inside gtk_widget_size_allocate() to create an adjusted
@@ -96957,7 +97443,7 @@ Note that the background is still drawn when the widget is mapped.
<description>
Specifies whether @widget can be a default widget. See
gtk_widget_grab_default() for details about the meaning of
-"default".
+“default”.
Since: 2.18
@@ -97036,7 +97522,7 @@ never should be called by an application.
Sets a widgets composite name. The widget must be
a composite child of its parent; see gtk_widget_push_composite_child().
-Deprecated: 3.10: Use gtk_widget_class_set_template(), or don't use this API at all.
+Deprecated: 3.10: Use gtk_widget_class_set_template(), or don’t use this API at all.
</description>
<parameters>
@@ -97102,11 +97588,11 @@ Since: 3.0
Sets the device event mask (see #GdkEventMask) for a widget. The event
mask determines which events a widget will receive from @device. Keep
in mind that different widgets have different default event masks, and by
-changing the event mask you may disrupt a widget's functionality,
+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_device_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;
+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.
@@ -97162,16 +97648,16 @@ set by gtk_widget_set_default_direction() will be used.
<function name="gtk_widget_set_double_buffered">
<description>
Widgets are double buffered by default; you can use this function
-to turn off the buffering. "Double buffered" simply means that
+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_region() 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
+update in one smooth step, and don’t see individual graphics
primitives being rendered.
-In very simple terms, double buffered widgets don't flicker,
+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.
@@ -97202,11 +97688,11 @@ windows.
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,
+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 widgets that have no window.
+mask. This function can’t be used with widgets that have no window.
(See gtk_widget_get_has_window()). To get events on those widgets,
place them inside a #GtkEventBox and receive events on the event
box.
@@ -97268,9 +97754,9 @@ Since: 2.12
<function name="gtk_widget_set_has_window">
<description>
Specifies whether @widget has a #GdkWindow of its own. Note that
-all realized widgets have a non-%NULL "window" pointer
+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
+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.
@@ -97319,7 +97805,7 @@ automatic expand behavior.
This function forces the widget to expand or not to expand,
regardless of children. The override occurs because
gtk_widget_set_hexpand() sets the hexpand-set property (see
-gtk_widget_set_hexpand_set()) which causes the widget's hexpand
+gtk_widget_set_hexpand_set()) which causes the widget’s hexpand
value to be used, rather than looking at children and widget state.
</description>
@@ -97351,7 +97837,7 @@ expand value based on child widgets. If hexpand is not
set, then the expand value depends on whether any
children of the widget would like to expand.
-There are few reasons to use this function, but it's here
+There are few reasons to use this function, but it’s here
for completeness and consistency.
</description>
@@ -97373,7 +97859,7 @@ for completeness and consistency.
Marks the widget as being realized.
This function should only ever be called in a derived widget's
-"map" or "unmap" implementation.
+“map” or “unmap” implementation.
Since: 2.20
@@ -97529,10 +98015,9 @@ in the CSS file. See the documentation for the CSS syntax (on the
same page as the docs for #GtkStyleContext).
Note that the CSS syntax has certain special characters to delimit
-and represent elements in a selector (period, #, >, *...),
-so using these will make your widget impossible to match by name.
-Any combination of alphanumeric symbols, dashes and underscores will
-suffice.
+and represent elements in a selector (period, #, >, *...), so using
+these will make your widget impossible to match by name. Any combination
+of alphanumeric symbols, dashes and underscores will suffice.
</description>
<parameters>
@@ -97565,7 +98050,7 @@ Since: 2.4
</parameter_description>
</parameter>
<parameter name="no_show_all">
-<parameter_description> the new value for the "no-show-all" property
+<parameter_description> the new value for the “no-show-all” property
</parameter_description>
</parameter>
</parameters>
@@ -97583,10 +98068,10 @@ are some limitations:
For toplevel widgets this depends on the capabilities of the windowing
system. 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, although setting a window's opacity after the window has been
+always, although setting a window’s opacity after the window has been
shown causes it to flicker once on Windows.
-For child widgets it doesn't work if any affected widget has a native window, or
+For child widgets it doesn’t work if any affected widget has a native window, or
disables double buffering.
Since: 3.8
@@ -97632,15 +98117,12 @@ gtk_widget_unparent().
<description>
Sets a non default parent window for @widget.
-For GtkWindow classes, setting a @parent_window effects whether
+For #GtkWindow classes, setting a @parent_window effects whether
the window is a toplevel window or can be embedded into other
widgets.
-<note><para>
-For GtkWindow classes, this needs to be called before the
+For #GtkWindow classes, this needs to be called before the
window is realized.
-</para></note>
-
</description>
<parameters>
@@ -97661,7 +98143,7 @@ window is realized.
Marks the widget as being realized.
This function should only ever be called in a derived widget's
-"realize" or "unrealize" implementation.
+“realize” or “unrealize” implementation.
Since: 2.20
@@ -97686,7 +98168,7 @@ 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".
+“default”.
Since: 2.18
@@ -97715,7 +98197,7 @@ setting off will improve performance.
Note that for widgets where gtk_widget_get_has_window() is %FALSE
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
+allow containers that don’t draw anything to avoid excess
invalidations. If you set this flag on a widget with no window that
does draw on @widget->window, you are
responsible for invalidating both the old and new allocation of the
@@ -97741,9 +98223,9 @@ new portion of the widget will be redrawn.
<function name="gtk_widget_set_sensitive">
<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.
+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>
@@ -97761,7 +98243,7 @@ user can't interact with them. Insensitive widgets are known as
<function name="gtk_widget_set_size_request">
<description>
-Sets the minimum size of a widget; that is, the widget's size
+Sets the minimum size of a widget; that is, the widget’s size
request will be at least @width by @height. You can use this
function to force a widget to be larger than it normally would be.
@@ -97785,7 +98267,7 @@ 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.
+the “natural” size request of the widget will be used instead.
The size request set here does not include any margin from the
#GtkWidget properties margin-left, margin-right, margin-top, and
@@ -97837,6 +98319,10 @@ Deprecated: 3.0. Use gtk_widget_set_state_flags() instead.
This function is for use in widget implementations. Turns on flag
values in the current widget state (insensitive, prelighted, etc.).
+This function accepts the values %GTK_STATE_FLAG_DIR_LTR and
+%GTK_STATE_FLAG_DIR_RTL but ignores them. If you want to set the widget's
+direction, use gtk_widget_set_direction().
+
It is worth mentioning that any other state than %GTK_STATE_FLAG_INSENSITIVE,
will be propagated down to all non-internal children if @widget is a
#GtkContainer, while %GTK_STATE_FLAG_INSENSITIVE itself will be propagated
@@ -97891,7 +98377,7 @@ the default style
<description>
Enables or disables multiple pointer awareness. If this setting is %TRUE,
@widget will start receiving multiple, per device enter/leave events. Note
-that if custom #GdkWindow<!-- -->s are created in #GtkWidget::realize,
+that if custom #GdkWindows are created in #GtkWidget::realize,
gdk_window_set_support_multidevice() will have to be called manually on them.
Since: 3.0
@@ -97913,7 +98399,7 @@ Since: 3.0
<function name="gtk_widget_set_tooltip_markup">
<description>
Sets @markup as the contents of the tooltip, which is marked up with
-the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
+the [Pango text markup language][PangoMarkupFormat].
This function will take care of setting #GtkWidget:has-tooltip to %TRUE
and of the default handler for the #GtkWidget::query-tooltip signal.
@@ -97970,7 +98456,7 @@ 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().
+have the name “gtk-tooltip”, see gtk_widget_set_name().
Since: 2.12
@@ -98052,7 +98538,7 @@ See gtk_widget_set_hexpand_set() for more detail.
<function name="gtk_widget_set_visible">
<description>
Sets the visibility state of @widget. Note that setting this to
-%TRUE doesn't mean the widget is actually viewable, see
+%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()
@@ -98101,17 +98587,17 @@ so you should call this function before @widget is realized.
<function name="gtk_widget_set_window">
<description>
-Sets a widget's window. This function should only be used in a
-widget's #GtkWidget::realize implementation. The %window passed is
+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.
+widget’s init() function.
-<note><para>This function does not add any reference to @window.</para></note>
+Note that this function does not add any reference to @window.
Since: 2.18
@@ -98131,7 +98617,7 @@ Since: 2.18
<function name="gtk_widget_shape_combine_region">
<description>
-Sets a shape for this widget's GDK window. This allows for
+Sets a shape for this widget’s GDK window. This allows for
transparent windows etc., see gdk_window_shape_combine_region()
for more information.
@@ -98153,9 +98639,9 @@ Since: 3.0
<function name="gtk_widget_show">
<description>
-Flags a widget to be displayed. Any widget that isn't shown will
+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, 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,
@@ -98216,8 +98702,8 @@ and position to their child widgets.
In this function, the allocation may be adjusted. It will be forced
to a 1x1 minimum size, and the adjust_size_allocation virtual
method on the child will be used to adjust the allocation. Standard
-adjustments include removing the widget's margins, and applying the
-widget's #GtkWidget:halign and #GtkWidget:valign properties.
+adjustments include removing the widget’s margins, and applying the
+widget’s #GtkWidget:halign and #GtkWidget:valign properties.
For baseline support in containers you need to use gtk_widget_size_allocate_with_baseline()
instead.
@@ -98246,7 +98732,7 @@ will be forced to a 1x1 minimum size, and the
adjust_size_allocation virtual and adjust_baseline_allocation
methods on the child will be used to adjust the allocation and
baseline. Standard adjustments include removing the widget's
-margins, and applying the widget's #GtkWidget:halign and
+margins, and applying the widget’s #GtkWidget:halign and
#GtkWidget:valign properties.
If the child widget does not have a valign of %GTK_ALIGN_BASELINE the
@@ -98305,16 +98791,16 @@ Deprecated: 3.0: Use gtk_widget_get_preferred_size() instead.
<function name="gtk_widget_style_attach">
<description>
-This function attaches the widget's #GtkStyle to the widget's
+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"
+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
+“realize” implementation, because one of the parent classes
(finally #GtkWidget) would attach the style itself.
Since: 2.20
@@ -98420,8 +98906,8 @@ emitted.
<function name="gtk_widget_translate_coordinates">
<description>
-Translate coordinates relative to @src_widget's allocation to coordinates
-relative to @dest_widget's allocations. In order to perform this
+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.
@@ -98480,7 +98966,7 @@ Since: 2.12
<function name="gtk_widget_unmap">
<description>
This function is only for use in widget implementations. Causes
-a widget to be unmapped if it's currently mapped.
+a widget to be unmapped if it’s currently mapped.
</description>
<parameters>
@@ -98674,8 +99160,8 @@ Adds a mnemonic to this window.
<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
+will be done using the standard mechanism for the
+[window manager][gtk-X11-arch] or windowing
system. Otherwise, GDK will try to emulate window movement,
potentially not all that well, depending on the windowing system.
@@ -98709,8 +99195,8 @@ potentially not all that well, depending on the windowing system.
<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
+will be done using the standard mechanism for the
+[window manager][gtk-X11-arch] or windowing
system. Otherwise, GDK will try to emulate window resizing,
potentially not all that well, depending on the windowing system.
@@ -98767,12 +99253,12 @@ Since: 3.10
<function name="gtk_window_deiconify">
<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
+that you shouldn’t assume the window is definitely deiconified
+afterward, because other entities (e.g. the user or
+[window manager][gtk-X11-arch])) could iconify it
again before your code which assumes deiconification gets to run.
-You can track iconification via the "window-state-event" signal
+You can track iconification via the “window-state-event” signal
on #GtkWidget.
</description>
@@ -98788,14 +99274,14 @@ on #GtkWidget.
<function name="gtk_window_fullscreen">
<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
+shouldn’t assume the window is definitely full screen afterward,
+because other entities (e.g. the user or
+[window manager][gtk-X11-arch]) 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.
+don’t write code that crashes if not.
-You can track the fullscreen state via the "window-state-event" signal
+You can track the fullscreen state via the “window-state-event” signal
on #GtkWidget.
Since: 2.2
@@ -98920,7 +99406,7 @@ Since: 2.16
<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
+for that dimension, so the “natural” size of the window will be
used.
@@ -99002,7 +99488,7 @@ gtk_window_set_destroy_with_parent ().
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
+is not focused then `gtk_widget_has_focus (widget)` will
not be %TRUE for the widget.
@@ -99049,7 +99535,7 @@ Since: 3.2
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if 'focus rectangles' are supposed to be visible
+<return> %TRUE if “focus rectangles” are supposed to be visible
in this window.
</return>
@@ -99151,7 +99637,7 @@ the 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.
+member won’t be incremented.
</description>
@@ -99161,7 +99647,7 @@ member won't be incremented.
</parameter_description>
</parameter>
</parameters>
-<return> copy of window's icon list
+<return> copy of window’s icon list
</return>
</function>
@@ -99266,7 +99752,7 @@ 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
+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
@@ -99275,7 +99761,7 @@ 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
+Thus GTK+ is using a “best guess” that works with most
window managers.
Moreover, nearly all window managers are historically broken with
@@ -99286,16 +99772,16 @@ 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
+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
+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
+“GnomeClient” object in the GNOME libraries for example) and allow
the window manager to save your window sizes and positions.
@@ -99354,7 +99840,7 @@ the resize grip area
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the resize grip's area was retrieved
+<return> %TRUE if the resize grip’s area was retrieved
</return>
</function>
@@ -99399,15 +99885,16 @@ Since: 2.2
<function name="gtk_window_get_size">
<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
+it returns the size GTK+ will suggest to the
+[window manager][gtk-X11-arch]
+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
+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.
@@ -99416,7 +99903,7 @@ 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
+“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 not include the
@@ -99426,7 +99913,7 @@ 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
+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
@@ -99439,7 +99926,7 @@ of the window decorations/border into account, while your
application cannot.
In any case, if you insist on application-specified window
-positioning, there's still a better way than
+positioning, there’s still a better way than
doing it yourself - gtk_window_set_position() will frequently
handle the details for you.
@@ -99475,7 +99962,7 @@ Since: 2.2
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if window shouldn't be in pager
+<return> %TRUE if window shouldn’t be in pager
</return>
</function>
@@ -99493,7 +99980,7 @@ Since: 2.2
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if window shouldn't be in taskbar
+<return> %TRUE if window shouldn’t be in taskbar
</return>
</function>
@@ -99736,18 +100223,18 @@ Since: 2.4
<function name="gtk_window_iconify">
<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
+you shouldn’t assume the window is definitely iconified afterward,
+because other entities (e.g. the user or
+[window manager][gtk-X11-arch]) 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.
+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,
+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
+You can track iconification via the “window-state-event” signal
on #GtkWidget.
@@ -99791,7 +100278,7 @@ Retrieves the current maximized state of @window.
Note that since maximization is ultimately handled by the window
manager and happens asynchronously to an application request, you
-shouldn't assume the return value of this function changing
+shouldn’t assume the return value of this function changing
immediately (or at all), as an effect of calling
gtk_window_maximize() or gtk_window_unmaximize().
@@ -99815,7 +100302,7 @@ 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 must call
-<literal>g_list_foreach (result, (GFunc)g_object_ref, NULL)</literal> first, and
+`g_list_foreach (result, (GFunc)g_object_ref, NULL)` first, and
then unref all the widgets afterwards.
@@ -99829,18 +100316,18 @@ then unref all the widgets afterwards.
<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
+you shouldn’t assume the window is definitely maximized afterward,
+because other entities (e.g. the user or
+[window manager][gtk-X11-arch]) could unmaximize it
again, and not all window managers support maximization. But
-normally the window will end up maximized. Just don't write code
+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,
+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
+You can track maximization via the “window-state-event” signal
on #GtkWidget, or by listening to notifications on the
#GtkWindow:is-maximized property.
@@ -99881,7 +100368,7 @@ Activates the targets associated with the mnemonic.
<function name="gtk_window_move">
<description>
-Asks the <link linkend="gtk-X11-arch">window manager</link> to move
+Asks the [window manager][gtk-X11-arch] 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
@@ -99906,14 +100393,12 @@ 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
+`gtk_window_move (window, gdk_screen_width () - window_width,
+gdk_screen_height () - window_height)` (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 [Extended Window Manager Hints Specification](http://www.freedesktop.org/Standards/wm-spec)
+has a nice table of gravities in the “implementation notes” section.
The gtk_window_get_position() documentation may also be relevant.
@@ -99939,16 +100424,16 @@ The gtk_window_get_position() documentation may also be relevant.
<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
+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".
+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>.
+On X11, popup windows are not controlled by the
+[window manager][gtk-X11-arch].
If you simply want an undecorated window (no window borders), use
-gtk_window_set_decorated(), don't use #GTK_WINDOW_POPUP.
+gtk_window_set_decorated(), don’t use #GTK_WINDOW_POPUP.
All top-level windows created by gtk_window_new() are stored in
an internal top-level window list. This list can be obtained from
@@ -99973,7 +100458,7 @@ To delete a #GtkWindow, call gtk_window_destroy().
<function name="gtk_window_parse_geometry">
<description>
Parses a standard X Window System geometry string - see the
-manual page for X (type 'man X') for details on this.
+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.
@@ -99989,16 +100474,16 @@ 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
+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.
-|[
+|[<!-- language="C" -->
#include <gtk/gtk.h>
static void
fill_with_content (GtkWidget *vbox)
{
-/ * fill with content... * /
+// fill with content...
}
int
@@ -100006,13 +100491,15 @@ 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
+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_box_new (GTK_ORIENTATION_VERTICAL, FALSE, 0);
+vbox = gtk_box_new (GTK_ORIENTATION_VERTICAL,
+FALSE, 0);
gtk_container_add (GTK_CONTAINER (window), vbox);
fill_with_content (vbox);
@@ -100021,14 +100508,19 @@ 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_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]);
+gboolean res;
+res = gtk_window_parse_geometry (GTK_WINDOW (window),
+argv[1]);
+if (! res)
+fprintf (stderr,
+"Failed to parse “%s”\n",
+argv[1]);
}
gtk_widget_show_all (window);
@@ -100059,13 +100551,13 @@ return 0;
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.
+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
+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.
@@ -100375,15 +100867,15 @@ Since: 2.2
<function name="gtk_window_set_decorated">
<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
+controls, etc. Some [window managers][gtk-X11-arch]
+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_widget_show().
-On Windows, this function always works, since there's no window manager
+On Windows, this function always works, since there’s no window manager
policy involved.
@@ -100403,13 +100895,13 @@ policy involved.
<function name="gtk_window_set_default">
<description>
-The default widget is the widget that's activated when the user
+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 call gtk_widget_set_can_default() on the
-widget you'd like to make the default.
+unsets the default widget for a #GtkWindow. When setting (rather
+than unsetting) the default widget it’s generally easier to call
+gtk_widget_grab_default() on the widget. Before making a widget
+the default widget, you must call gtk_widget_set_can_default() on
+the widget you’d like to make the default.
</description>
<parameters>
@@ -100418,8 +100910,8 @@ widget you'd like to make the default.
</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_description> widget to be the default, or %NULL
+to unset the default widget for the toplevel
</parameter_description>
</parameter>
</parameters>
@@ -100533,7 +101025,7 @@ Since: 2.6
<function name="gtk_window_set_default_size">
<description>
-Sets the default size of a window. If the window's "natural" size
+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
@@ -100545,9 +101037,9 @@ 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).
+use the “natural” default size (the size request of the window).
-For more control over a window's initial size and how resizing works,
+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.
@@ -100559,7 +101051,7 @@ 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
+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>
@@ -100583,14 +101075,14 @@ passing 0 for @width and @height is OK, resulting in a 1x1 default size.
<function name="gtk_window_set_deletable">
<description>
By default, windows have a close button in the window frame. Some
-<link linkend="gtk-X11-arch">window managers</link> allow GTK+ to
+[window managers][gtk-X11-arch] 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_widget_show().
-On Windows, this function always works, since there's no window manager
+On Windows, this function always works, since there’s no window manager
policy involved.
Since: 2.10
@@ -100613,7 +101105,7 @@ Since: 2.10
<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
+shouldn’t persist beyond the lifetime of the main window they're
associated with, for example.
</description>
@@ -100732,7 +101224,7 @@ 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."
+typically “do what you mean.”
</description>
@@ -100802,13 +101294,17 @@ Since: 3.0
<function name="gtk_window_set_hide_titlebar_when_maximized">
<description>
-If @setting is %TRUE, then @window will request that it's titlebar
+If @setting is %TRUE, then @window will request that it’s titlebar
should be hidden when maximized.
-This is useful for windows that don't convey any information other
+This is useful for windows that don’t convey any information other
than the application name in the titlebar, to put the available
screen space to better use. If the underlying window system does not
support the request, the setting will not have any effect.
+Note that custom titlebars set with gtk_window_set_titlebar() are
+not affected by this. The application is in full control of their
+content and visibility anyway.
+
Since: 3.4
</description>
@@ -100833,7 +101329,7 @@ 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
+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.
@@ -100899,7 +101395,7 @@ 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
+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.
@@ -100914,7 +101410,7 @@ 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
+icon from their transient parent. So there’s no need to explicitly
set the icon on transient windows.
</description>
@@ -100958,25 +101454,25 @@ Since: 2.6
<function name="gtk_window_set_keep_above">
<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,
+you shouldn’t assume the window is definitely above afterward,
+because other entities (e.g. the user or
+[window manager][gtk-X11-arch]) 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
+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,
+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
+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.
+Note that, according to the
+[Extended Window Manager Hints Specification](http://www.freedesktop.org/Standards/wm-spec),
+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
@@ -100997,25 +101493,25 @@ Since: 2.4
<function name="gtk_window_set_keep_below">
<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,
+you shouldn’t assume the window is definitely below afterward,
+because other entities (e.g. the user or
+[window manager][gtk-X11-arch]) 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
+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,
+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
+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.
+Note that, according to the
+[Extended Window Manager Hints Specification](http://www.freedesktop.org/Standards/wm-spec),
+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
@@ -101078,7 +101574,7 @@ 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>
+parent; most [window managers][gtk-X11-arch]
will then disallow lowering the dialog below the parent.
@@ -101106,7 +101602,7 @@ 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
+Note that setting a window’s opacity after the window has been
shown causes it to flicker once on Windows.
Since: 2.12
@@ -101170,13 +101666,13 @@ by default.
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
+[window manager][gtk-X11-arch] 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
+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
+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.
@@ -101295,9 +101791,9 @@ Since: 2.12
<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
+is rendered by the [window manager][gtk-X11-arch],
+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.
@@ -101346,8 +101842,8 @@ Since: 3.10
<function name="gtk_window_set_transient_for">
<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
+window they were spawned from. This allows
+[window managers][gtk-X11-arch] 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
@@ -101421,8 +101917,8 @@ Since: 2.8
<function name="gtk_window_set_wmclass">
<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
+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
@@ -101452,16 +101948,16 @@ manager to restore window positions when loading a saved session.
<function name="gtk_window_stick">
<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
+desktops. Note that you shouldn’t assume the window is definitely
+stuck afterward, because other entities (e.g. the user or
+[window manager][gtk-X11-arch] 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.
+It’s permitted to call this function before showing a window.
-You can track stickiness via the "window-state-event" signal
+You can track stickiness via the “window-state-event” signal
on #GtkWidget.
@@ -101478,14 +101974,14 @@ on #GtkWidget.
<function name="gtk_window_unfullscreen">
<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
+shouldn’t assume the window is definitely not full screen
+afterward, because other entities (e.g. the user or
+[window manager][gtk-X11-arch]) 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.
+state. Just don’t write code that crashes if not.
-You can track the fullscreen state via the "window-state-event" signal
+You can track the fullscreen state via the “window-state-event” signal
on #GtkWidget.
Since: 2.2
@@ -101502,14 +101998,14 @@ Since: 2.2
<function name="gtk_window_unmaximize">
<description>
-Asks to unmaximize @window. Note that you shouldn't assume the
+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
+(e.g. the user or [window manager][gtk-X11-arch])
+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.
+end up unmaximized. Just don’t write code that crashes if not.
-You can track maximization via the "window-state-event" signal
+You can track maximization via the “window-state-event” signal
on #GtkWidget.
@@ -101526,13 +102022,13 @@ on #GtkWidget.
<function name="gtk_window_unstick">
<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
+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.
+(e.g. the user or [window manager][gtk-X11-arch]) 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
+You can track stickiness via the “window-state-event” signal
on #GtkWidget.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
