* Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
* file for a list of people on the GTK+ Team. See the ChangeLog
* files for a list of changes. These files are distributed with
- * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
+ * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
#undef GDK_DISABLE_DEPRECATED /* gdk_input_set_extension_events() */
#include "gtkrc.h"
#include "gtkselection.h"
#include "gtksettings.h"
-#include "gtksizegroup.h"
+#include "gtksizegroup-private.h"
#include "gtkwidget.h"
+#include "gtkwidgetprivate.h"
#include "gtkwindow.h"
#include "gtkbindings.h"
#include "gtkprivate.h"
* <refsect2 id="geometry-management">
* <title>Height-for-width Geometry Management</title>
* <para>
- * GTK+ uses a height-for-width (and width-for-height) geometry management system.
- * Height-for-width means that a widget can change how much vertical space it needs,
- * depending on the amount of horizontal space that it is given (and similar for
- * width-for-height). The most common example is a label that reflows to fill up the
- * available width, wraps to fewer lines, and therefore needs less height.
- *
- * GTK+'s traditional two-pass <link linkend="size-allocation">size-allocation</link>
- * algorithm does not allow this flexibility. #GtkWidget provides a default
- * implementation of the height-for-width methods for existing widgets,
- * which always requests the same height, regardless of the available width.
- *
- * Some important things to keep in mind when implementing
- * height-for-width and when using it in container
- * implementations.
- *
- * The geometry management system will query a logical hierarchy in
+ * GTK+ uses a height-for-width (and width-for-height) geometry management
+ * system Height-for-width means that a widget can change how much
+ * vertical space it needs, depending on the amount of horizontal space
+ * that it is given (and similar for width-for-height). The most common
+ * example is a label that reflows to fill up the available width, wraps
+ * to fewer lines, and therefore needs less height.
+ *
+ * Height-for-width geometry management is implemented in GTK+ by way
+ * of five virtual methods:
+ * <variablelist>
+ * <varlistentry>
+ * <term>#GtkWidgetClass.get_request_mode()</term>
+ * <listitem>
+ * This allows a widget to tell it's parent container whether
+ * it preferrs to be allocated in %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH
+ * or %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT mode.
+ * %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH means the widget prefers to
+ * have #GtkWidgetClass.get_preferred_width() called and then
+ * #GtkWidgetClass.get_preferred_height_for_width() and is the
+ * default return for unimplemented cases.
+ * However it's important to note (as described below) that any
+ * widget which trades height-for-width must respond properly to
+ * both #GtkSizeRequestModes since it might be queried in either
+ * orientation by it's parent container.
+ * </listitem>
+ * </varlistentry>
+ * <varlistentry>
+ * <term>#GtkWidgetClass.get_preferred_width()</term>
+ * <listitem>
+ * This is called by containers to obtain the minimum and
+ * natural width of a widget. A widget will never be allocated
+ * a width less than it's minimum and will only ever be allocated
+ * a width greater than the natural width once all of the said
+ * widget's siblings have received their natural widths.
+ * Furthermore a widget will only ever be allocated a width greater
+ * than it's natural width if it was configured to receive extra
+ * expand space from it's parent container.
+ * </listitem>
+ * </varlistentry>
+ * <varlistentry>
+ * <term>#GtkWidgetClass.get_preferred_height()</term>
+ * <listitem>
+ * This is called by containers to obtain the minimum and
+ * natural height of a widget.
+ * A widget that does not actually trade any height for width
+ * or width for height only has to implement these two virtual
+ * methods (#GtkWidgetClass.get_preferred_width() and
+ * #GtkWidgetClass.get_preferred_height()).
+ * </listitem>
+ * </varlistentry>
+ * <varlistentry>
+ * <term>#GtkWidgetClass.get_preferred_height_for_width()</term>
+ * <listitem>
+ * This is similar to #GtkWidgetClass.get_preferred_height() except
+ * that it is passed a contextual width to request height for. By
+ * implementing this virtual method it is possible for a #GtkLabel
+ * to tell it's parent how much height would be required if the
+ * label were to be allocated a said width.
+ * </listitem>
+ * </varlistentry>
+ * <varlistentry>
+ * <term>#GtkWidgetClass.get_preferred_width_for_height()</term>
+ * <listitem>
+ * This is analogous to #GtkWidgetClass.get_preferred_height_for_width()
+ * except that it operates in the oposite orientation. It's rare that
+ * a widget actually does %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT requests
+ * but can happen when for example; a widget or container gets additional
+ * columns to compensate for a smaller allocated height.
+ * </listitem>
+ * </varlistentry>
+ * </variablelist>
+ *
+ * There are some important things to keep in mind when implementing
+ * height-for-width and when using it in container implementations.
+ *
+ * The geometry management system will query a widget hierarchy in
* only one orientation at a time. When widgets are initially queried
- * for their minimum sizes it is generally done in a dual pass
- * in the direction chosen by the toplevel.
- *
- * For instance when queried in the normal height-for-width mode:
- * First the default minimum and natural width for each widget
- * in the interface will computed and collectively returned to
- * the toplevel by way of gtk_widget_get_preferred_width().
- * Next, the toplevel will use the minimum width to query for the
+ * for their minimum sizes it is generally done in two initial passes
+ * in the #GtkSizeRequestMode chosen by the toplevel.
+ *
+ * For example, when queried in the normal
+ * %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH mode:
+ * First, the default minimum and natural width for each widget
+ * in the interface will be computed using gtk_width_get_preferred_width().
+ * Because the preferred widths for each container depends on the preferred
+ * widths of thier children, this information propagates up the hierarchy,
+ * and finally a minimum and natural width is determined for the entire
+ * toplevel. Next, the toplevel will use the minimum width to query for the
* minimum height contextual to that width using
- * gtk_widget_get_preferred_height_for_width(), which will also
- * be a highly recursive operation. This minimum-for-minimum size can
- * be used to set the minimum size constraint on the toplevel.
- *
- * When allocating, each container can use the minimum and natural
- * sizes reported by their children to allocate natural sizes and
- * expose as much content as possible with the given allocation.
- *
- * That means that the request operation at allocation time will
- * usually fire again in contexts of different allocated sizes than
- * the ones originally queried for. #GtkWidget caches a
- * small number of results to avoid re-querying for the same
- * allocated size in one allocation cycle.
- *
- * A widget that does not actually do height-for-width
- * or width-for-height size negotiations only has to implement
- * #GtkWidgetClass.get_preferred_width() and
- * #GtkWidgetClass.get_preferred_height().
+ * gtk_widget_get_preferred_height_for_width(), which will also be a highly
+ * recursive operation. The minimum height for the minimum width is normally
+ * used to set the minimum size constraint on the toplevel
+ * (unless gtk_window_set_geometry_hints() is explicitly used instead).
+ *
+ * After the toplevel window has initially requested it's size in both
+ * dimensions it can go on to allocate itself a reasonable size (or a size
+ * previously specified with gtk_window_set_default_size()). During the
+ * recursive allocation process it's important to note that request cycles
+ * will be recursively executed while container widgets allocate their children.
+ * Each container widget, once allocated a size will go on to first share the
+ * space in one orientation among its children and then request each child's
+ * height for their target allocated width or width for allocated height
+ * depending. In this way a #GtkWidget will typically be requested its size
+ * a number of times before actually being allocated a size, the size a
+ * widget is finally allocated can of course differ from the size it
+ * requested. For this reason; #GtkWidget caches a small number of results
+ * to avoid re-querying for the same sizes in one allocation cycle.
+ *
+ * See <link linkend="container-geometry-management">GtkContainer's
+ * geometry management section</link>
+ * to learn more about how height-for-width allocations are performed
+ * by container widgets.
*
* If a widget does move content around to smartly use up the
- * allocated size, then it must support the request properly in
- * both orientations; even if the request only makes sense in
- * one orientation.
+ * allocated size, then it must support the request in both
+ * #GtkSizeRequestModes even if the widget in question only
+ * trades sizes in a single orientation.
*
* For instance, a #GtkLabel that does height-for-width word wrapping
- * will not expect to have #GtkWidgetClass.get_preferred_height() called because that
- * call is specific to a width-for-height request. In this case the
- * label must return the heights contextual to its minimum possible
- * width. By following this rule any widget that handles height-for-width
- * or width-for-height requests will always be allocated at least
- * enough space to fit its own content.
+ * will not expect to have #GtkWidgetClass.get_preferred_height() called
+ * because that call is specific to a width-for-height request. In this
+ * case the label must return the heights required for it's own minimum
+ * possible width. By following this rule any widget that handles
+ * height-for-width or width-for-height requests will always be allocated
+ * at least enough space to fit its own content.
+ *
+ * Here are some examples of how a %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH widget
+ * generally deals with width-for-height requests, for #GtkWidgetClass.get_preferred_height()
+ * it will do:
+ * <programlisting><![CDATA[
+ * static void
+ * foo_widget_get_preferred_height (GtkWidget *widget, gint *min_height, gint *nat_height)
+ * {
+ * if (i_am_in_height_for_width_mode)
+ * {
+ * gint min_width;
+ *
+ * GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, &min_width, NULL);
+ * GTK_WIDGET_GET_CLASS (widget)->get_preferred_height_for_width (widget, min_width,
+ * min_height, nat_height);
+ * }
+ * else
+ * {
+ * ... some widgets do both, for instance if a GtkLabel is rotated to 90 degrees
+ * it will return the minimum and natural height for the rotated label here.
+ * }
+ * }
+ * ]]></programlisting>
+ *
+ * And in #GtkWidgetClass.get_preferred_width_for_height() it will simply return
+ * the minimum and natural width:
+ *
+ * <programlisting><![CDATA[
+ * static void
+ * foo_widget_get_preferred_width_for_height (GtkWidget *widget, gint for_height,
+ * gint *min_width, gint *nat_width)
+ * {
+ * if (i_am_in_height_for_width_mode)
+ * {
+ * GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, min_width, nat_width);
+ * }
+ * else
+ * {
+ * ... again if a widget is sometimes operating in width-for-height mode
+ * (like a rotated GtkLabel) it can go ahead and do it's real width for
+ * height calculation here.
+ * }
+ * }
+ * ]]></programlisting>
*
* Often a widget needs to get its own request during size request or
* allocation, for example when computing height it may need to also
- * compute width, or when deciding how to use an allocation the widget may
- * need to know its natural size. In these cases, the widget should be
- * careful to call its virtual methods directly, like this:
+ * compute width, or when deciding how to use an allocation the widget
+ * may need to know its natural size. In these cases, the widget should
+ * be careful to call its virtual methods directly, like this:
* <example>
* <title>Widget calling its own size request method.</title>
* <programlisting>
- * GTK_WIDGET_GET_CLASS(widget)->get_preferred_width (widget), &min, &natural);
+ * GTK_WIDGET_GET_CLASS(widget)->get_preferred_width (widget),
+ * &min, &natural);
* </programlisting>
* </example>
*
guint width_request_needed : 1;
guint height_request_needed : 1;
+ /* Expand-related flags */
+ guint need_compute_expand : 1; /* Need to recompute computed_[hv]_expand */
+ guint computed_hexpand : 1; /* computed results (composite of child flags) */
+ guint computed_vexpand : 1;
+ guint hexpand : 1; /* application-forced expand */
+ guint vexpand : 1;
+ guint hexpand_set : 1; /* whether to use application-forced */
+ guint vexpand_set : 1; /* instead of computing from children */
+
/* The widget's name. If the widget does not have a name
* (the name is NULL), then its name (as returned by
* "gtk_widget_get_name") is its class's name.
GRAB_FOCUS,
FOCUS,
MOVE_FOCUS,
+ KEYNAV_FAILED,
EVENT,
EVENT_AFTER,
BUTTON_PRESS_EVENT,
SELECTION_RECEIVED,
PROXIMITY_IN_EVENT,
PROXIMITY_OUT_EVENT,
+ CLIENT_EVENT,
+ NO_EXPOSE_EVENT,
+ VISIBILITY_NOTIFY_EVENT,
+ WINDOW_STATE_EVENT,
+ DAMAGE_EVENT,
+ GRAB_BROKEN_EVENT,
DRAG_BEGIN,
DRAG_END,
DRAG_DATA_DELETE,
DRAG_DROP,
DRAG_DATA_GET,
DRAG_DATA_RECEIVED,
- CLIENT_EVENT,
- NO_EXPOSE_EVENT,
- VISIBILITY_NOTIFY_EVENT,
- WINDOW_STATE_EVENT,
POPUP_MENU,
SHOW_HELP,
ACCEL_CLOSURES_CHANGED,
SCREEN_CHANGED,
CAN_ACTIVATE_ACCEL,
- GRAB_BROKEN,
COMPOSITED_CHANGED,
QUERY_TOOLTIP,
- KEYNAV_FAILED,
DRAG_FAILED,
- DAMAGE_EVENT,
LAST_SIGNAL
};
PROP_MARGIN_RIGHT,
PROP_MARGIN_TOP,
PROP_MARGIN_BOTTOM,
- PROP_MARGIN
+ PROP_MARGIN,
+ PROP_HEXPAND,
+ PROP_VEXPAND,
+ PROP_HEXPAND_SET,
+ PROP_VEXPAND_SET,
+ PROP_EXPAND
};
typedef struct _GtkStateData GtkStateData;
static void gtk_widget_real_adjust_size_request (GtkWidget *widget,
GtkOrientation orientation,
- gint for_size,
gint *minimum_size,
gint *natural_size);
static void gtk_widget_real_adjust_size_allocation (GtkWidget *widget,
- GtkAllocation *allocation);
+ GtkOrientation orientation,
+ gint *natural_size,
+ gint *allocated_pos,
+ gint *allocated_size);
-static void gtk_widget_set_usize_internal (GtkWidget *widget,
- gint width,
- gint height);
+static void gtk_widget_set_usize_internal (GtkWidget *widget,
+ gint width,
+ gint height,
+ GtkQueueResizeFlags flags);
static void gtk_widget_add_events_internal (GtkWidget *widget,
GdkDevice *device,
static GtkTextDirection gtk_default_direction = GTK_TEXT_DIR_LTR;
static GParamSpecPool *style_property_spec_pool = NULL;
+/* XXX Temporarily here to fire warnings from gtksizerequest.c */
+guint _size_request_signal_id = 0;
+
static GQuark quark_property_parser = 0;
static GQuark quark_aux_info = 0;
static GQuark quark_accel_path = 0;
klass->destroy = gtk_widget_real_destroy;
klass->activate_signal = 0;
- klass->set_scroll_adjustments_signal = 0;
klass->dispatch_child_properties_changed = gtk_widget_dispatch_child_properties_changed;
klass->show = gtk_widget_real_show;
klass->show_all = gtk_widget_show;
klass->hide = gtk_widget_real_hide;
- klass->hide_all = gtk_widget_hide;
klass->map = gtk_widget_real_map;
klass->unmap = gtk_widget_real_unmap;
klass->realize = gtk_widget_real_realize;
klass->get_preferred_width = gtk_widget_real_get_width;
klass->get_preferred_height = gtk_widget_real_get_height;
klass->get_preferred_width_for_height = gtk_widget_real_get_width_for_height;
- klass->get_preferred_height_for_width = gtk_widget_real_get_height_for_width;
+ klass->get_preferred_height_for_width = gtk_widget_real_get_height_for_width;
klass->state_changed = NULL;
klass->parent_set = NULL;
klass->hierarchy_changed = NULL;
klass->mnemonic_activate = gtk_widget_real_mnemonic_activate;
klass->grab_focus = gtk_widget_real_grab_focus;
klass->focus = gtk_widget_real_focus;
+ klass->move_focus = gtk_widget_real_move_focus;
+ klass->keynav_failed = gtk_widget_real_keynav_failed;
klass->event = NULL;
klass->button_press_event = NULL;
klass->button_release_event = NULL;
klass->query_tooltip = gtk_widget_real_query_tooltip;
klass->show_help = gtk_widget_real_show_help;
-
+
/* Accessibility support */
klass->get_accessible = gtk_widget_real_get_accessible;
g_object_class_install_property (gobject_class,
PROP_PARENT,
g_param_spec_object ("parent",
- P_("Parent widget"),
+ P_("Parent widget"),
P_("The parent widget of this widget. Must be a Container widget"),
GTK_TYPE_CONTAINER,
GTK_PARAM_READWRITE));
/**
* GtkWidget:has-tooltip:
*
- * Enables or disables the emission of #GtkWidget::query-tooltip on @widget.
+ * Enables or disables the emission of #GtkWidget::query-tooltip on @widget.
* A value of %TRUE indicates that @widget can have a tooltip, in this case
* the widget will be queried using #GtkWidget::query-tooltip to determine
* whether it will provide a tooltip or not.
_gtk_marshal_VOID__VOID,
G_TYPE_NONE, 0);
+ /**
+ * GtkWidget:hexpand
+ *
+ * Whether to expand horizontally. See gtk_widget_set_hexpand().
+ *
+ * Since: 3.0
+ */
+ g_object_class_install_property (gobject_class,
+ PROP_HEXPAND,
+ g_param_spec_boolean ("hexpand",
+ P_("Horizontal Expand"),
+ P_("Whether widget wants more horizontal space"),
+ FALSE,
+ GTK_PARAM_READWRITE));
+
+ /**
+ * GtkWidget:hexpand-set
+ *
+ * Whether to use the #GtkWidget:hexpand property. See gtk_widget_get_hexpand_set().
+ *
+ * Since: 3.0
+ */
+ g_object_class_install_property (gobject_class,
+ PROP_HEXPAND_SET,
+ g_param_spec_boolean ("hexpand-set",
+ P_("Horizontal Expand Set"),
+ P_("Whether to use the hexpand property"),
+ FALSE,
+ GTK_PARAM_READWRITE));
+
+ /**
+ * GtkWidget:vexpand
+ *
+ * Whether to expand vertically. See gtk_widget_set_vexpand().
+ *
+ * Since: 3.0
+ */
+ g_object_class_install_property (gobject_class,
+ PROP_VEXPAND,
+ g_param_spec_boolean ("vexpand",
+ P_("Vertical Expand"),
+ P_("Whether widget wants more vertical space"),
+ FALSE,
+ GTK_PARAM_READWRITE));
+
+ /**
+ * GtkWidget:vexpand-set
+ *
+ * Whether to use the #GtkWidget:vexpand property. See gtk_widget_get_vexpand_set().
+ *
+ * Since: 3.0
+ */
+ g_object_class_install_property (gobject_class,
+ PROP_VEXPAND_SET,
+ g_param_spec_boolean ("vexpand-set",
+ P_("Vertical Expand Set"),
+ P_("Whether to use the vexpand property"),
+ FALSE,
+ GTK_PARAM_READWRITE));
+
+ /**
+ * GtkWidget:expand
+ *
+ * Whether to expand in both directions. Setting this sets both #GtkWidget:hexpand and #GtkWidget:vexpand
+ *
+ * Since: 3.0
+ */
+ g_object_class_install_property (gobject_class,
+ PROP_EXPAND,
+ g_param_spec_boolean ("expand",
+ P_("Expand Both"),
+ P_("Whether widget wants to expand in both directions"),
+ FALSE,
+ GTK_PARAM_READWRITE));
+
/**
* GtkWidget::show:
* @widget: the object which received the signal.
* GtkWidget::size-request:
* @widget: the object which received the signal.
* @requisition:
+ *
+ * Deprecated: 3.0: Either implement
+ * <link linkend="geometry-management">height-for-width geometry management</link> or
+ * use gtk_widget_set_size_request() instead of handling this signal.
*/
- widget_signals[SIZE_REQUEST] =
+ _size_request_signal_id = widget_signals[SIZE_REQUEST] =
g_signal_new (I_("size-request"),
G_TYPE_FROM_CLASS (gobject_class),
G_SIGNAL_RUN_FIRST,
* @widget: the object which received the signal.
* @allocation:
*/
- widget_signals[SIZE_ALLOCATE] =
+ widget_signals[SIZE_ALLOCATE] =
g_signal_new (I_("size-allocate"),
G_TYPE_FROM_CLASS (gobject_class),
G_SIGNAL_RUN_FIRST,
* @old_parent: (allow-none): the previous parent, or %NULL if the widget
* just got its initial parent.
*
- * The ::parent-set signal is emitted when a new parent
- * has been set on a widget.
+ * The ::parent-set signal is emitted when a new parent
+ * has been set on a widget.
*/
widget_signals[PARENT_SET] =
g_signal_new (I_("parent-set"),
* GtkWidget::style-set:
* @widget: the object on which the signal is emitted
* @previous_style: (allow-none): the previous style, or %NULL if the widget
- * just got its initial style
+ * just got its initial style
*
- * The ::style-set signal is emitted when a new style has been set
- * on a widget. Note that style-modifying functions like
+ * The ::style-set signal is emitted when a new style has been set
+ * on a widget. Note that style-modifying functions like
* gtk_widget_modify_base() also cause this signal to be emitted.
*/
widget_signals[STYLE_SET] =
* if it becomes unshadowed
*
* The ::grab-notify signal is emitted when a widget becomes
- * shadowed by a GTK+ grab (not a pointer or keyboard grab) on
- * another widget, or when it becomes unshadowed due to a grab
+ * shadowed by a GTK+ grab (not a pointer or keyboard grab) on
+ * another widget, or when it becomes unshadowed due to a grab
* being removed.
- *
- * A widget is shadowed by a gtk_grab_add() when the topmost
- * grab widget in the grab stack of its window group is not
+ *
+ * A widget is shadowed by a gtk_grab_add() when the topmost
+ * grab widget in the grab stack of its window group is not
* its ancestor.
*/
widget_signals[GRAB_NOTIFY] =
* @widget: the object which received the signal
* @pspec: the #GParamSpec of the changed child property
*
- * The ::child-notify signal is emitted for each
+ * The ::child-notify signal is emitted for each
* <link linkend="child-properties">child property</link> that has
- * changed on an object. The signal's detail holds the property name.
+ * changed on an object. The signal's detail holds the property name.
*/
widget_signals[CHILD_NOTIFY] =
g_signal_new (I_("child-notify"),
* @direction:
*/
widget_signals[MOVE_FOCUS] =
- g_signal_new_class_handler (I_("move-focus"),
- G_TYPE_FROM_CLASS (klass),
- G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
- G_CALLBACK (gtk_widget_real_move_focus),
- NULL, NULL,
- _gtk_marshal_VOID__ENUM,
- G_TYPE_NONE,
- 1,
- GTK_TYPE_DIRECTION_TYPE);
+ g_signal_new (I_("move-focus"),
+ G_TYPE_FROM_CLASS (klass),
+ G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
+ G_STRUCT_OFFSET (GtkWidgetClass, move_focus),
+ NULL, NULL,
+ _gtk_marshal_VOID__ENUM,
+ G_TYPE_NONE,
+ 1,
+ GTK_TYPE_DIRECTION_TYPE);
+
+ /**
+ * GtkWidget::keynav-failed:
+ * @widget: the object which received the signal
+ * @direction: the direction of movement
+ *
+ * Gets emitted if keyboard navigation fails.
+ * See gtk_widget_keynav_failed() for details.
+ *
+ * Returns: %TRUE if stopping keyboard navigation is fine, %FALSE
+ * if the emitting widget should try to handle the keyboard
+ * navigation attempt in its parent container(s).
+ *
+ * Since: 2.12
+ **/
+ widget_signals[KEYNAV_FAILED] =
+ g_signal_new (I_("keynav-failed"),
+ G_TYPE_FROM_CLASS (klass),
+ G_SIGNAL_RUN_LAST,
+ G_STRUCT_OFFSET (GtkWidgetClass, keynav_failed),
+ _gtk_boolean_handled_accumulator, NULL,
+ _gtk_marshal_BOOLEAN__ENUM,
+ G_TYPE_BOOLEAN, 1,
+ GTK_TYPE_DIRECTION_TYPE);
/**
* GtkWidget::event:
*
* The GTK+ main loop will emit three signals for each GDK event delivered
* to a widget: one generic ::event signal, another, more specific,
- * signal that matches the type of event delivered (e.g.
- * #GtkWidget::key-press-event) and finally a generic
+ * signal that matches the type of event delivered (e.g.
+ * #GtkWidget::key-press-event) and finally a generic
* #GtkWidget::event-after signal.
*
- * Returns: %TRUE to stop other handlers from being invoked for the event
+ * Returns: %TRUE to stop other handlers from being invoked for the event
* and to cancel the emission of the second specific ::event signal.
- * %FALSE to propagate the event further and to allow the emission of
+ * %FALSE to propagate the event further and to allow the emission of
* the second signal. The ::event-after signal is emitted regardless of
* the return value.
*/
* @widget: the object which received the signal.
* @event: the #GdkEvent which triggered this signal
*
- * After the emission of the #GtkWidget::event signal and (optionally)
- * the second more specific signal, ::event-after will be emitted
+ * After the emission of the #GtkWidget::event signal and (optionally)
+ * the second more specific signal, ::event-after will be emitted
* regardless of the previous two signals handlers return values.
*
*/
* The ::button-press-event signal will be emitted when a button
* (typically from a mouse) is pressed.
*
- * To receive this signal, the #GdkWindow associated to the
+ * To receive this signal, the #GdkWindow associated to the
* widget needs to enable the #GDK_BUTTON_PRESS_MASK mask.
*
* This signal will be sent to the grab widget if there is one.
*
- * Returns: %TRUE to stop other handlers from being invoked for the event.
+ * Returns: %TRUE to stop other handlers from being invoked for the event.
* %FALSE to propagate the event further.
*/
widget_signals[BUTTON_PRESS_EVENT] =
* The ::button-release-event signal will be emitted when a button
* (typically from a mouse) is released.
*
- * To receive this signal, the #GdkWindow associated to the
+ * To receive this signal, the #GdkWindow associated to the
* widget needs to enable the #GDK_BUTTON_RELEASE_MASK mask.
*
* This signal will be sent to the grab widget if there is one.
*
- * Returns: %TRUE to stop other handlers from being invoked for the event.
+ * Returns: %TRUE to stop other handlers from being invoked for the event.
* %FALSE to propagate the event further.
*/
widget_signals[BUTTON_RELEASE_EVENT] =
* this signal.
*
* The ::scroll-event signal is emitted when a button in the 4 to 7
- * range is pressed. Wheel mice are usually configured to generate
+ * range is pressed. Wheel mice are usually configured to generate
* button press events for buttons 4 and 5 when the wheel is turned.
*
* To receive this signal, the #GdkWindow associated to the widget needs
*
* This signal will be sent to the grab widget if there is one.
*
- * Returns: %TRUE to stop other handlers from being invoked for the event.
+ * Returns: %TRUE to stop other handlers from being invoked for the event.
* %FALSE to propagate the event further.
*/
widget_signals[SCROLL_EVENT] =
* @event: (type Gdk.EventMotion): the #GdkEventMotion which triggered
* this signal.
*
- * The ::motion-notify-event signal is emitted when the pointer moves
+ * The ::motion-notify-event signal is emitted when the pointer moves
* over the widget's #GdkWindow.
*
- * To receive this signal, the #GdkWindow associated to the widget
+ * To receive this signal, the #GdkWindow associated to the widget
* needs to enable the #GDK_POINTER_MOTION_MASK mask.
*
* This signal will be sent to the grab widget if there is one.
*
- * Returns: %TRUE to stop other handlers from being invoked for the event.
+ * Returns: %TRUE to stop other handlers from being invoked for the event.
* %FALSE to propagate the event further.
*/
widget_signals[MOTION_NOTIFY_EVENT] =
* @widget: the object on which the signal is emitted
*
* The ::composited-changed signal is emitted when the composited
- * status of @widget<!-- -->s screen changes.
+ * status of @widget<!-- -->s screen changes.
* See gdk_screen_is_composited().
*/
widget_signals[COMPOSITED_CHANGED] =
_gtk_marshal_VOID__VOID,
G_TYPE_NONE, 0);
- /**
- * GtkWidget::keynav-failed:
- * @widget: the object which received the signal
- * @direction: the direction of movement
- *
- * Gets emitted if keyboard navigation fails.
- * See gtk_widget_keynav_failed() for details.
- *
- * Returns: %TRUE if stopping keyboard navigation is fine, %FALSE
- * if the emitting widget should try to handle the keyboard
- * navigation attempt in its parent container(s).
- *
- * Since: 2.12
- **/
- widget_signals[KEYNAV_FAILED] =
- g_signal_new_class_handler (I_("keynav-failed"),
- G_TYPE_FROM_CLASS (klass),
- G_SIGNAL_RUN_LAST,
- G_CALLBACK (gtk_widget_real_keynav_failed),
- _gtk_boolean_handled_accumulator, NULL,
- _gtk_marshal_BOOLEAN__ENUM,
- G_TYPE_BOOLEAN, 1,
- GTK_TYPE_DIRECTION_TYPE);
-
/**
* GtkWidget::delete-event:
* @widget: the object which received the signal
* this signal will cause the window to be hidden instead, so that
* it can later be shown again without reconstructing it.
*
- * Returns: %TRUE to stop other handlers from being invoked for the event.
+ * Returns: %TRUE to stop other handlers from being invoked for the event.
* %FALSE to propagate the event further.
*/
widget_signals[DELETE_EVENT] =
* @event: the event which triggered this signal
*
* The ::destroy-event signal is emitted when a #GdkWindow is destroyed.
- * You rarely get this signal, because most widgets disconnect themselves
- * from their window before they destroy it, so no widget owns the
+ * You rarely get this signal, because most widgets disconnect themselves
+ * from their window before they destroy it, so no widget owns the
* window at destroy time.
- *
+ *
* To receive this signal, the #GdkWindow associated to the widget needs
* to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
* automatically for all new windows.
*
- * Returns: %TRUE to stop other handlers from being invoked for the event.
+ * Returns: %TRUE to stop other handlers from being invoked for the event.
* %FALSE to propagate the event further.
*/
widget_signals[DESTROY_EVENT] =
*
* This signal will be sent to the grab widget if there is one.
*
- * Returns: %TRUE to stop other handlers from being invoked for the event.
+ * Returns: %TRUE to stop other handlers from being invoked for the event.
* %FALSE to propagate the event further.
*/
widget_signals[KEY_PRESS_EVENT] =
*
* This signal will be sent to the grab widget if there is one.
*
- * Returns: %TRUE to stop other handlers from being invoked for the event.
+ * Returns: %TRUE to stop other handlers from being invoked for the event.
* %FALSE to propagate the event further.
*/
widget_signals[KEY_RELEASE_EVENT] =
*
* This signal will be sent to the grab widget if there is one.
*
- * Returns: %TRUE to stop other handlers from being invoked for the event.
+ * Returns: %TRUE to stop other handlers from being invoked for the event.
* %FALSE to propagate the event further.
*/
widget_signals[ENTER_NOTIFY_EVENT] =
*
* This signal will be sent to the grab widget if there is one.
*
- * Returns: %TRUE to stop other handlers from being invoked for the event.
+ * Returns: %TRUE to stop other handlers from being invoked for the event.
* %FALSE to propagate the event further.
*/
widget_signals[LEAVE_NOTIFY_EVENT] =
* to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
* automatically for all new windows.
*
- * Returns: %TRUE to stop other handlers from being invoked for the event.
+ * Returns: %TRUE to stop other handlers from being invoked for the event.
* %FALSE to propagate the event further.
*/
widget_signals[CONFIGURE_EVENT] =
* To receive this signal, the #GdkWindow associated to the widget needs
* to enable the #GDK_FOCUS_CHANGE_MASK mask.
*
- * Returns: %TRUE to stop other handlers from being invoked for the event.
+ * Returns: %TRUE to stop other handlers from being invoked for the event.
* %FALSE to propagate the event further.
*/
widget_signals[FOCUS_IN_EVENT] =
* To receive this signal, the #GdkWindow associated to the widget needs
* to enable the #GDK_FOCUS_CHANGE_MASK mask.
*
- * Returns: %TRUE to stop other handlers from being invoked for the event.
+ * Returns: %TRUE to stop other handlers from being invoked for the event.
* %FALSE to propagate the event further.
*/
widget_signals[FOCUS_OUT_EVENT] =
* to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
* automatically for all new windows.
*
- * Returns: %TRUE to stop other handlers from being invoked for the event.
+ * Returns: %TRUE to stop other handlers from being invoked for the event.
* %FALSE to propagate the event further.
*/
widget_signals[MAP_EVENT] =
* to enable the #GDK_STRUCTURE_MASK mask. GDK will enable this mask
* automatically for all new windows.
*
- * Returns: %TRUE to stop other handlers from being invoked for the event.
+ * Returns: %TRUE to stop other handlers from being invoked for the event.
* %FALSE to propagate the event further.
*/
widget_signals[UNMAP_EVENT] =
* To receive this signal, the #GdkWindow associated to the widget needs
* to enable the #GDK_PROPERTY_CHANGE_MASK mask.
*
- * Returns: %TRUE to stop other handlers from being invoked for the event.
+ * Returns: %TRUE to stop other handlers from being invoked for the event.
* %FALSE to propagate the event further.
*/
widget_signals[PROPERTY_NOTIFY_EVENT] =
* The ::selection-clear-event signal will be emitted when the
* the @widget's window has lost ownership of a selection.
*
- * Returns: %TRUE to stop other handlers from being invoked for the event.
+ * Returns: %TRUE to stop other handlers from being invoked for the event.
* %FALSE to propagate the event further.
*/
widget_signals[SELECTION_CLEAR_EVENT] =
* another client requests ownership of the selection owned by
* the @widget's window.
*
- * Returns: %TRUE to stop other handlers from being invoked for the event.
+ * Returns: %TRUE to stop other handlers from being invoked for the event.
* %FALSE to propagate the event further.
*/
widget_signals[SELECTION_REQUEST_EVENT] =
*
* This signal will be sent to the grab widget if there is one.
*
- * Returns: %TRUE to stop other handlers from being invoked for the event.
+ * Returns: %TRUE to stop other handlers from being invoked for the event.
* %FALSE to propagate the event further.
*/
widget_signals[PROXIMITY_IN_EVENT] =
*
* This signal will be sent to the grab widget if there is one.
*
- * Returns: %TRUE to stop other handlers from being invoked for the event.
+ * Returns: %TRUE to stop other handlers from being invoked for the event.
* %FALSE to propagate the event further.
*/
widget_signals[PROXIMITY_OUT_EVENT] =
* @drag_context: the drag context
* @time: the timestamp of the motion event
*
- * The ::drag-leave signal is emitted on the drop site when the cursor
- * leaves the widget. A typical reason to connect to this signal is to
- * undo things done in #GtkWidget::drag-motion, e.g. undo highlighting
+ * The ::drag-leave signal is emitted on the drop site when the cursor
+ * leaves the widget. A typical reason to connect to this signal is to
+ * undo things done in #GtkWidget::drag-motion, e.g. undo highlighting
* with gtk_drag_unhighlight()
*/
widget_signals[DRAG_LEAVE] =
* @widget: the object which received the signal
* @drag_context: the drag context
*
- * The ::drag-begin signal is emitted on the drag source when a drag is
- * started. A typical reason to connect to this signal is to set up a
+ * The ::drag-begin signal is emitted on the drag source when a drag is
+ * started. A typical reason to connect to this signal is to set up a
* custom drag icon with gtk_drag_source_set_icon().
*
* Note that some widgets set up a drag icon in the default handler of
* @widget: the object which received the signal
* @drag_context: the drag context
*
- * The ::drag-end signal is emitted on the drag source when a drag is
- * finished. A typical reason to connect to this signal is to undo
+ * The ::drag-end signal is emitted on the drag source when a drag is
+ * finished. A typical reason to connect to this signal is to undo
* things done in #GtkWidget::drag-begin.
*/
widget_signals[DRAG_END] =
* @widget: the object which received the signal
* @drag_context: the drag context
*
- * The ::drag-data-delete signal is emitted on the drag source when a drag
- * with the action %GDK_ACTION_MOVE is successfully completed. The signal
- * handler is responsible for deleting the data that has been dropped. What
- * "delete" means depends on the context of the drag operation.
+ * The ::drag-data-delete signal is emitted on the drag source when a drag
+ * with the action %GDK_ACTION_MOVE is successfully completed. The signal
+ * handler is responsible for deleting the data that has been dropped. What
+ * "delete" means depends on the context of the drag operation.
*/
widget_signals[DRAG_DATA_DELETE] =
g_signal_new (I_("drag-data-delete"),
* guint time)
* {
* GdkAtom target;
- *
+ *
* PrivateData *private_data = GET_PRIVATE_DATA (widget);
- *
- * if (!private_data->drag_highlight)
+ *
+ * if (!private_data->drag_highlight)
* {
* private_data->drag_highlight = 1;
* gtk_drag_highlight (widget);
* }
- *
+ *
* target = gtk_drag_dest_find_target (widget, context, NULL);
* if (target == GDK_NONE)
* gdk_drag_status (context, 0, time);
- * else
+ * else
* {
* private_data->pending_status = context->suggested_action;
* gtk_drag_get_data (widget, context, target, time);
* }
- *
+ *
* return TRUE;
* }
- *
+ *
* static void
* drag_data_received (GtkWidget *widget,
* GdkDragContext *context,
* guint time)
* {
* PrivateData *private_data = GET_PRIVATE_DATA (widget);
- *
- * if (private_data->suggested_action)
+ *
+ * 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
+ * * 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))
+ * if (!data_is_acceptable (str))
* gdk_drag_status (context, 0, time);
* else
* gdk_drag_status (context, private_data->suggested_action, time);
* @time: the timestamp of the motion event
* @returns: whether the cursor position is in a drop zone
*
- * The ::drag-drop signal is emitted on the drop site when the user drops
- * the data onto the widget. The signal handler must determine whether
- * the cursor position is in a drop zone or not. If it is not in a drop
- * zone, it returns %FALSE and no further processing is necessary.
- * Otherwise, the handler returns %TRUE. In this case, the handler must
- * ensure that gtk_drag_finish() is called to let the source know that
- * the drop is done. The call to gtk_drag_finish() can be done either
- * directly or in a #GtkWidget::drag-data-received handler which gets
- * triggered by calling gtk_drag_get_data() to receive the data for one
+ * The ::drag-drop signal is emitted on the drop site when the user drops
+ * the data onto the widget. The signal handler must determine whether
+ * the cursor position is in a drop zone or not. If it is not in a drop
+ * zone, it returns %FALSE and no further processing is necessary.
+ * Otherwise, the handler returns %TRUE. In this case, the handler must
+ * ensure that gtk_drag_finish() is called to let the source know that
+ * the drop is done. The call to gtk_drag_finish() can be done either
+ * directly or in a #GtkWidget::drag-data-received handler which gets
+ * triggered by calling gtk_drag_get_data() to receive the data for one
* or more of the supported targets.
*/
widget_signals[DRAG_DROP] =
* @widget: the object which received the signal
* @drag_context: the drag context
* @data: the #GtkSelectionData to be filled with the dragged data
- * @info: the info that has been registered with the target in the
+ * @info: the info that has been registered with the target in the
* #GtkTargetList
* @time: the timestamp at which the data was requested
*
- * The ::drag-data-get signal is emitted on the drag source when the drop
- * site requests the data which is dragged. It is the responsibility of
- * the signal handler to fill @data with the data in the format which
- * is indicated by @info. See gtk_selection_data_set() and
+ * The ::drag-data-get signal is emitted on the drag source when the drop
+ * site requests the data which is dragged. It is the responsibility of
+ * the signal handler to fill @data with the data in the format which
+ * is indicated by @info. See gtk_selection_data_set() and
* gtk_selection_data_set_text().
*/
widget_signals[DRAG_DATA_GET] =
* @x: where the drop happened
* @y: where the drop happened
* @data: the received data
- * @info: the info that has been registered with the target in the
+ * @info: the info that has been registered with the target in the
* #GtkTargetList
* @time: the timestamp at which the data was received
*
- * The ::drag-data-received signal is emitted on the drop site when the
- * dragged data has been received. If the data was received in order to
- * determine whether the drop will be accepted, the handler is expected
- * to call gdk_drag_status() and <emphasis>not</emphasis> finish the drag.
- * If the data was received in response to a #GtkWidget::drag-drop signal
- * (and this is the last target to be received), the handler for this
- * signal is expected to process the received data and then call
- * gtk_drag_finish(), setting the @success parameter depending on whether
- * the data was processed successfully.
- *
- * The handler may inspect and modify @drag_context->action before calling
- * gtk_drag_finish(), e.g. to implement %GDK_ACTION_ASK as shown in the
+ * The ::drag-data-received signal is emitted on the drop site when the
+ * dragged data has been received. If the data was received in order to
+ * determine whether the drop will be accepted, the handler is expected
+ * to call gdk_drag_status() and <emphasis>not</emphasis> finish the drag.
+ * If the data was received in response to a #GtkWidget::drag-drop signal
+ * (and this is the last target to be received), the handler for this
+ * signal is expected to process the received data and then call
+ * gtk_drag_finish(), setting the @success parameter depending on whether
+ * the data was processed successfully.
+ *
+ * The handler may inspect and modify @drag_context->action before calling
+ * gtk_drag_finish(), e.g. to implement %GDK_ACTION_ASK as shown in the
* following example:
* |[
- * void
+ * void
* drag_data_received (GtkWidget *widget,
* GdkDragContext *drag_context,
* gint x,
* {
* if ((data->length >= 0) && (data->format == 8))
* {
- * if (drag_context->action == GDK_ACTION_ASK)
+ * if (drag_context->action == GDK_ACTION_ASK)
* {
* GtkWidget *dialog;
* gint response;
- *
+ *
* dialog = gtk_message_dialog_new (NULL,
- * GTK_DIALOG_MODAL |
+ * GTK_DIALOG_MODAL |
* GTK_DIALOG_DESTROY_WITH_PARENT,
* GTK_MESSAGE_INFO,
* GTK_BUTTONS_YES_NO,
* "Move the data ?\n");
* response = gtk_dialog_run (GTK_DIALOG (dialog));
* gtk_widget_destroy (dialog);
- *
+ *
* if (response == GTK_RESPONSE_YES)
* drag_context->action = GDK_ACTION_MOVE;
* else
* drag_context->action = GDK_ACTION_COPY;
* }
- *
+ *
* gtk_drag_finish (drag_context, TRUE, FALSE, time);
* return;
* }
- *
+ *
* gtk_drag_finish (drag_context, FALSE, FALSE, time);
* }
* ]|
GTK_TYPE_SELECTION_DATA | G_SIGNAL_TYPE_STATIC_SCOPE,
G_TYPE_UINT,
G_TYPE_UINT);
-
+
/**
* GtkWidget::visibility-notify-event:
* @widget: the object which received the signal
* To receive this signal the #GdkWindow associated to the widget needs
* to enable the #GDK_VISIBILITY_NOTIFY_MASK mask.
*
- * Returns: %TRUE to stop other handlers from being invoked for the event.
+ * Returns: %TRUE to stop other handlers from being invoked for the event.
* %FALSE to propagate the event further.
*/
widget_signals[VISIBILITY_NOTIFY_EVENT] =
* receives a message (via a ClientMessage event) from another
* application.
*
- * Returns: %TRUE to stop other handlers from being invoked for
+ * Returns: %TRUE to stop other handlers from being invoked for
* the event. %FALSE to propagate the event further.
*/
widget_signals[CLIENT_EVENT] =
* @event: (type Gdk.EventNoExpose): the #GdkEventNoExpose which triggered
* this signal.
*
- * The ::no-expose-event will be emitted when the @widget's window is
+ * The ::no-expose-event will be emitted when the @widget's window is
* drawn as a copy of another #GdkDrawable which was completely unobscured.
* If the source window was partially obscured #GdkEventExpose events will
* be generated for those areas.
*
- * Returns: %TRUE to stop other handlers from being invoked for the event.
+ * Returns: %TRUE to stop other handlers from being invoked for the event.
* %FALSE to propagate the event further.
*/
widget_signals[NO_EXPOSE_EVENT] =
* @event: (type Gdk.EventWindowState): the #GdkEventWindowState which
* triggered this signal.
*
- * The ::window-state-event will be emitted when the state of the
+ * The ::window-state-event will be emitted when the state of the
* toplevel window associated to the @widget changes.
*
- * To receive this signal the #GdkWindow associated to the widget
- * needs to enable the #GDK_STRUCTURE_MASK mask. GDK will enable
+ * To receive this signal the #GdkWindow associated to the widget
+ * needs to enable the #GDK_STRUCTURE_MASK mask. GDK will enable
* this mask automatically for all new windows.
*
- * Returns: %TRUE to stop other handlers from being invoked for the
+ * Returns: %TRUE to stop other handlers from being invoked for the
* event. %FALSE to propagate the event further.
*/
widget_signals[WINDOW_STATE_EVENT] =
g_signal_new (I_("damage-event"),
G_TYPE_FROM_CLASS (klass),
G_SIGNAL_RUN_LAST,
- 0,
+ G_STRUCT_OFFSET (GtkWidgetClass, damage_event),
_gtk_boolean_handled_accumulator, NULL,
_gtk_marshal_BOOLEAN__BOXED,
G_TYPE_BOOLEAN, 1,
* @widget: the object which received the signal
* @event: the #GdkEventGrabBroken event
*
- * Emitted when a pointer or keyboard grab on a window belonging
- * to @widget gets broken.
- *
- * On X11, this happens when the grab window becomes unviewable
- * (i.e. it or one of its ancestors is unmapped), or if the same
+ * Emitted when a pointer or keyboard grab on a window belonging
+ * to @widget gets broken.
+ *
+ * On X11, this happens when the grab window becomes unviewable
+ * (i.e. it or one of its ancestors is unmapped), or if the same
* application grabs the pointer or keyboard again.
*
- * Returns: %TRUE to stop other handlers from being invoked for
+ * Returns: %TRUE to stop other handlers from being invoked for
* the event. %FALSE to propagate the event further.
*
* Since: 2.8
*/
- widget_signals[GRAB_BROKEN] =
+ widget_signals[GRAB_BROKEN_EVENT] =
g_signal_new (I_("grab-broken-event"),
G_TYPE_FROM_CLASS (klass),
G_SIGNAL_RUN_LAST,
/**
* GtkWidget::query-tooltip:
* @widget: the object which received the signal
- * @x: the x coordinate of the cursor position where the request has
+ * @x: the x coordinate of the cursor position where the request has
* been emitted, relative to @widget->window
- * @y: the y coordinate of the cursor position where the request has
+ * @y: the y coordinate of the cursor position where the request has
* been emitted, relative to @widget->window
* @keyboard_mode: %TRUE if the tooltip was trigged using the keyboard
* @tooltip: a #GtkTooltip
*
- * Emitted when #GtkWidget:has-tooltip is %TRUE and the #GtkSettings:gtk-tooltip-timeout
- * has expired with the cursor hovering "above" @widget; or emitted when @widget got
+ * Emitted when #GtkWidget:has-tooltip is %TRUE and the #GtkSettings:gtk-tooltip-timeout
+ * has expired with the cursor hovering "above" @widget; or emitted when @widget got
* focus in keyboard mode.
*
* Using the given coordinates, the signal handler should determine
* GtkWidget::popup-menu
* @widget: the object which received the signal
*
- * 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"/>
+ * 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"/>
* for an example of how to use this signal.
*
* Returns: %TRUE if a menu was activated
gtk_binding_entry_add_signal (binding_set, GDK_KEY_F10, GDK_SHIFT_MASK,
"popup-menu", 0);
gtk_binding_entry_add_signal (binding_set, GDK_KEY_Menu, 0,
- "popup-menu", 0);
+ "popup-menu", 0);
gtk_binding_entry_add_signal (binding_set, GDK_KEY_F1, GDK_CONTROL_MASK,
"show-help", 1,
gtk_binding_entry_add_signal (binding_set, GDK_KEY_F1, GDK_SHIFT_MASK,
"show-help", 1,
GTK_TYPE_WIDGET_HELP_TYPE,
- GTK_WIDGET_HELP_WHATS_THIS);
+ GTK_WIDGET_HELP_WHATS_THIS);
gtk_binding_entry_add_signal (binding_set, GDK_KEY_KP_F1, GDK_SHIFT_MASK,
"show-help", 1,
GTK_TYPE_WIDGET_HELP_TYPE,
/**
* GtkWidget:wide-separators:
*
- * The "wide-separators" style property defines whether separators have
+ * The "wide-separators" style property defines whether separators have
* configurable width and should be drawn using a box instead of a line.
*
* Since: 2.10
/**
* GtkWidget:scroll-arrow-hlength:
*
- * The "scroll-arrow-hlength" style property defines the length of
+ * The "scroll-arrow-hlength" style property defines the length of
* horizontal scroll arrows.
*
* Since: 2.10
/**
* GtkWidget:scroll-arrow-vlength:
*
- * The "scroll-arrow-vlength" style property defines the length of
+ * The "scroll-arrow-vlength" style property defines the length of
* vertical scroll arrows.
*
* Since: 2.10
gtk_container_add (GTK_CONTAINER (g_value_get_object (value)), widget);
break;
case PROP_WIDTH_REQUEST:
- gtk_widget_set_usize_internal (widget, g_value_get_int (value), -2);
+ gtk_widget_set_usize_internal (widget, g_value_get_int (value), -2, 0);
break;
case PROP_HEIGHT_REQUEST:
- gtk_widget_set_usize_internal (widget, -2, g_value_get_int (value));
+ gtk_widget_set_usize_internal (widget, -2, g_value_get_int (value), 0);
break;
case PROP_VISIBLE:
gtk_widget_set_visible (widget, g_value_get_boolean (value));
tooltip_window = g_object_get_qdata (object, quark_tooltip_window);
tooltip_markup = g_value_dup_string (value);
- /* Treat an empty string as a NULL string,
+ /* Treat an empty string as a NULL string,
* because an empty string would be useless for a tooltip:
*/
if (tooltip_markup && (strlen (tooltip_markup) == 0))
tooltip_text = g_value_get_string (value);
- /* Treat an empty string as a NULL string,
+ /* Treat an empty string as a NULL string,
* because an empty string would be useless for a tooltip:
*/
if (tooltip_text && (strlen (tooltip_text) == 0))
gtk_widget_set_margin_bottom (widget, g_value_get_int (value));
g_object_thaw_notify (G_OBJECT (widget));
break;
+ case PROP_HEXPAND:
+ gtk_widget_set_hexpand (widget, g_value_get_boolean (value));
+ break;
+ case PROP_HEXPAND_SET:
+ gtk_widget_set_hexpand_set (widget, g_value_get_boolean (value));
+ break;
+ case PROP_VEXPAND:
+ gtk_widget_set_vexpand (widget, g_value_get_boolean (value));
+ break;
+ case PROP_VEXPAND_SET:
+ gtk_widget_set_vexpand_set (widget, g_value_get_boolean (value));
+ break;
+ case PROP_EXPAND:
+ g_object_freeze_notify (G_OBJECT (widget));
+ gtk_widget_set_hexpand (widget, g_value_get_boolean (value));
+ gtk_widget_set_vexpand (widget, g_value_get_boolean (value));
+ g_object_thaw_notify (G_OBJECT (widget));
+ break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
break;
+ case PROP_HEXPAND:
+ g_value_set_boolean (value, gtk_widget_get_hexpand (widget));
+ break;
+ case PROP_HEXPAND_SET:
+ g_value_set_boolean (value, gtk_widget_get_hexpand_set (widget));
+ break;
+ case PROP_VEXPAND:
+ g_value_set_boolean (value, gtk_widget_get_vexpand (widget));
+ break;
+ case PROP_VEXPAND_SET:
+ g_value_set_boolean (value, gtk_widget_get_vexpand_set (widget));
+ break;
+ case PROP_EXPAND:
+ g_value_set_boolean (value,
+ gtk_widget_get_hexpand (widget) &&
+ gtk_widget_get_vexpand (widget));
+ break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
priv->height_request_needed = TRUE;
priv->alloc_needed = TRUE;
+ /* this will be set to TRUE if the widget gets a child or if the
+ * expand flag is set on the widget, but until one of those happen
+ * we know the expand is already properly FALSE.
+ *
+ * We really want to default FALSE here to avoid computing expand
+ * all over the place while initially building a widget tree.
+ */
+ priv->need_compute_expand = FALSE;
+
priv->style = gtk_widget_get_default_style ();
g_object_ref (priv->style);
}
/**
* gtk_widget_freeze_child_notify:
* @widget: a #GtkWidget
- *
- * Stops emission of #GtkWidget::child-notify signals on @widget. The
- * signals are queued until gtk_widget_thaw_child_notify() is called
- * on @widget.
+ *
+ * Stops emission of #GtkWidget::child-notify signals on @widget. The
+ * signals are queued until gtk_widget_thaw_child_notify() is called
+ * on @widget.
*
* This is the analogue of g_object_freeze_notify() for child properties.
**/
/**
* gtk_widget_child_notify:
* @widget: a #GtkWidget
- * @child_property: the name of a child property installed on the
+ * @child_property: the name of a child property installed on the
* class of @widget<!-- -->'s parent
- *
- * Emits a #GtkWidget::child-notify signal for the
- * <link linkend="child-properties">child property</link> @child_property
+ *
+ * Emits a #GtkWidget::child-notify signal for the
+ * <link linkend="child-properties">child property</link> @child_property
* on @widget.
*
* This is the analogue of g_object_notify() for child properties.
* @widget: a #GtkWidget
*
* Reverts the effect of a previous call to gtk_widget_freeze_child_notify().
- * This causes all queued #GtkWidget::child-notify signals on @widget to be
+ * This causes all queued #GtkWidget::child-notify signals on @widget to be
* emitted.
- */
+ */
void
gtk_widget_thaw_child_notify (GtkWidget *widget)
{
* gtk_widget_new:
* @type: type ID of the widget to create
* @first_property_name: name of first property to set
- * @Varargs: value of first property, followed by more properties,
+ * @Varargs: value of first property, followed by more properties,
* %NULL-terminated
- *
+ *
* This is a convenience function for creating a widget and setting
* its properties in one go. For example you might write:
* <literal>gtk_widget_new (GTK_TYPE_LABEL, "label", "Hello World", "xalign",
* 0.0, NULL)</literal> to create a left-aligned label. Equivalent to
* g_object_new(), but returns a widget so you don't have to
* cast the object yourself.
- *
+ *
* Return value: a new #GtkWidget of type @widget_type
**/
GtkWidget*
{
GtkWidget *widget;
va_list var_args;
-
+
g_return_val_if_fail (g_type_is_a (type, GTK_TYPE_WIDGET), NULL);
-
+
va_start (var_args, first_property_name);
widget = (GtkWidget *)g_object_new_valist (type, first_property_name, var_args);
va_end (var_args);
return widget;
}
-static inline void
+static inline void
gtk_widget_queue_draw_child (GtkWidget *widget)
{
GtkWidgetPrivate *priv = widget->priv;
/**
* gtk_widget_unparent:
* @widget: a #GtkWidget
- *
+ *
* This function is only for use in widget implementations.
* Should be called by implementations of the remove method
* on #GtkContainer, to dissociate a child from the container.
GObjectNotifyQueue *nqueue;
GtkWidget *toplevel;
GtkWidget *old_parent;
-
+
g_return_if_fail (GTK_IS_WIDGET (widget));
priv = widget->priv;
if (priv->parent == NULL)
return;
-
+
/* keep this function in sync with gtk_menu_detach()
*/
*/
priv->allocation.width = 1;
priv->allocation.height = 1;
-
+
if (gtk_widget_get_realized (widget))
{
if (priv->in_reparent)
* in the next parent.
*/
priv->child_visible = TRUE;
-
+
old_parent = priv->parent;
priv->parent = NULL;
gtk_widget_set_parent_window (widget, NULL);
+
+ /* parent may no longer expand if the removed
+ * child was expand=TRUE and could therefore
+ * be forcing it to.
+ */
+ if (gtk_widget_get_visible (widget) &&
+ (priv->need_compute_expand ||
+ priv->computed_hexpand ||
+ priv->computed_vexpand))
+ {
+ gtk_widget_queue_compute_expand (old_parent);
+ }
+
g_signal_emit (widget, widget_signals[PARENT_SET], 0, old_parent);
if (toplevel)
{
_gtk_widget_propagate_hierarchy_changed (widget, toplevel);
g_object_unref (toplevel);
}
-
+
g_object_notify (G_OBJECT (widget), "parent");
g_object_thaw_notify (G_OBJECT (widget));
if (!priv->parent)
/**
* gtk_widget_show:
* @widget: a #GtkWidget
- *
+ *
* 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
g_object_ref (widget);
if (!gtk_widget_is_toplevel (widget))
gtk_widget_queue_resize (widget);
+
+ /* see comment in set_parent() for why this should and can be
+ * conditional
+ */
+ if (widget->priv->need_compute_expand ||
+ widget->priv->computed_hexpand ||
+ widget->priv->computed_vexpand)
+ {
+ if (widget->priv->parent != NULL)
+ gtk_widget_queue_compute_expand (widget->priv->parent);
+ }
+
g_signal_emit (widget, widget_signals[SHOW], 0);
g_object_notify (G_OBJECT (widget), "visible");
g_object_unref (widget);
{
*flag = TRUE;
g_signal_handlers_disconnect_by_func (widget,
- gtk_widget_show_map_callback,
+ gtk_widget_show_map_callback,
flag);
}
/**
* gtk_widget_show_now:
* @widget: a #GtkWidget
- *
+ *
* Shows a widget. If the widget is an unmapped toplevel widget
* (i.e. a #GtkWindow that has not yet been shown), enter the main
* loop and wait for the window to actually be mapped. Be careful;
gtk_widget_show_now (GtkWidget *widget)
{
gint flag = FALSE;
-
+
g_return_if_fail (GTK_IS_WIDGET (widget));
/* make sure we will get event */
gtk_widget_show (widget);
g_signal_connect (widget, "map-event",
- G_CALLBACK (gtk_widget_show_map_callback),
+ G_CALLBACK (gtk_widget_show_map_callback),
&flag);
while (!flag)
/**
* gtk_widget_hide:
* @widget: a #GtkWidget
- *
+ *
* Reverses the effects of gtk_widget_show(), causing the widget to be
* hidden (invisible to the user).
**/
gtk_widget_hide (GtkWidget *widget)
{
g_return_if_fail (GTK_IS_WIDGET (widget));
-
+
if (gtk_widget_get_visible (widget))
{
GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
-
+
g_object_ref (widget);
if (toplevel != widget && gtk_widget_is_toplevel (toplevel))
_gtk_window_unset_focus_and_default (GTK_WINDOW (toplevel), widget);
+ /* a parent may now be expand=FALSE since we're hidden. */
+ if (widget->priv->need_compute_expand ||
+ widget->priv->computed_hexpand ||
+ widget->priv->computed_vexpand)
+ {
+ gtk_widget_queue_compute_expand (widget);
+ }
+
g_signal_emit (widget, widget_signals[HIDE], 0);
if (!gtk_widget_is_toplevel (widget))
gtk_widget_queue_resize (widget);
if (gtk_widget_get_visible (widget))
{
widget->priv->visible = FALSE;
-
+
if (gtk_widget_get_mapped (widget))
gtk_widget_unmap (widget);
}
/**
* gtk_widget_hide_on_delete:
* @widget: a #GtkWidget
- *
+ *
* Utility function; intended to be connected to the #GtkWidget::delete-event
* signal on a #GtkWindow. The function calls gtk_widget_hide() on its
* argument, then returns %TRUE. If connected to ::delete-event, the
* window frame, top right corner usually) will hide but not destroy
* the window. By default, GTK+ destroys windows when ::delete-event
* is received.
- *
+ *
* Return value: %TRUE
**/
gboolean
gtk_widget_hide_on_delete (GtkWidget *widget)
{
g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
-
+
gtk_widget_hide (widget);
-
+
return TRUE;
}
/**
* gtk_widget_show_all:
* @widget: a #GtkWidget
- *
+ *
* Recursively shows a widget, and any child widgets (if the widget is
* a container).
**/
class->show_all (widget);
}
-/**
- * gtk_widget_hide_all:
- * @widget: a #GtkWidget
- *
- * Recursively hides a widget and any child widgets.
- **/
-void
-gtk_widget_hide_all (GtkWidget *widget)
-{
- GtkWidgetClass *class;
-
- g_return_if_fail (GTK_IS_WIDGET (widget));
-
- if (gtk_widget_get_no_show_all (widget))
- return;
-
- class = GTK_WIDGET_GET_CLASS (widget);
-
- if (class->hide_all)
- class->hide_all (widget);
-}
-
/**
* gtk_widget_map:
* @widget: a #GtkWidget
- *
+ *
* This function is only for use in widget implementations. Causes
* a widget to be mapped if it isn't already.
**/
/**
* gtk_widget_realize:
* @widget: a #GtkWidget
- *
+ *
* Creates the GDK (windowing system) resources associated with a
* widget. For example, @widget->window will be created when a widget
* is realized. Normally realization happens implicitly; if you show
* a widget and all its parent containers, then the widget will be
* realized and mapped automatically.
- *
+ *
* 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
* isn't very useful otherwise. Many times when you think you might
* need it, a better approach is to connect to a signal that will be
* called after the widget is realized automatically, such as
- * GtkWidget::expose-event. Or simply g_signal_connect () to the
- * GtkWidget::realize signal.
+ * #GtkWidget::expose-event. Or simply g_signal_connect () to the
+ * #GtkWidget::realize signal.
**/
void
gtk_widget_realize (GtkWidget *widget)
GtkWidgetPrivate *priv;
GdkExtensionMode mode;
cairo_region_t *region;
-
+
g_return_if_fail (GTK_IS_WIDGET (widget));
g_return_if_fail (widget->priv->anchored ||
GTK_IS_INVISIBLE (widget));
g_warning ("Calling gtk_widget_realize() on a widget that isn't "
"inside a toplevel window is not going to work very well. "
"Widgets must be inside a toplevel container before realizing them.");
-
+
if (priv->parent && !gtk_widget_get_realized (priv->parent))
gtk_widget_realize (priv->parent);
gtk_widget_ensure_style (widget);
-
+
g_signal_emit (widget, widget_signals[REALIZE], 0);
gtk_widget_real_set_has_tooltip (widget,
region = g_object_get_qdata (G_OBJECT (widget), quark_shape_info);
gdk_window_shape_combine_region (priv->window, region, 0, 0);
}
-
+
region = g_object_get_qdata (G_OBJECT (widget), quark_input_shape_info);
if (region)
gdk_window_input_shape_combine_region (priv->window, region, 0, 0);
*****************************************/
/**
- * gtk_widget_queue_draw_area:
+ * gtk_widget_queue_draw_region:
* @widget: a #GtkWidget
- * @x: x coordinate of upper-left corner of rectangle to redraw
- * @y: y coordinate of upper-left corner of rectangle to redraw
- * @width: width of region to draw
- * @height: height of region to draw
+ * @region: region to draw
*
- * Invalidates the rectangular area of @widget defined by @x, @y,
- * @width and @height by calling gdk_window_invalidate_rect() on the
- * widget's window and all its child windows. Once the main loop
- * becomes idle (after the current batch of events has been processed,
- * roughly), the window will receive expose events for the union of
- * all regions that have been invalidated.
+ * Invalidates the rectangular area of @widget defined by @region by
+ * calling 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 invalidated.
*
* Normally you would only use this function in widget
- * implementations. You might also use it, or
- * gdk_window_invalidate_rect() directly, to schedule a redraw of a
+ * implementations. You might also use it to schedule a redraw of a
* #GtkDrawingArea or some portion thereof.
- *
- * Frequently you can just call gdk_window_invalidate_rect() or
- * gdk_window_invalidate_region() instead of this function. Those
- * functions will invalidate only a single window, instead of the
- * widget and all its children.
- *
- * The advantage of adding to the invalidated region compared to
- * simply drawing immediately is efficiency; using an invalid region
- * ensures that you only have to redraw one time.
**/
-void
-gtk_widget_queue_draw_area (GtkWidget *widget,
- gint x,
- gint y,
- gint width,
- gint height)
+void
+gtk_widget_queue_draw_region (GtkWidget *widget,
+ cairo_region_t *region)
{
GtkWidgetPrivate *priv;
- GdkRectangle invalid_rect;
GtkWidget *w;
-
+
g_return_if_fail (GTK_IS_WIDGET (widget));
priv = widget->priv;
if (!gtk_widget_get_realized (widget))
return;
-
+
/* Just return if the widget or one of its ancestors isn't mapped */
for (w = widget; w != NULL; w = w->priv->parent)
if (!gtk_widget_get_mapped (w))
return;
- /* Find the correct widget */
-
- if (gtk_widget_get_has_window (widget))
- {
- if (priv->parent)
- {
- /* Translate widget relative to window-relative */
-
- gint wx, wy, wwidth, wheight;
-
- gdk_window_get_position (priv->window, &wx, &wy);
- x -= wx - priv->allocation.x;
- y -= wy - priv->allocation.y;
-
- wwidth = gdk_window_get_width (priv->window);
- wheight = gdk_window_get_height (priv->window);
-
- if (x + width <= 0 || y + height <= 0 ||
- x >= wwidth || y >= wheight)
- return;
-
- if (x < 0)
- {
- width += x; x = 0;
- }
- if (y < 0)
- {
- height += y; y = 0;
- }
- if (x + width > wwidth)
- width = wwidth - x;
- if (y + height > wheight)
- height = wheight - y;
- }
- }
-
- invalid_rect.x = x;
- invalid_rect.y = y;
- invalid_rect.width = width;
- invalid_rect.height = height;
-
- gdk_window_invalidate_rect (priv->window, &invalid_rect, TRUE);
+ gdk_window_invalidate_region (priv->window, region, TRUE);
}
/**
- * gtk_widget_queue_draw:
+ * gtk_widget_queue_draw_area:
* @widget: a #GtkWidget
+ * @x: x coordinate of upper-left corner of rectangle to redraw
+ * @y: y coordinate of upper-left corner of rectangle to redraw
+ * @width: width of region to draw
+ * @height: height of region to draw
*
- * Equivalent to calling gtk_widget_queue_draw_area() for the
- * entire area of a widget.
+ * Convenience function that calls gtk_widget_queue_draw_region() on
+ * the region created from the given coordinates.
**/
-void
-gtk_widget_queue_draw (GtkWidget *widget)
-{
- GdkRectangle rect;
-
+void
+gtk_widget_queue_draw_area (GtkWidget *widget,
+ gint x,
+ gint y,
+ gint width,
+ gint height)
+{
+ GdkRectangle rect;
+ cairo_region_t *region;
+
+ g_return_if_fail (GTK_IS_WIDGET (widget));
+
+ rect.x = x;
+ rect.y = y;
+ rect.width = width;
+ rect.height = height;
+
+ region = cairo_region_create_rectangle (&rect);
+ gtk_widget_queue_draw_region (widget, region);
+ cairo_region_destroy (region);
+}
+
+/**
+ * gtk_widget_queue_draw:
+ * @widget: a #GtkWidget
+ *
+ * Equivalent to calling gtk_widget_queue_draw_area() for the
+ * entire area of a widget.
+ **/
+void
+gtk_widget_queue_draw (GtkWidget *widget)
+{
+ GdkRectangle rect;
+
g_return_if_fail (GTK_IS_WIDGET (widget));
gtk_widget_get_allocation (widget, &rect);
if (gtk_widget_get_realized (widget))
gtk_widget_queue_shallow_draw (widget);
-
- _gtk_size_group_queue_resize (widget);
+
+ _gtk_size_group_queue_resize (widget, 0);
}
/**
* gtk_widget_queue_resize_no_redraw:
* @widget: a #GtkWidget
*
- * This function works like gtk_widget_queue_resize(),
+ * This function works like gtk_widget_queue_resize(),
* except that the widget is not invalidated.
*
* Since: 2.4
{
g_return_if_fail (GTK_IS_WIDGET (widget));
- _gtk_size_group_queue_resize (widget);
+ _gtk_size_group_queue_resize (widget, 0);
}
/**
* gtk_widget_size_request:
* @widget: a #GtkWidget
* @requisition: (out): a #GtkRequisition to be filled in
- *
+ *
* This function is typically used when implementing a #GtkContainer
* subclass. Obtains the preferred size of a widget. The container
* uses this information to arrange its child widgets and decide what
* gtk_widget_get_child_requisition:
* @widget: a #GtkWidget
* @requisition: (out): a #GtkRequisition to be filled in
- *
+ *
* This function is only for use in widget implementations. Obtains
* @widget->requisition, unless someone has forced a particular
* geometry on the widget (e.g. with gtk_widget_set_size_request()),
if (!gtk_widget_get_realized (widget))
return;
-
+
if (gtk_widget_get_has_window (widget) && priv->parent)
{
int x, y;
gboolean alloc_needed;
gboolean size_changed;
gboolean position_changed;
+ gint natural_width, natural_height;
+ gint min_width, min_height;
priv = widget->priv;
g_return_if_fail (GTK_IS_WIDGET (widget));
-
+
#ifdef G_ENABLE_DEBUG
if (gtk_get_debug_flags () & GTK_DEBUG_GEOMETRY)
{
depth++;
parent = gtk_widget_get_parent (parent);
}
-
+
name = g_type_name (G_OBJECT_TYPE (G_OBJECT (widget)));
- g_print ("gtk_widget_size_allocate: %*s%s %d %d\n",
- 2 * depth, " ", name,
+ g_print ("gtk_widget_size_allocate: %*s%s %d %d\n",
+ 2 * depth, " ", name,
allocation->width, allocation->height);
}
#endif /* G_ENABLE_DEBUG */
-
+
alloc_needed = priv->alloc_needed;
if (!priv->width_request_needed && !priv->height_request_needed)
/* Preserve request/allocate ordering */
real_allocation = *allocation;
adjusted_allocation = real_allocation;
- GTK_WIDGET_GET_CLASS (widget)->adjust_size_allocation (widget, &adjusted_allocation);
+ if (gtk_widget_get_request_mode (widget) == GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH)
+ {
+ /* Go ahead and request the height for allocated width, note that the internals
+ * of get_height_for_width will internally limit the for_size to natural size
+ * when aligning implicitly.
+ */
+ gtk_widget_get_preferred_width (widget, &min_width, &natural_width);
+ gtk_widget_get_preferred_height_for_width (widget, real_allocation.width, NULL, &natural_height);
+ }
+ else
+ {
+ /* Go ahead and request the width for allocated height, note that the internals
+ * of get_width_for_height will internally limit the for_size to natural size
+ * when aligning implicitly.
+ */
+ gtk_widget_get_preferred_height (widget, &min_height, &natural_height);
+ gtk_widget_get_preferred_width_for_height (widget, real_allocation.height, NULL, &natural_width);
+ }
+
+ /* Now that we have the right natural height and width, go ahead and remove any margins from the
+ * allocated sizes and possibly limit them to the natural sizes */
+ GTK_WIDGET_GET_CLASS (widget)->adjust_size_allocation (widget,
+ GTK_ORIENTATION_HORIZONTAL,
+ &natural_width,
+ &adjusted_allocation.x,
+ &adjusted_allocation.width);
+ GTK_WIDGET_GET_CLASS (widget)->adjust_size_allocation (widget,
+ GTK_ORIENTATION_VERTICAL,
+ &natural_height,
+ &adjusted_allocation.y,
+ &adjusted_allocation.height);
if (adjusted_allocation.x < real_allocation.x ||
adjusted_allocation.y < real_allocation.y ||
real_allocation.width,
real_allocation.height);
}
-
+
real_allocation.width = MAX (real_allocation.width, 1);
real_allocation.height = MAX (real_allocation.height, 1);
if (!alloc_needed && !size_changed && !position_changed)
return;
-
+
g_signal_emit (widget, widget_signals[SIZE_ALLOCATE], 0, &real_allocation);
if (gtk_widget_get_mapped (widget))
gdk_window_invalidate_region (priv->window, invalidate, FALSE);
cairo_region_destroy (invalidate);
}
-
+
if (size_changed)
{
if (priv->redraw_on_alloc)
* gtk_widget_common_ancestor:
* @widget_a: a #GtkWidget
* @widget_b: a #GtkWidget
- *
+ *
* Find the common ancestor of @widget_a and @widget_b that
* is closest to the two widgets.
- *
+ *
* Return value: the closest common ancestor of @widget_a and
* @widget_b or %NULL if @widget_a and @widget_b do not
* share a common ancestor.
* relative to @dest_widget's allocations. In order to perform this
* operation, both widgets must be realized, and must share a common
* toplevel.
- *
+ *
* Return value: %FALSE if either widget was not realized, or there
* was no common ancestor. In this case, nothing is stored in
* *@dest_x and *@dest_y. Otherwise %TRUE.
}
static void
-get_span_inside_border (GtkWidget *widget,
- GtkAlign align,
- int start_pad,
- int end_pad,
- int allocated_outside_size,
- int natural_inside_size,
- int *coord_inside_p,
- int *size_inside_p)
+adjust_for_align(GtkAlign align,
+ gint *natural_size,
+ gint *allocated_pos,
+ gint *allocated_size)
{
- int inside_allocated;
- int content_size;
- int coord, size;
-
- inside_allocated = allocated_outside_size - start_pad - end_pad;
-
- content_size = natural_inside_size;
- if (content_size > inside_allocated)
- {
- /* didn't get full natural size */
- content_size = inside_allocated;
- }
-
- coord = size = 0; /* silence compiler */
switch (align)
{
case GTK_ALIGN_FILL:
- coord = start_pad;
- size = inside_allocated;
+ /* change nothing */
break;
case GTK_ALIGN_START:
- coord = start_pad;
- size = content_size;
+ /* keep *allocated_pos where it is */
+ *allocated_size = MIN (*allocated_size, *natural_size);
break;
case GTK_ALIGN_END:
- coord = allocated_outside_size - end_pad - content_size;
- size = content_size;
+ if (*allocated_size > *natural_size)
+ {
+ *allocated_pos += (*allocated_size - *natural_size);
+ *allocated_size = *natural_size;
+ }
break;
case GTK_ALIGN_CENTER:
- coord = start_pad + (inside_allocated - content_size) / 2;
- size = content_size;
+ if (*allocated_size > *natural_size)
+ {
+ *allocated_pos += (*allocated_size - *natural_size) / 2;
+ *allocated_size = MIN (*allocated_size, *natural_size);
+ }
break;
}
-
- if (coord_inside_p)
- *coord_inside_p = coord;
-
- if (size_inside_p)
- *size_inside_p = size;
-}
-
-static void
-get_span_inside_border_horizontal (GtkWidget *widget,
- const GtkWidgetAuxInfo *aux_info,
- int allocated_outside_width,
- int natural_inside_width,
- int *x_inside_p,
- int *width_inside_p)
-{
- get_span_inside_border (widget,
- aux_info->halign,
- aux_info->margin.left,
- aux_info->margin.right,
- allocated_outside_width,
- natural_inside_width,
- x_inside_p,
- width_inside_p);
}
static void
-get_span_inside_border_vertical (GtkWidget *widget,
- const GtkWidgetAuxInfo *aux_info,
- int allocated_outside_height,
- int natural_inside_height,
- int *y_inside_p,
- int *height_inside_p)
-{
- get_span_inside_border (widget,
- aux_info->valign,
- aux_info->margin.top,
- aux_info->margin.bottom,
- allocated_outside_height,
- natural_inside_height,
- y_inside_p,
- height_inside_p);
+adjust_for_margin(gint start_margin,
+ gint end_margin,
+ gint *natural_size,
+ gint *allocated_pos,
+ gint *allocated_size)
+{
+ *natural_size -= (start_margin + end_margin);
+ *allocated_pos += start_margin;
+ *allocated_size -= (start_margin + end_margin);
}
static void
gtk_widget_real_adjust_size_allocation (GtkWidget *widget,
- GtkAllocation *allocation)
+ GtkOrientation orientation,
+ gint *natural_size,
+ gint *allocated_pos,
+ gint *allocated_size)
{
const GtkWidgetAuxInfo *aux_info;
- gint natural_width;
- gint natural_height;
- int x, y, w, h;
aux_info = _gtk_widget_get_aux_info_or_defaults (widget);
- if (gtk_widget_get_request_mode (widget) == GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH)
+ if (orientation == GTK_ORIENTATION_HORIZONTAL)
{
- gtk_widget_get_preferred_width (widget, NULL, &natural_width);
- get_span_inside_border_horizontal (widget,
- aux_info,
- allocation->width,
- natural_width,
- &x, &w);
-
- gtk_widget_get_preferred_height_for_width (widget, w, NULL, &natural_height);
- get_span_inside_border_vertical (widget,
- aux_info,
- allocation->height,
- natural_height,
- &y, &h);
+ adjust_for_margin (aux_info->margin.left,
+ aux_info->margin.right,
+ natural_size, allocated_pos, allocated_size);
+ adjust_for_align (aux_info->halign,
+ natural_size, allocated_pos, allocated_size);
}
- else /* GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT */
+ else
{
- gtk_widget_get_preferred_height (widget, NULL, &natural_height);
- get_span_inside_border_vertical (widget,
- aux_info,
- allocation->height,
- natural_height,
- &y, &h);
-
- gtk_widget_get_preferred_width_for_height (widget, h, NULL, &natural_width);
- get_span_inside_border_horizontal (widget,
- aux_info,
- allocation->width,
- natural_width,
- &x, &w);
+ adjust_for_margin (aux_info->margin.top,
+ aux_info->margin.bottom,
+ natural_size, allocated_pos, allocated_size);
+ adjust_for_align (aux_info->valign,
+ natural_size, allocated_pos, allocated_size);
}
-
- allocation->x += x;
- allocation->y += y;
- allocation->width = w;
- allocation->height = h;
}
static gboolean
* gtk_widget_can_activate_accel:
* @widget: a #GtkWidget
* @signal_id: the ID of a signal installed on @widget
- *
+ *
* 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
g_closure_set_marshal (closure, closure_accel_activate);
}
g_object_set_qdata_full (G_OBJECT (widget), quark_accel_closures, closures, closures_destroy);
-
+
aclosure = (AccelClosure*) closure;
g_assert (closure->data == widget);
g_assert (closure->marshal == closure_accel_activate);
GtkAccelGroupEntry *ag_entry;
GList *slist, *clist;
guint n;
-
+
g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), FALSE);
/* closures_destroy takes care of unrefing the closure */
g_object_unref (apath->accel_group);
-
+
g_slice_free (AccelPath, apath);
}
* Even when you you aren't using #GtkUIManager, if you only want to
* set up accelerators on menu items gtk_menu_item_set_accel_path()
* provides a somewhat more convenient interface.
- *
+ *
* Note that @accel_path string will be stored in a #GQuark. Therefore, if you
- * pass a static string, you can save some memory by interning it first with
+ * pass a static string, you can save some memory by interning it first with
* g_intern_static_string().
**/
void
* @group_cycling: %TRUE if there are other widgets with the same mnemonic
*
* Emits the #GtkWidget::mnemonic-activate signal.
- *
+ *
* The default handler for this signal activates the @widget if
* @group_cycling is %FALSE, and just grabs the focus if @group_cycling
* is %TRUE.
gboolean group_cycling)
{
gboolean handled;
-
+
g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
group_cycling = group_cycling != FALSE;
* @cr: a cairo context
* @window: the window to check
*
- * This function is supposed to be called in GtkWidget::draw
+ * This function is supposed to be called in #GtkWidget::draw
* implementations for widgets that support multiple windows.
* @cr must be untransformed from invoking of the draw function.
* This function will return %TRUE if the contents of the given
g_return_val_if_fail (GDK_IS_WINDOW (window), FALSE);
event = _gtk_cairo_get_event (cr);
-
+
return event == NULL ||
event->window == window;
}
if (clip_to_size)
{
- cairo_rectangle (cr,
+ cairo_rectangle (cr,
0, 0,
widget->priv->allocation.width,
widget->priv->allocation.height);
{
gboolean result;
- g_signal_emit (widget, widget_signals[DRAW],
+ g_signal_emit (widget, widget_signals[DRAW],
0, cr,
&result);
}
/**
* gtk_widget_draw:
- * @widget: the widget to draw. It must be drawable (see
+ * @widget: the widget to draw. It must be drawable (see
* gtk_widget_is_drawable()) and a size must have been allocated.
* @cr: a cairo context to draw to
*
* gtk_widget_event:
* @widget: a #GtkWidget
* @event: a #GdkEvent
- *
+ *
* 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).
* it were in the event queue. Don't synthesize expose events; instead,
* use gdk_window_invalidate_rect() to invalidate a region of the
* window.
- *
- * Return value: return from the event signal emission (%TRUE if
+ *
+ * Return value: return from the event signal emission (%TRUE if
* the event was handled)
**/
gboolean
"followed by gdk_window_process_updates().");
return TRUE;
}
-
+
return gtk_widget_event_internal (widget, event);
}
*y += wy;
}
- if (w == NULL)
- {
+ if (w == NULL)
+ {
*x = 0;
*y = 0;
return FALSE;
* modification will be applied.
*
* This is the inverse to the transformation GTK applies when
- * preparing an expose event to be emitted with the GtkWidget::draw
+ * preparing an expose event to be emitted with the #GtkWidget::draw
* signal. It is intended to help porting multiwindow widgets from
- * GTK 2 to the rendering architecture of GTK 3.
+ * GTK+ 2 to the rendering architecture of GTK+ 3.
**/
void
gtk_cairo_transform_to_window (cairo_t *cr,
* gtk_widget_send_expose:
* @widget: a #GtkWidget
* @event: a expose #GdkEvent
- *
+ *
* Very rarely-used function. This function is used to emit
* an expose event on a widget. This function is not normally used
* directly. The only time it is used is when propagating an expose
* event to a child %NO_WINDOW widget, and that is normally done
* using gtk_container_propagate_draw().
*
- * If you want to force an area of a window to be redrawn,
+ * If you want to force an area of a window to be redrawn,
* use gdk_window_invalidate_rect() or gdk_window_invalidate_region().
* To cause the redraw to be done immediately, follow that call
* with a call to gdk_window_process_updates().
- *
- * Return value: return from the event signal emission (%TRUE if
+ *
+ * Return value: return from the event signal emission (%TRUE if
* the event was handled)
**/
gint
case GDK_KEY_RELEASE:
case GDK_LEAVE_NOTIFY:
case GDK_PROXIMITY_OUT:
-#endif
-
+#endif
+
default:
/* Remaining events would make sense on an not-viewable window,
* or don't have an associated window.
signal_num = VISIBILITY_NOTIFY_EVENT;
break;
case GDK_GRAB_BROKEN:
- signal_num = GRAB_BROKEN;
+ signal_num = GRAB_BROKEN_EVENT;
break;
case GDK_DAMAGE:
signal_num = DAMAGE_EVENT;
/**
* gtk_widget_activate:
* @widget: a #GtkWidget that's activatable
- *
+ *
* 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
+ * press Enter on a widget during key navigation. If @widget isn't
* activatable, the function returns %FALSE.
- *
+ *
* Return value: %TRUE if the widget was activatable
**/
gboolean
gtk_widget_activate (GtkWidget *widget)
{
g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
-
+
if (WIDGET_CLASS (widget)->activate_signal)
{
/* FIXME: we should eventually check the signals signature here */
return FALSE;
}
-/**
- * gtk_widget_set_scroll_adjustments:
- * @widget: a #GtkWidget
- * @hadjustment: (allow-none): an adjustment for horizontal scrolling, or %NULL
- * @vadjustment: (allow-none): an adjustment for vertical scrolling, or %NULL
- *
- * For widgets that support scrolling, sets the scroll adjustments and
- * returns %TRUE. For widgets that don't support scrolling, does
- * nothing and returns %FALSE. Widgets that don't support scrolling
- * can be scrolled by placing them in a #GtkViewport, which does
- * support scrolling.
- *
- * Return value: %TRUE if the widget supports scrolling
- **/
-gboolean
-gtk_widget_set_scroll_adjustments (GtkWidget *widget,
- GtkAdjustment *hadjustment,
- GtkAdjustment *vadjustment)
-{
- guint signal_id;
- GSignalQuery query;
-
- g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
-
- if (hadjustment)
- g_return_val_if_fail (GTK_IS_ADJUSTMENT (hadjustment), FALSE);
- if (vadjustment)
- g_return_val_if_fail (GTK_IS_ADJUSTMENT (vadjustment), FALSE);
-
- signal_id = WIDGET_CLASS (widget)->set_scroll_adjustments_signal;
- if (!signal_id)
- return FALSE;
-
- g_signal_query (signal_id, &query);
- if (!query.signal_id ||
- !g_type_is_a (query.itype, GTK_TYPE_WIDGET) ||
- query.return_type != G_TYPE_NONE ||
- query.n_params != 2 ||
- query.param_types[0] != GTK_TYPE_ADJUSTMENT ||
- query.param_types[1] != GTK_TYPE_ADJUSTMENT)
- {
- g_warning (G_STRLOC ": signal \"%s::%s\" has wrong signature",
- G_OBJECT_TYPE_NAME (widget), query.signal_name);
- return FALSE;
- }
-
- g_signal_emit (widget, signal_id, 0, hadjustment, vadjustment);
- return TRUE;
-}
-
static void
gtk_widget_reparent_subwindows (GtkWidget *widget,
GdkWindow *new_window)
else
{
children = gdk_window_get_children (parent);
-
+
for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
{
GdkWindow *window = tmp_list->data;
if (child == widget)
gdk_window_reparent (window, new_window, 0, 0);
}
-
+
g_list_free (children);
}
}
GtkWidgetPrivate *priv = widget->priv;
g_assert (client_data != NULL);
-
+
if (!gtk_widget_get_has_window (widget))
{
if (priv->window)
*/
if (gtk_widget_get_realized (widget) && gtk_widget_get_realized (new_parent))
priv->in_reparent = TRUE;
-
+
g_object_ref (widget);
gtk_container_remove (GTK_CONTAINER (priv->parent), widget);
gtk_container_add (GTK_CONTAINER (new_parent), widget);
g_object_unref (widget);
-
+
if (priv->in_reparent)
{
priv->in_reparent = FALSE;
* @widget: a #GtkWidget
* @area: a rectangle
* @intersection: rectangle to store intersection of @widget and @area
- *
+ *
* Computes the intersection of a @widget's area and @area, storing
* the intersection in @intersection, and returns %TRUE if there was
* an intersection. @intersection may be %NULL if you're only
* interested in whether there was an intersection.
- *
+ *
* Return value: %TRUE if there was an intersection
**/
gboolean
GdkRectangle *dest;
GdkRectangle tmp;
gint return_val;
-
+
g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
g_return_val_if_fail (area != NULL, FALSE);
dest = intersection;
else
dest = &tmp;
-
+
return_val = gdk_rectangle_intersect (&priv->allocation, area, dest);
-
+
if (return_val && intersection && gtk_widget_get_has_window (widget))
{
intersection->x -= priv->allocation.x;
intersection->y -= priv->allocation.y;
}
-
+
return return_val;
}
/**
* gtk_widget_region_intersect:
* @widget: a #GtkWidget
- * @region: a #cairo_region_t, in the same coordinate system as
+ * @region: a #cairo_region_t, in the same coordinate system as
* @widget->allocation. That is, relative to @widget->window
* for %NO_WINDOW widgets; relative to the parent window
* of @widget->window for widgets with their own window.
* relative to @widget->window for %NO_WINDOW widgets, and
* relative to the parent window of @widget->window for
* widgets with their own window.
- *
+ *
* 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.
{
GdkRectangle rect;
cairo_region_t *dest;
-
+
g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
g_return_val_if_fail (region != NULL, NULL);
gtk_widget_get_allocation (widget, &rect);
-
+
dest = cairo_region_create_rectangle (&rect);
-
+
cairo_region_intersect (dest, region);
return dest;
* _gtk_widget_grab_notify:
* @widget: a #GtkWidget
* @was_grabbed: whether a grab is now in effect
- *
+ *
* Emits the #GtkWidget::grab-notify signal on @widget.
- *
+ *
* Since: 2.6
**/
void
/**
* gtk_widget_grab_focus:
* @widget: a #GtkWidget
- *
+ *
* 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.
if (!gtk_widget_is_sensitive (widget))
return;
-
+
g_object_ref (widget);
g_signal_emit (widget, widget_signals[GRAB_FOCUS], 0);
g_object_notify (G_OBJECT (widget), "has-focus");
{
GtkWidget *toplevel;
GtkWidget *widget;
-
+
/* clear the current focus setting, break if the current widget
* is the focus widget's parent, since containers above that will
* be set by the next loop.
return;
}
-
+
if (widget)
{
while (widget->priv->parent && widget->priv->parent != focus_widget->priv->parent)
/* gtk_widget_grab_focus() operates on a tree without window...
* actually, this is very questionable behaviour.
*/
-
+
gtk_container_foreach (GTK_CONTAINER (toplevel),
reset_focus_recurse,
NULL);
{
if (!gtk_widget_get_can_focus (widget))
return FALSE;
-
+
if (!gtk_widget_is_focus (widget))
{
gtk_widget_grab_focus (widget);
{
GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
- if (GTK_IS_WINDOW (toplevel) &&
- GTK_WINDOW_GET_CLASS (toplevel)->move_focus)
+ if (widget != toplevel && GTK_IS_WINDOW (toplevel))
{
- GTK_WINDOW_GET_CLASS (toplevel)->move_focus (GTK_WINDOW (toplevel),
- direction);
+ g_signal_emit (toplevel, widget_signals[MOVE_FOCUS], 0,
+ direction);
}
}
/**
* gtk_widget_is_focus:
* @widget: a #GtkWidget
- *
+ *
* Determines if the widget is the focus widget within its
* toplevel. (This does not mean that the %HAS_FOCUS flag is
* necessarily set; %HAS_FOCUS will only be set if the
* toplevel widget additionally has the global input focus.)
- *
+ *
* Return value: %TRUE if the widget is the focus widget.
**/
gboolean
g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
toplevel = gtk_widget_get_toplevel (widget);
-
+
if (GTK_IS_WINDOW (toplevel))
return widget == gtk_window_get_focus (GTK_WINDOW (toplevel));
else
* Causes @widget to become the default widget. @widget must have the
* %GTK_CAN_DEFAULT flag set; typically you have to set this flag
* yourself by calling <literal>gtk_widget_set_can_default (@widget,
- * %TRUE)</literal>. The default widget is activated when
- * the user presses Enter in a window. Default widgets must be
+ * %TRUE)</literal>. The default widget is activated when
+ * the user presses Enter in a window. Default widgets must be
* activatable, that is, gtk_widget_activate() should affect them. Note
* that #GtkEntry widgets require the "activates-default" property
* set to %TRUE before they activate the default widget when Enter
gtk_widget_grab_default (GtkWidget *widget)
{
GtkWidget *window;
-
+
g_return_if_fail (GTK_IS_WIDGET (widget));
g_return_if_fail (gtk_widget_get_can_default (widget));
-
+
window = gtk_widget_get_toplevel (widget);
-
+
if (window && gtk_widget_is_toplevel (window))
gtk_window_set_default (GTK_WINDOW (window), widget);
else
* gtkrc file. You can apply a style to widgets with a particular name
* in the gtkrc file. See the documentation for gtkrc files (on the
* same page as the docs for #GtkRcStyle).
- *
- * Note that widget names are separated by periods in paths (see
+ *
+ * Note that widget names are separated by periods in paths (see
* gtk_widget_path()), so names with embedded periods may cause confusion.
**/
void
{
GtkWidgetPrivate *priv;
gchar *new_name;
-
+
g_return_if_fail (GTK_IS_WIDGET (widget));
priv = widget->priv;
/**
* gtk_widget_get_name:
* @widget: a #GtkWidget
- *
+ *
* Retrieves the name of a widget. See gtk_widget_set_name() for the
* significance of widget names.
- *
+ *
* Return value: name of the widget. This string is owned by GTK+ and
* should not be modified or freed
**/
data.parent_sensitive = TRUE;
gtk_widget_propagate_state (widget, &data);
-
+
if (gtk_widget_is_drawable (widget))
gtk_widget_queue_draw (widget);
}
* (gtk_widget_get_window() never returns a %NULL window when a widget
* is realized), but for many of them it's actually the #GdkWindow of
* one of its parent widgets. Widgets that do not create a %window for
- * themselves in GtkWidget::realize() must announce this by
+ * themselves in #GtkWidget::realize must announce this by
* calling this function with @has_window = %FALSE.
*
* This function should only be called by widget implementations,
* @app_paintable: %TRUE if the application will paint on the widget
*
* Sets whether the application intends to draw on the widget in
- * an #GtkWidget::draw handler.
+ * an #GtkWidget::draw handler.
*
- * This is a hint to the widget and does not affect the behavior of
- * the GTK+ core; many widgets ignore this flag entirely. For widgets
- * that do pay attention to the flag, such as #GtkEventBox and #GtkWindow,
- * the effect is to suppress default themed drawing of the widget's
- * background. (Children of the widget will still be drawn.) The application
+ * This is a hint to the widget and does not affect the behavior of
+ * the GTK+ core; many widgets ignore this flag entirely. For widgets
+ * that do pay attention to the flag, such as #GtkEventBox and #GtkWindow,
+ * the effect is to suppress default themed drawing of the widget's
+ * background. (Children of the widget will still be drawn.) The application
* is then entirely responsible for drawing the widget background.
*
* Note that the background is still drawn when the widget is mapped.
* In very simple terms, double buffered widgets don't flicker,
* so you would only use this function to turn off double buffering
* if you had special needs and really knew what you were doing.
- *
+ *
* Note: if you turn off double-buffering, you have to handle
- * expose events, since even the clearing to the background color or
- * pixmap will not happen automatically (as it is done in
+ * expose events, since even the clearing to the background color or
+ * pixmap will not happen automatically (as it is done in
* gdk_window_begin_paint()).
**/
void
* when it is allocated to a new size. Otherwise, only the
* new portion of the widget will be redrawn.
*
- * Sets whether the entire widget is queued for drawing when its size
+ * Sets whether the entire widget is queued for drawing when its size
* allocation changes. By default, this setting is %TRUE and
* the entire widget is redrawn on every size change. If your widget
* leaves the upper left unchanged when made bigger, turning this
* off all allocation on resizing: the widget will not even redraw if
* its position changes; this is to allow containers that don't draw
* anything to avoid excess invalidations. If you set this flag on a
- * %NO_WINDOW widget that <emphasis>does</emphasis> draw on @widget->window,
- * you are responsible for invalidating both the old and new allocation
+ * %NO_WINDOW widget that <emphasis>does</emphasis> draw on @widget->window,
+ * you are responsible for invalidating both the old and new allocation
* of the widget when the widget is moved and responsible for invalidating
* regions newly when the widget increases size.
**/
* @widget: a #GtkWidget
* @parent: parent container
*
- * This function is useful only when implementing subclasses of
+ * This function is useful only when implementing subclasses of
* #GtkContainer.
* Sets the container as the parent of @widget, and takes care of
* some details such as updating the state and style of the child
{
GtkWidgetPrivate *priv;
GtkStateData data;
-
+
g_return_if_fail (GTK_IS_WIDGET (widget));
g_return_if_fail (GTK_IS_WIDGET (parent));
g_return_if_fail (widget != parent);
data.use_forall = gtk_widget_is_sensitive (parent) != gtk_widget_is_sensitive (widget);
gtk_widget_propagate_state (widget, &data);
-
+
gtk_widget_reset_rc_styles (widget);
g_signal_emit (widget, widget_signals[PARENT_SET], 0, NULL);
gtk_widget_queue_resize (widget);
}
+
+ /* child may cause parent's expand to change, if the child is
+ * expanded. If child is not expanded, then it can't modify the
+ * parent's expand. If the child becomes expanded later then it will
+ * queue compute_expand then. This optimization plus defaulting
+ * newly-constructed widgets to need_compute_expand=FALSE should
+ * mean that initially building a widget tree doesn't have to keep
+ * walking up setting need_compute_expand on parents over and over.
+ *
+ * We can't change a parent to need to expand unless we're visible.
+ */
+ if (gtk_widget_get_visible (widget) &&
+ (priv->need_compute_expand ||
+ priv->computed_hexpand ||
+ priv->computed_vexpand))
+ {
+ gtk_widget_queue_compute_expand (parent);
+ }
}
/**
gboolean initial_emission;
initial_emission = !widget->priv->rc_style && !widget->priv->user_style;
-
+
widget->priv->rc_style = FALSE;
widget->priv->user_style = TRUE;
-
+
gtk_widget_set_style_internal (widget, style, initial_emission);
}
else
/**
* gtk_widget_get_style:
* @widget: a #GtkWidget
- *
+ *
* Simply an accessor function that returns @widget->style.
*
* Return value: (transfer none): the widget's #GtkStyle
* gtk_widget_modify_style:
* @widget: a #GtkWidget
* @style: the #GtkRcStyle holding the style modifications
- *
+ *
* Modifies style values on the widget. Modifications made using this
* technique take precedence over style values set via an RC file,
* however, they will be overriden if a style is explicitely set on
* to such functions gtk_widget_modify_fg() will have a cumulative
* effect with the initial modifications.
**/
-void
+void
gtk_widget_modify_style (GtkWidget *widget,
GtkRcStyle *style)
{
g_return_if_fail (GTK_IS_WIDGET (widget));
g_return_if_fail (GTK_IS_RC_STYLE (style));
-
+
g_object_set_qdata_full (G_OBJECT (widget),
quark_rc_style,
gtk_rc_style_copy (style),
/* note that "style" may be invalid here if it was the old
* modifier style and the only reference was our own.
*/
-
+
if (widget->priv->rc_style)
gtk_widget_reset_rc_style (widget);
}
/**
* gtk_widget_get_modifier_style:
* @widget: a #GtkWidget
- *
+ *
* Returns the current modifier style for the widget. (As set by
* gtk_widget_modify_style().) If no style has previously set, a new
* #GtkRcStyle will be created with all values unset, and set as the
gtk_widget_get_modifier_style (GtkWidget *widget)
{
GtkRcStyle *rc_style;
-
+
g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
rc_style = g_object_get_qdata (G_OBJECT (widget), quark_rc_style);
GtkStateType state,
const GdkColor *color)
{
- GtkRcStyle *rc_style = gtk_widget_get_modifier_style (widget);
+ GtkRcStyle *rc_style = gtk_widget_get_modifier_style (widget);
if (color)
{
default:
g_assert_not_reached();
}
-
+
rc_style->color_flags[state] |= component;
}
else
*
* Sets the background color for a widget in a particular state.
* All other style values are left untouched. See also
- * gtk_widget_modify_style().
+ * gtk_widget_modify_style().
*
* Note that "no window" widgets (which have the %GTK_NO_WINDOW flag set)
- * draw on their parent container's window and thus may not draw any
- * background themselves. This is the case for e.g. #GtkLabel. To modify
- * the background of such widgets, you have to set the background color
- * on their parent; if you want to set the background of a rectangular
- * area around a label, try placing the label in a #GtkEventBox widget
+ * 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.
**/
void
* and #GtkTextView. See also gtk_widget_modify_style().
*
* Note that "no window" widgets (which have the %GTK_NO_WINDOW flag set)
- * draw on their parent container's window and thus may not draw any
- * background themselves. This is the case for e.g. #GtkLabel. To modify
- * the background of such widgets, you have to set the base color on their
- * parent; if you want to set the background of a rectangular area around
- * a label, try placing the label in a #GtkEventBox widget and setting
+ * 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.
**/
void
*
* Sets the cursor color to use in a widget, overriding the
* #GtkWidget:cursor-color and #GtkWidget:secondary-cursor-color
- * style properties. All other style values are left untouched.
+ * style properties. All other style values are left untouched.
* See also gtk_widget_modify_style().
*
* Since: 2.12
g_return_if_fail (GTK_IS_WIDGET (widget));
- rc_style = gtk_widget_get_modifier_style (widget);
+ rc_style = gtk_widget_get_modifier_style (widget);
if (rc_style->font_desc)
pango_font_description_free (rc_style->font_desc);
rc_style->font_desc = pango_font_description_copy (font_desc);
else
rc_style->font_desc = NULL;
-
+
gtk_widget_modify_style (widget, rc_style);
}
if (context)
g_object_set_qdata (G_OBJECT (widget), quark_pango_context, NULL);
}
-
+
_gtk_tooltip_hide (widget);
g_signal_emit (widget, widget_signals[SCREEN_CHANGED], 0, old_screen);
}
g_object_ref (widget);
priv->anchored = new_anchored;
-
+
g_signal_emit (widget, widget_signals[HIERARCHY_CHANGED], 0, info->previous_toplevel);
do_screen_change (widget, info->previous_screen, info->new_screen);
-
+
if (GTK_IS_CONTAINER (widget))
gtk_container_forall (GTK_CONTAINER (widget),
gtk_widget_propagate_hierarchy_changed_recurse,
client_data);
-
+
g_object_unref (widget);
}
}
* _gtk_widget_propagate_hierarchy_changed:
* @widget: a #GtkWidget
* @previous_toplevel: Previous toplevel
- *
+ *
* Propagates changes in the anchored state to a widget and all
* children, unsetting or setting the %ANCHORED flag, and
* emitting #GtkWidget::hierarchy-changed.
HierarchyChangedInfo *info = client_data;
g_object_ref (widget);
-
+
do_screen_change (widget, info->previous_screen, info->new_screen);
-
+
if (GTK_IS_CONTAINER (widget))
gtk_container_forall (GTK_CONTAINER (widget),
gtk_widget_propagate_screen_changed_recurse,
client_data);
-
+
g_object_unref (widget);
}
/**
* gtk_widget_is_composited:
* @widget: a #GtkWidget
- *
+ *
* Whether @widget can rely on having its alpha channel
* drawn correctly. On X11 this function returns whether a
* compositing manager is running for @widget's screen.
* Please note that the semantics of this call will change
* in the future if used on a widget that has a composited
* window in its hierarchy (as set by gdk_window_set_composited()).
- *
+ *
* Return value: %TRUE if the widget can rely on its alpha
* channel being drawn correctly.
- *
+ *
* Since: 2.10
*/
gboolean
GdkScreen *screen;
g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
-
+
screen = gtk_widget_get_screen (widget);
-
+
return gdk_screen_is_composited (screen);
}
propagate_composited_changed,
NULL);
}
-
+
g_signal_emit (widget, widget_signals[COMPOSITED_CHANGED], 0);
}
* _gtk_widget_propagate_screen_changed:
* @widget: a #GtkWidget
* @previous_screen: Previous screen
- *
+ *
* Propagates changes in the screen for a widget to all
* children, emitting #GtkWidget::screen-changed.
**/
{
if (widget->priv->rc_style)
gtk_widget_reset_rc_style (widget);
-
+
if (GTK_IS_CONTAINER (widget))
gtk_container_forall (GTK_CONTAINER (widget),
reset_rc_styles_recurse,
/**
* gtk_widget_get_default_style:
- *
+ *
* Returns the default style used by all widgets initially.
*
* Returns: (transfer none): the default style. This #GtkStyle object is owned
gtk_default_style = gtk_style_new ();
g_object_ref (gtk_default_style);
}
-
+
return gtk_default_style;
}
/**
* gtk_widget_get_pango_context:
* @widget: a #GtkWidget
- *
+ *
* Gets a #PangoContext with the appropriate font map, font description,
* and base direction for this widget. Unlike the context returned
* by gtk_widget_create_pango_context(), this context is owned by
*
* If you create and keep a #PangoLayout using this context, you must
* deal with changes to the context by calling pango_layout_context_changed()
- * on the layout in response to the #GtkWidget::style-set and
+ * on the layout in response to the #GtkWidget::style-set and
* #GtkWidget::direction-changed signals for the widget.
*
* Return value: (transfer none): the #PangoContext for the widget.
PangoContext *context;
g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
-
+
context = g_object_get_qdata (G_OBJECT (widget), quark_pango_context);
if (!context)
{
gtk_widget_update_pango_context (GtkWidget *widget)
{
PangoContext *context = gtk_widget_peek_pango_context (widget);
-
+
if (context)
{
GdkScreen *screen;
GtkWidgetPrivate *priv;
GtkIconSet *icon_set;
GdkPixbuf *retval;
-
+
g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
g_return_val_if_fail (stock_id != NULL, NULL);
g_return_val_if_fail (size > GTK_ICON_SIZE_INVALID || size == -1, NULL);
priv = widget->priv;
gtk_widget_ensure_style (widget);
-
+
icon_set = gtk_style_lookup_icon_set (priv->style, stock_id);
if (icon_set == NULL)
* gtk_widget_set_parent_window:
* @widget: a #GtkWidget.
* @parent_window: the new parent window.
- *
+ *
* Sets a non default parent window for @widget.
**/
void
GdkWindow *old_parent_window;
g_return_if_fail (GTK_IS_WIDGET (widget));
-
+
old_parent_window = g_object_get_qdata (G_OBJECT (widget),
quark_parent_window);
if (parent_window != old_parent_window)
{
- g_object_set_qdata (G_OBJECT (widget), quark_parent_window,
+ g_object_set_qdata (G_OBJECT (widget), quark_parent_window,
parent_window);
if (old_parent_window)
g_object_unref (old_parent_window);
* @is_visible: if %TRUE, @widget should be mapped along with its parent.
*
* Sets whether @widget should be mapped along with its when its parent
- * is mapped and @widget has been shown with gtk_widget_show().
+ * is mapped and @widget has been shown with gtk_widget_show().
*
* The child visibility can be set for widget before it is added to
* a container with gtk_widget_set_parent(), to avoid mapping
* children unnecessary before immediately unmapping them. However
* it will be reset to its default state of %TRUE when the widget
* is removed from a container.
- *
+ *
* Note that changing the child visibility of a widget does not
* queue a resize on the widget. Most of the time, the size of
* a widget is computed from all visible children, whether or
/**
* gtk_widget_get_child_visible:
* @widget: a #GtkWidget
- *
+ *
* Gets the value set with gtk_widget_set_child_visible().
* If you feel a need to use this function, your code probably
- * needs reorganization.
+ * needs reorganization.
*
* This function is only useful for container implementations and
* never should be called by an application.
gtk_widget_get_child_visible (GtkWidget *widget)
{
g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
-
+
return widget->priv->child_visible;
}
gtk_widget_get_screen_unchecked (GtkWidget *widget)
{
GtkWidget *toplevel;
-
+
toplevel = gtk_widget_get_toplevel (widget);
if (gtk_widget_is_toplevel (toplevel))
/**
* gtk_widget_get_screen:
* @widget: a #GtkWidget
- *
+ *
* Get the #GdkScreen from the toplevel window associated with
* this widget. This function can only be called after the widget
* has been added to a widget hierarchy with a #GtkWindow
gtk_widget_get_screen (GtkWidget *widget)
{
GdkScreen *screen;
-
+
g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
screen = gtk_widget_get_screen_unchecked (widget);
/**
* gtk_widget_has_screen:
* @widget: a #GtkWidget
- *
+ *
* Checks whether there is a #GdkScreen is associated with
* this widget. All toplevel widgets have an associated
* screen, and all widgets added into a hierarchy with a toplevel
* window at the top.
- *
+ *
* Return value: %TRUE if there is a #GdkScreen associcated
* with the widget.
*
/**
* gtk_widget_get_display:
* @widget: a #GtkWidget
- *
+ *
* Get the #GdkDisplay for the toplevel window associated with
* this widget. This function can only be called after the widget
* has been added to a widget hierarchy with a #GtkWindow at the top.
gtk_widget_get_display (GtkWidget *widget)
{
g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
-
+
return gdk_screen_get_display (gtk_widget_get_screen (widget));
}
/**
* gtk_widget_get_root_window:
* @widget: a #GtkWidget
- *
+ *
* Get the root window where this widget is located. This function can
* only be called after the widget has been added to a widget
* hierarchy with #GtkWindow at the top.
* 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.
- *
+ *
* gtk_widget_child_focus() is called by containers as the user moves
* around the window using keyboard shortcuts. @direction indicates
* what kind of motion is taking place (up, down, left, right, tab
if (!GTK_IS_CONTAINER (widget) &&
!gtk_widget_get_can_focus (widget))
return FALSE;
-
+
g_signal_emit (widget,
widget_signals[FOCUS],
0,
* navigation outside the widget, e.g. by calling
* gtk_widget_child_focus() on the widget's toplevel.
*
- * The default ::keynav-failed handler returns %TRUE for
- * %GTK_DIR_TAB_FORWARD and %GTK_DIR_TAB_BACKWARD. For the other
- * values of #GtkDirectionType, it looks at the
- * #GtkSettings:gtk-keynav-cursor-only setting and returns %FALSE
+ * The default ::keynav-failed handler returns %TRUE for
+ * %GTK_DIR_TAB_FORWARD and %GTK_DIR_TAB_BACKWARD. For the other
+ * values of #GtkDirectionType, it looks at the
+ * #GtkSettings:gtk-keynav-cursor-only setting and returns %FALSE
* if the setting is %TRUE. This way the entire user interface
* becomes cursor-navigatable on input devices such as mobile phones
* which only have cursor keys but no tab key.
* gtk_widget_error_bell() to notify the user of the failed keyboard
* navigation.
*
- * A use case for providing an own implementation of ::keynav-failed
+ * A use case for providing an own implementation of ::keynav-failed
* (either by connecting to it or by overriding it) would be a row of
* #GtkEntry widgets where the user should be able to navigate the
- * entire row with the cursor keys, as e.g. known from user interfaces
+ * entire row with the cursor keys, as e.g. known from user interfaces
* that require entering license keys.
*
* Return value: %TRUE if stopping keyboard navigation is fine, %FALSE
* gtk_widget_error_bell:
* @widget: a #GtkWidget
*
- * Notifies the user about an input-related error on this widget.
+ * Notifies the user about an input-related error on this widget.
* If the #GtkSettings:gtk-error-bell setting is %TRUE, it calls
* gdk_window_beep(), otherwise it does nothing.
*
}
static void
-gtk_widget_set_usize_internal (GtkWidget *widget,
- gint width,
- gint height)
+gtk_widget_set_usize_internal (GtkWidget *widget,
+ gint width,
+ gint height,
+ GtkQueueResizeFlags flags)
{
GtkWidgetAuxInfo *aux_info;
gboolean changed = FALSE;
-
+
g_object_freeze_notify (G_OBJECT (widget));
aux_info = _gtk_widget_get_aux_info (widget, TRUE);
-
+
if (width > -2 && aux_info->width != width)
{
- g_object_notify (G_OBJECT (widget), "width-request");
+ if ((flags & GTK_QUEUE_RESIZE_INVALIDATE_ONLY) == 0)
+ g_object_notify (G_OBJECT (widget), "width-request");
aux_info->width = width;
changed = TRUE;
}
if (height > -2 && aux_info->height != height)
{
- g_object_notify (G_OBJECT (widget), "height-request");
+ if ((flags & GTK_QUEUE_RESIZE_INVALIDATE_ONLY) == 0)
+ g_object_notify (G_OBJECT (widget), "height-request");
aux_info->height = height;
changed = TRUE;
}
-
+
if (gtk_widget_get_visible (widget) && changed)
- gtk_widget_queue_resize (widget);
+ {
+ if ((flags & GTK_QUEUE_RESIZE_INVALIDATE_ONLY) == 0)
+ gtk_widget_queue_resize (widget);
+ else
+ _gtk_size_group_queue_resize (widget, GTK_QUEUE_RESIZE_INVALIDATE_ONLY);
+ }
g_object_thaw_notify (G_OBJECT (widget));
}
* will force them to leave the window at least as large as the size
* request. When dealing with window sizes,
* gtk_window_set_geometry_hints() can be a useful function as well.
- *
+ *
* Note the inherent danger of setting any fixed size - themes,
* translations into other languages, different fonts, and user action
* can all change the appropriate size for a given widget. So, it's
width = 1;
if (height == 0)
height = 1;
-
- gtk_widget_set_usize_internal (widget, width, height);
+
+ gtk_widget_set_usize_internal (widget, width, height, 0);
}
*height = aux_info->height;
}
+/**
+ * _gtk_widget_override_size_request:
+ * @widget: a #GtkWidget
+ * @width: new forced minimum width
+ * @height: new forced minimum height
+ * @old_width: location to store previous forced minimum width
+ * @old_width: location to store previous forced minumum height
+ *
+ * Temporarily establishes a forced minimum size for a widget; this
+ * is used by GtkWindow when calculating the size to add to the
+ * window's geometry widget. Cached sizes for the widget and its
+ * parents are invalidated, so that subsequent calls to the size
+ * negotiation machinery produce the overriden result, but the
+ * widget is not queued for relayout or redraw. The old size must
+ * be restored with _gtk_widget_restore_size_request() or things
+ * will go screwy.
+ */
+void
+_gtk_widget_override_size_request (GtkWidget *widget,
+ int width,
+ int height,
+ int *old_width,
+ int *old_height)
+{
+ gtk_widget_get_size_request (widget, old_width, old_height);
+ gtk_widget_set_usize_internal (widget, width, height,
+ GTK_QUEUE_RESIZE_INVALIDATE_ONLY);
+}
+
+/**
+ * _gtk_widget_restore_size_request:
+ * @widget: a #GtkWidget
+ * @old_width: saved forced minimum size
+ * @old_height: saved forced minimum size
+ *
+ * Undoes the operation of_gtk_widget_override_size_request().
+ */
+void
+_gtk_widget_restore_size_request (GtkWidget *widget,
+ int old_width,
+ int old_height)
+{
+ gtk_widget_set_usize_internal (widget, old_width, old_height,
+ GTK_QUEUE_RESIZE_INVALIDATE_ONLY);
+}
+
/**
* gtk_widget_set_events:
* @widget: a #GtkWidget
{
g_return_if_fail (GTK_IS_WIDGET (widget));
g_return_if_fail (!gtk_widget_get_realized (widget));
-
+
g_object_set_qdata (G_OBJECT (widget), quark_event_mask,
GINT_TO_POINTER (events));
g_object_notify (G_OBJECT (widget), "events");
/**
* gtk_widget_get_toplevel:
* @widget: a #GtkWidget
- *
+ *
* This function returns the topmost widget in the container hierarchy
* @widget is a part of. If @widget has no parent widgets, it will be
* returned as the topmost widget. No reference will be added to the
* returned widget; it should not be unreferenced.
*
* Note the difference in behavior vs. gtk_widget_get_ancestor();
- * <literal>gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW)</literal>
+ * <literal>gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW)</literal>
* would return
* %NULL if @widget wasn't inside a toplevel window, and if the
* window was inside a #GtkWindow-derived widget which was in turn
* inside the toplevel #GtkWindow. While the second case may
* seem unlikely, it actually happens when a #GtkPlug is embedded
* inside a #GtkSocket within the same application.
- *
+ *
* To reliably find the toplevel #GtkWindow, use
* gtk_widget_get_toplevel() and check if the %TOPLEVEL flags
* is set on the result.
* gtk_widget_get_ancestor:
* @widget: a #GtkWidget
* @widget_type: ancestor type
- *
+ *
* Gets the first ancestor of @widget with type @widget_type. For example,
- * <literal>gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)</literal> gets
- * the first #GtkBox that's an ancestor of @widget. No reference will be
- * added to the returned widget; it should not be unreferenced. See note
- * about checking for a toplevel #GtkWindow in the docs for
+ * <literal>gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)</literal> gets
+ * the first #GtkBox that's an ancestor of @widget. No reference will be
+ * added to the returned widget; it should not be unreferenced. See note
+ * about checking for a toplevel #GtkWindow in the docs for
* gtk_widget_get_toplevel().
- *
- * Note that unlike gtk_widget_is_ancestor(), gtk_widget_get_ancestor()
+ *
+ * Note that unlike gtk_widget_is_ancestor(), gtk_widget_get_ancestor()
* considers @widget to be an ancestor of itself.
*
* Return value: (transfer none): the ancestor widget, or %NULL if not found
if (!(widget && g_type_is_a (G_OBJECT_TYPE (widget), widget_type)))
return NULL;
-
+
return widget;
}
* gtk_widget_set_visual:
* @widget: a #GtkWidget
* @visual: visual to be used or %NULL to unset a previous one
- *
+ *
* Sets the visual that should be used for by widget and its children for
* creating #GdkWindows. The visual must be on the same #GdkScreen as
* returned by gdk_widget_get_screen(), so handling the
- * GtkWidget::screen-changed signal is necessary.
+ * #GtkWidget::screen-changed signal is necessary.
*
* Setting a new @visual will not cause @widget to recreate its windows,
* so you should call this function before @widget is realized.
g_return_if_fail (gtk_widget_get_screen (widget) == gdk_visual_get_screen (visual));
}
- g_object_set_qdata_full (G_OBJECT (widget),
+ g_object_set_qdata_full (G_OBJECT (widget),
quark_visual,
g_object_ref (visual),
g_object_unref);
/**
* gtk_widget_get_visual:
* @widget: a #GtkWidget
- *
+ *
* Gets the visual that will be used to render @widget.
*
* Return value: (transfer none): the visual for @widget
/**
* gtk_widget_get_settings:
* @widget: a #GtkWidget
- *
+ *
* Gets the settings object holding the settings (global property
* settings, RC file information, etc) used for this widget.
*
gtk_widget_get_settings (GtkWidget *widget)
{
g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
-
+
return gtk_settings_get_for_screen (gtk_widget_get_screen (widget));
}
/**
* gtk_widget_get_events:
* @widget: a #GtkWidget
- *
+ *
* Returns the event mask for the widget (a bitfield containing flags
* from the #GdkEventMask enumeration). These are the events that the widget
* will receive.
- *
+ *
* Return value: event mask for @widget
**/
gint
/**
* gtk_widget_get_extension_events:
* @widget: a #GtkWidget
- *
+ *
* Retrieves the extension events the widget will receive; see
* gdk_input_set_extension_events().
- *
+ *
* Return value: extension events for @widget
**/
GdkExtensionMode
*x = -1;
if (y)
*y = -1;
-
+
if (gtk_widget_get_realized (widget))
{
gdk_window_get_pointer (priv->window, x, y, NULL);
* gtk_widget_is_ancestor:
* @widget: a #GtkWidget
* @ancestor: another #GtkWidget
- *
+ *
* Determines whether @widget is somewhere inside @ancestor, possibly with
* intermediate containers.
- *
- * Return value: %TRUE if @ancestor contains @widget as a child,
+ *
+ * Return value: %TRUE if @ancestor contains @widget as a child,
* grandchild, great grandchild, etc.
**/
gboolean
return TRUE;
widget = widget->priv->parent;
}
-
+
return FALSE;
}
* gtk_widget_set_composite_name:
* @widget: a #GtkWidget.
* @name: the name to set
- *
+ *
* Sets a widgets composite name. The widget must be
* a composite child of its parent; see gtk_widget_push_composite_child().
**/
* gtk_widget_get_composite_name:
* @widget: a #GtkWidget
*
- * Obtains the composite name of a widget.
+ * Obtains the composite name of a widget.
*
* Returns: the composite name of @widget, or %NULL if @widget is not
- * a composite child. The string should be freed when it is no
+ * a composite child. The string should be freed when it is no
* longer needed.
**/
gchar*
/**
* gtk_widget_push_composite_child:
- *
+ *
* Makes all newly-created widgets as composite children until
* the corresponding gtk_widget_pop_composite_child() call.
- *
+ *
* A composite child is a child that's an implementation detail of the
* container it's inside and should not be visible to people using the
* container. Composite children aren't treated differently by GTK (but
- * see gtk_container_foreach() vs. gtk_container_forall()), but e.g. GUI
+ * see gtk_container_foreach() vs. gtk_container_forall()), but e.g. GUI
* builders might want to treat them in a different way.
- *
+ *
* Here is a simple example:
* |[
* gtk_widget_push_composite_child ();
- * scrolled_window->hscrollbar = gtk_hscrollbar_new (hadjustment);
+ * 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_set_parent (scrolled_window->hscrollbar,
* GTK_WIDGET (scrolled_window));
* g_object_ref (scrolled_window->hscrollbar);
* ]|
* gtk_widget_pop_composite_child:
*
* Cancels the effect of a previous call to gtk_widget_push_composite_child().
- **/
+ **/
void
gtk_widget_pop_composite_child (void)
{
GtkTextDirection old_dir)
{
gtk_widget_update_pango_context (widget);
-
+
g_signal_emit (widget, widget_signals[DIRECTION_CHANGED], 0, old_dir);
}
* gtk_widget_set_direction:
* @widget: a #GtkWidget
* @dir: the new direction
- *
+ *
* Sets the reading direction on a particular widget. This direction
* controls the primary direction for widgets containing text,
* and also the direction in which the children of a container are
GtkTextDirection dir)
{
GtkTextDirection old_dir;
-
+
g_return_if_fail (GTK_IS_WIDGET (widget));
g_return_if_fail (dir >= GTK_TEXT_DIR_NONE && dir <= GTK_TEXT_DIR_RTL);
/**
* gtk_widget_get_direction:
* @widget: a #GtkWidget
- *
+ *
* Gets the reading direction for a particular widget. See
* gtk_widget_set_direction().
- *
+ *
* Return value: the reading direction for the widget.
**/
GtkTextDirection
gtk_widget_get_direction (GtkWidget *widget)
{
g_return_val_if_fail (GTK_IS_WIDGET (widget), GTK_TEXT_DIR_LTR);
-
+
if (widget->priv->direction == GTK_TEXT_DIR_NONE)
return gtk_default_direction;
else
GtkTextDirection old_dir = GPOINTER_TO_UINT (data);
g_object_ref (widget);
-
+
if (widget->priv->direction == GTK_TEXT_DIR_NONE)
gtk_widget_emit_direction_changed (widget, old_dir);
-
+
if (GTK_IS_CONTAINER (widget))
gtk_container_forall (GTK_CONTAINER (widget),
gtk_widget_set_default_direction_recurse,
* gtk_widget_set_default_direction:
* @dir: the new default direction. This cannot be
* %GTK_TEXT_DIR_NONE.
- *
+ *
* Sets the default reading direction for widgets where the
* direction has not been explicitly set by gtk_widget_set_direction().
**/
{
GList *toplevels, *tmp_list;
GtkTextDirection old_dir = gtk_default_direction;
-
+
gtk_default_direction = dir;
tmp_list = toplevels = gtk_window_list_toplevels ();
g_list_foreach (toplevels, (GFunc)g_object_ref, NULL);
-
+
while (tmp_list)
{
gtk_widget_set_default_direction_recurse (tmp_list->data,
/**
* gtk_widget_get_default_direction:
- *
+ *
* Obtains the current default reading direction. See
* gtk_widget_set_default_direction().
*
- * Return value: the current default direction.
+ * Return value: the current default direction.
**/
GtkTextDirection
gtk_widget_get_default_direction (void)
GtkWidgetPrivate *priv = widget->priv;
GtkWidgetAuxInfo *aux_info;
GtkAccessible *accessible;
-
+
gtk_grab_remove (widget);
g_object_unref (priv->style);
priv->style = NULL;
g_free (priv->name);
-
+
aux_info =_gtk_widget_get_aux_info (widget, FALSE);
if (aux_info)
gtk_widget_aux_info_destroy (aux_info);
GtkWidgetPrivate *priv = widget->priv;
g_assert (gtk_widget_get_realized (widget));
-
+
if (!gtk_widget_get_mapped (widget))
{
gtk_widget_set_mapped (widget, TRUE);
-
+
if (gtk_widget_get_has_window (widget))
gdk_window_show (priv->window);
}
GtkWidgetPrivate *priv = widget->priv;
g_assert (!gtk_widget_get_has_window (widget));
-
+
gtk_widget_set_realized (widget, TRUE);
if (priv->parent)
{
/* We must do unrealize child widget BEFORE container widget.
* gdk_window_destroy() destroys specified xwindow and its sub-xwindows.
- * So, unrealizing container widget bofore its children causes the problem
+ * So, unrealizing container widget bofore its children causes the problem
* (for example, gdk_ic_destroy () with destroyed window causes crash. )
*/
}
gtk_selection_remove_all (widget);
-
+
gtk_widget_set_realized (widget, FALSE);
}
static void
gtk_widget_real_adjust_size_request (GtkWidget *widget,
GtkOrientation orientation,
- gint for_size,
gint *minimum_size,
gint *natural_size)
{
/**
* _gtk_widget_peek_request_cache:
- *
+ *
* Returns the address of the widget's request cache (strictly for
* internal use in gtksizerequest.c)
- *
+ *
* Return value: the address of @widget's size request cache.
**/
gpointer
synth_crossing (from, GDK_LEAVE_NOTIFY, from_window,
device, mode, GDK_NOTIFY_INFERIOR);
for (list = to_ancestors; list; list = list->next)
- synth_crossing (NULL, GDK_ENTER_NOTIFY, (GdkWindow *) list->data,
+ synth_crossing (NULL, GDK_ENTER_NOTIFY, (GdkWindow *) list->data,
device, mode, GDK_NOTIFY_VIRTUAL);
synth_crossing (to, GDK_ENTER_NOTIFY, to_window,
device, mode, GDK_NOTIFY_ANCESTOR);
}
else
{
- while (from_ancestors != NULL && to_ancestors != NULL
+ while (from_ancestors != NULL && to_ancestors != NULL
&& from_ancestors->data == to_ancestors->data)
{
- from_ancestors = g_list_delete_link (from_ancestors,
+ from_ancestors = g_list_delete_link (from_ancestors,
from_ancestors);
to_ancestors = g_list_delete_link (to_ancestors, to_ancestors);
}
* _gtk_widget_get_aux_info:
* @widget: a #GtkWidget
* @create: if %TRUE, create the structure if it doesn't exist
- *
+ *
* Get the #GtkWidgetAuxInfo structure for the widget.
- *
+ *
* Return value: the #GtkAuxInfo structure for the widget, or
* %NULL if @create is %FALSE and one doesn't already exist.
*/
gboolean create)
{
GtkWidgetAuxInfo *aux_info;
-
+
aux_info = g_object_get_qdata (G_OBJECT (widget), quark_aux_info);
if (!aux_info && create)
{
g_object_set_qdata (G_OBJECT (widget), quark_aux_info, aux_info);
}
-
+
return aux_info;
}
}
/**
- * gtk_widget_shape_combine_region:
+ * gtk_widget_shape_combine_region:
* @widget: a #GtkWidget
* @region: (allow-none): shape to be added, or %NULL to remove an existing shape
- *
+ *
* Sets a shape for this widget's GDK window. This allows for
* transparent windows etc., see gdk_window_shape_combine_region()
* for more information.
cairo_region_t *region)
{
GtkWidgetPrivate *priv;
-
+
g_return_if_fail (GTK_IS_WIDGET (widget));
/* set_shape doesn't work on widgets without gdk window */
g_return_if_fail (gtk_widget_get_has_window (widget));
if (priv->window)
gdk_window_shape_combine_region (priv->window, NULL, 0, 0);
-
+
g_object_set_qdata (G_OBJECT (widget), quark_shape_info, NULL);
}
else
{
priv->has_shape_mask = TRUE;
-
+
g_object_set_qdata_full (G_OBJECT (widget), quark_shape_info,
cairo_region_copy (region),
(GDestroyNotify) cairo_region_destroy);
-
+
/* set shape if widget has a gdk window already.
* otherwise the shape is scheduled to be set by gtk_widget_realize().
*/
* @region: (allow-none): shape to be added, or %NULL to remove an existing shape
*
* Sets an input shape for this widget's GDK window. This allows for
- * windows which react to mouse click in a nonrectangular region, see
+ * windows which react to mouse click in a nonrectangular region, see
* gdk_window_input_shape_combine_region() for more information.
*
* Since: 3.0
cairo_region_t *region)
{
GtkWidgetPrivate *priv;
-
+
g_return_if_fail (GTK_IS_WIDGET (widget));
/* set_shape doesn't work on widgets without gdk window */
g_return_if_fail (gtk_widget_get_has_window (widget));
{
if (priv->window)
gdk_window_input_shape_combine_region (priv->window, NULL, 0, 0);
-
+
g_object_set_qdata (G_OBJECT (widget), quark_input_shape_info, NULL);
}
else
{
- g_object_set_qdata_full (G_OBJECT (widget), quark_input_shape_info,
+ g_object_set_qdata_full (G_OBJECT (widget), quark_input_shape_info,
cairo_region_copy (region),
(GDestroyNotify) cairo_region_destroy);
-
+
/* set shape if widget has a gdk window already.
* otherwise the shape is scheduled to be set by gtk_widget_realize().
*/
* @klass: a #GtkWidgetClass
* @pspec: the #GParamSpec for the style property
* @parser: the parser for the style property
- *
- * Installs a style property on a widget class.
+ *
+ * Installs a style property on a widget class.
**/
void
gtk_widget_class_install_style_property_parser (GtkWidgetClass *klass,
g_return_if_fail (G_IS_PARAM_SPEC (pspec));
g_return_if_fail (pspec->flags & G_PARAM_READABLE);
g_return_if_fail (!(pspec->flags & (G_PARAM_CONSTRUCT_ONLY | G_PARAM_CONSTRUCT)));
-
+
if (g_param_spec_pool_lookup (style_property_spec_pool, pspec->name, G_OBJECT_CLASS_TYPE (klass), FALSE))
{
g_warning (G_STRLOC ": class `%s' already contains a style property named `%s'",
* gtk_widget_class_install_style_property:
* @klass: a #GtkWidgetClass
* @pspec: the #GParamSpec for the property
- *
+ *
* Installs a style property on a widget class. The parser for the
* style property is determined by the value type of @pspec.
**/
* gtk_widget_class_list_style_properties:
* @klass: a #GtkWidgetClass
* @n_properties: location to return the number of style properties found
- * @returns: an newly allocated array of #GParamSpec*. The array must
+ * @returns: an newly allocated array of #GParamSpec*. The array must
* be freed with g_free().
*
* Returns all style properties of a widget class.
* gtk_widget_style_get_property:
* @widget: a #GtkWidget
* @property_name: the name of a style property
- * @value: location to return the property value
+ * @value: location to return the property value
*
* Gets the value of a style property of @widget.
*/
G_OBJECT_TYPE (widget),
pspec,
(GtkRcPropertyParser) g_param_spec_get_qdata (pspec, quark_property_parser));
-
+
/* auto-conversion of the caller's value type
*/
if (G_VALUE_TYPE (value) == G_PARAM_SPEC_VALUE_TYPE (pspec))
* @var_args: a <type>va_list</type> of pairs of property names and
* locations to return the property values, starting with the location
* for @first_property_name.
- *
- * Non-vararg variant of gtk_widget_style_get(). Used primarily by language
+ *
+ * Non-vararg variant of gtk_widget_style_get(). Used primarily by language
* bindings.
- */
+ */
void
gtk_widget_style_get_valist (GtkWidget *widget,
const gchar *first_property_name,
* gtk_widget_style_get:
* @widget: a #GtkWidget
* @first_property_name: the name of the first property to get
- * @Varargs: pairs of property names and locations to
- * return the property values, starting with the location for
+ * @Varargs: pairs of property names and locations to
+ * return the property values, starting with the location for
* @first_property_name, terminated by %NULL.
*
* Gets the values of a multiple style properties of @widget.
static gchar *rev_path = NULL;
static guint tmp_path_len = 0;
guint len;
-
+
g_return_if_fail (GTK_IS_WIDGET (widget));
len = 0;
const gchar *s;
gchar *d;
guint l;
-
+
string = gtk_widget_get_name (widget);
l = strlen (string);
while (tmp_path_len <= len + l + 1)
rev_path[len++] = 0;
}
while (widget);
-
+
if (path_length)
*path_length = len - 1;
if (path_reversed)
*
* 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().
- *
+ *
**/
void
gtk_widget_class_path (GtkWidget *widget,
static gchar *rev_path = NULL;
static guint tmp_path_len = 0;
guint len;
-
+
g_return_if_fail (GTK_IS_WIDGET (widget));
len = 0;
const gchar *s;
gchar *d;
guint l;
-
+
string = g_type_name (G_OBJECT_TYPE (widget));
l = strlen (string);
while (tmp_path_len <= len + l + 1)
rev_path[len++] = 0;
}
while (widget);
-
+
if (path_length)
*path_length = len - 1;
if (path_reversed)
/**
* gtk_requisition_free:
* @requisition: a #GtkRequisition
- *
+ *
* Frees a #GtkRequisition.
**/
void
return klass->get_accessible (widget);
}
-static AtkObject*
+static AtkObject*
gtk_widget_real_get_accessible (GtkWidget *widget)
{
AtkObject* accessible;
- accessible = g_object_get_qdata (G_OBJECT (widget),
+ accessible = g_object_get_qdata (G_OBJECT (widget),
quark_accessible_object);
if (!accessible)
{
AtkRegistry *default_registry;
default_registry = atk_get_default_registry ();
- factory = atk_registry_get_factory (default_registry,
+ factory = atk_registry_get_factory (default_registry,
G_TYPE_FROM_INSTANCE (widget));
accessible =
atk_object_factory_create_accessible (factory,
G_OBJECT (widget));
- g_object_set_qdata (G_OBJECT (widget),
+ g_object_set_qdata (G_OBJECT (widget),
quark_accessible_object,
accessible);
}
return accessible;
}
+/*
+ * Expand flag management
+ */
+
+static void
+gtk_widget_update_computed_expand (GtkWidget *widget)
+{
+ GtkWidgetPrivate *priv;
+
+ priv = widget->priv;
+
+ if (priv->need_compute_expand)
+ {
+ gboolean h, v;
+
+ if (priv->hexpand_set)
+ h = priv->hexpand;
+ else
+ h = FALSE;
+
+ if (priv->vexpand_set)
+ v = priv->vexpand;
+ else
+ v = FALSE;
+
+ /* we don't need to use compute_expand if both expands are
+ * forced by the app
+ */
+ if (!(priv->hexpand_set && priv->vexpand_set))
+ {
+ if (GTK_WIDGET_GET_CLASS (widget)->compute_expand != NULL)
+ {
+ gboolean ignored;
+
+ GTK_WIDGET_GET_CLASS (widget)->compute_expand (widget,
+ priv->hexpand_set ? &ignored : &h,
+ priv->vexpand_set ? &ignored : &v);
+ }
+ }
+
+ priv->need_compute_expand = FALSE;
+ priv->computed_hexpand = h != FALSE;
+ priv->computed_vexpand = v != FALSE;
+ }
+}
+
+/**
+ * gtk_widget_queue_compute_expand:
+ * @widget: a #GtkWidget
+ *
+ * Mark @widget as needing to recompute its expand flags. Call
+ * this function when setting legacy expand child properties
+ * on the child of a container.
+ *
+ * See gtk_widget_compute_expand().
+ */
+void
+gtk_widget_queue_compute_expand (GtkWidget *widget)
+{
+ GtkWidget *parent;
+ gboolean changed_anything;
+
+ if (widget->priv->need_compute_expand)
+ return;
+
+ changed_anything = FALSE;
+ parent = widget;
+ while (parent != NULL)
+ {
+ if (!parent->priv->need_compute_expand)
+ {
+ parent->priv->need_compute_expand = TRUE;
+ changed_anything = TRUE;
+ }
+
+ /* Note: if we had an invariant that "if a child needs to
+ * compute expand, its parents also do" then we could stop going
+ * up when we got to a parent that already needed to
+ * compute. However, in general we compute expand lazily (as
+ * soon as we see something in a subtree that is expand, we know
+ * we're expanding) and so this invariant does not hold and we
+ * have to always walk all the way up in case some ancestor
+ * is not currently need_compute_expand.
+ */
+
+ parent = parent->priv->parent;
+ }
+
+ /* recomputing expand always requires
+ * a relayout as well
+ */
+ if (changed_anything)
+ gtk_widget_queue_resize (widget);
+}
+
+/**
+ * gtk_widget_compute_expand:
+ * @widget: the widget
+ * @orientation: expand direction
+ *
+ * Computes whether a container should give this widget extra space
+ * when possible. Containers should check this, rather than
+ * looking at gtk_widget_get_hexpand() or gtk_widget_get_vexpand().
+ *
+ * This function already checks whether the widget is visible, so
+ * visibility does not need to be checked separately. Non-visible
+ * widgets are not expanded.
+ *
+ * The computed expand value uses either the expand setting explicitly
+ * set on the widget itself, or, if none has been explicitly set,
+ * the widget may expand if some of its children do.
+ *
+ * Return value: whether widget tree rooted here should be expanded
+ */
+gboolean
+gtk_widget_compute_expand (GtkWidget *widget,
+ GtkOrientation orientation)
+{
+ g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
+
+ /* We never make a widget expand if not even showing. */
+ if (!gtk_widget_get_visible (widget))
+ return FALSE;
+
+ gtk_widget_update_computed_expand (widget);
+
+ if (orientation == GTK_ORIENTATION_HORIZONTAL)
+ {
+ return widget->priv->computed_hexpand;
+ }
+ else
+ {
+ return widget->priv->computed_vexpand;
+ }
+}
+
+static void
+gtk_widget_set_expand (GtkWidget *widget,
+ GtkOrientation orientation,
+ gboolean expand)
+{
+ const char *expand_prop;
+ const char *expand_set_prop;
+ gboolean was_both;
+ GtkWidgetPrivate *priv;
+
+ g_return_if_fail (GTK_IS_WIDGET (widget));
+
+ priv = widget->priv;
+
+ expand = expand != FALSE;
+
+ was_both = priv->hexpand && priv->vexpand;
+
+ if (orientation == GTK_ORIENTATION_HORIZONTAL)
+ {
+ if (priv->hexpand_set &&
+ priv->hexpand == expand)
+ return;
+
+ priv->hexpand_set = TRUE;
+ priv->hexpand = expand;
+
+ expand_prop = "hexpand";
+ expand_set_prop = "hexpand-set";
+ }
+ else
+ {
+ if (priv->vexpand_set &&
+ priv->vexpand == expand)
+ return;
+
+ priv->vexpand_set = TRUE;
+ priv->vexpand = expand;
+
+ expand_prop = "vexpand";
+ expand_set_prop = "vexpand-set";
+ }
+
+ gtk_widget_queue_compute_expand (widget);
+
+ g_object_freeze_notify (G_OBJECT (widget));
+ g_object_notify (G_OBJECT (widget), expand_prop);
+ g_object_notify (G_OBJECT (widget), expand_set_prop);
+ if (was_both != (priv->hexpand && priv->vexpand))
+ g_object_notify (G_OBJECT (widget), "expand");
+ g_object_thaw_notify (G_OBJECT (widget));
+}
+
+static void
+gtk_widget_set_expand_set (GtkWidget *widget,
+ GtkOrientation orientation,
+ gboolean set)
+{
+ GtkWidgetPrivate *priv;
+ const char *prop;
+
+ priv = widget->priv;
+
+ set = set != FALSE;
+
+ if (orientation == GTK_ORIENTATION_HORIZONTAL)
+ {
+ if (set == priv->hexpand_set)
+ return;
+
+ priv->hexpand_set = set;
+ prop = "hexpand-set";
+ }
+ else
+ {
+ if (set == priv->vexpand_set)
+ return;
+
+ priv->vexpand_set = set;
+ prop = "vexpand-set";
+ }
+
+ gtk_widget_queue_compute_expand (widget);
+
+ g_object_notify (G_OBJECT (widget), prop);
+}
+
+/**
+ * gtk_widget_get_hexpand:
+ * @widget: the widget
+ *
+ * Gets whether the widget would like any available extra horizontal
+ * space. When a user resizes a #GtkWindow, widgets with expand=TRUE
+ * generally receive the extra space. For example, a list or
+ * scrollable area or document in your window would often be set to
+ * expand.
+ *
+ * Containers should use gtk_widget_compute_expand() rather than
+ * 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
+ * than computing whether the entire widget tree rooted at this widget
+ * wants to expand.
+ *
+ * Return value: whether hexpand flag is set
+ */
+gboolean
+gtk_widget_get_hexpand (GtkWidget *widget)
+{
+ g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
+
+ return widget->priv->hexpand;
+}
+
+/**
+ * gtk_widget_set_hexpand:
+ * @widget: the widget
+ * @expand: whether to expand
+ *
+ * Sets whether the widget would like any available extra horizontal
+ * space. When a user resizes a #GtkWindow, widgets with expand=TRUE
+ * generally receive the extra space. For example, a list or
+ * scrollable area or document in your window would often be set to
+ * expand.
+ *
+ * Call this function to set the expand flag if you would like your
+ * widget to become larger horizontally when the window has extra
+ * room.
+ *
+ * By default, widgets automatically expand if any of their children
+ * want to expand. (To see if a widget will automatically expand given
+ * its current children and state, call gtk_widget_compute_expand(). A
+ * container can decide how the expandability of children affects the
+ * expansion of the container by overriding the compute_expand virtual
+ * method on #GtkWidget.).
+ *
+ * Setting hexpand explicitly with this function will override the
+ * 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
+ * value to be used, rather than looking at children and widget state.
+ */
+void
+gtk_widget_set_hexpand (GtkWidget *widget,
+ gboolean expand)
+{
+ g_return_if_fail (GTK_IS_WIDGET (widget));
+
+ gtk_widget_set_expand (widget, GTK_ORIENTATION_HORIZONTAL, expand);
+}
+
+/**
+ * gtk_widget_get_hexpand_set:
+ * @widget: the widget
+ *
+ * Gets whether gtk_widget_set_hexpand() has been used to
+ * explicitly set the expand flag on this widget.
+ *
+ * If hexpand is set, then it overrides any computed
+ * 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
+ * for completeness and consistency.
+ *
+ * Return value: whether hexpand has been explicitly set
+ */
+gboolean
+gtk_widget_get_hexpand_set (GtkWidget *widget)
+{
+ g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
+
+ return widget->priv->hexpand_set;
+}
+
+/**
+ * gtk_widget_set_hexpand_set:
+ * @widget: the widget
+ * @set: value for hexpand-set property
+ *
+ * Sets whether the hexpand flag (see gtk_widget_get_hexpand()) will
+ * be used.
+ *
+ * The hexpand-set property will be set automatically when you call
+ * gtk_widget_set_hexpand() to set hexpand, so the most likely
+ * reason to use this function would be to unset an explicit expand
+ * flag.
+ *
+ * If hexpand is set, then it overrides any computed
+ * 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
+ * for completeness and consistency.
+ *
+ * Return value: whether hexpand has been explicitly set
+ */
+void
+gtk_widget_set_hexpand_set (GtkWidget *widget,
+ gboolean set)
+{
+ g_return_if_fail (GTK_IS_WIDGET (widget));
+
+ gtk_widget_set_expand_set (widget, GTK_ORIENTATION_HORIZONTAL, set);
+}
+
+
+/**
+ * gtk_widget_get_vexpand:
+ * @widget: the widget
+ *
+ * Gets whether the widget would like any available extra vertical
+ * space.
+ *
+ * See gtk_widget_get_hexpand() for more detail.
+ *
+ * Return value: whether vexpand flag is set
+ */
+gboolean
+gtk_widget_get_vexpand (GtkWidget *widget)
+{
+ g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
+
+ return widget->priv->vexpand;
+}
+
+/**
+ * gtk_widget_set_vexpand:
+ * @widget: the widget
+ * @expand: whether to expand
+ *
+ * Sets whether the widget would like any available extra vertical
+ * space.
+ *
+ * See gtk_widget_set_hexpand() for more detail.
+ */
+void
+gtk_widget_set_vexpand (GtkWidget *widget,
+ gboolean expand)
+{
+ g_return_if_fail (GTK_IS_WIDGET (widget));
+
+ gtk_widget_set_expand (widget, GTK_ORIENTATION_VERTICAL, expand);
+}
+
+/**
+ * gtk_widget_get_vexpand_set:
+ * @widget: the widget
+ *
+ * Gets whether gtk_widget_set_vexpand() has been used to
+ * explicitly set the expand flag on this widget.
+ *
+ * See gtk_widget_get_hexpand_set() for more detail.
+ *
+ * Return value: whether vexpand has been explicitly set
+ */
+gboolean
+gtk_widget_get_vexpand_set (GtkWidget *widget)
+{
+ g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
+
+ return widget->priv->vexpand_set;
+}
+
+/**
+ * gtk_widget_set_vexpand_set:
+ * @widget: the widget
+ * @set: value for vexpand-set property
+ *
+ * Sets whether the vexpand flag (see gtk_widget_get_vexpand()) will
+ * be used.
+ *
+ * See gtk_widget_set_hexpand_set() for more detail.
+ *
+ * Return value: whether vexpand has been explicitly set
+ */
+void
+gtk_widget_set_vexpand_set (GtkWidget *widget,
+ gboolean set)
+{
+ g_return_if_fail (GTK_IS_WIDGET (widget));
+
+ gtk_widget_set_expand_set (widget, GTK_ORIENTATION_VERTICAL, set);
+}
+
/*
* GtkBuildable implementation
*/
* to use. %GDK_SELECTION_CLIPBOARD gives the
* default clipboard. Another common value
* is %GDK_SELECTION_PRIMARY, which gives
- * the primary X selection.
- *
+ * the primary X selection.
+ *
* Returns the clipboard object for the given selection to
* be used with @widget. @widget must have a #GdkDisplay
* associated with it, so must be attached to a toplevel
{
GList *list = NULL;
GSList *l;
-
+
g_return_val_if_fail (GTK_IS_WIDGET (widget), NULL);
for (l = g_object_get_qdata (G_OBJECT (widget), quark_mnemonic_labels); l; l = l->next)
* gtk_widget_add_mnemonic_label:
* @widget: a #GtkWidget
* @label: a #GtkWidget that acts as a mnemonic label for @widget
- *
+ *
* Adds a widget to the list of mnemonic labels for
* this widget. (See gtk_widget_list_mnemonic_labels()). Note the
* list of mnemonic labels for the widget is cleared when the
old_list = g_object_steal_qdata (G_OBJECT (widget), quark_mnemonic_labels);
new_list = g_slist_prepend (old_list, label);
-
+
g_object_set_qdata_full (G_OBJECT (widget), quark_mnemonic_labels,
new_list, (GDestroyNotify) g_slist_free);
}
* @widget: a #GtkWidget
* @label: a #GtkWidget that was previously set as a mnemnic label for
* @widget with gtk_widget_add_mnemonic_label().
- *
+ *
* Removes a widget from the list of mnemonic labels for
* this widget. (See gtk_widget_list_mnemonic_labels()). The widget
* must have previously been added to the list with
/**
* gtk_widget_get_no_show_all:
* @widget: a #GtkWidget
- *
- * Returns the current value of the GtkWidget:no-show-all property,
- * which determines whether calls to gtk_widget_show_all() and
- * gtk_widget_hide_all() will affect this widget.
- *
+ *
+ * Returns the current value of the #GtkWidget:no-show-all property,
+ * which determines whether calls to gtk_widget_show_all()
+ * will affect this widget.
+ *
* Return value: the current value of the "no-show-all" property.
*
* Since: 2.4
gtk_widget_get_no_show_all (GtkWidget *widget)
{
g_return_val_if_fail (GTK_IS_WIDGET (widget), FALSE);
-
+
return widget->priv->no_show_all;
}
* gtk_widget_set_no_show_all:
* @widget: a #GtkWidget
* @no_show_all: the new value for the "no-show-all" property
- *
- * Sets the #GtkWidget:no-show-all property, which determines whether
- * calls to gtk_widget_show_all() and gtk_widget_hide_all() will affect
- * this widget.
+ *
+ * Sets the #GtkWidget:no-show-all property, which determines whether
+ * calls to gtk_widget_show_all() will affect this widget.
*
* This is mostly for use in constructing widget hierarchies with externally
* controlled visibility, see #GtkUIManager.
- *
+ *
* Since: 2.4
**/
void
* @text: the contents of the tooltip for @widget
*
* Sets @text as the contents of the tooltip. This function will take
- * care of setting GtkWidget:has-tooltip to %TRUE and of the default
- * handler for the GtkWidget::query-tooltip signal.
+ * care of setting #GtkWidget:has-tooltip to %TRUE and of the default
+ * handler for the #GtkWidget::query-tooltip signal.
*
- * See also the GtkWidget:tooltip-text property and gtk_tooltip_set_text().
+ * See also the #GtkWidget:tooltip-text property and gtk_tooltip_set_text().
*
* Since: 2.12
*/
* Sets @markup as the contents of the tooltip, which is marked up with
* the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
*
- * This function will take care of setting GtkWidget:has-tooltip to %TRUE
- * and of the default handler for the GtkWidget::query-tooltip signal.
+ * This function will take care of setting #GtkWidget:has-tooltip to %TRUE
+ * and of the default handler for the #GtkWidget::query-tooltip signal.
*
- * See also the GtkWidget:tooltip-markup property and
+ * See also the #GtkWidget:tooltip-markup property and
* gtk_tooltip_set_markup().
*
* Since: 2.12
* @has_tooltip: whether or not @widget has a tooltip.
*
* Sets the has-tooltip property on @widget to @has_tooltip. See
- * GtkWidget:has-tooltip for more information.
+ * #GtkWidget:has-tooltip for more information.
*
* Since: 2.12
*/
* @widget: a #GtkWidget
*
* Returns the current value of the has-tooltip property. See
- * GtkWidget:has-tooltip for more information.
+ * #GtkWidget:has-tooltip for more information.
*
* Return value: current value of has-tooltip on @widget.
*
*
* Returns the width that has currently been allocated to @widget.
* This function is intended to be used when implementing handlers
- * for the GtkWidget::draw function.
+ * for the #GtkWidget::draw function.
*
* Returns: the width of the @widget
**/
*
* Returns the height that has currently been allocated to @widget.
* This function is intended to be used when implementing handlers
- * for the GtkWidget::draw function.
+ * for the #GtkWidget::draw function.
*
* Returns: the height of the @widget
**/
* @window: a #GdkWindow
*
* Sets a widget's window. This function should only be used in a
- * widget's GtkWidget::realize() implementation. The %window passed is
+ * 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().
return res;
}
+/**
+ * gtk_widget_in_destruction:
+ * @widget: a #GtkWidget
+ *
+ * Returns whether the widget is currently being destroyed.
+ * This information can sometimes be used to avoid doing
+ * unnecessary work.
+ *
+ * Returns: %TRUE if @widget is being destroyed
+ */
gboolean
gtk_widget_in_destruction (GtkWidget *widget)
{
projects / ~andy / gtk / blobdiff