Functions
gtk_widget_new ()
GtkWidget *
gtk_widget_new (GType type,
const gchar *first_property_name,
...);
This is a convenience function for creating a widget and setting
its properties in one go. For example you might write:
gtk_widget_new (GTK_TYPE_LABEL, "label", "Hello World", "xalign",
0.0, NULL) to create a left-aligned label. Equivalent to
g_object_new(), but returns a widget so you don’t have to
cast the object yourself.
gtk_widget_destroy ()
void
gtk_widget_destroy (GtkWidget *widget);
Destroys a widget.
When a widget is destroyed all references it holds on other objects
will be released:
if the widget is inside a container, it will be removed from its
parent
if the widget is a container, all its children will be destroyed,
recursively
if the widget is a top level, it will be removed from the list
of top level widgets that GTK+ maintains internally
It's expected that all references held on the widget will also
be released; you should connect to the “destroy” signal
if you hold a reference to widget
and you wish to remove it when
this function is called. It is not necessary to do so if you are
implementing a GtkContainer, as you'll be able to use the
GtkContainerClass.remove() virtual function for that.
It's important to notice that gtk_widget_destroy() will only cause
the widget
to be finalized if no additional references, acquired
using g_object_ref(), are held on it. In case additional references
are in place, the widget
will be in an "inert" state after calling
this function; widget
will still point to valid memory, allowing you
to release the references you hold, but you may not query the widget's
own state.
You should typically call this function on top level widgets, and
rarely on child widgets.
See also: gtk_container_remove()
gtk_widget_in_destruction ()
gboolean
gtk_widget_in_destruction (GtkWidget *widget);
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
gtk_widget_destroyed ()
void
gtk_widget_destroyed (GtkWidget *widget,
GtkWidget **widget_pointer);
This function sets *widget_pointer
to NULL if widget_pointer
!=
NULL. It’s intended to be used as a callback connected to the
“destroy” signal of a widget. You connect gtk_widget_destroyed()
as a signal handler, and pass the address of your widget variable
as user data. Then when the widget is destroyed, the variable will
be set to NULL. Useful for example to avoid multiple copies
of the same dialog.
gtk_widget_unparent ()
void
gtk_widget_unparent (GtkWidget *widget);
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.
gtk_widget_show ()
void
gtk_widget_show (GtkWidget *widget);
Flags a widget to be displayed. Any widget that isn’t shown will
not appear on the screen. If you want to show all the widgets in a
container, it’s easier to call gtk_widget_show_all() on the
container, instead of individually showing the widgets.
Remember that you have to show the containers containing a widget,
in addition to the widget itself, before it will appear onscreen.
When a toplevel container is shown, it is immediately realized and
mapped; other shown widgets are realized and mapped when their
toplevel container is realized and mapped.
gtk_widget_show_now ()
void
gtk_widget_show_now (GtkWidget *widget);
Shows a widget. If the widget is an unmapped toplevel widget
(i.e. a GtkWindow that has not yet been shown), enter the main
loop and wait for the window to actually be mapped. Be careful;
because the main loop is running, anything can happen during
this function.
gtk_widget_hide ()
void
gtk_widget_hide (GtkWidget *widget);
Reverses the effects of gtk_widget_show(), causing the widget to be
hidden (invisible to the user).
gtk_widget_show_all ()
void
gtk_widget_show_all (GtkWidget *widget);
Recursively shows a widget, and any child widgets (if the widget is
a container).
gtk_widget_map ()
void
gtk_widget_map (GtkWidget *widget);
This function is only for use in widget implementations. Causes
a widget to be mapped if it isn’t already.
gtk_widget_unmap ()
void
gtk_widget_unmap (GtkWidget *widget);
This function is only for use in widget implementations. Causes
a widget to be unmapped if it’s currently mapped.
gtk_widget_realize ()
void
gtk_widget_realize (GtkWidget *widget);
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
widget
itself. If a widget is not yet inside a toplevel window
when you realize it, bad things will happen.
This function is primarily used in widget implementations, and
isn’t very useful otherwise. Many times when you think you might
need it, a better approach is to connect to a signal that will be
called after the widget is realized automatically, such as
“draw”. Or simply g_signal_connect() to the
“realize” signal.
gtk_widget_unrealize ()
void
gtk_widget_unrealize (GtkWidget *widget);
This function is only useful in widget implementations.
Causes a widget to be unrealized (frees all GDK resources
associated with the widget, such as widget->window
).
gtk_widget_draw ()
void
gtk_widget_draw (GtkWidget *widget,
cairo_t *cr);
Draws widget
to cr
. The top left corner of the widget will be
drawn to the currently set origin point of cr
.
You should pass a cairo context as cr
argument that is in an
original state. Otherwise the resulting drawing is undefined. For
example changing the operator using cairo_set_operator() or the
line width using cairo_set_line_width() might have unwanted side
effects.
You may however change the context’s transform matrix - like with
cairo_scale(), cairo_translate() or cairo_set_matrix() and clip
region with cairo_clip() prior to calling this function. Also, it
is fine to modify the context with cairo_save() and
cairo_push_group() prior to calling this function.
Note that special-purpose widgets may contain special code for
rendering to the screen and might appear differently on screen
and when rendered using gtk_widget_draw().
Since: 3.0
gtk_widget_queue_resize ()
void
gtk_widget_queue_resize (GtkWidget *widget);
This function is only for use in widget implementations.
Flags a widget to have its size renegotiated; should
be called when a widget for some reason has a new size request.
For example, when you change the text in a GtkLabel, GtkLabel
queues a resize to ensure there’s enough space for the new text.
Note that you cannot call gtk_widget_queue_resize() on a widget
from inside its implementation of the GtkWidgetClass::size_allocate
virtual method. Calls to gtk_widget_queue_resize() from inside
GtkWidgetClass::size_allocate will be silently ignored.
gtk_widget_queue_resize_no_redraw ()
void
gtk_widget_queue_resize_no_redraw (GtkWidget *widget);
This function works like gtk_widget_queue_resize(),
except that the widget is not invalidated.
Since: 2.4
gtk_widget_queue_allocate ()
void
gtk_widget_queue_allocate (GtkWidget *widget);
This function is only for use in widget implementations.
Flags the widget for a rerun of the GtkWidgetClass::size_allocate
function. Use this function instead of gtk_widget_queue_resize()
when the widget
's size request didn't change but it wants to
reposition its contents.
An example user of this function is gtk_widget_set_halign().
Since: 3.20
gtk_widget_get_frame_clock ()
GdkFrameClock *
gtk_widget_get_frame_clock (GtkWidget *widget);
Obtains the frame clock for a widget. The frame clock is a global
“ticker” that can be used to drive animations and repaints. The
most common reason to get the frame clock is to call
gdk_frame_clock_get_frame_time(), in order to get a time to use for
animating. For example you might record the start of the animation
with an initial value from gdk_frame_clock_get_frame_time(), and
then update the animation by calling
gdk_frame_clock_get_frame_time() again during each repaint.
gdk_frame_clock_request_phase() will result in a new frame on the
clock, but won’t necessarily repaint any widgets. To repaint a
widget, you have to use gtk_widget_queue_draw() which invalidates
the widget (thus scheduling it to receive a draw on the next
frame). gtk_widget_queue_draw() will also end up requesting a frame
on the appropriate frame clock.
A widget’s frame clock will not change while the widget is
mapped. Reparenting a widget (which implies a temporary unmap) can
change the widget’s frame clock.
Unrealized widgets do not have a frame clock.
Since: 3.8
gtk_widget_get_scale_factor ()
gint
gtk_widget_get_scale_factor (GtkWidget *widget);
Retrieves the internal scale factor that maps from window coordinates
to the actual device pixels. On traditional systems this is 1, on
high density outputs, it can be a higher value (typically 2).
See gdk_window_get_scale_factor().
Returns
the scale factor for widget
Since: 3.10
gtk_widget_add_tick_callback ()
guint
gtk_widget_add_tick_callback (GtkWidget *widget,
GtkTickCallback callback,
gpointer user_data,
GDestroyNotify notify);
Queues an animation frame update and adds a callback to be called
before each frame. Until the tick callback is removed, it will be
called frequently (usually at the frame rate of the output device
or as quickly as the application can be repainted, whichever is
slower). For this reason, is most suitable for handling graphics
that change every frame or every few frames. The tick callback does
not automatically imply a relayout or repaint. If you want a
repaint or relayout, and aren’t changing widget properties that
would trigger that (for example, changing the text of a GtkLabel),
then you will have to call gtk_widget_queue_resize() or
gtk_widget_queue_draw_area() yourself.
gdk_frame_clock_get_frame_time() should generally be used for timing
continuous animations and
gdk_frame_timings_get_predicted_presentation_time() if you are
trying to display isolated frames at particular times.
This is a more convenient alternative to connecting directly to the
“update” signal of GdkFrameClock, since you don't
have to worry about when a GdkFrameClock is assigned to a widget.
Since: 3.8
gtk_widget_size_request ()
void
gtk_widget_size_request (GtkWidget *widget,
GtkRequisition *requisition);
This function is typically used when implementing a GtkContainer
subclass. Obtains the preferred size of a widget. The container
uses this information to arrange its child widgets and decide what
size allocations to give them with gtk_widget_size_allocate().
You can also call this function from an application, with some
caveats. Most notably, getting a size request requires the widget
to be associated with a screen, because font information may be
needed. Multihead-aware applications should keep this in mind.
Also remember that the size request is not necessarily the size
a widget will actually be allocated.
gtk_widget_get_child_requisition ()
void
gtk_widget_get_child_requisition (GtkWidget *widget,
GtkRequisition *requisition);
gtk_widget_get_child_requisition has been deprecated since version 3.0 and should not be used in newly-written code.
Use gtk_widget_get_preferred_size() instead.
This function is only for use in widget implementations. Obtains
widget->requisition
, unless someone has forced a particular
geometry on the widget (e.g. with gtk_widget_set_size_request()),
in which case it returns that geometry instead of the widget's
requisition.
This function differs from gtk_widget_size_request() in that
it retrieves the last size request value from widget->requisition
,
while gtk_widget_size_request() actually calls the "size_request" method
on widget
to compute the size request and fill in widget->requisition
,
and only then returns widget->requisition
.
Because this function does not call the “size_request” method, it
can only be used when you know that widget->requisition
is
up-to-date, that is, gtk_widget_size_request() has been called
since the last time a resize was queued. In general, only container
implementations have this information; applications should use
gtk_widget_size_request().
gtk_widget_size_allocate ()
void
gtk_widget_size_allocate (GtkWidget *widget,
GtkAllocation *allocation);
This function is only used by GtkContainer subclasses, to assign a size
and position to their child widgets.
In this function, the allocation may be adjusted. It will be forced
to a 1x1 minimum size, and the adjust_size_allocation virtual
method on the child will be used to adjust the allocation. Standard
adjustments include removing the widget’s margins, and applying the
widget’s “halign” and “valign” properties.
For baseline support in containers you need to use gtk_widget_size_allocate_with_baseline()
instead.
gtk_widget_size_allocate_with_baseline ()
void
gtk_widget_size_allocate_with_baseline
(GtkWidget *widget,
GtkAllocation *allocation,
gint baseline);
This function is only used by GtkContainer subclasses, to assign a size,
position and (optionally) baseline to their child widgets.
In this function, the allocation and baseline may be adjusted. It
will be forced to a 1x1 minimum size, and the
adjust_size_allocation virtual and adjust_baseline_allocation
methods on the child will be used to adjust the allocation and
baseline. Standard adjustments include removing the widget's
margins, and applying the widget’s “halign” and
“valign” properties.
If the child widget does not have a valign of GTK_ALIGN_BASELINE the
baseline argument is ignored and -1 is used instead.
Since: 3.10
gtk_widget_set_accel_path ()
void
gtk_widget_set_accel_path (GtkWidget *widget,
const gchar *accel_path,
GtkAccelGroup *accel_group);
Given an accelerator group, accel_group
, and an accelerator path,
accel_path
, sets up an accelerator in accel_group
so whenever the
key binding that is defined for accel_path
is pressed, widget
will be activated. This removes any accelerators (for any
accelerator group) installed by previous calls to
gtk_widget_set_accel_path(). Associating accelerators with
paths allows them to be modified by the user and the modifications
to be saved for future use. (See gtk_accel_map_save().)
This function is a low level function that would most likely
be used by a menu creation system like GtkUIManager. If you
use GtkUIManager, setting up accelerator paths will be done
automatically.
Even when you you aren’t using GtkUIManager, if you only want to
set up accelerators on menu items gtk_menu_item_set_accel_path()
provides a somewhat more convenient interface.
Note that accel_path
string will be stored in a GQuark. Therefore, if you
pass a static string, you can save some memory by interning it first with
g_intern_static_string().
gtk_widget_can_activate_accel ()
gboolean
gtk_widget_can_activate_accel (GtkWidget *widget,
guint signal_id);
Determines whether an accelerator that activates the signal
identified by signal_id
can currently be activated.
This is done by emitting the “can-activate-accel”
signal on widget
; if the signal isn’t overridden by a
handler or in a derived widget, then the default check is
that the widget must be sensitive, and the widget and all
its ancestors mapped.
Returns
TRUE if the accelerator can be activated.
Since: 2.4
gtk_widget_event ()
gboolean
gtk_widget_event (GtkWidget *widget,
GdkEvent *event);
Rarely-used function. This function is used to emit
the event signals on a widget (those signals should never
be emitted without using this function to do so).
If you want to synthesize an event though, don’t use this function;
instead, use gtk_main_do_event() so the event will behave as if
it were in the event queue. Don’t synthesize expose events; instead,
use gdk_window_invalidate_rect() to invalidate a region of the
window.
Returns
return from the event signal emission (TRUE if
the event was handled)
gtk_widget_activate ()
gboolean
gtk_widget_activate (GtkWidget *widget);
For widgets that can be “activated” (buttons, menu items, etc.)
this function activates them. Activation is what happens when you
press Enter on a widget during key navigation. If widget
isn't
activatable, the function returns FALSE.
Returns
TRUE if the widget was activatable
gtk_widget_reparent ()
void
gtk_widget_reparent (GtkWidget *widget,
GtkWidget *new_parent);
Moves a widget from one GtkContainer to another, handling reference
count issues to avoid destroying the widget.
gtk_widget_intersect ()
gboolean
gtk_widget_intersect (GtkWidget *widget,
const GdkRectangle *area,
GdkRectangle *intersection);
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.
Returns
TRUE if there was an intersection
gtk_widget_is_focus ()
gboolean
gtk_widget_is_focus (GtkWidget *widget);
Determines if the widget is the focus widget within its
toplevel. (This does not mean that the “has-focus” property is
necessarily set; “has-focus” will only be set if the
toplevel widget additionally has the global input focus.)
Returns
TRUE if the widget is the focus widget.
gtk_widget_grab_focus ()
void
gtk_widget_grab_focus (GtkWidget *widget);
Causes widget
to have the keyboard focus for the GtkWindow it's
inside. widget
must be a focusable widget, such as a GtkEntry;
something like GtkFrame won’t work.
More precisely, it must have the GTK_CAN_FOCUS flag set. Use
gtk_widget_set_can_focus() to modify that flag.
The widget also needs to be realized and mapped. This is indicated by the
related signals. Grabbing the focus immediately after creating the widget
will likely fail and cause critical warnings.
gtk_widget_grab_default ()
void
gtk_widget_grab_default (GtkWidget *widget);
Causes widget
to become the default widget. widget
must be able to be
a default widget; typically you would ensure this yourself
by calling gtk_widget_set_can_default() with a TRUE value.
The default widget is activated when
the user presses Enter in a window. Default widgets must be
activatable, that is, gtk_widget_activate() should affect them. Note
that GtkEntry widgets require the “activates-default” property
set to TRUE before they activate the default widget when Enter
is pressed and the GtkEntry is focused.
gtk_widget_set_name ()
void
gtk_widget_set_name (GtkWidget *widget,
const gchar *name);
Widgets can be named, which allows you to refer to them from a
CSS file. You can apply a style to widgets with a particular name
in the CSS file. See the documentation for the CSS syntax (on the
same page as the docs for GtkStyleContext).
Note that the CSS syntax has certain special characters to delimit
and represent elements in a selector (period, #, >, *...), so using
these will make your widget impossible to match by name. Any combination
of alphanumeric symbols, dashes and underscores will suffice.
gtk_widget_get_name ()
const gchar *
gtk_widget_get_name (GtkWidget *widget);
Retrieves the name of a widget. See gtk_widget_set_name() for the
significance of widget names.
Returns
name of the widget. This string is owned by GTK+ and
should not be modified or freed
gtk_widget_set_state ()
void
gtk_widget_set_state (GtkWidget *widget,
GtkStateType state);
gtk_widget_set_state has been deprecated since version 3.0 and should not be used in newly-written code.
Use gtk_widget_set_state_flags() instead.
This function is for use in widget implementations. Sets the state
of a widget (insensitive, prelighted, etc.) Usually you should set
the state using wrapper functions such as gtk_widget_set_sensitive().
gtk_widget_set_sensitive ()
void
gtk_widget_set_sensitive (GtkWidget *widget,
gboolean sensitive);
Sets the sensitivity of a widget. A widget is sensitive if the user
can interact with it. Insensitive widgets are “grayed out” and the
user can’t interact with them. Insensitive widgets are known as
“inactive”, “disabled”, or “ghosted” in some other toolkits.
gtk_widget_set_parent ()
void
gtk_widget_set_parent (GtkWidget *widget,
GtkWidget *parent);
This function is useful only when implementing subclasses of
GtkContainer.
Sets the container as the parent of widget
, and takes care of
some details such as updating the state and style of the child
to reflect its new location. The opposite function is
gtk_widget_unparent().
gtk_widget_set_parent_window ()
void
gtk_widget_set_parent_window (GtkWidget *widget,
GdkWindow *parent_window);
Sets a non default parent window for widget
.
For GtkWindow classes, setting a parent_window
effects whether
the window is a toplevel window or can be embedded into other
widgets.
For GtkWindow classes, this needs to be called before the
window is realized.
gtk_widget_get_parent_window ()
GdkWindow *
gtk_widget_get_parent_window (GtkWidget *widget);
Gets widget
’s parent window, or NULL if it does not have one.
Returns
the parent window of widget
, or NULL
if it does not have a parent window.
[transfer none][nullable]
gtk_widget_set_events ()
void
gtk_widget_set_events (GtkWidget *widget,
gint events);
Sets the event mask (see GdkEventMask) for a widget. The event
mask determines which events a widget will receive. Keep in mind
that different widgets have different default event masks, and by
changing the event mask you may disrupt a widget’s functionality,
so be careful. This function must be called while a widget is
unrealized. Consider gtk_widget_add_events() for widgets that are
already realized, or if you want to preserve the existing event
mask. This function can’t be used with widgets that have no window.
(See gtk_widget_get_has_window()). To get events on those widgets,
place them inside a GtkEventBox and receive events on the event
box.
gtk_widget_get_events ()
gint
gtk_widget_get_events (GtkWidget *widget);
Returns the event mask (see GdkEventMask) for the widget. These are the
events that the widget will receive.
Note: Internally, the widget event mask will be the logical OR of the event
mask set through gtk_widget_set_events() or gtk_widget_add_events(), and the
event mask necessary to cater for every GtkEventController created for the
widget.
Returns
event mask for widget
gtk_widget_set_device_events ()
void
gtk_widget_set_device_events (GtkWidget *widget,
GdkDevice *device,
GdkEventMask events);
Sets the device event mask (see GdkEventMask) for a widget. The event
mask determines which events a widget will receive from device
. Keep
in mind that different widgets have different default event masks, and by
changing the event mask you may disrupt a widget’s functionality,
so be careful. This function must be called while a widget is
unrealized. Consider gtk_widget_add_device_events() for widgets that are
already realized, or if you want to preserve the existing event
mask. This function can’t be used with windowless widgets (which return
FALSE from gtk_widget_get_has_window());
to get events on those widgets, place them inside a GtkEventBox
and receive events on the event box.
Since: 3.0
gtk_widget_get_device_events ()
GdkEventMask
gtk_widget_get_device_events (GtkWidget *widget,
GdkDevice *device);
Returns the events mask for the widget corresponding to an specific device. These
are the events that the widget will receive when device
operates on it.
Returns
device event mask for widget
Since: 3.0
gtk_widget_set_device_enabled ()
void
gtk_widget_set_device_enabled (GtkWidget *widget,
GdkDevice *device,
gboolean enabled);
Enables or disables a GdkDevice to interact with widget
and all its children.
It does so by descending through the GdkWindow hierarchy
and enabling the same mask that is has for core events
(i.e. the one that gdk_window_get_events() returns).
Since: 3.0
gtk_widget_get_toplevel ()
GtkWidget *
gtk_widget_get_toplevel (GtkWidget *widget);
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();
gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW)
would return
NULL if widget
wasn’t inside a toplevel window, and if the
window was inside a GtkWindow-derived widget which was in turn
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 call GTK_IS_WINDOW()
on the result. For instance, to get the title of a widget's toplevel
window, one might use:
Returns
the topmost ancestor of widget
, or widget
itself
if there’s no ancestor.
[transfer none]
gtk_widget_get_ancestor ()
GtkWidget *
gtk_widget_get_ancestor (GtkWidget *widget,
GType widget_type);
Gets the first ancestor of widget
with type widget_type
. For example,
gtk_widget_get_ancestor (widget, GTK_TYPE_BOX) gets
the first GtkBox that’s an ancestor of widget
. No reference will be
added to the returned widget; it should not be unreferenced. See note
about checking for a toplevel GtkWindow in the docs for
gtk_widget_get_toplevel().
Note that unlike gtk_widget_is_ancestor(), gtk_widget_get_ancestor()
considers widget
to be an ancestor of itself.
Returns
the ancestor widget, or NULL if not found.
[transfer none][nullable]
gtk_widget_get_visual ()
GdkVisual *
gtk_widget_get_visual (GtkWidget *widget);
Gets the visual that will be used to render widget
.
Returns
the visual for widget
.
[transfer none]
gtk_widget_set_visual ()
void
gtk_widget_set_visual (GtkWidget *widget,
GdkVisual *visual);
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 gtk_widget_get_screen(), so handling the
“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.
gtk_widget_get_pointer ()
void
gtk_widget_get_pointer (GtkWidget *widget,
gint *x,
gint *y);
Obtains the location of the mouse pointer in widget coordinates.
Widget coordinates are a bit odd; for historical reasons, they are
defined as widget->window
coordinates for widgets that return TRUE for
gtk_widget_get_has_window(); and are relative to widget->allocation.x
,
widget->allocation.y
otherwise.
gtk_widget_is_ancestor ()
gboolean
gtk_widget_is_ancestor (GtkWidget *widget,
GtkWidget *ancestor);
Determines whether widget
is somewhere inside ancestor
, possibly with
intermediate containers.
Returns
TRUE if ancestor
contains widget
as a child,
grandchild, great grandchild, etc.
gtk_widget_translate_coordinates ()
gboolean
gtk_widget_translate_coordinates (GtkWidget *src_widget,
GtkWidget *dest_widget,
gint src_x,
gint src_y,
gint *dest_x,
gint *dest_y);
Translate coordinates relative to src_widget
’s allocation to coordinates
relative to dest_widget
’s allocations. In order to perform this
operation, both widgets must be realized, and must share a common
toplevel.
Returns
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.
gtk_widget_hide_on_delete ()
gboolean
gtk_widget_hide_on_delete (GtkWidget *widget);
Utility function; intended to be connected to the “delete-event”
signal on a GtkWindow. The function calls gtk_widget_hide() on its
argument, then returns TRUE. If connected to ::delete-event, the
result is that clicking the close button for a window (on the
window frame, top right corner usually) will hide but not destroy
the window. By default, GTK+ destroys windows when ::delete-event
is received.
gtk_widget_set_style ()
void
gtk_widget_set_style (GtkWidget *widget,
GtkStyle *style);
gtk_widget_set_style has been deprecated since version 3.0 and should not be used in newly-written code.
Use GtkStyleContext instead
Used to set the GtkStyle for a widget (widget->style
). Since
GTK 3, this function does nothing, the passed in style is ignored.
gtk_widget_ensure_style ()
void
gtk_widget_ensure_style (GtkWidget *widget);
gtk_widget_ensure_style has been deprecated since version 3.0 and should not be used in newly-written code.
Use GtkStyleContext instead
Ensures that widget
has a style (widget->style
).
Not a very useful function; most of the time, if you
want the style, the widget is realized, and realized
widgets are guaranteed to have a style already.
gtk_widget_get_style ()
GtkStyle *
gtk_widget_get_style (GtkWidget *widget);
gtk_widget_get_style has been deprecated since version 3.0 and should not be used in newly-written code.
Use GtkStyleContext instead
Simply an accessor function that returns widget->style
.
Returns
the widget’s GtkStyle.
[transfer none]
gtk_widget_reset_rc_styles ()
void
gtk_widget_reset_rc_styles (GtkWidget *widget);
Reset the styles of widget
and all descendents, so when
they are looked up again, they get the correct values
for the currently loaded RC file settings.
This function is not useful for applications.
gtk_widget_get_default_style ()
GtkStyle *
gtk_widget_get_default_style (void);
Returns the default style used by all widgets initially.
Returns
the default style. This GtkStyle
object is owned by GTK+ and should not be modified or freed.
[transfer none]
gtk_widget_set_direction ()
void
gtk_widget_set_direction (GtkWidget *widget,
GtkTextDirection dir);
Sets the reading direction on a particular widget. This direction
controls the primary direction for widgets containing text,
and also the direction in which the children of a container are
packed. The ability to set the direction is present in order
so that correct localization into languages with right-to-left
reading directions can be done. Generally, applications will
let the default reading direction present, except for containers
where the containers are arranged in an order that is explicitly
visual rather than logical (such as buttons for text justification).
If the direction is set to GTK_TEXT_DIR_NONE, then the value
set by gtk_widget_set_default_direction() will be used.
gtk_widget_set_default_direction ()
void
gtk_widget_set_default_direction (GtkTextDirection dir);
Sets the default reading direction for widgets where the
direction has not been explicitly set by gtk_widget_set_direction().
gtk_widget_input_shape_combine_region ()
void
gtk_widget_input_shape_combine_region (GtkWidget *widget,
cairo_region_t *region);
Sets an input shape for this widget’s GDK window. This allows for
windows which react to mouse click in a nonrectangular region, see
gdk_window_input_shape_combine_region() for more information.
Since: 3.0
gtk_widget_path ()
void
gtk_widget_path (GtkWidget *widget,
guint *path_length,
gchar **path,
gchar **path_reversed);
gtk_widget_path has been deprecated since version 3.0 and should not be used in newly-written code.
Use gtk_widget_get_path() instead
Obtains the full path to widget
. The path is simply the name of a
widget and all its parents in the container hierarchy, separated by
periods. The name of a widget comes from
gtk_widget_get_name(). Paths are used to apply styles to a widget
in gtkrc configuration files. Widget names are the type of the
widget by default (e.g. “GtkButton”) or can be set to an
application-specific value with gtk_widget_set_name(). By setting
the name of a widget, you allow users or theme authors to apply
styles to that specific widget in their gtkrc
file. path_reversed_p
fills in the path in reverse order,
i.e. starting with widget
’s name instead of starting with the name
of widget
’s outermost ancestor.
gtk_widget_get_composite_name ()
gchar *
gtk_widget_get_composite_name (GtkWidget *widget);
gtk_widget_get_composite_name has been deprecated since version 3.10 and should not be used in newly-written code.
Use gtk_widget_class_set_template(), or don’t use this API at all.
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
longer needed.
gtk_widget_override_background_color ()
void
gtk_widget_override_background_color (GtkWidget *widget,
GtkStateFlags state,
const GdkRGBA *color);
gtk_widget_override_background_color has been deprecated since version 3.16 and should not be used in newly-written code.
This function is not useful in the context of CSS-based
rendering. If you wish to change the way a widget renders its background
you should use a custom CSS style, through an application-specific
GtkStyleProvider and a CSS style class. You can also override the default
drawing of a widget through the “draw” signal, and use Cairo to
draw a specific color, regardless of the CSS style.
Sets the background color to use for a widget.
All other style values are left untouched.
See gtk_widget_override_color().
Since: 3.0
gtk_widget_override_color ()
void
gtk_widget_override_color (GtkWidget *widget,
GtkStateFlags state,
const GdkRGBA *color);
gtk_widget_override_color has been deprecated since version 3.16 and should not be used in newly-written code.
Use a custom style provider and style classes instead
Sets the color to use for a widget.
All other style values are left untouched.
This function does not act recursively. Setting the color of a
container does not affect its children. Note that some widgets that
you may not think of as containers, for instance GtkButtons,
are actually containers.
This API is mostly meant as a quick way for applications to
change a widget appearance. If you are developing a widgets
library and intend this change to be themeable, it is better
done by setting meaningful CSS classes in your
widget/container implementation through gtk_style_context_add_class().
This way, your widget library can install a GtkCssProvider
with the GTK_STYLE_PROVIDER_PRIORITY_FALLBACK priority in order
to provide a default styling for those widgets that need so, and
this theming may fully overridden by the user’s theme.
Note that for complex widgets this may bring in undesired
results (such as uniform background color everywhere), in
these cases it is better to fully style such widgets through a
GtkCssProvider with the GTK_STYLE_PROVIDER_PRIORITY_APPLICATION
priority.
Since: 3.0
gtk_widget_override_font ()
void
gtk_widget_override_font (GtkWidget *widget,
const PangoFontDescription *font_desc);
gtk_widget_override_font has been deprecated since version 3.16 and should not be used in newly-written code.
This function is not useful in the context of CSS-based
rendering. If you wish to change the font a widget uses to render its text
you should use a custom CSS style, through an application-specific
GtkStyleProvider and a CSS style class.
Sets the font to use for a widget. All other style values are
left untouched. See gtk_widget_override_color().
Since: 3.0
gtk_widget_override_symbolic_color ()
void
gtk_widget_override_symbolic_color (GtkWidget *widget,
const gchar *name,
const GdkRGBA *color);
gtk_widget_override_symbolic_color has been deprecated since version 3.16 and should not be used in newly-written code.
This function is not useful in the context of CSS-based
rendering. If you wish to change the color used to render symbolic icons
you should use a custom CSS style, through an application-specific
GtkStyleProvider and a CSS style class.
Sets a symbolic color for a widget.
All other style values are left untouched.
See gtk_widget_override_color() for overriding the foreground
or background color.
Since: 3.0
gtk_widget_override_cursor ()
void
gtk_widget_override_cursor (GtkWidget *widget,
const GdkRGBA *cursor,
const GdkRGBA *secondary_cursor);
gtk_widget_override_cursor has been deprecated since version 3.16 and should not be used in newly-written code.
This function is not useful in the context of CSS-based
rendering. If you wish to change the color used to render the primary
and secondary cursors you should use a custom CSS style, through an
application-specific GtkStyleProvider and a CSS style class.
Sets the cursor color to use in a widget, overriding the
cursor-color and secondary-cursor-color
style properties. All other style values are left untouched.
See also gtk_widget_modify_style().
Note that the underlying properties have the GdkColor type,
so the alpha value in primary
and secondary
will be ignored.
Since: 3.0
gtk_widget_modify_style ()
void
gtk_widget_modify_style (GtkWidget *widget,
GtkRcStyle *style);
gtk_widget_modify_style has been deprecated since version 3.0 and should not be used in newly-written code.
Use GtkStyleContext with a custom GtkStyleProvider instead
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 overridden
if a style is explicitly set on the widget using gtk_widget_set_style().
The GtkRcStyle is designed so each field can either be
set or unset, so it is possible, using this function, to modify some
style values and leave the others unchanged.
Note that modifications made with this function are not cumulative
with previous calls to gtk_widget_modify_style() or with such
functions as gtk_widget_modify_fg(). If you wish to retain
previous values, you must first call gtk_widget_get_modifier_style(),
make your modifications to the returned style, then call
gtk_widget_modify_style() with that style. On the other hand,
if you first call gtk_widget_modify_style(), subsequent calls
to such functions gtk_widget_modify_fg() will have a cumulative
effect with the initial modifications.
gtk_widget_get_modifier_style ()
GtkRcStyle *
gtk_widget_get_modifier_style (GtkWidget *widget);
gtk_widget_get_modifier_style has been deprecated since version 3.0 and should not be used in newly-written code.
Use GtkStyleContext with a custom GtkStyleProvider instead
Returns the current modifier style for the widget. (As set by
gtk_widget_modify_style().) If no style has previously set, a new
GtkRcStyle will be created with all values unset, and set as the
modifier style for the widget. If you make changes to this rc
style, you must call gtk_widget_modify_style(), passing in the
returned rc style, to make sure that your changes take effect.
Caution: passing the style back to gtk_widget_modify_style() will
normally end up destroying it, because gtk_widget_modify_style() copies
the passed-in style and sets the copy as the new modifier style,
thus dropping any reference to the old modifier style. Add a reference
to the modifier style if you want to keep it alive.
Returns
the modifier style for the widget.
This rc style is owned by the widget. If you want to keep a
pointer to value this around, you must add a refcount using
g_object_ref().
[transfer none]
gtk_widget_modify_bg ()
void
gtk_widget_modify_bg (GtkWidget *widget,
GtkStateType state,
const GdkColor *color);
Sets the background color for a widget in a particular state.
All other style values are left untouched.
See also gtk_widget_modify_style().
Note that “no window” widgets (which have the GTK_NO_WINDOW
flag set) draw on their parent container’s window and thus may
not draw any background themselves. This is the case for e.g.
GtkLabel.
To modify the background of such widgets, you have to set the
background color on their parent; if you want to set the background
of a rectangular area around a label, try placing the label in
a GtkEventBox widget and setting the background color on that.
gtk_widget_modify_base ()
void
gtk_widget_modify_base (GtkWidget *widget,
GtkStateType state,
const GdkColor *color);
Sets the base color for a widget in a particular state.
All other style values are left untouched. The base color
is the background color used along with the text color
(see gtk_widget_modify_text()) for widgets such as GtkEntry
and GtkTextView. See also gtk_widget_modify_style().
Note that “no window” widgets (which have the GTK_NO_WINDOW
flag set) draw on their parent container’s window and thus may
not draw any background themselves. This is the case for e.g.
GtkLabel.
To modify the background of such widgets, you have to set the
base color on their parent; if you want to set the background
of a rectangular area around a label, try placing the label in
a GtkEventBox widget and setting the base color on that.
gtk_widget_modify_cursor ()
void
gtk_widget_modify_cursor (GtkWidget *widget,
const GdkColor *primary,
const GdkColor *secondary);
gtk_widget_modify_cursor has been deprecated since version 3.0 and should not be used in newly-written code.
Use gtk_widget_override_cursor() instead.
Sets the cursor color to use in a widget, overriding the GtkWidget
cursor-color and secondary-cursor-color
style properties.
All other style values are left untouched.
See also gtk_widget_modify_style().
Since: 2.12
gtk_widget_get_pango_context ()
PangoContext *
gtk_widget_get_pango_context (GtkWidget *widget);
Gets a PangoContext with the appropriate font map, font description,
and base direction for this widget. Unlike the context returned
by gtk_widget_create_pango_context(), this context is owned by
the widget (it can be used until the screen for the widget changes
or the widget is removed from its toplevel), and will be updated to
match any changes to the widget’s attributes. This can be tracked
by using the “screen-changed” signal on the widget.
gtk_widget_set_font_map ()
void
gtk_widget_set_font_map (GtkWidget *widget,
PangoFontMap *font_map);
Sets the font map to use for Pango rendering. When not set, the widget
will inherit the font map from its parent.
Since: 3.18
gtk_widget_create_pango_layout ()
PangoLayout *
gtk_widget_create_pango_layout (GtkWidget *widget,
const gchar *text);
Creates a new PangoLayout with the appropriate font map,
font description, and base direction for drawing text for
this widget.
If you keep a PangoLayout created in this way around, you need
to re-create it when the widget PangoContext is replaced.
This can be tracked by using the “screen-changed” signal
on the widget.
gtk_widget_render_icon ()
GdkPixbuf *
gtk_widget_render_icon (GtkWidget *widget,
const gchar *stock_id,
GtkIconSize size,
const gchar *detail);
A convenience function that uses the theme settings for widget
to look up stock_id
and render it to a pixbuf. stock_id
should
be a stock icon ID such as GTK_STOCK_OPEN or GTK_STOCK_OK. size
should be a size such as GTK_ICON_SIZE_MENU. detail
should be a
string that identifies the widget or code doing the rendering, so
that theme engines can special-case rendering for that widget or
code.
The pixels in the returned GdkPixbuf are shared with the rest of
the application and should not be modified. The pixbuf should be
freed after use with g_object_unref().
Returns
a new pixbuf, or NULL if the
stock ID wasn’t known.
[nullable][transfer full]
gtk_widget_render_icon_pixbuf ()
GdkPixbuf *
gtk_widget_render_icon_pixbuf (GtkWidget *widget,
const gchar *stock_id,
GtkIconSize size);
gtk_widget_render_icon_pixbuf has been deprecated since version 3.10 and should not be used in newly-written code.
Use gtk_icon_theme_load_icon() instead.
A convenience function that uses the theme engine and style
settings for widget
to look up stock_id
and render it to
a pixbuf. stock_id
should be a stock icon ID such as
GTK_STOCK_OPEN or GTK_STOCK_OK. size
should be a size
such as GTK_ICON_SIZE_MENU.
The pixels in the returned GdkPixbuf are shared with the rest of
the application and should not be modified. The pixbuf should be freed
after use with g_object_unref().
Returns
a new pixbuf, or NULL if the
stock ID wasn’t known.
[transfer full][nullable]
Since: 3.0
gtk_widget_pop_composite_child ()
void
gtk_widget_pop_composite_child (void);
gtk_widget_pop_composite_child has been deprecated since version 3.10 and should not be used in newly-written code.
Use gtk_widget_class_set_template(), or don’t use this API at all.
Cancels the effect of a previous call to gtk_widget_push_composite_child().
gtk_widget_push_composite_child ()
void
gtk_widget_push_composite_child (void);
gtk_widget_push_composite_child has been deprecated since version 3.10 and should not be used in newly-written code.
This API never really worked well and was mostly unused, now
we have a more complete mechanism for composite children, see gtk_widget_class_set_template().
Makes all newly-created widgets as composite children until
the corresponding gtk_widget_pop_composite_child() call.
A composite child is a child that’s an implementation detail of the
container it’s inside and should not be visible to people using the
container. Composite children aren’t treated differently by GTK+ (but
see gtk_container_foreach() vs. gtk_container_forall()), but e.g. GUI
builders might want to treat them in a different way.
gtk_widget_queue_draw_area ()
void
gtk_widget_queue_draw_area (GtkWidget *widget,
gint x,
gint y,
gint width,
gint height);
Convenience function that calls gtk_widget_queue_draw_region() on
the region created from the given coordinates.
The region here is specified in widget coordinates.
Widget coordinates are a bit odd; for historical reasons, they are
defined as widget->window
coordinates for widgets that return TRUE for
gtk_widget_get_has_window(), and are relative to widget->allocation.x
,
widget->allocation.y
otherwise.
width
or height
may be 0, in this case this function does
nothing. Negative values for width
and height
are not allowed.
gtk_widget_queue_draw_region ()
void
gtk_widget_queue_draw_region (GtkWidget *widget,
const cairo_region_t *region);
Invalidates the 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 to schedule a redraw of a
GtkDrawingArea or some portion thereof.
Since: 3.0
gtk_widget_set_app_paintable ()
void
gtk_widget_set_app_paintable (GtkWidget *widget,
gboolean app_paintable);
Sets whether the application intends to draw on the widget in
an “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
is then entirely responsible for drawing the widget background.
Note that the background is still drawn when the widget is mapped.
gtk_widget_set_double_buffered ()
void
gtk_widget_set_double_buffered (GtkWidget *widget,
gboolean double_buffered);
gtk_widget_set_double_buffered has been deprecated since version 3.14 and should not be used in newly-written code.
This function does not work under non-X11 backends or with
non-native windows.
It should not be used in newly written code.
Widgets are double buffered by default; you can use this function
to turn off the buffering. “Double buffered” simply means that
gdk_window_begin_draw_frame() and gdk_window_end_draw_frame() are called
automatically around expose events sent to the
widget. gdk_window_begin_draw_frame() diverts all drawing to a widget's
window to an offscreen buffer, and gdk_window_end_draw_frame() draws the
buffer to the screen. The result is that users see the window
update in one smooth step, and don’t see individual graphics
primitives being rendered.
In very simple terms, double buffered widgets don’t flicker,
so you would only use this function to turn off double buffering
if you had special needs and really knew what you were doing.
Note: if you turn off double-buffering, you have to handle
expose events, since even the clearing to the background color or
pixmap will not happen automatically (as it is done in
gdk_window_begin_draw_frame()).
In 3.10 GTK and GDK have been restructured for translucent drawing. Since
then expose events for double-buffered widgets are culled into a single
event to the toplevel GDK window. If you now unset double buffering, you
will cause a separate rendering pass for every widget. This will likely
cause rendering problems - in particular related to stacking - and usually
increases rendering times significantly.
gtk_widget_set_redraw_on_allocate ()
void
gtk_widget_set_redraw_on_allocate (GtkWidget *widget,
gboolean redraw_on_allocate);
Sets whether the entire widget is queued for drawing when its size
allocation changes. By default, this setting is TRUE and
the entire widget is redrawn on every size change. If your widget
leaves the upper left unchanged when made bigger, turning this
setting off will improve performance.
Note that for widgets where gtk_widget_get_has_window() is FALSE
setting this flag to FALSE turns off all allocation on resizing:
the widget will not even redraw if its position changes; this is to
allow containers that don’t draw anything to avoid excess
invalidations. If you set this flag on a widget with no window that
does draw on widget->window
, you are
responsible for invalidating both the old and new allocation of the
widget when the widget is moved and responsible for invalidating
regions newly when the widget increases size.
gtk_widget_set_composite_name ()
void
gtk_widget_set_composite_name (GtkWidget *widget,
const gchar *name);
gtk_widget_set_composite_name has been deprecated since version 3.10 and should not be used in newly-written code.
Use gtk_widget_class_set_template(), or don’t use this API at all.
Sets a widgets composite name. The widget must be
a composite child of its parent; see gtk_widget_push_composite_child().
gtk_widget_class_install_style_property ()
void
gtk_widget_class_install_style_property
(GtkWidgetClass *klass,
GParamSpec *pspec);
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_install_style_property_parser ()
void
gtk_widget_class_install_style_property_parser
(GtkWidgetClass *klass,
GParamSpec *pspec,
GtkRcPropertyParser parser);
Installs a style property on a widget class.
[skip]
gtk_widget_class_find_style_property ()
GParamSpec *
gtk_widget_class_find_style_property (GtkWidgetClass *klass,
const gchar *property_name);
Finds a style property of a widget class by name.
Returns
the GParamSpec of the style property or
NULL if class
has no style property with that name.
[transfer none]
Since: 2.2
gtk_widget_class_list_style_properties ()
GParamSpec **
gtk_widget_class_list_style_properties
(GtkWidgetClass *klass,
guint *n_properties);
Returns all style properties of a widget class.
Returns
a
newly allocated array of GParamSpec*. The array must be
freed with g_free().
[array length=n_properties][transfer container]
Since: 2.2
gtk_widget_region_intersect ()
cairo_region_t *
gtk_widget_region_intersect (GtkWidget *widget,
const cairo_region_t *region);
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.
Returns
A newly allocated region holding the intersection of widget
and region
.
gtk_widget_send_expose ()
gint
gtk_widget_send_expose (GtkWidget *widget,
GdkEvent *event);
gtk_widget_send_expose has been deprecated since version 3.22 and should not be used in newly-written code.
Application and widget code should not handle
expose events directly; invalidation should use the GtkWidget
API, and drawing should only happen inside “draw”
implementations
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 windowless child widget (gtk_widget_get_has_window() is FALSE),
and that is normally done using gtk_container_propagate_draw().
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().
Returns
return from the event signal emission (TRUE if
the event was handled)
gtk_widget_send_focus_change ()
gboolean
gtk_widget_send_focus_change (GtkWidget *widget,
GdkEvent *event);
Sends the focus change event
to widget
This function is not meant to be used by applications. The only time it
should be used is when it is necessary for a GtkWidget to assign focus
to a widget that is semantically owned by the first widget even though
it’s not a direct child - for instance, a search entry in a floating
window similar to the quick search in GtkTreeView.
An example of its usage is:
Returns
the return value from the event signal emission: TRUE
if the event was handled, and FALSE otherwise
Since: 2.20
gtk_widget_style_get ()
void
gtk_widget_style_get (GtkWidget *widget,
const gchar *first_property_name,
...);
Gets the values of a multiple style properties of widget
.
gtk_widget_style_get_property ()
void
gtk_widget_style_get_property (GtkWidget *widget,
const gchar *property_name,
GValue *value);
Gets the value of a style property of widget
.
gtk_widget_style_get_valist ()
void
gtk_widget_style_get_valist (GtkWidget *widget,
const gchar *first_property_name,
va_list var_args);
Non-vararg variant of gtk_widget_style_get(). Used primarily by language
bindings.
gtk_widget_style_attach ()
void
gtk_widget_style_attach (GtkWidget *widget);
gtk_widget_style_attach has been deprecated since version 3.0 and should not be used in newly-written code.
This step is unnecessary with GtkStyleContext.
This function attaches the widget’s GtkStyle to the widget's
GdkWindow. It is a replacement for
and should only ever be called in a derived widget’s “realize”
implementation which does not chain up to its parent class'
“realize” implementation, because one of the parent classes
(finally GtkWidget) would attach the style itself.
Since: 2.20
gtk_widget_class_set_accessible_type ()
void
gtk_widget_class_set_accessible_type (GtkWidgetClass *widget_class,
GType type);
Sets the type to be used for creating accessibles for widgets of
widget_class
. The given type
must be a subtype of the type used for
accessibles of the parent class.
This function should only be called from class init functions of widgets.
Since: 3.2
gtk_widget_class_set_accessible_role ()
void
gtk_widget_class_set_accessible_role (GtkWidgetClass *widget_class,
AtkRole role);
Sets the default AtkRole to be set on accessibles created for
widgets of widget_class
. Accessibles may decide to not honor this
setting if their role reporting is more refined. Calls to
gtk_widget_class_set_accessible_type() will reset this value.
In cases where you want more fine-grained control over the role of
accessibles created for widget_class
, you should provide your own
accessible type and use gtk_widget_class_set_accessible_type()
instead.
If role
is ATK_ROLE_INVALID, the default role will not be changed
and the accessible’s default role will be used instead.
This function should only be called from class init functions of widgets.
Since: 3.2
gtk_widget_get_accessible ()
AtkObject *
gtk_widget_get_accessible (GtkWidget *widget);
Returns the accessible object that describes the widget to an
assistive technology.
If accessibility support is not available, this AtkObject
instance may be a no-op. Likewise, if no class-specific AtkObject
implementation is available for the widget instance in question,
it will inherit an AtkObject implementation from the first ancestor
class for which such an implementation is defined.
The documentation of the
ATK
library contains more information about accessible objects and their uses.
Returns
the AtkObject associated with widget
.
[transfer none]
gtk_widget_child_focus ()
gboolean
gtk_widget_child_focus (GtkWidget *widget,
GtkDirectionType direction);
This function is used by custom widget implementations; if you're
writing an app, you’d use gtk_widget_grab_focus() to move the focus
to a particular widget, and gtk_container_set_focus_chain() to
change the focus tab order. So you may want to investigate those
functions instead.
gtk_widget_child_focus() is called by containers as the user moves
around the window using keyboard shortcuts. direction
indicates
what kind of motion is taking place (up, down, left, right, tab
forward, tab backward). gtk_widget_child_focus() emits the
“focus” signal; widgets override the default handler
for this signal in order to implement appropriate focus behavior.
The default ::focus handler for a widget should return TRUE if
moving in direction
left the focus on a focusable location inside
that widget, and FALSE if moving in direction
moved the focus
outside the widget. If returning TRUE, widgets normally
call gtk_widget_grab_focus() to place the focus accordingly;
if returning FALSE, they don’t modify the current focus location.
Returns
TRUE if focus ended up inside widget
gtk_widget_get_child_visible ()
gboolean
gtk_widget_get_child_visible (GtkWidget *widget);
Gets the value set with gtk_widget_set_child_visible().
If you feel a need to use this function, your code probably
needs reorganization.
This function is only useful for container implementations and
never should be called by an application.
Returns
TRUE if the widget is mapped with the parent.
gtk_widget_get_parent ()
GtkWidget *
gtk_widget_get_parent (GtkWidget *widget);
Returns the parent container of widget
.
Returns
the parent container of widget
, or NULL.
[transfer none][nullable]
gtk_widget_get_settings ()
GtkSettings *
gtk_widget_get_settings (GtkWidget *widget);
Gets the settings object holding the settings used for this widget.
Note that this function can only be called when the GtkWidget
is attached to a toplevel, since the settings object is specific
to a particular GdkScreen.
Returns
the relevant GtkSettings object.
[transfer none]
gtk_widget_get_clipboard ()
GtkClipboard *
gtk_widget_get_clipboard (GtkWidget *widget,
GdkAtom 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
window.
Returns
the appropriate clipboard object. If no
clipboard already exists, a new one will
be created. Once a clipboard object has
been created, it is persistent for all time.
[transfer none]
Since: 2.2
gtk_widget_get_display ()
GdkDisplay *
gtk_widget_get_display (GtkWidget *widget);
Get the GdkDisplay for the toplevel window associated with
this widget. This function can only be called after the widget
has been added to a widget hierarchy with a GtkWindow at the top.
In general, you should only create display specific
resources when a widget has been realized, and you should
free those resources when the widget is unrealized.
Returns
the GdkDisplay for the toplevel for this widget.
[transfer none]
Since: 2.2
gtk_widget_get_root_window ()
GdkWindow *
gtk_widget_get_root_window (GtkWidget *widget);
gtk_widget_get_root_window has been deprecated since version 3.12 and should not be used in newly-written code.
Use gdk_screen_get_root_window() instead
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.
The root window is useful for such purposes as creating a popup
GdkWindow associated with the window. In general, you should only
create display specific resources when a widget has been realized,
and you should free those resources when the widget is unrealized.
Returns
the GdkWindow root window for the toplevel for this widget.
[transfer none]
Since: 2.2
gtk_widget_get_screen ()
GdkScreen *
gtk_widget_get_screen (GtkWidget *widget);
Get the GdkScreen from the toplevel window associated with
this widget. This function can only be called after the widget
has been added to a widget hierarchy with a GtkWindow
at the top.
In general, you should only create screen specific
resources when a widget has been realized, and you should
free those resources when the widget is unrealized.
Returns
the GdkScreen for the toplevel for this widget.
[transfer none]
Since: 2.2
gtk_widget_has_screen ()
gboolean
gtk_widget_has_screen (GtkWidget *widget);
Checks whether there is a GdkScreen is associated with
this widget. All toplevel widgets have an associated
screen, and all widgets added into a hierarchy with a toplevel
window at the top.
Since: 2.2
gtk_widget_set_child_visible ()
void
gtk_widget_set_child_visible (GtkWidget *widget,
gboolean is_visible);
Sets whether widget
should be mapped along with its when its parent
is mapped and widget
has been shown with gtk_widget_show().
The child visibility can be set for widget before it is added to
a container with gtk_widget_set_parent(), to avoid mapping
children unnecessary before immediately unmapping them. However
it will be reset to its default state of TRUE when the widget
is removed from a container.
Note that changing the child visibility of a widget does not
queue a resize on the widget. Most of the time, the size of
a widget is computed from all visible children, whether or
not they are mapped. If this is not the case, the container
can queue a resize itself.
This function is only useful for container implementations and
never should be called by an application.
gtk_widget_set_size_request ()
void
gtk_widget_set_size_request (GtkWidget *widget,
gint width,
gint height);
Sets the minimum size of a widget; that is, the widget’s size
request will be at least width
by height
. You can use this
function to force a widget to be larger than it normally would be.
In most cases, gtk_window_set_default_size() is a better choice for
toplevel windows than this function; setting the default size will
still allow users to shrink the window. Setting the size request
will force them to leave the window at least as large as the size
request. When dealing with window sizes,
gtk_window_set_geometry_hints() can be a useful function as well.
Note the inherent danger of setting any fixed size - themes,
translations into other languages, different fonts, and user action
can all change the appropriate size for a given widget. So, it's
basically impossible to hardcode a size that will always be
correct.
The size request of a widget is the smallest size a widget can
accept while still functioning well and drawing itself correctly.
However in some strange cases a widget may be allocated less than
its requested size, and in many cases a widget may be allocated more
space than it requested.
If the size request in a given direction is -1 (unset), then
the “natural” size request of the widget will be used instead.
The size request set here does not include any margin from the
GtkWidget properties margin-left, margin-right, margin-top, and
margin-bottom, but it does include pretty much all other padding
or border properties set by any subclass of GtkWidget.
gtk_widget_set_no_show_all ()
void
gtk_widget_set_no_show_all (GtkWidget *widget,
gboolean no_show_all);
Sets the “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
gtk_widget_get_no_show_all ()
gboolean
gtk_widget_get_no_show_all (GtkWidget *widget);
Returns the current value of the “no-show-all” property,
which determines whether calls to gtk_widget_show_all()
will affect this widget.
Returns
the current value of the “no-show-all” property.
Since: 2.4
gtk_widget_list_mnemonic_labels ()
GList *
gtk_widget_list_mnemonic_labels (GtkWidget *widget);
Returns a newly allocated list of the widgets, normally labels, for
which this widget is the target of a mnemonic (see for example,
gtk_label_set_mnemonic_widget()).
The widgets in the list are not individually referenced. If you
want to iterate through the list and perform actions involving
callbacks that might destroy the widgets, you
must call g_list_foreach (result,
(GFunc)g_object_ref, NULL) first, and then unref all the
widgets afterwards.
Returns
the list of
mnemonic labels; free this list
with g_list_free() when you are done with it.
[element-type GtkWidget][transfer container]
Since: 2.4
gtk_widget_add_mnemonic_label ()
void
gtk_widget_add_mnemonic_label (GtkWidget *widget,
GtkWidget *label);
Adds a widget to the list of mnemonic labels for
this widget. (See gtk_widget_list_mnemonic_labels()). Note the
list of mnemonic labels for the widget is cleared when the
widget is destroyed, so the caller must make sure to update
its internal state at this point as well, by using a connection
to the “destroy” signal or a weak notifier.
Since: 2.4
gtk_widget_is_composited ()
gboolean
gtk_widget_is_composited (GtkWidget *widget);
gtk_widget_is_composited has been deprecated since version 3.22 and should not be used in newly-written code.
Use gdk_screen_is_composited() instead.
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()).
Returns
TRUE if the widget can rely on its alpha
channel being drawn correctly.
Since: 2.10
gtk_widget_error_bell ()
void
gtk_widget_error_bell (GtkWidget *widget);
Notifies the user about an input-related error on this widget.
If the “gtk-error-bell” setting is TRUE, it calls
gdk_window_beep(), otherwise it does nothing.
Note that the effect of gdk_window_beep() can be configured in many
ways, depending on the windowing backend and the desktop environment
or window manager that is used.
Since: 2.12
gtk_widget_keynav_failed ()
gboolean
gtk_widget_keynav_failed (GtkWidget *widget,
GtkDirectionType direction);
This function should be called whenever keyboard navigation within
a single widget hits a boundary. The function emits the
“keynav-failed” signal on the widget and its return
value should be interpreted in a way similar to the return value of
gtk_widget_child_focus():
When TRUE is returned, stay in the widget, the failed keyboard
navigation is OK and/or there is nowhere we can/should move the
focus to.
When FALSE is returned, the caller should continue with keyboard
navigation outside the widget, e.g. by calling
gtk_widget_child_focus() on the widget’s toplevel.
The default ::keynav-failed handler returns FALSE for
GTK_DIR_TAB_FORWARD and GTK_DIR_TAB_BACKWARD. For the other
values of GtkDirectionType it returns TRUE.
Whenever the default handler returns TRUE, it also calls
gtk_widget_error_bell() to notify the user of the failed keyboard
navigation.
A use case for providing an own implementation of ::keynav-failed
(either by connecting to it or by overriding it) would be a row of
GtkEntry widgets where the user should be able to navigate the
entire row with the cursor keys, as e.g. known from user interfaces
that require entering license keys.
Returns
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
gtk_widget_get_tooltip_markup ()
gchar *
gtk_widget_get_tooltip_markup (GtkWidget *widget);
Gets the contents of the tooltip for widget
.
Returns
the tooltip text, or NULL. You should free the
returned string with g_free() when done.
[nullable]
Since: 2.12
gtk_widget_get_tooltip_text ()
gchar *
gtk_widget_get_tooltip_text (GtkWidget *widget);
Gets the contents of the tooltip for widget
.
Returns
the tooltip text, or NULL. You should free the
returned string with g_free() when done.
[nullable]
Since: 2.12
gtk_widget_set_tooltip_window ()
void
gtk_widget_set_tooltip_window (GtkWidget *widget,
GtkWindow *custom_window);
Replaces the default window used for displaying
tooltips with custom_window
. GTK+ will take care of showing and
hiding custom_window
at the right moment, to behave likewise as
the default tooltip window. If custom_window
is NULL, the default
tooltip window will be used.
Since: 2.12
gtk_widget_get_has_tooltip ()
gboolean
gtk_widget_get_has_tooltip (GtkWidget *widget);
Returns the current value of the has-tooltip property. See
“has-tooltip” for more information.
Returns
current value of has-tooltip on widget
.
Since: 2.12
gtk_widget_set_has_tooltip ()
void
gtk_widget_set_has_tooltip (GtkWidget *widget,
gboolean has_tooltip);
Sets the has-tooltip property on widget
to has_tooltip
. See
“has-tooltip” for more information.
Since: 2.12
gtk_widget_trigger_tooltip_query ()
void
gtk_widget_trigger_tooltip_query (GtkWidget *widget);
Triggers a tooltip query on the display where the toplevel of widget
is located. See gtk_tooltip_trigger_tooltip_query() for more
information.
Since: 2.12
gtk_widget_get_window ()
GdkWindow *
gtk_widget_get_window (GtkWidget *widget);
Returns the widget’s window if it is realized, NULL otherwise
Returns
widget
’s window.
[transfer none][nullable]
Since: 2.14
gtk_widget_unregister_window ()
void
gtk_widget_unregister_window (GtkWidget *widget,
GdkWindow *window);
Unregisters a GdkWindow from the widget that was previously set up with
gtk_widget_register_window(). You need to call this when the window is
no longer used by the widget, such as when you destroy it.
Since: 3.8
gtk_cairo_should_draw_window ()
gboolean
gtk_cairo_should_draw_window (cairo_t *cr,
GdkWindow *window);
This function is supposed to be called in “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
window
are supposed to be drawn and FALSE otherwise. Note
that when the drawing was not initiated by the windowing
system this function will return TRUE for all windows, so
you need to draw the bottommost window first. Also, do not
use “else if” statements to check which window should be drawn.
Returns
TRUE if window
should be drawn
Since: 3.0
gtk_cairo_transform_to_window ()
void
gtk_cairo_transform_to_window (cairo_t *cr,
GtkWidget *widget,
GdkWindow *window);
Transforms the given cairo context cr
that from widget
-relative
coordinates to window
-relative coordinates.
If the widget
’s window is not an ancestor of window
, no
modification will be applied.
This is the inverse to the transformation GTK applies when
preparing an expose event to be emitted with the “draw”
signal. It is intended to help porting multiwindow widgets from
GTK+ 2 to the rendering architecture of GTK+ 3.
Since: 3.0
gtk_widget_get_allocated_width ()
int
gtk_widget_get_allocated_width (GtkWidget *widget);
Returns the width that has currently been allocated to widget
.
This function is intended to be used when implementing handlers
for the “draw” function.
Returns
the width of the widget
gtk_widget_get_allocated_height ()
int
gtk_widget_get_allocated_height (GtkWidget *widget);
Returns the height that has currently been allocated to widget
.
This function is intended to be used when implementing handlers
for the “draw” function.
Returns
the height of the widget
gtk_widget_get_allocation ()
void
gtk_widget_get_allocation (GtkWidget *widget,
GtkAllocation *allocation);
Retrieves the widget’s allocation.
Note, when implementing a GtkContainer: a widget’s allocation will
be its “adjusted” allocation, that is, the widget’s parent
container typically calls gtk_widget_size_allocate() with an
allocation, and that allocation is then adjusted (to handle margin
and alignment for example) before assignment to the widget.
gtk_widget_get_allocation() returns the adjusted allocation that
was actually assigned to the widget. The adjusted allocation is
guaranteed to be completely contained within the
gtk_widget_size_allocate() allocation, however. So a GtkContainer
is guaranteed that its children stay inside the assigned bounds,
but not that they have exactly the bounds the container assigned.
There is no way to get the original allocation assigned by
gtk_widget_size_allocate(), since it isn’t stored; if a container
implementation needs that information it will have to track it itself.
Since: 2.18
gtk_widget_set_allocation ()
void
gtk_widget_set_allocation (GtkWidget *widget,
const GtkAllocation *allocation);
Sets the widget’s allocation. This should not be used
directly, but from within a widget’s size_allocate method.
The allocation set should be the “adjusted” or actual
allocation. If you’re implementing a GtkContainer, you want to use
gtk_widget_size_allocate() instead of gtk_widget_set_allocation().
The GtkWidgetClass::adjust_size_allocation virtual method adjusts the
allocation inside gtk_widget_size_allocate() to create an adjusted
allocation.
Since: 2.18
gtk_widget_get_allocated_baseline ()
int
gtk_widget_get_allocated_baseline (GtkWidget *widget);
Returns the baseline that has currently been allocated to widget
.
This function is intended to be used when implementing handlers
for the “draw” function, and when allocating child
widgets in “size_allocate”.
Returns
the baseline of the widget
, or -1 if none
Since: 3.10
gtk_widget_get_clip ()
void
gtk_widget_get_clip (GtkWidget *widget,
GtkAllocation *clip);
Retrieves the widget’s clip area.
The clip area is the area in which all of widget
's drawing will
happen. Other toolkits call it the bounding box.
Historically, in GTK+ the clip area has been equal to the allocation
retrieved via gtk_widget_get_allocation().
Since: 3.14
gtk_widget_set_clip ()
void
gtk_widget_set_clip (GtkWidget *widget,
const GtkAllocation *clip);
Sets the widget’s clip. This must not be used directly,
but from within a widget’s size_allocate method.
It must be called after gtk_widget_set_allocation() (or after chaining up
to the parent class), because that function resets the clip.
The clip set should be the area that widget
draws on. If widget
is a
GtkContainer, the area must contain all children's clips.
If this function is not called by widget
during a ::size-allocate handler,
the clip will be set to widget
's allocation.
Since: 3.14
gtk_widget_set_can_default ()
void
gtk_widget_set_can_default (GtkWidget *widget,
gboolean can_default);
Specifies whether widget
can be a default widget. See
gtk_widget_grab_default() for details about the meaning of
“default”.
Since: 2.18
gtk_widget_set_can_focus ()
void
gtk_widget_set_can_focus (GtkWidget *widget,
gboolean can_focus);
Specifies whether widget
can own the input focus. See
gtk_widget_grab_focus() for actually setting the input focus on a
widget.
Since: 2.18
gtk_widget_get_focus_on_click ()
gboolean
gtk_widget_get_focus_on_click (GtkWidget *widget);
Returns whether the widget should grab focus when it is clicked with the mouse.
See gtk_widget_set_focus_on_click().
Returns
TRUE if the widget should grab focus when it is clicked with
the mouse.
Since: 3.20
gtk_widget_set_focus_on_click ()
void
gtk_widget_set_focus_on_click (GtkWidget *widget,
gboolean focus_on_click);
Sets whether the widget should grab focus when it is clicked with the mouse.
Making mouse clicks not grab focus is useful in places like toolbars where
you don’t want the keyboard focus removed from the main area of the
application.
Since: 3.20
gtk_widget_get_double_buffered ()
gboolean
gtk_widget_get_double_buffered (GtkWidget *widget);
gtk_widget_get_double_buffered is deprecated and should not be used in newly-written code.
Determines whether the widget is double buffered.
See gtk_widget_set_double_buffered()
Returns
TRUE if the widget is double buffered
Since: 2.18
gtk_widget_set_has_window ()
void
gtk_widget_set_has_window (GtkWidget *widget,
gboolean has_window);
Specifies whether widget
has a GdkWindow of its own. Note that
all realized widgets have a non-NULL “window” pointer
(gtk_widget_get_window() never returns a NULL window when a widget
is realized), but for many of them it’s actually the GdkWindow of
one of its parent widgets. Widgets that do not create a window for
themselves in “realize” must announce this by
calling this function with has_window
= FALSE.
This function should only be called by widget implementations,
and they should call it in their init() function.
Since: 2.18
gtk_widget_get_sensitive ()
gboolean
gtk_widget_get_sensitive (GtkWidget *widget);
Returns the widget’s sensitivity (in the sense of returning
the value that has been set using gtk_widget_set_sensitive()).
The effective sensitivity of a widget is however determined by both its
own and its parent widget’s sensitivity. See gtk_widget_is_sensitive().
Returns
TRUE if the widget is sensitive
Since: 2.18
gtk_widget_is_sensitive ()
gboolean
gtk_widget_is_sensitive (GtkWidget *widget);
Returns the widget’s effective sensitivity, which means
it is sensitive itself and also its parent widget is sensitive
Returns
TRUE if the widget is effectively sensitive
Since: 2.18
gtk_widget_get_visible ()
gboolean
gtk_widget_get_visible (GtkWidget *widget);
Determines whether the widget is visible. If you want to
take into account whether the widget’s parent is also marked as
visible, use gtk_widget_is_visible() instead.
This function does not check if the widget is obscured in any way.
See gtk_widget_set_visible().
Returns
TRUE if the widget is visible
Since: 2.18
gtk_widget_set_visible ()
void
gtk_widget_set_visible (GtkWidget *widget,
gboolean visible);
Sets the visibility state of widget
. Note that setting this to
TRUE doesn’t mean the widget is actually viewable, see
gtk_widget_get_visible().
This function simply calls gtk_widget_show() or gtk_widget_hide()
but is nicer to use when the visibility of the widget depends on
some condition.
Since: 2.18
gtk_widget_unset_state_flags ()
void
gtk_widget_unset_state_flags (GtkWidget *widget,
GtkStateFlags flags);
This function is for use in widget implementations. Turns off flag
values for the current widget state (insensitive, prelighted, etc.).
See gtk_widget_set_state_flags().
Since: 3.0
gtk_widget_has_default ()
gboolean
gtk_widget_has_default (GtkWidget *widget);
Determines whether widget
is the current default widget within its
toplevel. See gtk_widget_set_can_default().
Returns
TRUE if widget
is the current default widget within
its toplevel, FALSE otherwise
Since: 2.18
gtk_widget_has_focus ()
gboolean
gtk_widget_has_focus (GtkWidget *widget);
Determines if the widget has the global input focus. See
gtk_widget_is_focus() for the difference between having the global
input focus, and only having the focus within a toplevel.
Returns
TRUE if the widget has the global input focus.
Since: 2.18
gtk_widget_has_visible_focus ()
gboolean
gtk_widget_has_visible_focus (GtkWidget *widget);
Determines if the widget should show a visible indication that
it has the global input focus. This is a convenience function for
use in ::draw handlers that takes into account whether focus
indication should currently be shown in the toplevel window of
widget
. See gtk_window_get_focus_visible() for more information
about focus indication.
To find out if the widget has the global input focus, use
gtk_widget_has_focus().
Returns
TRUE if the widget should display a “focus rectangle”
Since: 3.2
gtk_widget_has_grab ()
gboolean
gtk_widget_has_grab (GtkWidget *widget);
Determines whether the widget is currently grabbing events, so it
is the only widget receiving input events (keyboard and mouse).
See also gtk_grab_add().
Returns
TRUE if the widget is in the grab_widgets stack
Since: 2.18
gtk_widget_has_rc_style ()
gboolean
gtk_widget_has_rc_style (GtkWidget *widget);
gtk_widget_has_rc_style has been deprecated since version 3.0 and should not be used in newly-written code.
Use GtkStyleContext instead
Determines if the widget style has been looked up through the rc mechanism.
Returns
TRUE if the widget has been looked up through the rc
mechanism, FALSE otherwise.
Since: 2.20
gtk_widget_is_drawable ()
gboolean
gtk_widget_is_drawable (GtkWidget *widget);
Determines whether widget
can be drawn to. A widget can be drawn
to if it is mapped and visible.
Returns
TRUE if widget
is drawable, FALSE otherwise
Since: 2.18
gtk_widget_is_toplevel ()
gboolean
gtk_widget_is_toplevel (GtkWidget *widget);
Determines whether widget
is a toplevel widget.
Currently only GtkWindow and GtkInvisible (and out-of-process
GtkPlugs) are toplevel widgets. Toplevel widgets have no parent
widget.
Returns
TRUE if widget
is a toplevel, FALSE otherwise
Since: 2.18
gtk_widget_set_window ()
void
gtk_widget_set_window (GtkWidget *widget,
GdkWindow *window);
Sets a widget’s window. This function should only be used in a
widget’s “realize” implementation. The window passed is
usually either new window created with gdk_window_new(), or the
window of its parent widget as returned by
gtk_widget_get_parent_window().
Widgets must indicate whether they will create their own GdkWindow
by calling gtk_widget_set_has_window(). This is usually done in the
widget’s init() function.
Note that this function does not add any reference to window
.
Since: 2.18
gtk_widget_set_receives_default ()
void
gtk_widget_set_receives_default (GtkWidget *widget,
gboolean receives_default);
Specifies whether widget
will be treated as the default widget
within its toplevel when it has the focus, even if another widget
is the default.
See gtk_widget_grab_default() for details about the meaning of
“default”.
Since: 2.18
gtk_widget_get_receives_default ()
gboolean
gtk_widget_get_receives_default (GtkWidget *widget);
Determines whether widget
is always treated as the default widget
within its toplevel when it has the focus, even if another widget
is the default.
See gtk_widget_set_receives_default().
Returns
TRUE if widget
acts as the default widget when focused,
FALSE otherwise
Since: 2.18
gtk_widget_set_support_multidevice ()
void
gtk_widget_set_support_multidevice (GtkWidget *widget,
gboolean support_multidevice);
Enables or disables multiple pointer awareness. If this setting is TRUE,
widget
will start receiving multiple, per device enter/leave events. Note
that if custom GdkWindows are created in “realize”,
gdk_window_set_support_multidevice() will have to be called manually on them.
Since: 3.0
gtk_widget_set_realized ()
void
gtk_widget_set_realized (GtkWidget *widget,
gboolean realized);
Marks the widget as being realized. This function must only be
called after all GdkWindows for the widget
have been created
and registered.
This function should only ever be called in a derived widget's
“realize” or “unrealize” implementation.
Since: 2.20
gtk_widget_get_realized ()
gboolean
gtk_widget_get_realized (GtkWidget *widget);
Determines whether widget
is realized.
Returns
TRUE if widget
is realized, FALSE otherwise
Since: 2.20
gtk_widget_set_mapped ()
void
gtk_widget_set_mapped (GtkWidget *widget,
gboolean mapped);
Marks the widget as being mapped.
This function should only ever be called in a derived widget's
“map” or “unmap” implementation.
Since: 2.20
gtk_widget_get_mapped ()
gboolean
gtk_widget_get_mapped (GtkWidget *widget);
Whether the widget is mapped.
Returns
TRUE if the widget is mapped, FALSE otherwise.
Since: 2.20
gtk_widget_get_requisition ()
void
gtk_widget_get_requisition (GtkWidget *widget,
GtkRequisition *requisition);
gtk_widget_get_requisition has been deprecated since version 3.0 and should not be used in newly-written code.
The GtkRequisition cache on the widget was
removed, If you need to cache sizes across requests and allocations,
add an explicit cache to the widget in question instead.
Retrieves the widget’s requisition.
This function should only be used by widget implementations in
order to figure whether the widget’s requisition has actually
changed after some internal state change (so that they can call
gtk_widget_queue_resize() instead of gtk_widget_queue_draw()).
Normally, gtk_widget_size_request() should be used.
Since: 2.20
gtk_widget_device_is_shadowed ()
gboolean
gtk_widget_device_is_shadowed (GtkWidget *widget,
GdkDevice *device);
Returns TRUE if device
has been shadowed by a GTK+
device grab on another widget, so it would stop sending
events to widget
. This may be used in the
“grab-notify” signal to check for specific
devices. See gtk_device_grab_add().
Returns
TRUE if there is an ongoing grab on device
by another GtkWidget than widget
.
Since: 3.0
gtk_widget_insert_action_group ()
void
gtk_widget_insert_action_group (GtkWidget *widget,
const gchar *name,
GActionGroup *group);
Inserts group
into widget
. Children of widget
that implement
GtkActionable can then be associated with actions in group
by
setting their “action-name” to
prefix
.action-name.
If group
is NULL, a previously inserted group for name
is removed
from widget
.
Since: 3.6
gtk_widget_get_opacity ()
double
gtk_widget_get_opacity (GtkWidget *widget);
Fetches the requested opacity for this widget.
See gtk_widget_set_opacity().
Returns
the requested opacity for this widget.
Since: 3.8
gtk_widget_set_opacity ()
void
gtk_widget_set_opacity (GtkWidget *widget,
double opacity);
Request the widget
to be rendered partially transparent,
with opacity 0 being fully transparent and 1 fully opaque. (Opacity values
are clamped to the [0,1] range.).
This works on both toplevel widget, and child widgets, although there
are some limitations:
For toplevel widgets this depends on the capabilities of the windowing
system. On X11 this has any effect only on X screens with a compositing manager
running. See gtk_widget_is_composited(). On Windows it should work
always, although setting a window’s opacity after the window has been
shown causes it to flicker once on Windows.
For child widgets it doesn’t work if any affected widget has a native window, or
disables double buffering.
Since: 3.8
gtk_widget_list_action_prefixes ()
const gchar **
gtk_widget_list_action_prefixes (GtkWidget *widget);
Retrieves a NULL-terminated array of strings containing the prefixes of
GActionGroup's available to widget
.
Returns
a NULL-terminated array of strings.
[transfer container]
Since: 3.16
gtk_widget_get_action_group ()
GActionGroup *
gtk_widget_get_action_group (GtkWidget *widget,
const gchar *prefix);
Retrieves the GActionGroup that was registered using prefix
. The resulting
GActionGroup may have been registered to widget
or any GtkWidget in its
ancestry.
If no action group was found matching prefix
, then NULL is returned.
Since: 3.16
gtk_widget_get_path ()
GtkWidgetPath *
gtk_widget_get_path (GtkWidget *widget);
Returns the GtkWidgetPath representing widget
, if the widget
is not connected to a toplevel widget, a partial path will be
created.
gtk_widget_get_style_context ()
GtkStyleContext *
gtk_widget_get_style_context (GtkWidget *widget);
Returns the style context associated to widget
. The returned object is
guaranteed to be the same for the lifetime of widget
.
Returns
a GtkStyleContext. This memory is owned by widget
and
must not be freed.
[transfer none]
gtk_widget_reset_style ()
void
gtk_widget_reset_style (GtkWidget *widget);
Updates the style context of widget
and all descendants
by updating its widget path. GtkContainers may want
to use this on a child when reordering it in a way that a different
style might apply to it. See also gtk_container_get_path_for_child().
Since: 3.0
gtk_widget_class_get_css_name ()
const char *
gtk_widget_class_get_css_name (GtkWidgetClass *widget_class);
Gets the name used by this class for matching in CSS code. See
gtk_widget_class_set_css_name() for details.
Returns
the CSS name of the given class
Since: 3.20
gtk_widget_class_set_css_name ()
void
gtk_widget_class_set_css_name (GtkWidgetClass *widget_class,
const char *name);
Sets the name to be used for CSS matching of widgets.
If this function is not called for a given class, the name
of the parent class is used.
Since: 3.20
gtk_widget_get_preferred_height ()
void
gtk_widget_get_preferred_height (GtkWidget *widget,
gint *minimum_height,
gint *natural_height);
Retrieves a widget’s initial minimum and natural height.
This call is specific to width-for-height requests.
The returned request will be modified by the
GtkWidgetClass::adjust_size_request virtual method and by any
GtkSizeGroups that have been applied. That is, the returned request
is the one that should be used for layout, not necessarily the one
returned by the widget itself.
Since: 3.0
gtk_widget_get_preferred_width ()
void
gtk_widget_get_preferred_width (GtkWidget *widget,
gint *minimum_width,
gint *natural_width);
Retrieves a widget’s initial minimum and natural width.
This call is specific to height-for-width requests.
The returned request will be modified by the
GtkWidgetClass::adjust_size_request virtual method and by any
GtkSizeGroups that have been applied. That is, the returned request
is the one that should be used for layout, not necessarily the one
returned by the widget itself.
Since: 3.0
gtk_widget_get_preferred_height_for_width ()
void
gtk_widget_get_preferred_height_for_width
(GtkWidget *widget,
gint width,
gint *minimum_height,
gint *natural_height);
Retrieves a widget’s minimum and natural height if it would be given
the specified width
.
The returned request will be modified by the
GtkWidgetClass::adjust_size_request virtual method and by any
GtkSizeGroups that have been applied. That is, the returned request
is the one that should be used for layout, not necessarily the one
returned by the widget itself.
Since: 3.0
gtk_widget_get_preferred_width_for_height ()
void
gtk_widget_get_preferred_width_for_height
(GtkWidget *widget,
gint height,
gint *minimum_width,
gint *natural_width);
Retrieves a widget’s minimum and natural width if it would be given
the specified height
.
The returned request will be modified by the
GtkWidgetClass::adjust_size_request virtual method and by any
GtkSizeGroups that have been applied. That is, the returned request
is the one that should be used for layout, not necessarily the one
returned by the widget itself.
Since: 3.0
gtk_widget_get_preferred_height_and_baseline_for_width ()
void
gtk_widget_get_preferred_height_and_baseline_for_width
(GtkWidget *widget,
gint width,
gint *minimum_height,
gint *natural_height,
gint *minimum_baseline,
gint *natural_baseline);
Retrieves a widget’s minimum and natural height and the corresponding baselines if it would be given
the specified width
, or the default height if width
is -1. The baselines may be -1 which means
that no baseline is requested for this widget.
The returned request will be modified by the
GtkWidgetClass::adjust_size_request and GtkWidgetClass::adjust_baseline_request virtual methods
and by any GtkSizeGroups that have been applied. That is, the returned request
is the one that should be used for layout, not necessarily the one
returned by the widget itself.
Since: 3.10
gtk_widget_get_request_mode ()
GtkSizeRequestMode
gtk_widget_get_request_mode (GtkWidget *widget);
Gets whether the widget prefers a height-for-width layout
or a width-for-height layout.
GtkBin widgets generally propagate the preference of
their child, container widgets need to request something either in
context of their children or in context of their allocation
capabilities.
Since: 3.0
gtk_widget_get_preferred_size ()
void
gtk_widget_get_preferred_size (GtkWidget *widget,
GtkRequisition *minimum_size,
GtkRequisition *natural_size);
Retrieves the minimum and natural size of a widget, taking
into account the widget’s preference for height-for-width management.
This is used to retrieve a suitable size by container widgets which do
not impose any restrictions on the child placement. It can be used
to deduce toplevel window and menu sizes as well as child widgets in
free-form containers such as GtkLayout.
Handle with care. Note that the natural height of a height-for-width
widget will generally be a smaller size than the minimum height, since the required
height for the natural width is generally smaller than the required height for
the minimum width.
Use gtk_widget_get_preferred_height_and_baseline_for_width() if you want to support
baseline alignment.
Since: 3.0
gtk_distribute_natural_allocation ()
gint
gtk_distribute_natural_allocation (gint extra_space,
guint n_requested_sizes,
GtkRequestedSize *sizes);
Distributes extra_space
to child sizes
by bringing smaller
children up to natural size first.
The remaining space will be added to the minimum_size
member of the
GtkRequestedSize struct. If all sizes reach their natural size then
the remaining space is returned.
Returns
The remainder of extra_space
after redistributing space
to sizes
.
gtk_widget_get_halign ()
GtkAlign
gtk_widget_get_halign (GtkWidget *widget);
Gets the value of the “halign” property.
For backwards compatibility reasons this method will never return
GTK_ALIGN_BASELINE, but instead it will convert it to
GTK_ALIGN_FILL. Baselines are not supported for horizontal
alignment.
Returns
the horizontal alignment of widget
gtk_widget_set_halign ()
void
gtk_widget_set_halign (GtkWidget *widget,
GtkAlign align);
Sets the horizontal alignment of widget
.
See the “halign” property.
gtk_widget_get_valign ()
GtkAlign
gtk_widget_get_valign (GtkWidget *widget);
Gets the value of the “valign” property.
For backwards compatibility reasons this method will never return
GTK_ALIGN_BASELINE, but instead it will convert it to
GTK_ALIGN_FILL. If your widget want to support baseline aligned
children it must use gtk_widget_get_valign_with_baseline(), or
g_object_get (widget, "valign", &value, NULL), which will
also report the true value.
Returns
the vertical alignment of widget
, ignoring baseline alignment
gtk_widget_set_valign ()
void
gtk_widget_set_valign (GtkWidget *widget,
GtkAlign align);
Sets the vertical alignment of widget
.
See the “valign” property.
gtk_widget_get_margin_left ()
gint
gtk_widget_get_margin_left (GtkWidget *widget);
gtk_widget_get_margin_left has been deprecated since version 3.12 and should not be used in newly-written code.
Use gtk_widget_get_margin_start() instead.
Gets the value of the “margin-left” property.
Returns
The left margin of widget
Since: 3.0
gtk_widget_set_margin_left ()
void
gtk_widget_set_margin_left (GtkWidget *widget,
gint margin);
gtk_widget_set_margin_left has been deprecated since version 3.12 and should not be used in newly-written code.
Use gtk_widget_set_margin_start() instead.
Sets the left margin of widget
.
See the “margin-left” property.
Since: 3.0
gtk_widget_get_margin_right ()
gint
gtk_widget_get_margin_right (GtkWidget *widget);
gtk_widget_get_margin_right has been deprecated since version 3.12 and should not be used in newly-written code.
Use gtk_widget_get_margin_end() instead.
Gets the value of the “margin-right” property.
Returns
The right margin of widget
Since: 3.0
gtk_widget_set_margin_right ()
void
gtk_widget_set_margin_right (GtkWidget *widget,
gint margin);
gtk_widget_set_margin_right has been deprecated since version 3.12 and should not be used in newly-written code.
Use gtk_widget_set_margin_end() instead.
Sets the right margin of widget
.
See the “margin-right” property.
Since: 3.0
gtk_widget_get_margin_start ()
gint
gtk_widget_get_margin_start (GtkWidget *widget);
Gets the value of the “margin-start” property.
Returns
The start margin of widget
Since: 3.12
gtk_widget_set_margin_start ()
void
gtk_widget_set_margin_start (GtkWidget *widget,
gint margin);
Sets the start margin of widget
.
See the “margin-start” property.
Since: 3.12
gtk_widget_get_margin_end ()
gint
gtk_widget_get_margin_end (GtkWidget *widget);
Gets the value of the “margin-end” property.
Returns
The end margin of widget
Since: 3.12
gtk_widget_set_margin_end ()
void
gtk_widget_set_margin_end (GtkWidget *widget,
gint margin);
Sets the end margin of widget
.
See the “margin-end” property.
Since: 3.12
gtk_widget_get_margin_top ()
gint
gtk_widget_get_margin_top (GtkWidget *widget);
Gets the value of the “margin-top” property.
Returns
The top margin of widget
Since: 3.0
gtk_widget_set_margin_top ()
void
gtk_widget_set_margin_top (GtkWidget *widget,
gint margin);
Sets the top margin of widget
.
See the “margin-top” property.
Since: 3.0
gtk_widget_get_margin_bottom ()
gint
gtk_widget_get_margin_bottom (GtkWidget *widget);
Gets the value of the “margin-bottom” property.
Returns
The bottom margin of widget
Since: 3.0
gtk_widget_set_margin_bottom ()
void
gtk_widget_set_margin_bottom (GtkWidget *widget,
gint margin);
Sets the bottom margin of widget
.
See the “margin-bottom” property.
Since: 3.0
gtk_widget_get_hexpand ()
gboolean
gtk_widget_get_hexpand (GtkWidget *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.
Returns
whether hexpand flag is set
gtk_widget_set_hexpand ()
void
gtk_widget_set_hexpand (GtkWidget *widget,
gboolean 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.
gtk_widget_get_hexpand_set ()
gboolean
gtk_widget_get_hexpand_set (GtkWidget *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.
Returns
whether hexpand has been explicitly set
gtk_widget_set_hexpand_set ()
void
gtk_widget_set_hexpand_set (GtkWidget *widget,
gboolean set);
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.
gtk_widget_get_vexpand ()
gboolean
gtk_widget_get_vexpand (GtkWidget *widget);
Gets whether the widget would like any available extra vertical
space.
See gtk_widget_get_hexpand() for more detail.
Returns
whether vexpand flag is set
gtk_widget_set_vexpand ()
void
gtk_widget_set_vexpand (GtkWidget *widget,
gboolean expand);
Sets whether the widget would like any available extra vertical
space.
See gtk_widget_set_hexpand() for more detail.
gtk_widget_queue_compute_expand ()
void
gtk_widget_queue_compute_expand (GtkWidget *widget);
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().
gtk_widget_compute_expand ()
gboolean
gtk_widget_compute_expand (GtkWidget *widget,
GtkOrientation orientation);
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.
Returns
whether widget tree rooted here should be expanded
gtk_widget_init_template ()
void
gtk_widget_init_template (GtkWidget *widget);
Creates and initializes child widgets defined in templates. This
function must be called in the instance initializer for any
class which assigned itself a template using gtk_widget_class_set_template()
It is important to call this function in the instance initializer
of a GtkWidget subclass and not in GObject.constructed() or
GObject.constructor() for two reasons.
One reason is that generally derived widgets will assume that parent
class composite widgets have been created in their instance
initializers.
Another reason is that when calling g_object_new() on a widget with
composite templates, it’s important to build the composite widgets
before the construct properties are set. Properties passed to g_object_new()
should take precedence over properties set in the private template XML.
Since: 3.10
gtk_widget_get_template_child ()
GObject *
gtk_widget_get_template_child (GtkWidget *widget,
GType widget_type,
const gchar *name);
Fetch an object build from the template XML for widget_type
in this widget
instance.
This will only report children which were previously declared with
gtk_widget_class_bind_template_child_full() or one of its
variants.
This function is only meant to be called for code which is private to the widget_type
which
declared the child and is meant for language bindings which cannot easily make use
of the GObject structure offsets.
Returns
The object built in the template XML with the id name
.
[transfer none]
gtk_widget_class_bind_template_child()
#define gtk_widget_class_bind_template_child(widget_class, TypeName, member_name)
Binds a child widget defined in a template to the widget_class
.
This macro is a convenience wrapper around the
gtk_widget_class_bind_template_child_full() function.
This macro will use the offset of the member_name
inside the TypeName
instance structure.
Since: 3.10
gtk_widget_class_bind_template_child_internal()
#define gtk_widget_class_bind_template_child_internal(widget_class, TypeName, member_name)
Binds a child widget defined in a template to the widget_class
, and
also makes it available as an internal child in GtkBuilder, under the
name member_name
.
This macro is a convenience wrapper around the
gtk_widget_class_bind_template_child_full() function.
This macro will use the offset of the member_name
inside the TypeName
instance structure.
Since: 3.10
gtk_widget_class_bind_template_child_private()
#define gtk_widget_class_bind_template_child_private(widget_class, TypeName, member_name)
Binds a child widget defined in a template to the widget_class
.
This macro is a convenience wrapper around the
gtk_widget_class_bind_template_child_full() function.
This macro will use the offset of the member_name
inside the TypeName
private data structure (it uses G_PRIVATE_OFFSET(), so the private struct
must be added with G_ADD_PRIVATE()).
Since: 3.10
gtk_widget_class_bind_template_child_internal_private()
#define gtk_widget_class_bind_template_child_internal_private(widget_class, TypeName, member_name)
Binds a child widget defined in a template to the widget_class
, and
also makes it available as an internal child in GtkBuilder, under the
name member_name
.
This macro is a convenience wrapper around the
gtk_widget_class_bind_template_child_full() function.
This macro will use the offset of the member_name
inside the TypeName
private data structure.
Since: 3.10
gtk_widget_class_bind_template_child_full ()
void
gtk_widget_class_bind_template_child_full
(GtkWidgetClass *widget_class,
const gchar *name,
gboolean internal_child,
gssize struct_offset);
Automatically assign an object declared in the class template XML to be set to a location
on a freshly built instance’s private data, or alternatively accessible via gtk_widget_get_template_child().
The struct can point either into the public instance, then you should use G_STRUCT_OFFSET(WidgetType, member)
for struct_offset
, or in the private struct, then you should use G_PRIVATE_OFFSET(WidgetType, member).
An explicit strong reference will be held automatically for the duration of your
instance’s life cycle, it will be released automatically when GObjectClass.dispose() runs
on your instance and if a struct_offset
that is != 0 is specified, then the automatic location
in your instance public or private data will be set to NULL. You can however access an automated child
pointer the first time your classes GObjectClass.dispose() runs, or alternatively in
GtkWidgetClass.destroy().
If internal_child
is specified, GtkBuildableIface.get_internal_child() will be automatically
implemented by the GtkWidget class so there is no need to implement it manually.
The wrapper macros gtk_widget_class_bind_template_child(), gtk_widget_class_bind_template_child_internal(),
gtk_widget_class_bind_template_child_private() and gtk_widget_class_bind_template_child_internal_private()
might be more convenient to use.
Note that this must be called from a composite widget classes class
initializer after calling gtk_widget_class_set_template().
Since: 3.10
gtk_widget_class_bind_template_callback()
#define gtk_widget_class_bind_template_callback(widget_class, callback)
Binds a callback function defined in a template to the widget_class
.
This macro is a convenience wrapper around the
gtk_widget_class_bind_template_callback_full() function.
Since: 3.10
Signal Details
The “accel-closures-changed” signal
void
user_function (GtkWidget *widget,
gpointer user_data)
The “button-press-event” signal
gboolean
user_function (GtkWidget *widget,
GdkEvent *event,
gpointer user_data)
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
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.
FALSE to propagate the event further.
Flags: Run Last
The “button-release-event” signal
gboolean
user_function (GtkWidget *widget,
GdkEvent *event,
gpointer user_data)
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
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.
FALSE to propagate the event further.
Flags: Run Last
The “can-activate-accel” signal
gboolean
user_function (GtkWidget *widget,
guint signal_id,
gpointer user_data)
Determines whether an accelerator that activates the signal
identified by signal_id
can currently be activated.
This signal is present to allow applications and derived
widgets to override the default GtkWidget handling
for determining whether an accelerator can be activated.
Returns
TRUE if the signal can be activated.
Flags: Run Last
The “child-notify” signal
void
user_function (GtkWidget *widget,
GParamSpec *child_property,
gpointer user_data)
The ::child-notify signal is emitted for each
child property that has
changed on an object. The signal's detail holds the property name.
Flags: No Hooks
The “composited-changed” signal
void
user_function (GtkWidget *widget,
gpointer user_data)
The ::composited-changed signal is emitted when the composited
status of widgets
screen changes.
See gdk_screen_is_composited().
GtkWidget::composited-changed has been deprecated since version 3.22 and should not be used in newly-written code.
Use GdkScreen::composited-changed instead.
Flags: Action
The “configure-event” signal
gboolean
user_function (GtkWidget *widget,
GdkEvent *event,
gpointer user_data)
The ::configure-event signal will be emitted when the size, position or
stacking of the widget
's window has changed.
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.
FALSE to propagate the event further.
Flags: Run Last
The “damage-event” signal
gboolean
user_function (GtkWidget *widget,
GdkEvent *event,
gpointer user_data)
Emitted when a redirected window belonging to widget
gets drawn into.
The region/area members of the event shows what area of the redirected
drawable was drawn into.
Returns
TRUE to stop other handlers from being invoked for the event.
FALSE to propagate the event further.
Flags: Run Last
Since: 2.14
The “delete-event” signal
gboolean
user_function (GtkWidget *widget,
GdkEvent *event,
gpointer user_data)
The ::delete-event signal is emitted if a user requests that
a toplevel window is closed. The default handler for this signal
destroys the window. Connecting gtk_widget_hide_on_delete() to
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.
FALSE to propagate the event further.
Flags: Run Last
The “destroy” signal
void
user_function (GtkWidget *object,
gpointer user_data)
Signals that all holders of a reference to the widget should release
the reference that they hold. May result in finalization of the widget
if all references are released.
This signal is not suitable for saving widget state.
Flags: No Hooks
The “destroy-event” signal
gboolean
user_function (GtkWidget *widget,
GdkEvent *event,
gpointer user_data)
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
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.
FALSE to propagate the event further.
Flags: Run Last
The “direction-changed” signal
void
user_function (GtkWidget *widget,
GtkTextDirection previous_direction,
gpointer user_data)
The ::direction-changed signal is emitted when the text direction
of a widget changes.
Flags: Run First
The “drag-begin” signal
void
user_function (GtkWidget *widget,
GdkDragContext *context,
gpointer user_data)
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 e.g. gtk_drag_source_set_icon_pixbuf().
Note that some widgets set up a drag icon in the default handler of
this signal, so you may have to use g_signal_connect_after() to
override what the default handler did.
Flags: Run Last
The “drag-data-delete” signal
void
user_function (GtkWidget *widget,
GdkDragContext *context,
gpointer user_data)
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.
Flags: Run Last
The “drag-data-received” signal
void
user_function (GtkWidget *widget,
GdkDragContext *context,
gint x,
gint y,
GtkSelectionData *data,
guint info,
guint time,
gpointer user_data)
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 not finish the drag.
If the data was received in response to a “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.
Applications must create some means to determine why the signal was emitted
and therefore whether to call gdk_drag_status() or gtk_drag_finish().
The handler may inspect the selected action with
gdk_drag_context_get_selected_action() before calling
gtk_drag_finish(), e.g. to implement GDK_ACTION_ASK as
shown in the following example:
Flags: Run Last
The “drag-drop” signal
gboolean
user_function (GtkWidget *widget,
GdkDragContext *context,
gint x,
gint y,
guint time,
gpointer user_data)
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 “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.
Returns
whether the cursor position is in a drop zone
Flags: Run Last
The “drag-end” signal
void
user_function (GtkWidget *widget,
GdkDragContext *context,
gpointer user_data)
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 “drag-begin”.
Flags: Run Last
The “drag-failed” signal
gboolean
user_function (GtkWidget *widget,
GdkDragContext *context,
GtkDragResult result,
gpointer user_data)
The ::drag-failed signal is emitted on the drag source when a drag has
failed. The signal handler may hook custom code to handle a failed DnD
operation based on the type of error, it returns TRUE is the failure has
been already handled (not showing the default "drag operation failed"
animation), otherwise it returns FALSE.
Returns
TRUE if the failed drag operation has been already handled.
Flags: Run Last
Since: 2.12
The “drag-leave” signal
void
user_function (GtkWidget *widget,
GdkDragContext *context,
guint time,
gpointer user_data)
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 “drag-motion”, e.g. undo highlighting
with gtk_drag_unhighlight().
Likewise, the “drag-leave” signal is also emitted before the
::drag-drop signal, for instance to allow cleaning up of a preview item
created in the “drag-motion” signal handler.
Flags: Run Last
The “drag-motion” signal
gboolean
user_function (GtkWidget *widget,
GdkDragContext *context,
gint x,
gint y,
guint time,
gpointer user_data)
The ::drag-motion signal is emitted on the drop site when the user
moves the cursor over the widget during a drag. 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 is responsible for providing the necessary information for
displaying feedback to the user, by calling gdk_drag_status().
If the decision whether the drop will be accepted or rejected can't be
made based solely on the cursor position and the type of the data, the
handler may inspect the dragged data by calling gtk_drag_get_data() and
defer the gdk_drag_status() call to the “drag-data-received”
handler. Note that you must pass GTK_DEST_DEFAULT_DROP,
GTK_DEST_DEFAULT_MOTION or GTK_DEST_DEFAULT_ALL to gtk_drag_dest_set()
when using the drag-motion signal that way.
Also note that there is no drag-enter signal. The drag receiver has to
keep track of whether he has received any drag-motion signals since the
last “drag-leave” and if not, treat the drag-motion signal as
an "enter" signal. Upon an "enter", the handler will typically highlight
the drop site with gtk_drag_highlight().
Returns
whether the cursor position is in a drop zone
Flags: Run Last
The “draw” signal
gboolean
user_function (GtkWidget *widget,
CairoContext *cr,
gpointer user_data)
This signal is emitted when a widget is supposed to render itself.
The widget
's top left corner must be painted at the origin of
the passed in context and be sized to the values returned by
gtk_widget_get_allocated_width() and
gtk_widget_get_allocated_height().
Signal handlers connected to this signal can modify the cairo
context passed as cr
in any way they like and don't need to
restore it. The signal emission takes care of calling cairo_save()
before and cairo_restore() after invoking the handler.
The signal handler will get a cr
with a clip region already set to the
widget's dirty region, i.e. to the area that needs repainting. Complicated
widgets that want to avoid redrawing themselves completely can get the full
extents of the clip region with gdk_cairo_get_clip_rectangle(), or they can
get a finer-grained representation of the dirty region with
cairo_copy_clip_rectangle_list().
Returns
TRUE to stop other handlers from being invoked for the event.
FALSE to propagate the event further.
Flags: Run Last
Since: 3.0
The “enter-notify-event” signal
gboolean
user_function (GtkWidget *widget,
GdkEvent *event,
gpointer user_data)
The ::enter-notify-event will be emitted when the pointer enters
the widget
's window.
To receive this signal, the GdkWindow associated to the widget needs
to enable the GDK_ENTER_NOTIFY_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.
FALSE to propagate the event further.
Flags: Run Last
The “event” signal
gboolean
user_function (GtkWidget *widget,
GdkEvent *event,
gpointer user_data)
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.
“key-press-event”) and finally a generic
“event-after” signal.
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
the second signal. The ::event-after signal is emitted regardless of
the return value.
Flags: Run Last
The “event-after” signal
void
user_function (GtkWidget *widget,
GdkEvent *event,
gpointer user_data)
After the emission of the “event” signal and (optionally)
the second more specific signal, ::event-after will be emitted
regardless of the previous two signals handlers return values.
The “focus-in-event” signal
gboolean
user_function (GtkWidget *widget,
GdkEvent *event,
gpointer user_data)
The ::focus-in-event signal will be emitted when the keyboard focus
enters the widget
's window.
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.
FALSE to propagate the event further.
Flags: Run Last
The “focus-out-event” signal
gboolean
user_function (GtkWidget *widget,
GdkEvent *event,
gpointer user_data)
The ::focus-out-event signal will be emitted when the keyboard focus
leaves the widget
's window.
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.
FALSE to propagate the event further.
Flags: Run Last
The “grab-broken-event” signal
gboolean
user_function (GtkWidget *widget,
GdkEvent *event,
gpointer user_data)
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
the event. FALSE to propagate the event further.
Flags: Run Last
Since: 2.8
The “grab-notify” signal
void
user_function (GtkWidget *widget,
gboolean was_grabbed,
gpointer user_data)
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
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
its ancestor.
Flags: Run First
The “hierarchy-changed” signal
void
user_function (GtkWidget *widget,
GtkWidget *previous_toplevel,
gpointer user_data)
The ::hierarchy-changed signal is emitted when the
anchored state of a widget changes. A widget is
“anchored” when its toplevel
ancestor is a GtkWindow. This signal is emitted when
a widget changes from un-anchored to anchored or vice-versa.
Flags: Run Last
The “key-press-event” signal
gboolean
user_function (GtkWidget *widget,
GdkEvent *event,
gpointer user_data)
The ::key-press-event signal is emitted when a key is pressed. The signal
emission will reoccur at the key-repeat rate when the key is kept pressed.
To receive this signal, the GdkWindow associated to the widget needs
to enable the GDK_KEY_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.
FALSE to propagate the event further.
Flags: Run Last
The “key-release-event” signal
gboolean
user_function (GtkWidget *widget,
GdkEvent *event,
gpointer user_data)
The ::key-release-event signal is emitted when a key is released.
To receive this signal, the GdkWindow associated to the widget needs
to enable the GDK_KEY_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.
FALSE to propagate the event further.
Flags: Run Last
The “leave-notify-event” signal
gboolean
user_function (GtkWidget *widget,
GdkEvent *event,
gpointer user_data)
The ::leave-notify-event will be emitted when the pointer leaves
the widget
's window.
To receive this signal, the GdkWindow associated to the widget needs
to enable the GDK_LEAVE_NOTIFY_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.
FALSE to propagate the event further.
Flags: Run Last
The “map” signal
void
user_function (GtkWidget *widget,
gpointer user_data)
The ::map signal is emitted when widget
is going to be mapped, that is
when the widget is visible (which is controlled with
gtk_widget_set_visible()) and all its parents up to the toplevel widget
are also visible. Once the map has occurred, “map-event” will
be emitted.
The ::map signal can be used to determine whether a widget will be drawn,
for instance it can resume an animation that was stopped during the
emission of “unmap”.
Flags: Run First
The “map-event” signal
gboolean
user_function (GtkWidget *widget,
GdkEvent *event,
gpointer user_data)
The ::map-event signal will be emitted when the widget
's window is
mapped. A window is mapped when it becomes visible on the screen.
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.
FALSE to propagate the event further.
Flags: Run Last
The “mnemonic-activate” signal
gboolean
user_function (GtkWidget *widget,
gboolean group_cycling,
gpointer user_data)
The default handler for this signal activates widget
if group_cycling
is FALSE, or just makes widget
grab focus if group_cycling
is TRUE.
Returns
TRUE to stop other handlers from being invoked for the event.
FALSE to propagate the event further.
Flags: Run Last
The “motion-notify-event” signal
gboolean
user_function (GtkWidget *widget,
GdkEvent *event,
gpointer user_data)
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
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.
FALSE to propagate the event further.
Flags: Run Last
The “parent-set” signal
void
user_function (GtkWidget *widget,
GtkWidget *old_parent,
gpointer user_data)
The ::parent-set signal is emitted when a new parent
has been set on a widget.
Flags: Run First
The “popup-menu” signal
gboolean
user_function (GtkWidget *widget,
gpointer user_data)
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 the
Popup Menu Migration Checklist
for an example of how to use this signal.
Returns
TRUE if a menu was activated
Flags: Action
The “property-notify-event” signal
gboolean
user_function (GtkWidget *widget,
GdkEvent *event,
gpointer user_data)
The ::property-notify-event signal will be emitted when a property on
the widget
's window has been changed or deleted.
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.
FALSE to propagate the event further.
Flags: Run Last
The “proximity-in-event” signal
gboolean
user_function (GtkWidget *widget,
GdkEvent *event,
gpointer user_data)
To receive this signal the GdkWindow associated to the widget needs
to enable the GDK_PROXIMITY_IN_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.
FALSE to propagate the event further.
Flags: Run Last
The “proximity-out-event” signal
gboolean
user_function (GtkWidget *widget,
GdkEvent *event,
gpointer user_data)
To receive this signal the GdkWindow associated to the widget needs
to enable the GDK_PROXIMITY_OUT_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.
FALSE to propagate the event further.
Flags: Run Last
The “query-tooltip” signal
gboolean
user_function (GtkWidget *widget,
gint x,
gint y,
gboolean keyboard_mode,
GtkTooltip *tooltip,
gpointer user_data)
Emitted when “has-tooltip” is TRUE and the hover 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
whether a tooltip should be shown for widget
. If this is the case
TRUE should be returned, FALSE otherwise. Note that if
keyboard_mode
is TRUE, the values of x
and y
are undefined and
should not be used.
The signal handler is free to manipulate tooltip
with the therefore
destined function calls.
Returns
TRUE if tooltip
should be shown right now, FALSE otherwise.
Flags: Run Last
Since: 2.12
The “realize” signal
void
user_function (GtkWidget *widget,
gpointer user_data)
The ::realize signal is emitted when widget
is associated with a
GdkWindow, which means that gtk_widget_realize() has been called or the
widget has been mapped (that is, it is going to be drawn).
Flags: Run First
The “screen-changed” signal
void
user_function (GtkWidget *widget,
GdkScreen *previous_screen,
gpointer user_data)
The ::screen-changed signal gets emitted when the
screen of a widget has changed.
Flags: Run Last
The “scroll-event” signal
gboolean
user_function (GtkWidget *widget,
GdkEvent *event,
gpointer user_data)
The ::scroll-event signal is emitted when a button in the 4 to 7
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
to enable the GDK_SCROLL_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.
FALSE to propagate the event further.
Flags: Run Last
The “selection-clear-event” signal
gboolean
user_function (GtkWidget *widget,
GdkEvent *event,
gpointer user_data)
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.
FALSE to propagate the event further.
Flags: Run Last
The “selection-request-event” signal
gboolean
user_function (GtkWidget *widget,
GdkEvent *event,
gpointer user_data)
The ::selection-request-event signal will be emitted when
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.
FALSE to propagate the event further.
Flags: Run Last
The “style-set” signal
void
user_function (GtkWidget *widget,
GtkStyle *previous_style,
gpointer user_data)
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.
Note that this signal is emitted for changes to the deprecated
GtkStyle. To track changes to the GtkStyleContext associated
with a widget, use the “style-updated” signal.
GtkWidget::style-set has been deprecated since version 3.0 and should not be used in newly-written code.
Use the “style-updated” signal
Flags: Run First
The “unmap” signal
void
user_function (GtkWidget *widget,
gpointer user_data)
The ::unmap signal is emitted when widget
is going to be unmapped, which
means that either it or any of its parents up to the toplevel widget have
been set as hidden.
As ::unmap indicates that a widget will not be shown any longer, it can be
used to, for example, stop an animation on the widget.
Flags: Run First
The “unmap-event” signal
gboolean
user_function (GtkWidget *widget,
GdkEvent *event,
gpointer user_data)
The ::unmap-event signal will be emitted when the widget
's window is
unmapped. A window is unmapped when it becomes invisible on the screen.
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.
FALSE to propagate the event further.
Flags: Run Last
The “unrealize” signal
void
user_function (GtkWidget *widget,
gpointer user_data)
The ::unrealize signal is emitted when the GdkWindow associated with
widget
is destroyed, which means that gtk_widget_unrealize() has been
called or the widget has been unmapped (that is, it is going to be
hidden).
Flags: Run Last
The “visibility-notify-event” signal
gboolean
user_function (GtkWidget *widget,
GdkEvent *event,
gpointer user_data)
The ::visibility-notify-event will be emitted when the widget
's
window is obscured or unobscured.
To receive this signal the GdkWindow associated to the widget needs
to enable the GDK_VISIBILITY_NOTIFY_MASK mask.
GtkWidget::visibility-notify-event has been deprecated since version 3.12 and should not be used in newly-written code.
Modern composited windowing systems with pervasive
transparency make it impossible to track the visibility of a window
reliably, so this signal can not be guaranteed to provide useful
information.
Returns
TRUE to stop other handlers from being invoked for the event.
FALSE to propagate the event further.
Flags: Run Last
The “window-state-event” signal
gboolean
user_function (GtkWidget *widget,
GdkEvent *event,
gpointer user_data)
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
this mask automatically for all new windows.
Returns
TRUE to stop other handlers from being invoked for the
event. FALSE to propagate the event further.
Flags: Run Last