Optionalproperties: Partial<Gtk.AppChooserDialog.ConstructorProps>Internal$signalsCompile-time signal type information.
This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.
Static$gtypeRead-OnlywindowThe widget's window if it is realized, null otherwise.
Construct OnlygfileThe GFile used by the Gtk.AppChooserDialog. The dialog's Gtk.AppChooserWidget content type will be guessed from the file, if present.
The text to show at the top of the dialog. The string may contain Pango markup.
The content type of the Gtk.AppChooser object.
See [GContentType][gio-GContentType] for more information about content types.
The content type of the Gtk.AppChooser object.
See [GContentType][gio-GContentType] for more information about content types.
Whether to expand in both directions. Setting this sets both Gtk.Widget.hexpand and Gtk.Widget.vexpand
Whether to expand in both directions. Setting this sets both Gtk.Widget.hexpand and Gtk.Widget.vexpand
Enables or disables the emission of Gtk.Widget.SignalSignatures.query_tooltip | Gtk.Widget::query-tooltip on widget.
A value of true indicates that widget can have a tooltip, in this case
the widget will be queried using Gtk.Widget.SignalSignatures.query_tooltip | Gtk.Widget::query-tooltip to determine
whether it will provide a tooltip or not.
Note that setting this property to true for the first time will change
the event masks of the GdkWindows of this widget to include leave-notify
and motion-notify events. This cannot and will not be undone when the
property is set to false again.
Enables or disables the emission of Gtk.Widget.SignalSignatures.query_tooltip | Gtk.Widget::query-tooltip on widget.
A value of true indicates that widget can have a tooltip, in this case
the widget will be queried using Gtk.Widget.SignalSignatures.query_tooltip | Gtk.Widget::query-tooltip to determine
whether it will provide a tooltip or not.
Note that setting this property to true for the first time will change
the event masks of the GdkWindows of this widget to include leave-notify
and motion-notify events. This cannot and will not be undone when the
property is set to false again.
Enables or disables the emission of Gtk.Widget.SignalSignatures.query_tooltip | Gtk.Widget::query-tooltip on widget.
A value of true indicates that widget can have a tooltip, in this case
the widget will be queried using Gtk.Widget.SignalSignatures.query_tooltip | Gtk.Widget::query-tooltip to determine
whether it will provide a tooltip or not.
Note that setting this property to true for the first time will change
the event masks of the GdkWindows of this widget to include leave-notify
and motion-notify events. This cannot and will not be undone when the
property is set to false again.
Enables or disables the emission of Gtk.Widget.SignalSignatures.query_tooltip | Gtk.Widget::query-tooltip on widget.
A value of true indicates that widget can have a tooltip, in this case
the widget will be queried using Gtk.Widget.SignalSignatures.query_tooltip | Gtk.Widget::query-tooltip to determine
whether it will provide a tooltip or not.
Note that setting this property to true for the first time will change
the event masks of the GdkWindows of this widget to include leave-notify
and motion-notify events. This cannot and will not be undone when the
property is set to false again.
Whether to use the Gtk.Widget.hexpand property. See gtk_widget_get_hexpand_set().
Whether to use the Gtk.Widget.hexpand property. See gtk_widget_get_hexpand_set().
Whether to use the Gtk.Widget.hexpand property. See gtk_widget_get_hexpand_set().
Whether to use the Gtk.Widget.hexpand property. See gtk_widget_get_hexpand_set().
Margin on end of widget, horizontally. This property supports left-to-right and right-to-left text directions.
This property adds margin outside of the widget's normal size
request, the margin will be added in addition to the size from
gtk_widget_set_size_request() for example.
Margin on end of widget, horizontally. This property supports left-to-right and right-to-left text directions.
This property adds margin outside of the widget's normal size
request, the margin will be added in addition to the size from
gtk_widget_set_size_request() for example.
Margin on left side of widget.
This property adds margin outside of the widget's normal size
request, the margin will be added in addition to the size from
gtk_widget_set_size_request() for example.
since 3.12: Use Gtk.Widget.margin_start instead.
Margin on left side of widget.
This property adds margin outside of the widget's normal size
request, the margin will be added in addition to the size from
gtk_widget_set_size_request() for example.
Deprecatedval: numbersince 3.12: Use Gtk.Widget.margin_start instead.
Margin on right side of widget.
This property adds margin outside of the widget's normal size
request, the margin will be added in addition to the size from
gtk_widget_set_size_request() for example.
since 3.12: Use Gtk.Widget.margin_end instead.
Margin on right side of widget.
This property adds margin outside of the widget's normal size
request, the margin will be added in addition to the size from
gtk_widget_set_size_request() for example.
Deprecatedval: numbersince 3.12: Use Gtk.Widget.margin_end instead.
Margin on start of widget, horizontally. This property supports left-to-right and right-to-left text directions.
This property adds margin outside of the widget's normal size
request, the margin will be added in addition to the size from
gtk_widget_set_size_request() for example.
Margin on start of widget, horizontally. This property supports left-to-right and right-to-left text directions.
This property adds margin outside of the widget's normal size
request, the margin will be added in addition to the size from
gtk_widget_set_size_request() for example.
Margin on end of widget, horizontally. This property supports left-to-right and right-to-left text directions.
This property adds margin outside of the widget's normal size
request, the margin will be added in addition to the size from
gtk_widget_set_size_request() for example.
Margin on end of widget, horizontally. This property supports left-to-right and right-to-left text directions.
This property adds margin outside of the widget's normal size
request, the margin will be added in addition to the size from
gtk_widget_set_size_request() for example.
Margin on left side of widget.
This property adds margin outside of the widget's normal size
request, the margin will be added in addition to the size from
gtk_widget_set_size_request() for example.
since 3.12: Use Gtk.Widget.margin_start instead.
Margin on left side of widget.
This property adds margin outside of the widget's normal size
request, the margin will be added in addition to the size from
gtk_widget_set_size_request() for example.
Deprecatedval: numbersince 3.12: Use Gtk.Widget.margin_start instead.
Margin on right side of widget.
This property adds margin outside of the widget's normal size
request, the margin will be added in addition to the size from
gtk_widget_set_size_request() for example.
since 3.12: Use Gtk.Widget.margin_end instead.
Margin on right side of widget.
This property adds margin outside of the widget's normal size
request, the margin will be added in addition to the size from
gtk_widget_set_size_request() for example.
Deprecatedval: numbersince 3.12: Use Gtk.Widget.margin_end instead.
Margin on start of widget, horizontally. This property supports left-to-right and right-to-left text directions.
This property adds margin outside of the widget's normal size
request, the margin will be added in addition to the size from
gtk_widget_set_size_request() for example.
Margin on start of widget, horizontally. This property supports left-to-right and right-to-left text directions.
This property adds margin outside of the widget's normal size
request, the margin will be added in addition to the size from
gtk_widget_set_size_request() for example.
The style of the widget, which contains information about how it will look (colors, etc).
Use Gtk.StyleContext instead
The style of the widget, which contains information about how it will look (colors, etc).
Use Gtk.StyleContext instead
Sets the text of tooltip to be the given string, which is marked up
with the [Pango text markup language][PangoMarkupFormat].
Also see gtk_tooltip_set_markup().
This is a convenience property which will take care of getting the
tooltip shown if the given string is not null: Gtk.Widget.has_tooltip
will automatically be set to true and there will be taken care of
Gtk.Widget.SignalSignatures.query_tooltip | Gtk.Widget::query-tooltip in the default signal handler.
Note that if both Gtk.Widget.tooltip_text and Gtk.Widget.tooltip_markup are set, the last one wins.
Sets the text of tooltip to be the given string, which is marked up
with the [Pango text markup language][PangoMarkupFormat].
Also see gtk_tooltip_set_markup().
This is a convenience property which will take care of getting the
tooltip shown if the given string is not null: Gtk.Widget.has_tooltip
will automatically be set to true and there will be taken care of
Gtk.Widget.SignalSignatures.query_tooltip | Gtk.Widget::query-tooltip in the default signal handler.
Note that if both Gtk.Widget.tooltip_text and Gtk.Widget.tooltip_markup are set, the last one wins.
Sets the text of tooltip to be the given string.
Also see gtk_tooltip_set_text().
This is a convenience property which will take care of getting the
tooltip shown if the given string is not null: Gtk.Widget.has_tooltip
will automatically be set to true and there will be taken care of
Gtk.Widget.SignalSignatures.query_tooltip | Gtk.Widget::query-tooltip in the default signal handler.
Note that if both Gtk.Widget.tooltip_text and Gtk.Widget.tooltip_markup are set, the last one wins.
Sets the text of tooltip to be the given string.
Also see gtk_tooltip_set_text().
This is a convenience property which will take care of getting the
tooltip shown if the given string is not null: Gtk.Widget.has_tooltip
will automatically be set to true and there will be taken care of
Gtk.Widget.SignalSignatures.query_tooltip | Gtk.Widget::query-tooltip in the default signal handler.
Note that if both Gtk.Widget.tooltip_text and Gtk.Widget.tooltip_markup are set, the last one wins.
Sets the text of tooltip to be the given string, which is marked up
with the [Pango text markup language][PangoMarkupFormat].
Also see gtk_tooltip_set_markup().
This is a convenience property which will take care of getting the
tooltip shown if the given string is not null: Gtk.Widget.has_tooltip
will automatically be set to true and there will be taken care of
Gtk.Widget.SignalSignatures.query_tooltip | Gtk.Widget::query-tooltip in the default signal handler.
Note that if both Gtk.Widget.tooltip_text and Gtk.Widget.tooltip_markup are set, the last one wins.
Sets the text of tooltip to be the given string, which is marked up
with the [Pango text markup language][PangoMarkupFormat].
Also see gtk_tooltip_set_markup().
This is a convenience property which will take care of getting the
tooltip shown if the given string is not null: Gtk.Widget.has_tooltip
will automatically be set to true and there will be taken care of
Gtk.Widget.SignalSignatures.query_tooltip | Gtk.Widget::query-tooltip in the default signal handler.
Note that if both Gtk.Widget.tooltip_text and Gtk.Widget.tooltip_markup are set, the last one wins.
Sets the text of tooltip to be the given string.
Also see gtk_tooltip_set_text().
This is a convenience property which will take care of getting the
tooltip shown if the given string is not null: Gtk.Widget.has_tooltip
will automatically be set to true and there will be taken care of
Gtk.Widget.SignalSignatures.query_tooltip | Gtk.Widget::query-tooltip in the default signal handler.
Note that if both Gtk.Widget.tooltip_text and Gtk.Widget.tooltip_markup are set, the last one wins.
Sets the text of tooltip to be the given string.
Also see gtk_tooltip_set_text().
This is a convenience property which will take care of getting the
tooltip shown if the given string is not null: Gtk.Widget.has_tooltip
will automatically be set to true and there will be taken care of
Gtk.Widget.SignalSignatures.query_tooltip | Gtk.Widget::query-tooltip in the default signal handler.
Note that if both Gtk.Widget.tooltip_text and Gtk.Widget.tooltip_markup are set, the last one wins.
Whether to use the Gtk.Widget.vexpand property. See gtk_widget_get_vexpand_set().
Whether to use the Gtk.Widget.vexpand property. See gtk_widget_get_vexpand_set().
Whether to use the Gtk.Widget.vexpand property. See gtk_widget_get_vexpand_set().
Whether to use the Gtk.Widget.vexpand property. See gtk_widget_get_vexpand_set().
The Gtk.Application associated with the window.
The application will be kept alive for at least as long as it
has any windows associated with it (see g_application_hold()
for a way to keep it alive without windows).
Normally, the connection between the application and the window
will remain until the window is destroyed, but you can explicitly
remove it by setting the :application property to null.
The widget to which this window is attached.
See gtk_window_set_attached_to().
Examples of places where specifying this relation is useful are for instance a Gtk.Menu created by a Gtk.ComboBox, a completion popup window created by Gtk.Entry or a typeahead search entry created by Gtk.TreeView.
The widget to which this window is attached.
See gtk_window_set_attached_to().
Examples of places where specifying this relation is useful are for instance a Gtk.Menu created by a Gtk.ComboBox, a completion popup window created by Gtk.Entry or a typeahead search entry created by Gtk.TreeView.
The window gravity of the window. See gtk_window_move() and Gdk.Gravity for
more details about window gravity.
Whether the window has a corner resize grip.
Note that the resize grip is only shown if the window is actually resizable and not maximized. Use Gtk.Window.resize_grip_visible to find out if the resize grip is currently shown.
Whether the window has a corner resize grip.
Note that the resize grip is only shown if the window is actually resizable and not maximized. Use Gtk.Window.resize_grip_visible to find out if the resize grip is currently shown.
The :icon-name property specifies the name of the themed icon to use as the window icon. See Gtk.IconTheme for more details.
The :icon-name property specifies the name of the themed icon to use as the window icon. See Gtk.IconTheme for more details.
true if the dialog uses a Gtk.HeaderBar for action buttons
instead of the action-area.
For technical reasons, this property is declared as an integer
property, but you should only set it to true or false.
true if the dialog uses a Gtk.HeaderBar for action buttons
instead of the action-area.
For technical reasons, this property is declared as an integer
property, but you should only set it to true or false.
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.
true if the widget was activatable
Installs an accelerator for this widget in accel_group that causes
accel_signal to be emitted if the accelerator is activated.
The accel_group needs to be added to the widget’s toplevel via
gtk_window_add_accel_group(), and the signal must be of type GObject.SignalFlags.ACTION.
Accelerators added through this function are not user changeable during
runtime. If you want to support accelerators that can be changed by the
user, use gtk_accel_map_add_entry() and gtk_widget_set_accel_path() or
gtk_menu_item_set_accel_path() instead.
widget signal to emit on accelerator activation
accel group for this widget, added to its toplevel
GDK keyval of the accelerator
modifier key combination of the accelerator
flag accelerators, e.g. Gtk.AccelFlags.VISIBLE
Adds the device events in the bitfield events to the event mask for
widget. See gtk_widget_set_device_events() for details.
an event mask, see Gdk.EventMask
Adds the events in the bitfield events to the event mask for
widget. See gtk_widget_set_events() and the
[input handling overview][event-masks] for details.
an event mask, see Gdk.EventMask
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 Gtk.Widget::destroy signal or a weak notifier.
a Gtk.Widget that acts as a mnemonic label for widget
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 Gtk.Label),
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 Gdk.FrameClock::update signal of Gdk.FrameClock, since you don't have to worry about when a Gdk.FrameClock is assigned to a widget.
function to call for updating animations
an id for the connection of this callback. Remove the callback by passing it to gtk_widget_remove_tick_callback()
Creates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
GObject.Binding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A GObject.Object can have multiple bindings.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Complete version of g_object_bind_property().
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well. The transform_from function is only used in case
of bidirectional bindings, otherwise it will be ignored
The binding will automatically be removed when either the source or the
target instances are finalized. This will release the reference that is
being held on the GObject.Binding instance; if you want to hold on to the
GObject.Binding instance, you will need to hold a reference to it.
To remove the binding, call g_binding_unbind().
A GObject.Object can have multiple bindings.
The same user_data parameter will be used for both transform_to
and transform_from transformation functions; the notify function will
be called once, when the binding is removed. If you need different data
for each transformation function, please use
g_object_bind_property_with_closures() instead.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
Optionaltransform_to: BindingTransformFuncthe transformation function from the source to the target, or null to use the default
Optionaltransform_from: BindingTransformFuncthe transformation function from the target to the source, or null to use the default
Optionalnotify: DestroyNotifya function to call when disposing the binding, to free resources used by the transformation functions, or null if not required
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of
g_object_bind_property_full(), using GClosures instead of
function pointers.
the property on source to bind
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Blocks a handler of an instance so it will not be called during any signal emissions
Handler ID of the handler to be blocked
Determines whether an accelerator that activates the signal
identified by signal_id can currently be activated.
This is done by emitting the Gtk.Widget.SignalSignatures.can_activate_accel | Gtk.Widget::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.
the ID of a signal installed on widget
true if the accelerator can be activated.
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
Gtk.Widget::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.
direction of focus movement
true if focus ended up inside widget
Emits a Gtk.Widget.SignalSignatures.child_notify | Gtk.Widget::child-notify signal for the
[child property][child-properties] child_property
on widget.
This is the analogue of g_object_notify() for child properties.
Also see gtk_container_child_notify().
the name of a child property installed on the class of widget’s parent
Same as gtk_widget_path(), but always uses the name of a widget’s type,
never uses a custom name set with gtk_widget_set_name().
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.
expand direction
whether widget tree rooted here should be expanded
SignalconnectSignalconnect_Creates a new Pango.Context with the appropriate font map,
font options, font description, and base direction for drawing
text for this widget. See also gtk_widget_get_pango_context().
the new Pango.Context
Creates a new Pango.Layout with the appropriate font map, font description, and base direction for drawing text for this widget.
If you keep a Pango.Layout created in this way around, you need to re-create it when the widget Pango.Context is replaced. This can be tracked by using the Gtk.Widget.SignalSignatures.screen_changed | Gtk.Widget::screen-changed signal on the widget.
Optionaltext: stringtext to set on the layout (can be null)
the new Pango.Layout
Destroys a widget.
When a widget is destroyed all references it holds on other objects will be released:
It's expected that all references held on the widget will also
be released; you should connect to the Gtk.Widget::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 Gtk.Container, as you'll be able to use the
Gtk.ContainerClass.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()
This function sets *widget_pointer to null if widget_pointer !=
null. It’s intended to be used as a callback connected to the
“destroy” signal of a widget. You connect gtk_widget_destroyed()
as a signal handler, and pass the address of your widget variable
as user data. Then when the widget is destroyed, the variable will
be set to null. Useful for example to avoid multiple copies
of the same dialog.
Returns 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
Gtk.Widget.SignalSignatures.grab_notify | Gtk.Widget::grab-notify signal to check for specific
devices. See gtk_device_grab_add().
true if there is an ongoing grab on device by another Gtk.Widget than widget.
Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
Handler ID of the handler to be disconnected
This function is equivalent to gtk_drag_begin_with_coordinates(),
passing -1, -1 as coordinates.
The targets (data formats) in which the source can provide the data
A bitmask of the allowed drag actions for this drag
The button the user clicked to start the drag
Optionalevent: Gdk.EventThe event that triggered the start of the drag, or null if none can be obtained.
the context for this drag
Initiates a drag on the source side. The function only needs to be used
when the application is starting drags itself, and is not needed when
gtk_drag_source_set() is used.
The event is used to retrieve the timestamp that will be used internally to
grab the pointer. If event is null, then GDK_CURRENT_TIME will be used.
However, you should try to pass a real event in all cases, since that can be
used to get information about the drag.
Generally there are three cases when you want to start a drag by hand by calling this function:
During a Gtk.Widget.SignalSignatures.button_press_event | Gtk.Widget::button-press-event handler, if you want to start a drag
immediately when the user presses the mouse button. Pass the event
that you have in your Gtk.Widget.SignalSignatures.button_press_event | Gtk.Widget::button-press-event handler.
During a Gtk.Widget.SignalSignatures.motion_notify_event | Gtk.Widget::motion-notify-event handler, if you want to start a drag
when the mouse moves past a certain threshold distance after a button-press.
Pass the event that you have in your Gtk.Widget.SignalSignatures.motion_notify_event | Gtk.Widget::motion-notify-event handler.
During a timeout handler, if you want to start a drag after the mouse
button is held down for some time. Try to save the last event that you got
from the mouse, using gdk_event_copy(), and pass it to this function
(remember to free the event with gdk_event_free() when you are done).
If you really cannot pass a real event, pass null instead.
The targets (data formats) in which the source can provide the data
A bitmask of the allowed drag actions for this drag
The button the user clicked to start the drag
The event that triggered the start of the drag, or null if none can be obtained.
The initial x coordinate to start dragging from, in the coordinate space of widget. If -1 is passed, the coordinates are retrieved from event or the current pointer position
The initial y coordinate to start dragging from, in the coordinate space of widget. If -1 is passed, the coordinates are retrieved from event or the current pointer position
the context for this drag
Checks to see if a mouse drag starting at (start_x, start_y) and ending
at (current_x, current_y) has passed the GTK+ drag threshold, and thus
should trigger the beginning of a drag-and-drop operation.
X coordinate of start of drag
Y coordinate of start of drag
current X coordinate
current Y coordinate
true if the drag threshold has been passed.
Add the image targets supported by Gtk.SelectionData to
the target list of the drag destination. The targets
are added with info = 0. If you need another value,
use gtk_target_list_add_image_targets() and
gtk_drag_dest_set_target_list().
Add the text targets supported by Gtk.SelectionData to
the target list of the drag destination. The targets
are added with info = 0. If you need another value,
use gtk_target_list_add_text_targets() and
gtk_drag_dest_set_target_list().
Add the URI targets supported by Gtk.SelectionData to
the target list of the drag destination. The targets
are added with info = 0. If you need another value,
use gtk_target_list_add_uri_targets() and
gtk_drag_dest_set_target_list().
Looks for a match between the supported targets of context and the
dest_target_list, returning the first matching target, otherwise
returning GDK_NONE. dest_target_list should usually be the return
value from gtk_drag_dest_get_target_list(), but some widgets may
have different valid targets for different parts of the widget; in
that case, they will have to implement a drag_motion handler that
passes the correct target list to this function.
drag context
Optionaltarget_list: TargetListlist of droppable targets, or null to use gtk_drag_dest_get_target_list (widget).
first target that the source offers and the dest can accept, or GDK_NONE
Returns the list of targets this widget can accept from drag-and-drop.
the Gtk.TargetList, or null if none
Returns whether the widget has been configured to always emit Gtk.Widget.SignalSignatures.drag_motion | Gtk.Widget::drag-motion signals.
true if the widget always emits Gtk.Widget.SignalSignatures.drag_motion | Gtk.Widget::drag-motion events
Sets a widget as a potential drop destination, and adds default behaviors.
The default behaviors listed in flags have an effect similar
to installing default handlers for the widget’s drag-and-drop signals
(Gtk.Widget.SignalSignatures.drag_motion | Gtk.Widget::drag-motion, Gtk.Widget.SignalSignatures.drag_drop | Gtk.Widget::drag-drop, ...). They all exist
for convenience. When passing #GTK_DEST_DEFAULT_ALL for instance it is
sufficient to connect to the widget’s Gtk.Widget.SignalSignatures.drag_data_received | Gtk.Widget::drag-data-received
signal to get primitive, but consistent drag-and-drop support.
Things become more complicated when you try to preview the dragged data,
as described in the documentation for Gtk.Widget.SignalSignatures.drag_motion | Gtk.Widget::drag-motion. The default
behaviors described by flags make some assumptions, that can conflict
with your own signal handlers. For instance #GTK_DEST_DEFAULT_DROP causes
invokations of gdk_drag_status() in the context of Gtk.Widget.SignalSignatures.drag_motion | Gtk.Widget::drag-motion,
and invokations of gtk_drag_finish() in Gtk.Widget.SignalSignatures.drag_data_received | Gtk.Widget::drag-data-received.
Especially the later is dramatic, when your own Gtk.Widget.SignalSignatures.drag_motion | Gtk.Widget::drag-motion
handler calls gtk_drag_get_data() to inspect the dragged data.
There’s no way to set a default action here, you can use the Gtk.Widget.SignalSignatures.drag_motion | Gtk.Widget::drag-motion callback for that. Here’s an example which selects the action to use depending on whether the control key is pressed or not:
static void
drag_motion (GtkWidget *widget,
GdkDragContext *context,
gint x,
gint y,
guint time)
{
GdkModifierType mask;
gdk_window_get_pointer (gtk_widget_get_window (widget),
NULL, NULL, &mask);
if (mask & GDK_CONTROL_MASK)
gdk_drag_status (context, GDK_ACTION_COPY, time);
else
gdk_drag_status (context, GDK_ACTION_MOVE, time);
}
which types of default drag behavior to use
a pointer to an array of GtkTargetEntrys indicating the drop types that this widget will accept, or null. Later you can access the list with gtk_drag_dest_get_target_list() and gtk_drag_dest_find_target().
a bitmask of possible actions for a drop onto this widget.
Sets this widget as a proxy for drops to another window.
the window to which to forward drag events
the drag protocol which the proxy_window accepts (You can use gdk_drag_get_protocol() to determine this)
If true, send the same coordinates to the destination, because it is an embedded subwindow.
Sets the target types that this widget can accept from drag-and-drop.
The widget must first be made into a drag destination with
gtk_drag_dest_set().
Optionaltarget_list: TargetListlist of droppable targets, or null for none
Tells the widget to emit Gtk.Widget.SignalSignatures.drag_motion | Gtk.Widget::drag-motion and Gtk.Widget.SignalSignatures.drag_leave | Gtk.Widget::drag-leave events regardless of the targets and the Gtk.DestDefaults.MOTION flag.
This may be used when a widget wants to do generic actions regardless of the targets that the source offers.
whether to accept all targets
Clears information about a drop destination set with
gtk_drag_dest_set(). The widget will no longer receive
notification of drags.
Gets the data associated with a drag. When the data
is received or the retrieval fails, GTK+ will emit a
Gtk.Widget.SignalSignatures.drag_data_received | Gtk.Widget::drag-data-received signal. Failure of the retrieval
is indicated by the length field of the selection_data
signal parameter being negative. However, when gtk_drag_get_data()
is called implicitely because the Gtk.DestDefaults.DROP was set,
then the widget will not receive notification of failed
drops.
the drag context
the target (form of the data) to retrieve
a timestamp for retrieving the data. This will generally be the time received in a Gtk.Widget.SignalSignatures.drag_motion | Gtk.Widget::drag-motion or Gtk.Widget.SignalSignatures.drag_drop | Gtk.Widget::drag-drop signal
Highlights a widget as a currently hovered drop target.
To end the highlight, call gtk_drag_unhighlight().
GTK+ calls this automatically if Gtk.DestDefaults.HIGHLIGHT is set.
Add the writable image targets supported by Gtk.SelectionData to
the target list of the drag source. The targets
are added with info = 0. If you need another value,
use gtk_target_list_add_image_targets() and
gtk_drag_source_set_target_list().
Add the text targets supported by Gtk.SelectionData to
the target list of the drag source. The targets
are added with info = 0. If you need another value,
use gtk_target_list_add_text_targets() and
gtk_drag_source_set_target_list().
Add the URI targets supported by Gtk.SelectionData to
the target list of the drag source. The targets
are added with info = 0. If you need another value,
use gtk_target_list_add_uri_targets() and
gtk_drag_source_set_target_list().
Gets the list of targets this widget can provide for drag-and-drop.
the Gtk.TargetList, or null if none
Sets up a widget so that GTK+ will start a drag operation when the user clicks and drags on the widget. The widget must have a window.
the bitmask of buttons that can start the drag
the table of targets that the drag will support, may be null
the bitmask of possible actions for a drag from this widget
Sets the icon that will be used for drags from a particular source
to icon. See the docs for Gtk.IconTheme for more details.
Sets the icon that will be used for drags from a particular source to a themed icon. See the docs for Gtk.IconTheme for more details.
name of icon to use
Sets the icon that will be used for drags from a particular widget
from a GdkPixbuf.Pixbuf. GTK+ retains a reference for pixbuf and will
release it when it is no longer needed.
the GdkPixbuf.Pixbuf for the drag icon
Sets the icon that will be used for drags from a particular source to a stock icon.
the ID of the stock icon to use
Changes the target types that this widget offers for drag-and-drop.
The widget must first be made into a drag source with
gtk_drag_source_set().
Optionaltarget_list: TargetListlist of draggable targets, or null for none
Undoes the effects of gtk_drag_source_set().
Removes a highlight set by gtk_drag_highlight() from
a widget.
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().
SignalemitEnsures 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.
Notifies the user about an input-related error on this widget.
If the Gtk.Settings.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.
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.
return from the event signal emission (true if the event was handled)
This function is intended for GObject.Object implementations to re-enforce
a [floating][floating-ref] object reference. Doing this is seldom
required: all GInitiallyUnowneds are created with a floating reference
which usually just needs to be sunken by calling g_object_ref_sink().
Stops emission of Gtk.Widget.SignalSignatures.child_notify | Gtk.Widget::child-notify signals on widget. The
signals are queued until gtk_widget_thaw_child_notify() is called
on widget.
This is the analogue of g_object_freeze_notify() for child properties.
Increases the freeze count on object. If the freeze count is
non-zero, the emission of "notify" signals on object is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
GObject.Object::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Returns the accessible object that describes the widget to an assistive technology.
If accessibility support is not available, this Atk.Object instance may be a no-op. Likewise, if no class-specific Atk.Object implementation is available for the widget instance in question, it will inherit an Atk.Object 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.
the Atk.Object associated with widget
Retrieves the Gio.ActionGroup that was registered using prefix. The resulting
Gio.ActionGroup may have been registered to widget or any Gtk.Widget in its
ancestry.
If no action group was found matching prefix, then null is returned.
The “prefix” of the action group.
A Gio.ActionGroup or null.
Returns the baseline that has currently been allocated to widget.
This function is intended to be used when implementing handlers
for the Gtk.Widget::draw function, and when allocating child
widgets in Gtk.Widget.SignalSignatures.size_allocate | Gtk.Widget::size_allocate.
the baseline of the widget, or -1 if none
Returns the height that has currently been allocated to widget.
This function is intended to be used when implementing handlers
for the Gtk.Widget::draw function.
the height of the widget
Retrieves the widget’s allocated size.
This function returns the last values passed to
gtk_widget_size_allocate_with_baseline(). The value differs from
the size returned in gtk_widget_get_allocation() in that functions
like gtk_widget_set_halign() can adjust the allocation, but not
the value returned by this function.
If a widget is not visible, its allocated size is 0.
Returns the width that has currently been allocated to widget.
This function is intended to be used when implementing handlers
for the Gtk.Widget::draw function.
the width of the widget
Retrieves the widget’s allocation.
Note, when implementing a Gtk.Container: 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 Gtk.Container
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.
Gets the first ancestor of widget with type widget_type. For example,
gtk_widget_get_ancestor (widget, GTK_TYPE_BOX) gets
the first Gtk.Box 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 Gtk.Window 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.
ancestor type
the ancestor widget, or null if not found
Returns the currently selected application.
a Gio.AppInfo for the currently selected application, or null if none is selected. Free with g_object_unref()
Determines whether the application intends to draw on the widget in an Gtk.Widget::draw handler.
See gtk_widget_set_app_paintable()
true if the widget is app paintable
Determines whether widget can be a default widget. See
gtk_widget_set_can_default().
true if widget can be a default widget, false otherwise
Determines whether widget can own the input focus. See
gtk_widget_set_can_focus().
true if widget can own the input focus, false otherwise
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().
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.
true if the widget is mapped with the parent.
Returns the clipboard object for the given selection to
be used with widget. widget must have a Gdk.Display
associated with it, so must be attached to a toplevel
window.
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.
Obtains the composite name of a widget.
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.
Returns the current value of the Gtk.AppChooser.content_type property.
the content type of self. Free with g_free()
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
the data if found, or null if no such data exists.
Gets the reading direction for a particular widget. See
gtk_widget_set_direction().
the reading direction for the widget.
Get the Gdk.Display 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 Gtk.Window 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.
the Gdk.Display for the toplevel for this widget.
Determines whether the widget is double buffered.
See gtk_widget_set_double_buffered()
true if the widget is double buffered
Returns the event mask (see Gdk.EventMask) 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 Gtk.EventController created for the
widget.
event mask for widget
Returns whether the widget should grab focus when it is clicked with the mouse.
See gtk_widget_set_focus_on_click().
true if the widget should grab focus when it is clicked with the mouse.
Gets the font map that has been set with gtk_widget_set_font_map().
A Pango.FontMap, or null
Returns the cairo.FontOptions used for Pango rendering. When not set, the defaults font options for the Gdk.Screen will be used.
the cairo.FontOptions or null if not set
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.
a Gdk.FrameClock, or null if widget is unrealized
Gets the value of the Gtk.Widget.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.
the horizontal alignment of widget
Returns the current value of the has-tooltip property. See Gtk.Widget.has_tooltip for more information.
current value of has-tooltip on widget.
Determines whether widget has a Gdk.Window of its own. See
gtk_widget_set_has_window().
true if widget has a window, false otherwise
Returns the text to display at the top of the dialog.
the text to display at the top of the dialog, or null, in which case a default text is displayed
Gets whether the widget would like any available extra horizontal space. When a user resizes a Gtk.Window, 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.
whether hexpand flag is set
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.
whether hexpand has been explicitly set
Whether the widget is mapped.
true if the widget is mapped, false otherwise.
Returns the modifier mask the widget’s windowing system backend
uses for a particular purpose.
See gdk_keymap_get_modifier_mask().
the use case for the modifier mask
the modifier mask used for intent.
Returns the current modifier style for the widget. (As set by
gtk_widget_modify_style().) If no style has previously set, a new
Gtk.RcStyle 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.
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().
Retrieves the name of a widget. See gtk_widget_set_name() for the
significance of widget names.
name of the widget. This string is owned by GTK+ and should not be modified or freed
Returns the current value of the Gtk.Widget.no_show_all property,
which determines whether calls to gtk_widget_show_all()
will affect this widget.
the current value of the “no-show-all” property.
Fetches the requested opacity for this widget.
See gtk_widget_set_opacity().
the requested opacity for this widget.
Gets a Pango.Context 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 Gtk.Widget.SignalSignatures.screen_changed | Gtk.Widget::screen-changed signal on the widget.
the Pango.Context for the widget.
Returns the Gtk.WidgetPath representing widget, if the widget
is not connected to a toplevel widget, a partial path will be
created.
The Gtk.WidgetPath representing widget
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.
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.
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.
the width which is available for allocation, or -1 if none
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.
the width which is available for allocation
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.
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.
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.
the height which is available for allocation
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
The name of the property to get
Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
This function gets back user data pointers stored via
g_object_set_qdata().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Determines whether widget is realized.
true if widget is realized, false otherwise
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().
true if widget acts as the default widget when focused, false otherwise
Gets whether the widget prefers a height-for-width layout or a width-for-height layout.
Gtk.Bin 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.
The Gtk.SizeRequestMode preferred by widget.
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.
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 Gtk.Window at the top.
The root window is useful for such purposes as creating a popup Gdk.Window 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.
the Gdk.Window root window for the toplevel for this 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().
the scale factor for widget
Get the Gdk.Screen 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 Gtk.Window 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.
the Gdk.Screen for the toplevel for this 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().
true if the widget is sensitive
Gets the settings object holding the settings used for this widget.
Note that this function can only be called when the Gtk.Widget is attached to a toplevel, since the settings object is specific to a particular Gdk.Screen.
the relevant Gtk.Settings object
Gets the size request that was explicitly set for the widget using
gtk_widget_set_size_request(). A value of -1 stored in width or
height indicates that that dimension has not been set explicitly
and the natural requisition of the widget will be used instead. See
gtk_widget_set_size_request(). To get the size a widget will
actually request, call gtk_widget_get_preferred_size() instead of
this function.
Returns the widget state as a flag set. It is worth mentioning
that the effective Gtk.StateFlags.INSENSITIVE state will be
returned, that is, also based on parent insensitivity, even if
widget itself is sensitive.
Also note that if you are looking for a way to obtain the
Gtk.StateFlags to pass to a Gtk.StyleContext method, you
should look at gtk_style_context_get_state().
The state flags for widget
Returns the style context associated to widget. The returned object is
guaranteed to be the same for the lifetime of widget.
a Gtk.StyleContext. This memory is owned by widget and must not be freed.
Returns true if widget is multiple pointer aware. See
gtk_widget_set_support_multidevice() for more information.
true if widget is multidevice aware.
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.
The GObject.GType to get a template child for
The “id” of the child defined in the template XML
The object built in the template XML with the id name
Gets the contents of the tooltip for widget.
the tooltip text, or null. You should free the returned string with g_free() when done.
Gets the contents of the tooltip for widget.
the tooltip text, or null. You should free the returned string with g_free() when done.
Returns the Gtk.Window of the current tooltip. This can be the
GtkWindow created by default, or the custom tooltip window set
using gtk_widget_set_tooltip_window().
The Gtk.Window of the current tooltip.
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 Gtk.Window-derived widget which was in turn
inside the toplevel Gtk.Window. While the second case may
seem unlikely, it actually happens when a Gtk.Plug is embedded
inside a Gtk.Socket within the same application.
To reliably find the toplevel Gtk.Window, 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:
static const char *
get_widget_toplevel_title (GtkWidget *widget)
{
GtkWidget *toplevel = gtk_widget_get_toplevel (widget);
if (GTK_IS_WINDOW (toplevel))
{
return gtk_window_get_title (GTK_WINDOW (toplevel));
}
return NULL;
}
the topmost ancestor of widget, or widget itself if there’s no ancestor.
Gets the value of the Gtk.Widget.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.
the vertical alignment of widget, ignoring baseline alignment
Gets the value of the Gtk.Widget.valign property, including Gtk.Align.BASELINE.
the vertical alignment of widget
Gets whether the widget would like any available extra vertical space.
See gtk_widget_get_hexpand() for more detail.
whether vexpand flag is set
Gets whether gtk_widget_set_vexpand() has been used to
explicitly set the expand flag on this widget.
See gtk_widget_get_hexpand_set() for more detail.
whether vexpand has been explicitly set
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().
true if the widget is visible
Gets n_properties properties for an object.
Obtained properties will be set to values. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Makes widget the current grabbed widget.
This means that interaction with other widgets in the same application is blocked and mouse as well as keyboard events are delivered to this widget.
If widget is not sensitive, it is not set as the current
grabbed widget and this function does nothing.
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 Gtk.Entry widgets require the “activates-default” property
set to true before they activate the default widget when Enter
is pressed and the Gtk.Entry is focused.
Causes widget to have the keyboard focus for the Gtk.Window it's
inside. widget must be a focusable widget, such as a Gtk.Entry;
something like Gtk.Frame 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.
Removes the grab from the given widget.
You have to pair calls to gtk_grab_add() and gtk_grab_remove().
If widget does not have the grab, this function does nothing.
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().
true if the widget is in the grab_widgets stack
Determines if the widget style has been looked up through the rc mechanism.
true if the widget has been looked up through the rc mechanism, false otherwise.
Checks whether there is a Gdk.Screen 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.
true if there is a Gdk.Screen associated with the 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().
true if the widget should display a “focus rectangle”
Reverses the effects of gtk_widget_show(), causing the widget to be
hidden (invisible to the user).
Utility function; intended to be connected to the Gtk.Widget.SignalSignatures.delete_event | Gtk.Widget::delete-event
signal on a Gtk.Window. 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.
true
Returns whether the widget is currently being destroyed. This information can sometimes be used to avoid doing unnecessary work.
true if widget is being destroyed
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 Gtk.Widget subclass and not in GObject.Object.constructed() or GObject.Object.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.
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.
Inserts group into widget. Children of widget that implement
Gtk.Actionable 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.
the prefix for actions in group
Optionalgroup: Gio.ActionGroupa Gio.ActionGroup, or null
Determines whether widget is somewhere inside ancestor, possibly with
intermediate containers.
another Gtk.Widget
true if ancestor contains widget as a child, grandchild, great grandchild, etc.
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()).
true if the widget can rely on its alpha channel being drawn correctly.
Determines whether widget can be drawn to. A widget can be drawn
to if it is mapped and visible.
true if widget is drawable, false otherwise
Checks whether object has a [floating][floating-ref] reference.
true if object has a floating reference
Returns the widget’s effective sensitivity, which means it is sensitive itself and also its parent widget is sensitive
true if the widget is effectively sensitive
Determines whether widget is a toplevel widget.
Currently only Gtk.Window and Gtk.Invisible (and out-of-process
GtkPlugs) are toplevel widgets. Toplevel widgets have no parent
widget.
true if widget is a toplevel, false otherwise
Determines whether the widget and all its parents are marked as visible.
This function does not check if the widget is obscured in any way.
See also gtk_widget_get_visible() and gtk_widget_set_visible()
true if the widget and all its parents are visible
This function should be called whenever keyboard navigation within
a single widget hits a boundary. The function emits the
Gtk.Widget.SignalSignatures.keynav_failed | Gtk.Widget::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.DirectionType.TAB_FORWARD and Gtk.DirectionType.TAB_BACKWARD. For the other
values of Gtk.DirectionType 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 Gtk.Entry 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.
direction of focus movement
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).
Lists the closures used by widget for accelerator group connections
with gtk_accel_group_connect_by_path() or gtk_accel_group_connect().
The closures can be used to monitor accelerator changes on widget,
by connecting to the GtkAccelGroup::accel-changed signal of the
Gtk.AccelGroup of a closure which can be found out with
gtk_accel_group_from_accel_closure().
a newly allocated GLib.List of closures
Retrieves a null-terminated array of strings containing the prefixes of
Gio.ActionGroup's available to widget.
a null-terminated array of strings.
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.
the list of mnemonic labels; free this list with g_list_free() when you are done with it.
This function is only for use in widget implementations. Causes a widget to be mapped if it isn’t already.
Emits the Gtk.Widget.SignalSignatures.mnemonic_activate | Gtk.Widget::mnemonic-activate signal.
true if there are other widgets with the same mnemonic
true if the signal has been handled
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 Gtk.Entry
and Gtk.TextView. See also gtk_widget_modify_style().
Note that “no window” widgets (which have the
GTK_NO_WINDOWflag set) draw on their parent container’s window and thus may not draw any background themselves. This is the case for e.g. Gtk.Label.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 Gtk.EventBox widget and setting the base color on that.
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_WINDOWflag set) draw on their parent container’s window and thus may not draw any background themselves. This is the case for e.g. Gtk.Label.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 Gtk.EventBox widget and setting the background color on that.
Sets the cursor color to use in a widget, overriding the Gtk.Widget cursor-color and secondary-cursor-color style properties.
All other style values are left untouched.
See also gtk_widget_modify_style().
Optionalprimary: Gdk.Colorthe color to use for primary cursor (does not need to be allocated), or null to undo the effect of previous calls to of gtk_widget_modify_cursor().
Optionalsecondary: Gdk.Colorthe color to use for secondary cursor (does not need to be allocated), or null to undo the effect of previous calls to of gtk_widget_modify_cursor().
Sets the foreground color for a widget in a particular state.
All other style values are left untouched.
See also gtk_widget_modify_style().
Sets the font to use for a widget.
All other style values are left untouched.
See also gtk_widget_modify_style().
Optionalfont_desc: Pango.FontDescriptionthe font description to use, or null to undo the effect of previous calls to gtk_widget_modify_font()
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 Gtk.RcStyle-struct 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.
the Gtk.RcStyle-struct holding the style modifications
Sets the text color for a widget in a particular state.
All other style values are left untouched.
The text color is the foreground color used along with the
base color (see gtk_widget_modify_base()) for widgets such
as Gtk.Entry and Gtk.TextView.
See also gtk_widget_modify_style().
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than
g_object_notify().
One way to avoid using g_object_notify() from within the
class that registered the properties, and using g_object_notify_by_pspec()
instead, is to store the GParamSpec used with
g_object_class_install_property() inside a static array, e.g.:
typedef enum
{
PROP_FOO = 1,
PROP_LAST
} MyObjectProperty;
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
0, 100,
50,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the GObject.ParamSpec of a property installed on the class of object.
Sets the background color to use for a widget.
All other style values are left untouched.
See gtk_widget_override_color().
the state for which to set the background color
Optionalcolor: Gdk.RGBAthe color to assign, or null to undo the effect of previous calls to gtk_widget_override_background_color()
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 Gtk.CssProvider
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
Gtk.CssProvider with the GTK_STYLE_PROVIDER_PRIORITY_APPLICATION
priority.
the state for which to set the color
Optionalcolor: Gdk.RGBAthe color to assign, or null to undo the effect of previous calls to gtk_widget_override_color()
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 Gdk.Color type,
so the alpha value in primary and secondary will be ignored.
Optionalcursor: Gdk.RGBAthe color to use for primary cursor (does not need to be allocated), or null to undo the effect of previous calls to of gtk_widget_override_cursor().
Optionalsecondary_cursor: Gdk.RGBAthe color to use for secondary cursor (does not need to be allocated), or null to undo the effect of previous calls to of gtk_widget_override_cursor().
Sets the font to use for a widget. All other style values are
left untouched. See gtk_widget_override_color().
Optionalfont_desc: Pango.FontDescriptionthe font description to use, or null to undo the effect of previous calls to gtk_widget_override_font()
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.
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.
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().
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().
Equivalent to calling gtk_widget_queue_draw_area() for the
entire area of a widget.
Convenience function that calls gtk_widget_queue_draw_region() on
the region created from the given coordinates.
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.
x coordinate of upper-left corner of rectangle to redraw
y coordinate of upper-left corner of rectangle to redraw
width of region to draw
height of region to draw
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 Gtk.DrawingArea or some portion thereof.
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 Gtk.Label, Gtk.Label 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.
This function works like gtk_widget_queue_resize(),
except that the widget is not invalidated.
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 Gtk.Widget::draw. Or simply g_signal_connect () to the Gtk.Widget::realize signal.
Increases the reference count of object.
Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type
of object will be propagated to the return type (using the GCC typeof()
extension), so any casting the caller needs to do on the return type must be
explicit.
the same object
Increase the reference count of object, and possibly remove the
[floating][floating-ref] reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
object
Reloads the list of applications.
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.
a cairo.Region, in the same coordinate system as widget->allocation. That is, relative to widget->window for widgets which return false from gtk_widget_get_has_window(); relative to the parent window of widget->window otherwise.
A newly allocated region holding the intersection of widget and region.
Registers a Gdk.Window with the widget and sets it up so that
the widget receives events for it. Call gtk_widget_unregister_window()
when destroying the window.
Before 3.8 you needed to call gdk_window_set_user_data() directly to set
this up. This is now deprecated and you should use gtk_widget_register_window()
instead. Old code will keep working as is, although some new features like
transparency might not work perfectly.
Removes an accelerator from widget, previously installed with
gtk_widget_add_accelerator().
accel group for this widget
GDK keyval of the accelerator
modifier key combination of the accelerator
whether an accelerator was installed and could be removed
Removes a widget from the list of mnemonic labels for
this widget. (See gtk_widget_list_mnemonic_labels()). The widget
must have previously been added to the list with
gtk_widget_add_mnemonic_label().
a Gtk.Widget that was previously set as a mnemonic label for widget with gtk_widget_add_mnemonic_label().
Removes a tick callback previously registered with
gtk_widget_add_tick_callback().
an id returned by gtk_widget_add_tick_callback()
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.Pixbuf are shared with the rest of
the application and should not be modified. The pixbuf should be
freed after use with g_object_unref().
a stock ID
a stock size (Gtk.IconSize). A size of (GtkIconSize)-1 means render at the size of the source and don’t scale (if there are multiple source sizes, GTK+ picks one of the available sizes).
Optionaldetail: stringrender detail to pass to theme engine
a new pixbuf, or null if the stock ID wasn’t known
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.Pixbuf are shared with the rest of
the application and should not be modified. The pixbuf should be freed
after use with g_object_unref().
a stock ID
a stock size (Gtk.IconSize). A size of (GtkIconSize)-1 means render at the size of the source and don’t scale (if there are multiple source sizes, GTK+ picks one of the available sizes).
a new pixbuf, or null if the stock ID wasn’t known
Moves a widget from one Gtk.Container to another, handling reference count issues to avoid destroying the widget.
a Gtk.Container to move the widget into
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.
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().
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system 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().
return from the event signal emission (true if the event was handled)
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 Gtk.Widget 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 Gtk.TreeView.
An example of its usage is:
GdkEvent *fevent = gdk_event_new (GDK_FOCUS_CHANGE);
fevent->focus_change.type = GDK_FOCUS_CHANGE;
fevent->focus_change.in = TRUE;
fevent->focus_change.window = _gtk_widget_get_window (widget);
if (fevent->focus_change.window != NULL)
g_object_ref (fevent->focus_change.window);
gtk_widget_send_focus_change (widget, fevent);
gdk_event_free (event);
the return value from the event signal emission: true if the event was handled, and false otherwise
Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
Object containing the properties to set
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 Gtk.UIManager. If you use Gtk.UIManager, setting up accelerator paths will be done automatically.
Even when you you aren’t using Gtk.UIManager, 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 GLib.Quark. Therefore, if you
pass a static string, you can save some memory by interning it first with
g_intern_static_string().
Optionalaccel_path: stringpath used to look up the accelerator
Optionalaccel_group: Gtk.AccelGroupSets 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 Gtk.Container, 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.
a pointer to a Gtk.Allocation to copy from
Sets whether the application intends to draw on the widget in an Gtk.Widget::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 Gtk.EventBox and Gtk.Window, 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.
true if the application will paint on the widget
Specifies whether widget can be a default widget. See
gtk_widget_grab_default() for details about the meaning of
“default”.
whether or not widget can be a default widget.
Specifies whether widget can own the input focus. See
gtk_widget_grab_focus() for actually setting the input focus on a
widget.
whether or not widget can own the input focus.
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.
if true, widget should be mapped along with its parent.
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
Gtk.Container, 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.
a pointer to a Gtk.Allocation to copy from
Sets a widgets composite name. The widget must be
a composite child of its parent; see gtk_widget_push_composite_child().
the name to set
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a GLib.Quark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the GLib.Quark storage growing unbounded.
name of the key
Optionaldata: anydata to associate with that key
Enables or disables a Gdk.Device to interact with widget
and all its children.
It does so by descending through the Gdk.Window hierarchy
and enabling the same mask that is has for core events
(i.e. the one that gdk_window_get_events() returns).
Sets the device event mask (see Gdk.EventMask) 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 Gtk.EventBox
and receive events on the event box.
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.TextDirection.NONE, then the value
set by gtk_widget_set_default_direction() will be used.
the new direction
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.
true to double-buffer a widget
Sets the event mask (see Gdk.EventMask) 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 Gtk.EventBox and receive events on the event
box.
event mask
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.
whether the widget should grab focus when clicked with the mouse
Sets the font map to use for Pango rendering. When not set, the widget will inherit the font map from its parent.
Optionalfont_map: Pango.FontMap<GObject.Object>a Pango.FontMap, or null to unset any previously set font map
Sets the cairo.FontOptions used for Pango rendering in this widget. When not set, the default font options for the Gdk.Screen will be used.
Optionaloptions: default.FontOptionsa cairo.FontOptions, or null to unset any previously set default font options.
Sets the horizontal alignment of widget.
See the Gtk.Widget.halign property.
Sets the has-tooltip property on widget to has_tooltip. See
Gtk.Widget.has_tooltip for more information.
whether or not widget has a tooltip.
Specifies whether widget has a Gdk.Window 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 Gdk.Window of
one of its parent widgets. Widgets that do not create a %window for
themselves in Gtk.Widget::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.
whether or not widget has a window.
Sets the text to display at the top of the dialog. If the heading is not set, the dialog displays a default text.
a string containing Pango markup
Sets whether the widget would like any available extra horizontal space. When a user resizes a Gtk.Window, 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 Gtk.Widget.).
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.
whether to expand
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.
value for hexpand-set property
Marks the widget as being mapped.
This function should only ever be called in a derived widget's “map” or “unmap” implementation.
true to mark the widget as mapped
Sets the bottom margin of widget.
See the Gtk.Widget.margin_bottom property.
the bottom margin
Sets the end margin of widget.
See the Gtk.Widget.margin_end property.
the end margin
Sets the left margin of widget.
See the Gtk.Widget.margin_left property.
the left margin
Sets the right margin of widget.
See the Gtk.Widget.margin_right property.
the right margin
Sets the start margin of widget.
See the Gtk.Widget.margin_start property.
the start margin
Sets the top margin of widget.
See the Gtk.Widget.margin_top property.
the top margin
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 Gtk.StyleContext).
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.
name for the widget
Sets the Gtk.Widget.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 Gtk.UIManager.
the new value for the “no-show-all” property
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.
desired opacity, between 0 and 1
This function is useful only when implementing subclasses of
Gtk.Container.
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().
Sets a non default parent window for widget.
For Gtk.Window classes, setting a parent_window effects whether
the window is a toplevel window or can be embedded into other
widgets.
For Gtk.Window classes, this needs to be called before the window is realized.
Sets a property on an object.
The name of the property to set
The value to set the property to
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.
true to mark the widget as realized
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”.
whether or not widget can be a default widget.
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.
if true, the entire widget will be redrawn when it is allocated to a new size. Otherwise, only the new portion of the widget will be redrawn.
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.
true to make the widget sensitive
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 Gtk.Widget 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 Gtk.Widget.
width widget should request, or -1 to unset
height widget should request, or -1 to unset
This function is for use in widget implementations. Turns on flag values in the current widget state (insensitive, prelighted, etc.).
This function accepts the values Gtk.StateFlags.DIR_LTR and
Gtk.StateFlags.DIR_RTL but ignores them. If you want to set the widget's
direction, use gtk_widget_set_direction().
It is worth mentioning that any other state than Gtk.StateFlags.INSENSITIVE,
will be propagated down to all non-internal children if widget is a
Gtk.Container, while Gtk.StateFlags.INSENSITIVE itself will be propagated
down to all Gtk.Container children by different means than turning on the
state flag down the hierarchy, both gtk_widget_get_state_flags() and
gtk_widget_is_sensitive() will make use of these.
State flags to turn on
Whether to clear state before turning on flags
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 Gtk.Widget::realize,
gdk_window_set_support_multidevice() will have to be called manually on them.
true to support input from multiple devices.
Sets markup as the contents of the tooltip, which is marked up with
the [Pango text markup language][PangoMarkupFormat].
This function will take care of setting Gtk.Widget.has_tooltip to true
and of the default handler for the Gtk.Widget.SignalSignatures.query_tooltip | Gtk.Widget::query-tooltip signal.
See also the Gtk.Widget.tooltip_markup property and
gtk_tooltip_set_markup().
Optionalmarkup: stringthe contents of the tooltip for widget, or null
Sets text as the contents of the tooltip. This function will take
care of setting Gtk.Widget.has_tooltip to true and of the default
handler for the Gtk.Widget.SignalSignatures.query_tooltip | Gtk.Widget::query-tooltip signal.
See also the Gtk.Widget.tooltip_text property and gtk_tooltip_set_text().
Optionaltext: stringthe contents of the tooltip for widget
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.
Optionalcustom_window: Gtk.Windowa Gtk.Window, or null
Sets the vertical alignment of widget.
See the Gtk.Widget.valign property.
Sets whether the widget would like any available extra vertical space.
See gtk_widget_set_hexpand() for more detail.
whether to expand
Sets whether the vexpand flag (see gtk_widget_get_vexpand()) will
be used.
See gtk_widget_set_hexpand_set() for more detail.
value for vexpand-set property
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.
whether the widget should be shown or not
Sets the visual that should be used for by widget and its children for
creating GdkWindows. The visual must be on the same Gdk.Screen as
returned by gtk_widget_get_screen(), so handling the
Gtk.Widget.SignalSignatures.screen_changed | Gtk.Widget::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.
Sets a widget’s window. This function should only be used in a
widget’s Gtk.Widget::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 Gdk.Window
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.
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.
Recursively shows a widget, and any child widgets (if the widget is a container).
Shows a widget. If the widget is an unmapped toplevel widget (i.e. a Gtk.Window that has not yet been shown), enter the main loop and wait for the window to actually be mapped. Be careful; because the main loop is running, anything can happen during this function.
This function is only used by Gtk.Container 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 Gtk.Widget.halign and Gtk.Widget.valign properties.
For baseline support in containers you need to use gtk_widget_size_allocate_with_baseline()
instead.
This function is only used by Gtk.Container 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 Gtk.Widget.halign and Gtk.Widget.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.
This function is typically used when implementing a Gtk.Container
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.
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
the data if found, or null if no such data exists.
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of
g_object_steal_qdata() would have left the destroy function set,
and thus the partial string list would have been freed upon
g_object_set_qdata_full().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
Name of the signal to stop emission of
This function attaches the widget’s Gtk.Style to the widget's Gdk.Window. It is a replacement for
widget->style = gtk_style_attach (widget->style, widget->window);
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 Gtk.Widget) would attach the style itself.
Gets the value of a style property of widget.
the name of a style property
location to return the property value
Reverts the effect of a previous call to gtk_widget_freeze_child_notify().
This causes all queued Gtk.Widget.SignalSignatures.child_notify | Gtk.Widget::child-notify signals on widget to be
emitted.
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
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.
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.
Triggers a tooltip query on the display where the toplevel of widget
is located. See gtk_tooltip_trigger_tooltip_query() for more
information.
Unblocks a handler so it will be called again during any signal emissions
Handler ID of the handler to be unblocked
This function is only for use in widget implementations. Causes a widget to be unmapped if it’s currently mapped.
This function is only for use in widget implementations. Should be called by implementations of the remove method on Gtk.Container, to dissociate a child from the container.
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).
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the GObject.Object may be reused in future (for example, if it is
an instance variable of another object), it is recommended to clear the
pointer to null rather than retain a dangling pointer to a potentially
invalid GObject.Object instance. Use g_clear_object() for this.
Unregisters a Gdk.Window 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.
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().
State flags to turn off
Virtualvfunc_Virtualvfunc_Virtualvfunc_Convert an initial size allocation assigned
by a Gtk.Container using gtk_widget_size_allocate(), into an actual
size allocation to be used by the widget. adjust_size_allocation
adjusts to a child widget’s actual allocation
from what a parent container computed for the
child. The adjusted allocation must be entirely within the original
allocation. In any custom implementation, chain up to the default
Gtk.Widget implementation of this method, which applies the margin
and alignment properties of Gtk.Widget. Chain up
before performing your own adjustments so your
own adjustments remove more allocation after the Gtk.Widget base
class has already removed margin and alignment. The natural size
passed in should be adjusted in the same way as the allocated size,
which allows adjustments to perform alignments or other changes
based on natural size.
Virtualvfunc_Convert an initial size request from a widget's
Gtk.SizeRequestMode virtual method implementations into a size request to
be used by parent containers in laying out the widget.
adjust_size_request adjusts from a child widget's
original request to what a parent container should
use for layout. The for_size argument will be -1 if the request should
not be for a particular size in the opposing orientation, i.e. if the
request is not height-for-width or width-for-height. If for_size is
greater than -1, it is the proposed allocation in the opposing
orientation that we need the request for. Implementations of
adjust_size_request should chain up to the default implementation,
which applies Gtk.Widget’s margin properties and imposes any values
from gtk_widget_set_size_request(). Chaining up should be last,
after your subclass adjusts the request, so
Gtk.Widget can apply constraints and add the margin properly.
Virtualvfunc_Signal will be emitted when a button (typically from a mouse) is pressed.
Virtualvfunc_Signal will be emitted when a button (typically from a mouse) is released.
Virtualvfunc_Determines whether an accelerator that activates the signal
identified by signal_id can currently be activated.
This is done by emitting the Gtk.Widget.SignalSignatures.can_activate_accel | Gtk.Widget::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.
the ID of a signal installed on widget
Virtualvfunc_Emits a Gtk.Widget.SignalSignatures.child_notify | Gtk.Widget::child-notify signal for the
[child property][child-properties] child_property
on widget.
This is the analogue of g_object_notify() for child properties.
Also see gtk_container_child_notify().
Virtualvfunc_Signal emitted when the composited status of
widgets screen changes. See gdk_screen_is_composited().
Virtualvfunc_Computes whether a container should give this widget extra space when possible.
Virtualvfunc_Signal will be emitted when the size, position or stacking of the widget’s window has changed.
Virtualvfunc_the constructed function is called by g_object_new() as the
final step of the object creation process. At the point of the call, all
construction properties have been set on the object. The purpose of this
call is to allow for object initialisation steps that can only be performed
after construction properties have been set. constructed implementors
should chain up to the constructed call of their parent class to allow it
to complete its initialisation.
Virtualvfunc_Signal emitted when a redirected window belonging to widget gets drawn into.
Virtualvfunc_Signal emitted if a user requests that a toplevel window is closed.
Virtualvfunc_Destroys a widget.
When a widget is destroyed all references it holds on other objects will be released:
It's expected that all references held on the widget will also
be released; you should connect to the Gtk.Widget::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 Gtk.Container, as you'll be able to use the
Gtk.ContainerClass.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()
Virtualvfunc_Virtualvfunc_Signal emitted when the text direction of a widget changes.
Virtualvfunc_Virtualvfunc_Virtualvfunc_the dispose function is supposed to drop all references to other
objects, but keep the instance otherwise intact, so that client method
invocations still work. It may be run multiple times (due to reference
loops). Before returning, dispose should chain up to the dispose method
of the parent class.
Virtualvfunc_Signal emitted on the drag source when a drag is started.
Virtualvfunc_Signal emitted on the drag source when a drag with the action Gdk.DragAction.MOVE is successfully completed.
Virtualvfunc_Signal emitted on the drag source when the drop site requests the data which is dragged.
Virtualvfunc_Signal emitted on the drop site when the dragged data has been received.
Virtualvfunc_Signal emitted on the drop site when the user drops the data onto the widget.
Virtualvfunc_Signal emitted on the drag source when a drag is finished.
Virtualvfunc_Signal emitted on the drag source when a drag has failed.
Virtualvfunc_Signal emitted on the drop site when the cursor leaves the widget.
Virtualvfunc_signal emitted on the drop site when the user moves the cursor over the widget during a drag.
Virtualvfunc_Virtualvfunc_Signal event will be emitted when the pointer enters the widget’s window.
Virtualvfunc_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.
Virtualvfunc_instance finalization function, should finish the finalization of
the instance begun in dispose and chain up to the finalize method of the
parent class.
Virtualvfunc_Virtualvfunc_Signal emitted when the keyboard focus enters the widget’s window.
Virtualvfunc_Signal emitted when the keyboard focus leaves the widget’s window.
Virtualvfunc_Returns the accessible object that describes the widget to an assistive technology.
If accessibility support is not available, this Atk.Object instance may be a no-op. Likewise, if no class-specific Atk.Object implementation is available for the widget instance in question, it will inherit an Atk.Object 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.
Virtualvfunc_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.
Virtualvfunc_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.
the width which is available for allocation, or -1 if none
Virtualvfunc_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.
the width which is available for allocation
Virtualvfunc_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.
Virtualvfunc_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.
the height which is available for allocation
Virtualvfunc_Virtualvfunc_Gets whether the widget prefers a height-for-width layout or a width-for-height layout.
Gtk.Bin 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.
Virtualvfunc_Signal emitted when a pointer or keyboard grab on a window belonging to widget gets broken.
Virtualvfunc_Causes widget to have the keyboard focus for the Gtk.Window it's
inside. widget must be a focusable widget, such as a Gtk.Entry;
something like Gtk.Frame 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.
Virtualvfunc_Signal 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.
Virtualvfunc_Reverses the effects of gtk_widget_show(), causing the widget to be
hidden (invisible to the user).
Virtualvfunc_Virtualvfunc_Virtualvfunc_Virtualvfunc_This function should be called whenever keyboard navigation within
a single widget hits a boundary. The function emits the
Gtk.Widget.SignalSignatures.keynav_failed | Gtk.Widget::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.DirectionType.TAB_FORWARD and Gtk.DirectionType.TAB_BACKWARD. For the other
values of Gtk.DirectionType 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 Gtk.Entry 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.
direction of focus movement
Virtualvfunc_Will be emitted when the pointer leaves the widget’s window.
Virtualvfunc_This function is only for use in widget implementations. Causes a widget to be mapped if it isn’t already.
Virtualvfunc_Virtualvfunc_Emits the Gtk.Widget.SignalSignatures.mnemonic_activate | Gtk.Widget::mnemonic-activate signal.
true if there are other widgets with the same mnemonic
Virtualvfunc_Signal emitted when the pointer moves over the widget’s Gdk.Window.
Virtualvfunc_Signal emitted when a change of focus is requested
Virtualvfunc_Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
Virtualvfunc_Virtualvfunc_Signal emitted whenever a widget should pop up a context menu.
Virtualvfunc_Signal will be emitted when a property on the widget’s window has been changed or deleted.
Virtualvfunc_Virtualvfunc_Virtualvfunc_Virtualvfunc_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 Gtk.DrawingArea or some portion thereof.
Virtualvfunc_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 Gtk.Widget::draw. Or simply g_signal_connect () to the Gtk.Widget::realize signal.
Virtualvfunc_Virtualvfunc_Signal emitted when a button in the 4 to 7 range is pressed.
Virtualvfunc_Signal will be emitted when the the widget’s window has lost ownership of a selection.
Virtualvfunc_Virtualvfunc_Virtualvfunc_Virtualvfunc_Signal will be emitted when another client requests ownership of the selection owned by the widget's window.
Virtualvfunc_the generic setter for all properties of this type. Should be
overridden for every type with properties. If implementations of
set_property don't emit property change notification explicitly, this will
be done implicitly by the type system. However, if the notify signal is
emitted explicitly, the type system will not emit it a second time.
Virtualvfunc_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.
Virtualvfunc_Recursively shows a widget, and any child widgets (if the widget is a container).
Virtualvfunc_Virtualvfunc_This function is only used by Gtk.Container 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 Gtk.Widget.halign and Gtk.Widget.valign properties.
For baseline support in containers you need to use gtk_widget_size_allocate_with_baseline()
instead.
Virtualvfunc_Virtualvfunc_Signal emitted when the widget state changes,
see gtk_widget_get_state_flags().
Virtualvfunc_Virtualvfunc_Signal emitted when the GtkStyleContext of a widget is changed.
Virtualvfunc_Virtualvfunc_This function is only for use in widget implementations. Causes a widget to be unmapped if it’s currently mapped.
Virtualvfunc_Signal will be emitted when the widget’s window is unmapped.
Virtualvfunc_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).
Virtualvfunc_Signal emitted when the widget’s window is obscured or unobscured.
Virtualvfunc_Signal emitted when the state of the toplevel window associated to the widget changes.
This function essentially limits the life time of the closure to
the life time of the object. That is, when the object is finalized,
the closure is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure, to ensure that an extra
reference count is held on object during invocation of the
closure. Usually, this function will be called on closures that
use this object as closure data.
GObject.Closure to watch
StaticnewStaticnew_Activates the default widget for the window, unless the current
focused widget has been configured to receive the default action
(see gtk_widget_set_receives_default()), in which case the
focused widget is activated.
true if a widget got activated.
Activates the current focused widget within the window.
true if a widget got activated.
Activates mnemonics and accelerators for this Gtk.Window. This is normally called by the default ::key_press_event handler for toplevel windows, however in some cases it may be useful to call this directly when overriding the standard key handling for a toplevel window.
true if a mnemonic or accelerator was found and activated.
Adds widget to container. Typically used for simple containers
such as Gtk.Window, Gtk.Frame, or Gtk.Button; for more complicated
layout containers such as Gtk.Box or Gtk.Grid, this function will
pick default packing parameters that may not be correct. So
consider functions such as gtk_box_pack_start() and
gtk_grid_attach() as an alternative to gtk_container_add() in
those cases. A widget may be added to only one container at a time;
you can’t place the same widget inside two different containers.
Note that some containers, such as Gtk.ScrolledWindow or Gtk.ListBox, may add intermediate children between the added widget and the container.
Associate accel_group with window, such that calling
gtk_accel_groups_activate() on window will activate accelerators
in accel_group.
Adds an activatable widget to the action area of a Gtk.Dialog,
connecting a signal handler that will emit the Gtk.Dialog::response
signal on the dialog when the widget is activated. The widget is
appended to the end of the dialog’s action area. If you want to add a
non-activatable widget, simply pack it into the action_area field
of the Gtk.Dialog struct.
Adds a button with the given text and sets things up so that
clicking the button will emit the Gtk.Dialog::response signal with
the given response_id. The button is appended to the end of the
dialog’s action area. The button widget is returned, but usually
you don’t need it.
text of button
response ID for the button
the Gtk.Button widget that was added
Starts moving a window. This function is used if an application has window movement grips. When GDK can support it, the window movement will be done using the standard mechanism for the [window manager][gtk-X11-arch] or windowing system. Otherwise, GDK will try to emulate window movement, potentially not all that well, depending on the windowing system.
mouse button that initiated the drag
X position where the user clicked to initiate the drag, in root window coordinates
Y position where the user clicked to initiate the drag
timestamp from the click event that initiated the drag
Starts resizing a window. This function is used if an application has window resizing controls. When GDK can support it, the resize will be done using the standard mechanism for the [window manager][gtk-X11-arch] or windowing system. Otherwise, GDK will try to emulate window resizing, potentially not all that well, depending on the windowing system.
position of the resize control
mouse button that initiated the drag
X position where the user clicked to initiate the drag, in root window coordinates
Y position where the user clicked to initiate the drag
timestamp from the click event that initiated the drag
Emits a Gtk.Widget.SignalSignatures.child_notify | Gtk.Widget::child-notify signal for the
[child property][child-properties] specified by
pspec on the child.
This is an analogue of g_object_notify_by_pspec() for child properties.
the child widget
the GObject.ParamSpec of a child property instealled on the class of container
Requests that the window is closed, similar to what happens when a window manager close button is clicked.
This function can be used with close buttons in custom titlebars.
Constructs a child of buildable with the name name.
Gtk.Builder calls this function if a “constructor” has been specified in the UI definition.
Gtk.Builder used to construct this object
name of child to construct
the constructed child
This is similar to gtk_buildable_parser_finished() but is
called once for each custom tag handled by the buildable.
This is called at the end of each custom element handled by the buildable.
Gtk.Builder used to construct this object
child object or null for non-child tags
name of tag
Optionaldata: anyuser data that will be passed in to parser functions
This is called for each unknown element under <child>.
a Gtk.Builder used to construct this object
child object or null for non-child tags
name of tag
true if a object has a custom implementation, false if it doesn't.
Asks to deiconify (i.e. unminimize) the specified window. Note
that you shouldn’t assume the window is definitely deiconified
afterward, because other entities (e.g. the user or
[window manager][gtk-X11-arch])) could iconify it
again before your code which assumes deiconification gets to run.
You can track iconification via the “window-state-event” signal on Gtk.Widget.
Invokes callback on each direct child of container, including
children that are considered “internal” (implementation details
of the container). “Internal” children generally weren’t added
by the user of the container, but were added by the container
implementation itself.
Most applications should use gtk_container_foreach(), rather
than gtk_container_forall().
Invokes callback on each non-internal child of container.
See gtk_container_forall() for details on what constitutes
an “internal” child. For all practical purposes, this function
should iterate over precisely those child widgets that were
added to the container by the application with explicit add()
calls.
It is permissible to remove the child from the callback handler.
Most applications should use gtk_container_foreach(),
rather than gtk_container_forall().
Asks to place window in the fullscreen state. Note that you
shouldn’t assume the window is definitely full screen afterward,
because other entities (e.g. the user or
[window manager][gtk-X11-arch]) could unfullscreen it
again, and not all window managers honor requests to fullscreen
windows. But normally the window will end up fullscreen. Just
don’t write code that crashes if not.
You can track the fullscreen state via the “window-state-event” signal on Gtk.Widget.
Asks to place window in the fullscreen state. Note that you shouldn't assume
the window is definitely full screen afterward.
You can track the fullscreen state via the "window-state-event" signal on Gtk.Widget.
a Gdk.Screen to draw to
which monitor to go fullscreen on
Gets the value set by gtk_window_set_accept_focus().
true if window should receive the input focus
Gets the Gtk.Application associated with the window (if any).
a Gtk.Application, or null
Retrieves the border width of the container. See
gtk_container_set_border_width().
the current border width
Returns whether the window has been set to have decorations
such as a title bar via gtk_window_set_decorated().
true if the window has been set to have decorations
Gets the default size of the window. A value of -1 for the width or height indicates that a default size has not been explicitly set for that dimension, so the “natural” size of the window will be used.
Returns whether the window has been set to have a close button
via gtk_window_set_deletable().
true if the window has been set to have a close button
Returns whether the window will be destroyed with its transient parent. See gtk_window_set_destroy_with_parent ().
true if the window will be destroyed with its transient parent.
Retrieves the current focused widget within the window.
Note that this is the widget that would have the focus
if the toplevel window focused; if the toplevel window
is not focused then gtk_widget_has_focus (widget) will
not be true for the widget.
the currently focused widget, or null if there is none.
Retrieves the focus chain of the container, if one has been
set explicitly. If no focus chain has been explicitly
set, GTK+ computes the focus chain based on the positions
of the children. In that case, GTK+ stores null in
focusable_widgets and returns false.
true if the focus chain of the container has been set explicitly.
Retrieves the horizontal focus adjustment for the container. See gtk_container_set_focus_hadjustment ().
the horizontal focus adjustment, or null if none has been set.
Gets the value set by gtk_window_set_focus_on_map().
true if window should receive the input focus when mapped.
Retrieves the vertical focus adjustment for the container. See
gtk_container_set_focus_vadjustment().
the vertical focus adjustment, or null if none has been set.
Gets the value of the Gtk.Window.focus_visible property.
true if “focus rectangles” are supposed to be visible in this window.
Returns the group for window or the default group, if
window is null or if window does not have an explicit
window group.
the Gtk.WindowGroup for a window or the default group
Determines whether the window may have a resize grip.
true if the window has a resize grip
Returns the header bar of dialog. Note that the
headerbar is only used by the dialog if the
Gtk.Dialog.use_header_bar property is true.
the header bar
Returns whether the window has requested to have its titlebar hidden when maximized. See gtk_window_set_hide_titlebar_when_maximized ().
true if the window has requested to have its titlebar hidden when maximized
Returns the name of the themed icon for the window,
see gtk_window_set_icon_name().
the icon name or null if the window has no themed icon
Returns the mnemonic modifier for this window. See
gtk_window_set_mnemonic_modifier().
the modifier mask used to activate mnemonics on this window.
Gets the value of the Gtk.Window.mnemonics_visible property.
true if mnemonics are supposed to be visible in this window.
Returns whether the window is modal. See gtk_window_set_modal().
true if the window is set to be modal and establishes a grab when shown
Returns a newly created widget path representing all the widget hierarchy
from the toplevel down to and including child.
A newly created Gtk.WidgetPath
This function returns the position you need to pass to
gtk_window_move() to keep window in its current position.
This means that the meaning of the returned value varies with
window gravity. See gtk_window_move() for more details.
The reliability of this function depends on the windowing system currently in use. Some windowing systems, such as Wayland, do not support a global coordinate system, and thus the position of the window will always be (0, 0). Others, like X11, do not have a reliable way to obtain the geometry of the decorations of a window if they are provided by the window manager. Additionally, on X11, window manager have been known to mismanage window gravity, which result in windows moving even if you use the coordinates of the current position as returned by this function.
If you haven’t changed the window gravity, its gravity will be
#GDK_GRAVITY_NORTH_WEST. This means that gtk_window_get_position()
gets the position of the top-left corner of the window manager
frame for the window. gtk_window_move() sets the position of this
same top-left corner.
If a window has gravity #GDK_GRAVITY_STATIC the window manager
frame is not relevant, and thus gtk_window_get_position() will
always produce accurate results. However you can’t use static
gravity to do things like place a window in a corner of the screen,
because static gravity ignores the window manager decorations.
Ideally, this function should return appropriate values if the window has client side decorations, assuming that the windowing system supports global coordinates.
In practice, saving the window position should not be left to applications, as they lack enough knowledge of the windowing system and the window manager state to effectively do so. The appropriate way to implement saving the window position is to use a platform-specific protocol, wherever that is available.
Gets the value set by gtk_window_set_resizable().
true if the user can resize the window
If a window has a resize grip, this will retrieve the grip position, width and height into the specified Gdk.Rectangle.
true if the resize grip’s area was retrieved
Returns the resize mode for the container. See gtk_container_set_resize_mode ().
the current resize mode
Gets the response id of a widget in the action area of a dialog.
the response id of widget, or Gtk.ResponseType.NONE if widget doesn’t have a response id set.
Returns the role of the window. See gtk_window_set_role() for
further explanation.
the role of the window if set, or null. The returned is owned by the widget and must not be modified or freed.
Obtains the current size of window.
If window is not visible on screen, this function return the size GTK+
will suggest to the [window manager][gtk-X11-arch] for the initial window
size (but this is not reliably the same as the size the window manager
will actually select). See: gtk_window_set_default_size().
Depending on the windowing system and the window manager constraints,
the size returned by this function may not match the size set using
gtk_window_resize(); additionally, since gtk_window_resize() may be
implemented as an asynchronous operation, GTK+ cannot guarantee in any
way that this code:
// width and height are set elsewhere
gtk_window_resize (window, width, height);
int new_width, new_height;
gtk_window_get_size (window, &new_width, &new_height);
will result in new_width and new_height matching width and
height, respectively.
This function will return the logical size of the Gtk.Window, excluding the widgets used in client side decorations; there is, however, no guarantee that the result will be completely accurate because client side decoration may include widgets that depend on the user preferences and that may not be visibile at the time you call this function.
The dimensions returned by this function are suitable for being
stored across sessions; use gtk_window_set_default_size() to
restore them when before showing the window.
To avoid potential race conditions, you should only call this function in response to a size change notification, for instance inside a handler for the Gtk.Widget.SignalSignatures.size_allocate | Gtk.Widget::size-allocate signal, or inside a handler for the Gtk.Widget.SignalSignatures.configure_event | Gtk.Widget::configure-event signal:
static void
on_size_allocate (GtkWidget *widget, GtkAllocation *allocation)
{
int new_width, new_height;
gtk_window_get_size (GTK_WINDOW (widget), &new_width, &new_height);
...
}
Note that, if you connect to the Gtk.Widget.SignalSignatures.size_allocate | Gtk.Widget::size-allocate signal, you should not use the dimensions of the Gtk.Allocation passed to the signal handler, as the allocation may contain client side decorations added by GTK+, depending on the windowing system in use.
If you are getting a window size in order to position the window
on the screen, you should, instead, simply set the window’s semantic
type with gtk_window_set_type_hint(), which allows the window manager
to e.g. center dialogs. Also, if you set the transient parent of
dialogs with gtk_window_set_transient_for() window managers will
often center the dialog over its parent window. It's much preferred
to let the window manager handle these cases rather than doing it
yourself, because all apps will behave consistently and according to
user or system preferences, if the window manager handles it. Also,
the window manager can take into account the size of the window
decorations and border that it may add, and of which GTK+ has no
knowledge. Additionally, positioning windows in global screen coordinates
may not be allowed by the windowing system. For more information,
see: gtk_window_set_position().
Gets the value set by gtk_window_set_skip_pager_hint().
true if window shouldn’t be in pager
Gets the value set by gtk_window_set_skip_taskbar_hint()
true if window shouldn’t be in taskbar
Retrieves the title of the window. See gtk_window_set_title().
the title of the window, or null if none has been set explicitly. The returned string is owned by the widget and must not be modified or freed.
Gets the type hint for this window. See gtk_window_set_type_hint().
the type hint for window.
Gets the value set by gtk_window_set_urgency_hint()
true if window is urgent
Returns whether window has an explicit window group.
true if window has an explicit window group. Since 2.22
Asks to iconify (i.e. minimize) the specified window. Note that
you shouldn’t assume the window is definitely iconified afterward,
because other entities (e.g. the user or
[window manager][gtk-X11-arch]) could deiconify it
again, or there may not be a window manager in which case
iconification isn’t possible, etc. But normally the window will end
up iconified. Just don’t write code that crashes if not.
It’s permitted to call this function before showing a window, in which case the window will be iconified before it ever appears onscreen.
You can track iconification via the “window-state-event” signal on Gtk.Widget.
Asks to maximize window, so that it becomes full-screen. Note that
you shouldn’t assume the window is definitely maximized afterward,
because other entities (e.g. the user or
[window manager][gtk-X11-arch]) could unmaximize it
again, and not all window managers support maximization. But
normally the window will end up maximized. Just don’t write code
that crashes if not.
It’s permitted to call this function before showing a window, in which case the window will be maximized when it appears onscreen initially.
You can track maximization via the “window-state-event” signal on Gtk.Widget, or by listening to notifications on the Gtk.Window.is_maximized property.
Asks the [window manager][gtk-X11-arch] to move
window to the given position. Window managers are free to ignore
this; most window managers ignore requests for initial window
positions (instead using a user-defined placement algorithm) and
honor requests after the window has already been shown.
Note: the position is the position of the gravity-determined reference point for the window. The gravity determines two things: first, the location of the reference point in root window coordinates; and second, which point on the window is positioned at the reference point.
By default the gravity is #GDK_GRAVITY_NORTH_WEST, so the reference
point is simply the x, y supplied to gtk_window_move(). The
top-left corner of the window decorations (aka window frame or
border) will be placed at x, y. Therefore, to position a window
at the top left of the screen, you want to use the default gravity
(which is #GDK_GRAVITY_NORTH_WEST) and move the window to 0,0.
To position a window at the bottom right corner of the screen, you
would set #GDK_GRAVITY_SOUTH_EAST, which means that the reference
point is at x + the window width and y + the window height, and
the bottom-right corner of the window border will be placed at that
reference point. So, to place a window in the bottom right corner
you would first set gravity to south east, then write:
gtk_window_move (window, gdk_screen_width () - window_width, gdk_screen_height () - window_height) (note that this
example does not take multi-head scenarios into account).
The Extended Window Manager Hints Specification has a nice table of gravities in the “implementation notes” section.
The gtk_window_get_position() documentation may also be relevant.
X coordinate to move window to
Y coordinate to move window to
Parses a standard X Window System geometry string - see the
manual page for X (type “man X”) for details on this.
gtk_window_parse_geometry() does work on all GTK+ ports
including Win32 but is primarily intended for an X environment.
If either a size or a position can be extracted from the
geometry string, gtk_window_parse_geometry() returns true
and calls gtk_window_set_default_size() and/or gtk_window_move()
to resize/move the window.
If gtk_window_parse_geometry() returns true, it will also
set the #GDK_HINT_USER_POS and/or #GDK_HINT_USER_SIZE hints
indicating to the window manager that the size/position of
the window was user-specified. This causes most window
managers to honor the geometry.
Note that for gtk_window_parse_geometry() to work as expected, it has
to be called when the window has its “final” size, i.e. after calling
gtk_widget_show_all() on the contents and gtk_window_set_geometry_hints()
on the window.
#include <gtk/gtk.h>
static void
fill_with_content (GtkWidget *vbox)
{
// fill with content...
}
int
main (int argc, char *argv[])
{
GtkWidget *window, *vbox;
GdkGeometry size_hints = {
100, 50, 0, 0, 100, 50, 10,
10, 0.0, 0.0, GDK_GRAVITY_NORTH_WEST
};
gtk_init (&argc, &argv);
window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
vbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);
gtk_container_add (GTK_CONTAINER (window), vbox);
fill_with_content (vbox);
gtk_widget_show_all (vbox);
gtk_window_set_geometry_hints (GTK_WINDOW (window),
NULL,
&size_hints,
GDK_HINT_MIN_SIZE |
GDK_HINT_BASE_SIZE |
GDK_HINT_RESIZE_INC);
if (argc > 1)
{
gboolean res;
res = gtk_window_parse_geometry (GTK_WINDOW (window),
argv[1]);
if (! res)
fprintf (stderr,
"Failed to parse “%s”\n",
argv[1]);
}
gtk_widget_show_all (window);
gtk_main ();
return 0;
}
geometry string
true if string was parsed successfully
Presents a window to the user. This function should not be used as when it is called, it is too late to gather a valid timestamp to allow focus stealing prevention to work correctly.
Presents a window to the user. This may mean raising the window in the stacking order, deiconifying it, moving it to the current desktop, and/or giving it the keyboard focus, possibly dependent on the user’s platform, window manager, and preferences.
If window is hidden, this function calls gtk_widget_show()
as well.
This function should be used when the user tries to open a window
that’s already open. Say for example the preferences dialog is
currently open, and the user chooses Preferences from the menu
a second time; use gtk_window_present() to move the already-open dialog
where the user can see it.
Presents a window to the user in response to a user interaction. The timestamp should be gathered when the window was requested to be shown (when clicking a link for example), rather than once the window is ready to be shown.
the timestamp of the user interaction (typically a button or key press event) which triggered this call
When a container receives a call to the draw function, it must send
synthetic Gtk.Widget::draw calls to all children that don’t have their
own GdkWindows. This function provides a convenient way of doing this.
A container, when it receives a call to its Gtk.Widget::draw function,
calls gtk_container_propagate_draw() once for each child, passing in
the cr the container received.
gtk_container_propagate_draw() takes care of translating the origin of cr,
and deciding whether the draw needs to be sent to the child. It is a
convenient and optimized way of getting the same effect as calling
gtk_widget_draw() on the child directly.
In most cases, a container can simply either inherit the Gtk.Widget::draw implementation from Gtk.Container, or do some drawing and then chain to the ::draw implementation from Gtk.Container.
Propagate a key press or release event to the focus widget and
up the focus container chain until a widget handles event.
This is normally called by the default ::key_press_event and
::key_release_event handlers for toplevel windows,
however in some cases it may be useful to call this directly when
overriding the standard key handling for a toplevel window.
true if a widget in the focus chain handled the event.
Removes widget from container. widget must be inside container.
Note that container will own a reference to widget, and that this
may be the last reference held; so removing a widget from its
container can destroy that widget. If you want to use widget
again, you need to add a reference to it before removing it from
a container, using g_object_ref(). If you don’t want to use widget
again it’s usually more efficient to simply destroy it directly
using gtk_widget_destroy() since this will remove it from the
container and help break any circular reference count cycles.
Reverses the effects of gtk_window_add_accel_group().
Hides window, then reshows it, resetting the
default size and position of the window. Used
by GUI builders only.
Resizes the window as if the user had done so, obeying geometry
constraints. The default geometry constraint is that windows may
not be smaller than their size request; to override this
constraint, call gtk_widget_set_size_request() to set the window's
request to a smaller value.
If gtk_window_resize() is called before showing a window for the
first time, it overrides any default size set with
gtk_window_set_default_size().
Windows may not be resized smaller than 1 by 1 pixels.
When using client side decorations, GTK+ will do its best to adjust
the given size so that the resulting window size matches the
requested size without the title bar, borders and shadows added for
the client side decorations, but there is no guarantee that the
result will be totally accurate because these widgets added for
client side decorations depend on the theme and may not be realized
or visible at the time gtk_window_resize() is issued.
If the GtkWindow has a titlebar widget (see gtk_window_set_titlebar()), then
typically, gtk_window_resize() will compensate for the height of the titlebar
widget only if the height is known when the resulting GtkWindow configuration
is issued.
For example, if new widgets are added after the GtkWindow configuration
and cause the titlebar widget to grow in height, this will result in a
window content smaller that specified by gtk_window_resize() and not
a larger window.
width in pixels to resize the window to
height in pixels to resize the window to
Determines whether a resize grip is visible for the specified window.
true if a resize grip exists and is visible
Like gtk_window_resize(), but width and height are interpreted
in terms of the base size and increment set with
gtk_window_set_geometry_hints.
width in resize increments to resize the window to
height in resize increments to resize the window to
Emits the Gtk.Dialog::response signal with the given response ID.
Used to indicate that the user has responded to the dialog in some way;
typically either you or gtk_dialog_run() will be monitoring the
::response signal and take appropriate action.
response ID
Blocks in a recursive main loop until the dialog either emits the
Gtk.Dialog::response signal, or is destroyed. If the dialog is
destroyed during the call to gtk_dialog_run(), gtk_dialog_run() returns
#GTK_RESPONSE_NONE. Otherwise, it returns the response ID from the
::response signal emission.
Before entering the recursive main loop, gtk_dialog_run() calls
gtk_widget_show() on the dialog for you. Note that you still
need to show any children of the dialog yourself.
During gtk_dialog_run(), the default behavior of Gtk.Widget.SignalSignatures.delete_event | Gtk.Widget::delete-event
is disabled; if the dialog receives ::delete_event, it will not be
destroyed as windows usually are, and gtk_dialog_run() will return
#GTK_RESPONSE_DELETE_EVENT. Also, during gtk_dialog_run() the dialog
will be modal. You can force gtk_dialog_run() to return at any time by
calling gtk_dialog_response() to emit the ::response signal. Destroying
the dialog during gtk_dialog_run() is a very bad idea, because your
post-run code won’t know whether the dialog was destroyed or not.
After gtk_dialog_run() returns, you are responsible for hiding or
destroying the dialog if you wish to do so.
Typical usage of this function might be:
GtkWidget *dialog = gtk_dialog_new ();
// Set up dialog...
int result = gtk_dialog_run (GTK_DIALOG (dialog));
switch (result)
{
case GTK_RESPONSE_ACCEPT:
// do_application_specific_something ();
break;
default:
// do_nothing_since_dialog_was_cancelled ();
break;
}
gtk_widget_destroy (dialog);
Note that even though the recursive main loop gives the effect of a
modal dialog (it prevents the user from interacting with other
windows in the same window group while the dialog is run), callbacks
such as timeouts, IO channel watches, DND drops, etc, will
be triggered during a gtk_dialog_run() call.
response ID
Windows may set a hint asking the desktop environment not to receive the input focus. This function sets this hint.
true to let this window receive input focus
Sets an alternative button order. If the
Gtk.Settings.gtk_alternative_button_order setting is set to true,
the dialog buttons are reordered according to the order of the
response ids in new_order.
See gtk_dialog_set_alternative_button_order() for more information.
This function is for use by language bindings.
an array of response ids of dialog’s buttons
Sets or unsets the Gtk.Application associated with the window.
The application will be kept alive for at least as long as it has any windows
associated with it (see g_application_hold() for a way to keep it alive
without windows).
Normally, the connection between the application and the window will remain
until the window is destroyed, but you can explicitly remove it by setting
the application to null.
This is equivalent to calling gtk_application_remove_window() and/or
gtk_application_add_window() on the old/new applications as relevant.
Optionalapplication: Gtk.Applicationa Gtk.Application, or null to unset
Marks window as attached to attach_widget. This creates a logical binding
between the window and the widget it belongs to, which is used by GTK+ to
propagate information such as styling or accessibility to window as if it
was a children of attach_widget.
Examples of places where specifying this relation is useful are for instance a Gtk.Menu created by a Gtk.ComboBox, a completion popup window created by Gtk.Entry or a typeahead search entry created by Gtk.TreeView.
Note that this function should not be confused with
gtk_window_set_transient_for(), which specifies a window manager relation
between two toplevels instead.
Passing null for attach_widget detaches the window.
Optionalattach_widget: Gtk.Widgeta Gtk.Widget, or null
Sets the border width of the container.
The border width of a container is the amount of space to leave around the outside of the container. The only exception to this is Gtk.Window; because toplevel windows can’t leave space outside, they leave the space inside. The border is added on all sides of the container. To add space to only one side, use a specific Gtk.Widget.margin property on the child widget, for example Gtk.Widget.margin_top.
amount of blank space to leave outside the container. Valid values are in the range 0-65535 pixels.
By default, windows are decorated with a title bar, resize
controls, etc. Some [window managers][gtk-X11-arch]
allow GTK+ to disable these decorations, creating a
borderless window. If you set the decorated property to false
using this function, GTK+ will do its best to convince the window
manager not to decorate the window. Depending on the system, this
function may not have any effect when called on a window that is
already visible, so you should call it before calling gtk_widget_show().
On Windows, this function always works, since there’s no window manager policy involved.
true to decorate the window
The default widget is the widget that’s activated when the user
presses Enter in a dialog (for example). This function sets or
unsets the default widget for a Gtk.Window. When setting (rather
than unsetting) the default widget it’s generally easier to call
gtk_widget_grab_default() on the widget. Before making a widget
the default widget, you must call gtk_widget_set_can_default() on
the widget you’d like to make the default.
Like gtk_window_set_default_size(), but width and height are interpreted
in terms of the base size and increment set with
gtk_window_set_geometry_hints.
width in resize increments, or -1 to unset the default width
height in resize increments, or -1 to unset the default height
Sets the last widget in the dialog’s action area with the given response_id
as the default widget for the dialog. Pressing “Enter” normally activates
the default widget.
a response ID
Sets the default size of a window. If the window’s “natural” size (its size request) is larger than the default, the default will be ignored. More generally, if the default size does not obey the geometry hints for the window (gtk_window_set_geometry_hints() can be used to set these explicitly), the default size will be clamped to the nearest permitted size.
Unlike gtk_widget_set_size_request(), which sets a size request for
a widget and thus would keep users from shrinking the window, this
function only sets the initial size, just as if the user had
resized the window themselves. Users can still shrink the window
again as they normally would. Setting a default size of -1 means to
use the “natural” default size (the size request of the window).
For more control over a window’s initial size and how resizing works,
investigate gtk_window_set_geometry_hints().
For some uses, gtk_window_resize() is a more appropriate function.
gtk_window_resize() changes the current size of the window, rather
than the size to be used on initial display. gtk_window_resize() always
affects the window itself, not the geometry widget.
The default size of a window only affects the first time a window is shown; if a window is hidden and re-shown, it will remember the size it had prior to hiding, rather than using the default size.
Windows can’t actually be 0x0 in size, they must be at least 1x1, but
passing 0 for width and height is OK, resulting in a 1x1 default size.
If you use this function to reestablish a previously saved window size,
note that the appropriate size to save is the one returned by
gtk_window_get_size(). Using the window allocation directly will not
work in all circumstances and can lead to growing or shrinking windows.
width in pixels, or -1 to unset the default width
height in pixels, or -1 to unset the default height
By default, windows have a close button in the window frame. Some
[window managers][gtk-X11-arch] allow GTK+ to
disable this button. If you set the deletable property to false
using this function, GTK+ will do its best to convince the window
manager not to show a close button. Depending on the system, this
function may not have any effect when called on a window that is
already visible, so you should call it before calling gtk_widget_show().
On Windows, this function always works, since there’s no window manager policy involved.
true to decorate the window as deletable
If setting is true, then destroying the transient parent of window
will also destroy window itself. This is useful for dialogs that
shouldn’t persist beyond the lifetime of the main window they're
associated with, for example.
whether to destroy window with its transient parent
If focus is not the current focus widget, and is focusable, sets
it as the focus widget for the window. If focus is null, unsets
the focus widget for this window. To set the focus to a particular
widget in the toplevel, it is usually more convenient to use
gtk_widget_grab_focus() instead of this function.
Sets a focus chain, overriding the one computed automatically by GTK+.
In principle each widget in the chain should be a descendant of the container, but this is not enforced by this method, since it’s allowed to set the focus chain before you pack the widgets, or have a widget in the chain that isn’t always packed. The necessary checks are done when the focus chain is actually traversed.
Sets, or unsets if child is null, the focused child of container.
This function emits the GtkContainer::set_focus_child signal of
container. Implementations of Gtk.Container can override the
default behaviour by overriding the class closure of this signal.
This is function is mostly meant to be used by widgets. Applications can use
gtk_widget_grab_focus() to manually set the focus to a specific widget.
Optionalchild: Gtk.Widgeta Gtk.Widget, or null
Hooks up an adjustment to focus handling in a container, so when a child
of the container is focused, the adjustment is scrolled to show that
widget. This function sets the horizontal alignment.
See gtk_scrolled_window_get_hadjustment() for a typical way of obtaining
the adjustment and gtk_container_set_focus_vadjustment() for setting
the vertical adjustment.
The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the container.
an adjustment which should be adjusted when the focus is moved among the descendents of container
Windows may set a hint asking the desktop environment not to receive the input focus when the window is mapped. This function sets this hint.
true to let this window receive input focus on map
Hooks up an adjustment to focus handling in a container, so when a
child of the container is focused, the adjustment is scrolled to
show that widget. This function sets the vertical alignment. See
gtk_scrolled_window_get_vadjustment() for a typical way of obtaining
the adjustment and gtk_container_set_focus_hadjustment() for setting
the horizontal adjustment.
The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the container.
an adjustment which should be adjusted when the focus is moved among the descendents of container
This function sets up hints about how a window can be resized by the user. You can set a minimum and maximum size; allowed resize increments (e.g. for xterm, you can only resize by the size of a character); aspect ratios; and more. See the Gdk.Geometry struct.
widget the geometry hints used to be applied to or null. Since 3.20 this argument is ignored and GTK behaves as if null was set.
struct containing geometry information or null
mask indicating which struct fields should be paid attention to
Window gravity defines the meaning of coordinates passed to
gtk_window_move(). See gtk_window_move() and Gdk.Gravity for
more details.
The default window gravity is #GDK_GRAVITY_NORTH_WEST which will typically “do what you mean.”
Sets whether window has a corner resize grip.
Note that the resize grip is only shown if the window
is actually resizable and not maximized. Use
gtk_window_resize_grip_is_visible() to find out if the
resize grip is currently shown.
true to allow a resize grip
Tells GTK+ whether to drop its extra reference to the window
when gtk_widget_destroy() is called.
This function is only exported for the benefit of language bindings which may need to keep the window alive until their wrapper object is garbage collected. There is no justification for ever calling this function in an application.
the new value
If setting is true, then window will request that it’s titlebar
should be hidden when maximized.
This is useful for windows that don’t convey any information other
than the application name in the titlebar, to put the available
screen space to better use. If the underlying window system does not
support the request, the setting will not have any effect.
Note that custom titlebars set with gtk_window_set_titlebar() are
not affected by this. The application is in full control of their
content and visibility anyway.
whether to hide the titlebar when window is maximized
Sets up the icon representing a Gtk.Window. This icon is used when the window is minimized (also known as iconified). Some window managers or desktop environments may also place it in the window frame, or display it in other contexts. On others, the icon is not used at all, so your mileage may vary.
The icon should be provided in whatever size it was naturally drawn; that is, don’t scale the image before passing it to GTK+. Scaling is postponed until the last minute, when the desired final size is known, to allow best quality.
If you have your icon hand-drawn in multiple sizes, use
gtk_window_set_icon_list(). Then the best size will be used.
This function is equivalent to calling gtk_window_set_icon_list()
with a 1-element list.
See also gtk_window_set_default_icon_list() to set the icon
for all windows in your application in one go.
Sets the icon for window.
Warns on failure if err is null.
This function is equivalent to calling gtk_window_set_icon()
with a pixbuf created by loading the image from filename.
location of icon file
true if setting the icon succeeded.
Sets up the icon representing a Gtk.Window. The icon is used when the window is minimized (also known as iconified). Some window managers or desktop environments may also place it in the window frame, or display it in other contexts. On others, the icon is not used at all, so your mileage may vary.
gtk_window_set_icon_list() allows you to pass in the same icon in
several hand-drawn sizes. The list should contain the natural sizes
your icon is available in; that is, don’t scale the image before
passing it to GTK+. Scaling is postponed until the last minute,
when the desired final size is known, to allow best quality.
By passing several sizes, you may improve the final image quality of the icon, by reducing or eliminating automatic image scaling.
Recommended sizes to provide: 16x16, 32x32, 48x48 at minimum, and larger images (64x64, 128x128) if you have them.
See also gtk_window_set_default_icon_list() to set the icon
for all windows in your application in one go.
Note that transient windows (those who have been set transient for another
window using gtk_window_set_transient_for()) will inherit their
icon from their transient parent. So there’s no need to explicitly
set the icon on transient windows.
list of GdkPixbuf.Pixbuf
Sets the icon for the window from a named themed icon. See the docs for Gtk.IconTheme for more details. On some platforms, the window icon is not used at all.
Note that this has nothing to do with the WM_ICON_NAME property which is mentioned in the ICCCM.
Optionalname: stringthe name of the themed icon
Asks to keep window above, so that it stays on top. Note that
you shouldn’t assume the window is definitely above afterward,
because other entities (e.g. the user or
[window manager][gtk-X11-arch]) could not keep it above,
and not all window managers support keeping windows above. But
normally the window will end kept above. Just don’t write code
that crashes if not.
It’s permitted to call this function before showing a window, in which case the window will be kept above when it appears onscreen initially.
You can track the above state via the “window-state-event” signal on Gtk.Widget.
Note that, according to the Extended Window Manager Hints Specification, the above state is mainly meant for user preferences and should not be used by applications e.g. for drawing attention to their dialogs.
whether to keep window above other windows
Asks to keep window below, so that it stays in bottom. Note that
you shouldn’t assume the window is definitely below afterward,
because other entities (e.g. the user or
[window manager][gtk-X11-arch]) could not keep it below,
and not all window managers support putting windows below. But
normally the window will be kept below. Just don’t write code
that crashes if not.
It’s permitted to call this function before showing a window, in which case the window will be kept below when it appears onscreen initially.
You can track the below state via the “window-state-event” signal on Gtk.Widget.
Note that, according to the Extended Window Manager Hints Specification, the above state is mainly meant for user preferences and should not be used by applications e.g. for drawing attention to their dialogs.
whether to keep window below other windows
Sets the mnemonic modifier for this window.
the modifier mask used to activate mnemonics on this window.
Sets the Gtk.Window.mnemonics_visible property.
the new value
Sets a window modal or non-modal. Modal windows prevent interaction
with other windows in the same application. To keep modal dialogs
on top of main application windows, use
gtk_window_set_transient_for() to make the dialog transient for the
parent; most [window managers][gtk-X11-arch]
will then disallow lowering the dialog below the parent.
whether the window is modal
Sets a position constraint for this window. If the old or new constraint is Gtk.WindowPosition.CENTER_ALWAYS, this will also cause the window to be repositioned to satisfy the new constraint.
a position constraint.
Sets the reallocate_redraws flag of the container to the given value.
Containers requesting reallocation redraws get automatically redrawn if any of their children changed allocation.
the new value for the container’s reallocate_redraws flag
Sets whether the user can resize a window. Windows are user resizable by default.
true if the user can resize this window
Sets the resize mode for the container.
The resize mode of a container determines whether a resize request will be passed to the container’s parent, queued for later execution or executed immediately.
the new resize mode
Calls gtk_widget_set_sensitive (widget, setting)
for each widget in the dialog’s action area with the given response_id.
A convenient way to sensitize/desensitize dialog buttons.
a response ID
true for sensitive
This function is only useful on X11, not with other GTK+ targets.
In combination with the window title, the window role allows a [window manager][gtk-X11-arch] to identify "the same" window when an application is restarted. So for example you might set the “toolbox” role on your app’s toolbox window, so that when the user restarts their session, the window manager can put the toolbox back in the same place.
If a window already has a unique title, you don’t need to set the role, since the WM can use the title to identify the window when restoring the session.
unique identifier for the window to be used when restoring a session
Sets the Gdk.Screen where the window is displayed; if
the window is already mapped, it will be unmapped, and
then remapped on the new screen.
a Gdk.Screen.
Windows may set a hint asking the desktop environment not to display the window in the pager. This function sets this hint. (A "pager" is any desktop navigation tool such as a workspace switcher that displays a thumbnail representation of the windows on the screen.)
true to keep this window from appearing in the pager
Windows may set a hint asking the desktop environment not to display the window in the task bar. This function sets this hint.
true to keep this window from appearing in the task bar
Startup notification identifiers are used by desktop environment to
track application startup, to provide user feedback and other
features. This function changes the corresponding property on the
underlying GdkWindow. Normally, startup identifier is managed
automatically and you should only use this function in special cases
like transferring focus from other processes. You should use this
function before calling gtk_window_present() or any equivalent
function generating a window map event.
This function is only useful on X11, not with other GTK+ targets.
a string with startup-notification identifier
Sets the title of the Gtk.Window. The title of a window will be displayed in its title bar; on the X Window System, the title bar is rendered by the [window manager][gtk-X11-arch], so exactly how the title appears to users may vary according to a user’s exact configuration. The title should help a user distinguish this window from other windows they may have open. A good title might include the application name and current document filename, for example.
title of the window
Sets a custom titlebar for window.
A typical widget used here is Gtk.HeaderBar, as it provides various features expected of a titlebar while allowing the addition of child widgets to it.
If you set a custom titlebar, GTK+ will do its best to convince
the window manager not to put its own titlebar on the window.
Depending on the system, this function may not work for a window
that is already visible, so you set the titlebar before calling
gtk_widget_show().
Dialog windows should be set transient for the main application
window they were spawned from. This allows
[window managers][gtk-X11-arch] to e.g. keep the
dialog on top of the main window, or center the dialog over the
main window. gtk_dialog_new_with_buttons() and other convenience
functions in GTK+ will sometimes call
gtk_window_set_transient_for() on your behalf.
Passing null for parent unsets the current transient window.
On Wayland, this function can also be used to attach a new #GTK_WINDOW_POPUP to a #GTK_WINDOW_TOPLEVEL parent already mapped on screen so that the #GTK_WINDOW_POPUP will be created as a subsurface-based window #GDK_WINDOW_SUBSURFACE which can be positioned at will relatively to the #GTK_WINDOW_TOPLEVEL surface.
On Windows, this function puts the child window on top of the parent, much as the window manager would have done on X.
By setting the type hint for the window, you allow the window manager to decorate and handle the window in a way which is suitable to the function of the window in your application.
This function should be called before the window becomes visible.
gtk_dialog_new_with_buttons() and other convenience functions in GTK+
will sometimes call gtk_window_set_type_hint() on your behalf.
the window type
Windows may set a hint asking the desktop environment to draw the users attention to the window. This function sets this hint.
true to mark this window as urgent
Don’t use this function. It sets the X Window System “class” and
“name” hints for a window. According to the ICCCM, you should
always set these to the same value for all windows in an
application, and GTK+ sets them to that value by default, so calling
this function is sort of pointless. However, you may want to call
gtk_window_set_role() on each window in your application, for the
benefit of the session manager. Setting the role allows the window
manager to restore window positions when loading a saved session.
window name hint
window class hint
Asks to stick window, which means that it will appear on all user
desktops. Note that you shouldn’t assume the window is definitely
stuck afterward, because other entities (e.g. the user or
[window manager][gtk-X11-arch] could unstick it
again, and some window managers do not support sticking
windows. But normally the window will end up stuck. Just don't
write code that crashes if not.
It’s permitted to call this function before showing a window.
You can track stickiness via the “window-state-event” signal on Gtk.Widget.
Asks to toggle off the fullscreen state for window. Note that you
shouldn’t assume the window is definitely not full screen
afterward, because other entities (e.g. the user or
[window manager][gtk-X11-arch]) could fullscreen it
again, and not all window managers honor requests to unfullscreen
windows. But normally the window will end up restored to its normal
state. Just don’t write code that crashes if not.
You can track the fullscreen state via the “window-state-event” signal on Gtk.Widget.
Asks to unmaximize window. Note that you shouldn’t assume the
window is definitely unmaximized afterward, because other entities
(e.g. the user or [window manager][gtk-X11-arch])
could maximize it again, and not all window
managers honor requests to unmaximize. But normally the window will
end up unmaximized. Just don’t write code that crashes if not.
You can track maximization via the “window-state-event” signal on Gtk.Widget.
Removes a focus chain explicitly set with gtk_container_set_focus_chain().
Asks to unstick window, which means that it will appear on only
one of the user’s desktops. Note that you shouldn’t assume the
window is definitely unstuck afterward, because other entities
(e.g. the user or [window manager][gtk-X11-arch]) could
stick it again. But normally the window will
end up unstuck. Just don’t write code that crashes if not.
You can track stickiness via the “window-state-event” signal on Gtk.Widget.
Virtualvfunc_Activates the default widget for the window.
Virtualvfunc_Activates the current focused widget within the window.
Virtualvfunc_Adds widget to container. Typically used for simple containers
such as Gtk.Window, Gtk.Frame, or Gtk.Button; for more complicated
layout containers such as Gtk.Box or Gtk.Grid, this function will
pick default packing parameters that may not be correct. So
consider functions such as gtk_box_pack_start() and
gtk_grid_attach() as an alternative to gtk_container_add() in
those cases. A widget may be added to only one container at a time;
you can’t place the same widget inside two different containers.
Note that some containers, such as Gtk.ScrolledWindow or Gtk.ListBox, may add intermediate children between the added widget and the container.
Virtualvfunc_Virtualvfunc_Signal emitted when a size recalculation is needed.
Virtualvfunc_Virtualvfunc_Signal emitted when the user uses a keybinding to close the dialog.
Virtualvfunc_Virtualvfunc_Constructs a child of buildable with the name name.
Gtk.Builder calls this function if a “constructor” has been specified in the UI definition.
Gtk.Builder used to construct this object
name of child to construct
Virtualvfunc_Virtualvfunc_This is called at the end of each custom element handled by the buildable.
Gtk.Builder used to construct this object
child object or null for non-child tags
name of tag
Optionaldata: anyuser data that will be passed in to parser functions
Virtualvfunc_This is called for each unknown element under <child>.
a Gtk.Builder used to construct this object
child object or null for non-child tags
name of tag
Virtualvfunc_Class handler for the Gtk.Window.SignalSignatures.enable_debugging | Gtk.Window::enable-debugging keybinding signal. Since: 3.14
Virtualvfunc_Invokes callback on each direct child of container, including
children that are considered “internal” (implementation details
of the container). “Internal” children generally weren’t added
by the user of the container, but were added by the container
implementation itself.
Most applications should use gtk_container_foreach(), rather
than gtk_container_forall().
Virtualvfunc_Virtualvfunc_Virtualvfunc_Gets the name of the buildable object.
Gtk.Builder sets the name based on the
[GtkBuilder UI definition][BUILDER-UI]
used to construct the buildable.
Virtualvfunc_Returns a newly created widget path representing all the widget hierarchy
from the toplevel down to and including child.
Virtualvfunc_Signal gets emitted when the set of accelerators or mnemonics that are associated with window changes.
Virtualvfunc_Virtualvfunc_Removes widget from container. widget must be inside container.
Note that container will own a reference to widget, and that this
may be the last reference held; so removing a widget from its
container can destroy that widget. If you want to use widget
again, you need to add a reference to it before removing it from
a container, using g_object_ref(). If you don’t want to use widget
again it’s usually more efficient to simply destroy it directly
using gtk_widget_destroy() since this will remove it from the
container and help break any circular reference count cycles.
Virtualvfunc_Emits the Gtk.Dialog::response signal with the given response ID.
Used to indicate that the user has responded to the dialog in some way;
typically either you or gtk_dialog_run() will be monitoring the
::response signal and take appropriate action.
response ID
Virtualvfunc_Virtualvfunc_Virtualvfunc_If focus is not the current focus widget, and is focusable, sets
it as the focus widget for the window. If focus is null, unsets
the focus widget for this window. To set the focus to a particular
widget in the toplevel, it is usually more convenient to use
gtk_widget_grab_focus() instead of this function.
Virtualvfunc_Sets, or unsets if child is null, the focused child of container.
This function emits the GtkContainer::set_focus_child signal of
container. Implementations of Gtk.Container can override the
default behaviour by overriding the class closure of this signal.
This is function is mostly meant to be used by widgets. Applications can use
gtk_widget_grab_focus() to manually set the focus to a specific widget.
Optionalchild: Gtk.Widgeta Gtk.Widget, or null
Virtualvfunc_Sets the name of the buildable object.
name to set
Static_Staticbind_Staticbind_The “id” of the child defined in the template XML
Whether the child should be accessible as an “internal-child” when this class is used in GtkBuilder XML
The structure offset into the composite widget’s instance public or private structure where the automated child pointer should be set, or 0 to not assign the pointer.
Staticcompat_Optionaldata: anyStaticfind_Staticfind_Staticfind_Staticget_Staticget_Obtains the current default reading direction. See
gtk_widget_set_default_direction().
Staticget_Staticget_Returns the fallback icon name for windows that has been set
with gtk_window_set_default_icon_name(). The returned
string is owned by GTK+ and should not be modified. It
is only valid until the next call to
gtk_window_set_default_icon_name().
Staticget_Statichandle_Staticinstall_the GObject.ParamSpec array defining the new child properties
Staticinstall_the id for the property
the GObject.ParamSpec for the property
Staticinstall_Staticinstall_the id for the new property
the GObject.ParamSpec for the new property
Staticinstall_the GObject.ParamSpec for the property
Staticinterface_Find the GObject.ParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Staticinterface_Add a property to an interface; this is only useful for interfaces
that are added to GObject-derived types. Adding a property to an
interface forces all objects classes with that interface to have a
compatible property. The compatible property could be a newly
created GObject.ParamSpec, but normally
g_object_class_override_property() will be used so that the object
class only needs to provide an implementation and inherits the
property description, default value, bounds, and so forth from the
interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
GObject.TypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the GObject.ParamSpec for the new property
Staticinterface_Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Staticlist_Staticlist_Staticlist_Staticlist_Returns a list of all existing toplevel windows. The widgets
in the list are not individually referenced. If you want
to iterate through the list and perform actions involving
callbacks that might destroy the widgets, you must call
g_list_foreach (result, (GFunc)g_object_ref, NULL) first, and
then unref all the widgets afterwards.
StaticnewvStaticoverride_the new property ID
the name of a property registered in a parent class or in an interface of this class.
Staticpop_Cancels the effect of a previous call to gtk_widget_push_composite_child().
Staticpush_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.
Staticset_Staticset_The object type that implements the accessible for widget_class
Staticset_By default, after showing the first Gtk.Window, GTK+ calls
gdk_notify_startup_complete(). Call this function to disable
the automatic startup notification. You might do this if your
first window is a splash screen, and you want to delay notification
until after your real main window has been shown, for example.
In that example, you would disable startup notification temporarily, show your splash screen, then re-enable it so that showing the main window would automatically result in notification.
true to automatically do startup notification
Staticset_The Gtk.BuilderConnectFunc to use when connecting signals in the class template
Staticset_name to use
Staticset_Sets the default reading direction for widgets where the
direction has not been explicitly set by gtk_widget_set_direction().
the new default direction. This cannot be Gtk.TextDirection.NONE.
Staticset_Staticset_Sets an icon to be used as fallback for windows that haven't
had gtk_window_set_icon_list() called on them from a file
on disk. Warns on failure if err is null.
location of icon file
Staticset_Sets an icon list to be used as fallback for windows that haven't
had gtk_window_set_icon_list() called on them to set up a
window-specific icon list. This function allows you to set up the
icon for all windows in your app at once.
See gtk_window_set_icon_list() for more details.
a list of GdkPixbuf.Pixbuf
Staticset_Sets an icon to be used as fallback for windows that haven't
had gtk_window_set_icon_list() called on them from a named
themed icon, see gtk_window_set_icon_name().
the name of the themed icon
Staticset_Opens or closes the [interactive debugger][interactive-debugging], which offers access to the widget hierarchy of the application and to useful debugging tools.
true to enable interactive debugging
Staticset_A GLib.Bytes holding the Gtk.Builder XML
Staticset_The name of the resource to load the template from
Gtk.AppChooserDialog shows a Gtk.AppChooserWidget inside a Gtk.Dialog.
Note that Gtk.AppChooserDialog does not have any interesting methods of its own. Instead, you should get the embedded Gtk.AppChooserWidget using
gtk_app_chooser_dialog_get_widget()and call its methods if the generic Gtk.AppChooser interface is not sufficient for your needs.To set the heading that is shown above the Gtk.AppChooserWidget, use
gtk_app_chooser_dialog_set_heading().