The accessible role of the given GtkAccessible implementation.
The accessible role cannot be changed once set.
The GtkApplication 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.
Whether the widget or any of its descendents can accept the input focus.
This property is meant to be set by widget implementations, typically in their instance init function.
Whether the widget can receive pointer events.
The child widget.
A list of css classes applied to this widget.
The name of this widget in the CSS tree.
This property is meant to be set by widget implementations, typically in their instance init function.
The cursor used by widget.
Whether the window should have a frame (also known as decorations).
The default height of the window.
The default widget.
The default width of the window.
Whether the window frame should have a close button.
If this window should be destroyed when the parent is destroyed.
The display that will display this window.
Whether the widget should grab focus when it is clicked with the mouse.
This property is only relevant for widgets that can take focus.
Whether 'focus rectangles' are currently visible in this window.
This property is maintained by GTK based on user input and should not be set by applications.
The focus widget.
Whether this widget itself will accept the input focus.
Whether the window is fullscreen.
Setting this property is the equivalent of calling
[methodGtk.Window.fullscreen] or [methodGtk.Window.unfullscreen];
either operation is asynchronous, which means you will need to
connect to the ::notify signal in order to know whether the
operation was successful.
How to distribute horizontal space if widget gets extra space.
Whether the window frame should handle F10 for activating menubars.
Whether the widget is the default widget.
Whether the widget has the input focus.
Enables or disables the emission of the ::query-tooltip signal on widget.
A value of %TRUE indicates that widget can have a tooltip, in this case
the widget will be queried using [signalGtk.Widget::query-tooltip] to
determine whether it will provide a tooltip or not.
Override for height request of the widget.
If this is -1, the natural request will be used.
Whether to expand horizontally.
Whether to use the hexpand property.
If this window should be hidden when the users clicks the close button.
Specifies the name of the themed icon to use as the window icon.
See [classGtk.IconTheme] for more details.
Whether the toplevel is the currently active window.
The GtkLayoutManager instance to use to compute the preferred size
of the widget, and allocate its children.
This property is meant to be set by widget implementations, typically in their instance init function.
Margin on bottom 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
[methodGtk.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
[methodGtk.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
[methodGtk.Widget.set_size_request] for example.
Margin on top 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
[methodGtk.Widget.set_size_request] for example.
Whether the window is maximized.
Setting this property is the equivalent of calling
[methodGtk.Window.maximize] or [methodGtk.Window.unmaximize];
either operation is asynchronous, which means you will need to
connect to the ::notify signal in order to know whether the
operation was successful.
Whether mnemonics are currently visible in this window.
This property is maintained by GTK based on user input, and should not be set by applications.
If %TRUE, the window is modal.
The name of the widget.
The requested opacity of the widget.
How content outside the widget's content area is treated.
This property is meant to be set by widget implementations, typically in their instance init function.
The parent widget of this widget.
Whether the widget will receive the default action when it is focused.
If %TRUE, users can resize the window.
The GtkRoot widget of the widget tree containing this widget.
This will be %NULL if the widget is not contained in a root widget.
The scale factor of the widget.
The name of the section to show.
This should be the section-name of one of the GtkShortcutsSection
objects that are in this shortcuts window.
Whether the widget responds to input.
A write-only property for setting window's startup notification identifier.
The title of the window.
The titlebar widget.
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Also see [methodGtk.Tooltip.set_markup].
This is a convenience property which will take care of getting the
tooltip shown if the given string is not %NULL:
[propertyGtk.Widget:has-tooltip] will automatically be set to %TRUE
and there will be taken care of [signalGtk.Widget::query-tooltip] in
the default signal handler.
Note that if both [propertyGtk.Widget:tooltip-text] and
[propertyGtk.Widget:tooltip-markup] are set, the last one wins.
Sets the text of tooltip to be the given string.
Also see [methodGtk.Tooltip.set_text].
This is a convenience property which will take care of getting the
tooltip shown if the given string is not %NULL:
[propertyGtk.Widget:has-tooltip] will automatically be set to %TRUE
and there will be taken care of [signalGtk.Widget::query-tooltip] in
the default signal handler.
Note that if both [propertyGtk.Widget:tooltip-text] and
[propertyGtk.Widget:tooltip-markup] are set, the last one wins.
The transient parent of the window.
How to distribute vertical space if widget gets extra space.
Whether to expand vertically.
Whether to use the vexpand property.
The view name by which to filter the contents.
This should correspond to the [propertyGtk.ShortcutsGroup:view]
property of some of the [classGtk.ShortcutsGroup] objects that
are inside this shortcuts window.
Set this to %NULL to show all groups.
Whether the widget is visible.
Override for width request of the widget.
If this is -1, the natural request will be used.
Enable or disable an action installed with gtk_widget_class_install_action().
action name, such as "clipboard.paste"
whether the action is now enabled
For widgets that can be “activated” (buttons, menu items, etc.), this function activates them.
The activation will emit the signal set using
[methodGtk.WidgetClass.set_activate_signal] during class initialization.
Activation is what happens when you press Enter on a widget during key navigation.
If you wish to handle the activation keybinding yourself, it is
recommended to use [methodGtk.WidgetClass.add_shortcut] with an action
created with [ctorGtk.SignalAction.new].
If widget isn't activatable, the function returns %FALSE.
Looks up the action in the action groups associated with
widget and its ancestors, and activates it.
If the action is in an action group added with
[methodGtk.Widget.insert_action_group], the name is expected
to be prefixed with the prefix that was used when the group was
inserted.
The arguments must match the actions expected parameter type,
as returned by g_action_get_parameter_type().
Activates the default.activate action from widget.
Adds controller to widget so that it will receive events.
You will usually want to call this function right after
creating any kind of [classGtk.EventController].
a GtkEventController that hasn't been added to a widget yet
Adds a style class to widget.
After calling this function, the widgets style will match
for css_class, according to CSS matching rules.
Use [methodGtk.Widget.remove_css_class] to remove the
style again.
The style class to add to widget, without the leading '.' used for notation of style classes
Adds a widget to the list of mnemonic labels for this widget.
See [methodGtk.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.
Queues an animation frame update and adds a callback to be called before each frame.
Until the tick callback is removed, it will be called frequently
(usually at the frame rate of the output device or as quickly as
the application can be repainted, whichever is slower). For this
reason, is most suitable for handling graphics that change every
frame or every few frames. The tick callback does not automatically
imply a relayout or repaint. If you want a repaint or relayout, and
aren’t changing widget properties that would trigger that (for example,
changing the text of a GtkLabel), then you will have to call
[methodGtk.Widget.queue_resize] or [methodGtk.Widget.queue_draw]
yourself.
[methodGdk.FrameClock.get_frame_time] should generally be used
for timing continuous animations and
[methodGdk.FrameTimings.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
[signalGdk.FrameClock::update] signal of GdkFrameClock, since you
don't have to worry about when a GdkFrameClock is assigned to a widget.
function to call for updating animations
This function is only used by GtkWidget subclasses, to
assign a size, position and (optionally) baseline to their
child widgets.
In this function, the allocation and baseline may be adjusted. The given allocation will be forced to be bigger than the widget's minimum size, as well as at least 0×0 in size.
For a version that does not take a transform, see
[methodGtk.Widget.size_allocate].
New width of widget
New height of widget
New baseline of widget, or -1
Transformation to be applied to widget
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 instance to be updated with the same value of the "active" property of the action #GObject instance.
If flags contains %G_BINDING_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
#GBinding 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 can have multiple bindings.
the property on source to bind
the target #GObject
the property on target to bind
flags to pass to #GBinding
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 target #GObject
the property on target to bind
flags to pass to #GBinding
a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default
a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default
Called by widgets as the user moves around the window using keyboard shortcuts.
The direction argument indicates what kind of motion is taking place (up,
down, left, right, tab forward, tab backward).
This function calls the [vfuncGtk.Widget.focus] virtual function; widgets
can override the virtual function in order to implement appropriate focus
behavior.
The default focus() virtual function 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. When returning TRUE, widgets normallycall [methodGtk.Widget.grab_focus]
to place the focus accordingly; when returning FALSE, they don’t modify
the current focus location.
This function is used by custom widget implementations; if you're
writing an app, you’d use [methodGtk.Widget.grab_focus] to move
the focus to a particular widget.
direction of focus movement
Requests that the window is closed.
This is similar to what happens when a window manager close button is clicked.
This function can be used with close buttons in custom titlebars.
Computes the bounds for widget in the coordinate space of target.
FIXME: Explain what "bounds" are.
If the operation is successful, %TRUE is returned. If widget has no
bounds or the bounds cannot be expressed in target's coordinate space
(for example if both widgets are in different windows), %FALSE is
returned and bounds is set to the zero rectangle.
It is valid for widget and target to be the same widget.
Computes whether a container should give this widget extra space when possible.
Containers should check this, rather than looking at
[methodGtk.Widget.get_hexpand] or [methodGtk.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
Translates the given point in widget's coordinates to coordinates
relative to target’s coordinate system.
In order to perform this operation, both widgets must share a common ancestor.
the GtkWidget to transform into
a point in widget's coordinate system
Computes a matrix suitable to describe a transformation from
widget's coordinate system into target's coordinate system.
The transform can not be computed in certain cases, for example
when widget and target do not share a common ancestor. In that
case out_transform gets set to the identity matrix.
Tests if the point at (x, y) is contained in widget.
The coordinates for (x, y) must be in widget coordinates, so
(0, 0) is assumed to be the top left of widget's content area.
X coordinate to test, relative to widget's origin
Y coordinate to test, relative to widget's origin
Creates a new PangoLayout with the appropriate font map,
font description, and base direction for drawing text for
this widget.
If you keep a PangoLayout created in this way around,
you need to re-create it when the widget PangoContext
is replaced. This can be tracked by listening to changes
of the [propertyGtk.Widget:root] property on the widget.
text to set on the layout
Drop the internal reference GTK holds on toplevel windows.
Checks to see if a drag movement has passed the GTK drag threshold.
X coordinate of start of drag
Y coordinate of start of drag
current X coordinate
current Y coordinate
Notifies the user about an input-related error on this widget.
If the [propertyGtk.Settings:gtk-error-bell] setting is %TRUE,
it calls [methodGdk.Surface.beep], otherwise it does nothing.
Note that the effect of [methodGdk.Surface.beep] can be configured
in many ways, depending on the windowing backend and the desktop
environment or window manager that is used.
This function is intended for #GObject 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().
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::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.
Asks to place window in the fullscreen state.
Note that you shouldn’t assume the window is definitely fullscreen afterward, because other entities (e.g. the user or window manager unfullscreen it again, and not all window managers honor requests to fullscreen windows.
You can track the result of this operation via the
[propertyGdk.Toplevel:state] property, or by listening to
notifications of the [propertyGtk.Window:fullscreened] property.
Asks to place window in the fullscreen state on the given monitor.
Note that you shouldn't assume the window is definitely fullscreen afterward, or that the windowing system allows fullscreen windows on any given monitor.
You can track the result of this operation via the
[propertyGdk.Toplevel:state] property, or by listening to
notifications of the [propertyGtk.Window:fullscreened] property.
Retrieves the GtkAccessibleRole for the given GtkAccessible.
Returns the baseline that has currently been allocated to widget.
This function is intended to be used when implementing handlers
for the GtkWidgetClass.snapshot() function, and when allocating
child widgets in GtkWidgetClass.size_allocate().
Returns the height that has currently been allocated to widget.
Returns the width that has currently been allocated to widget.
Retrieves the widget’s allocation.
Note, when implementing a layout container: a widget’s allocation
will be its “adjusted” allocation, that is, the widget’s parent
typically calls [methodGtk.Widget.size_allocate] with an allocation,
and that allocation is then adjusted (to handle margin
and alignment for example) before assignment to the widget.
[methodGtk.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
[methodGtk.Widget.size_allocate] allocation, however.
So a layout container is guaranteed that its children stay inside the assigned bounds, but not that they have exactly the bounds the container assigned.
Gets the first ancestor of widget with type widget_type.
For example, gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)
gets the first GtkBox that’s an ancestor of widget. No
reference will be added to the returned widget; it should
not be unreferenced.
Note that unlike [methodGtk.Widget.is_ancestor], this function
considers widget to be an ancestor of itself.
ancestor type
Gets the GtkApplication associated with the window.
Gets the ID of the buildable object.
GtkBuilder sets the name based on the ID attribute
of the
Determines whether the input focus can enter widget or any
of its children.
See [methodGtk.Widget.set_focusable].
Queries whether widget can be the target of pointer events.
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 should never be called by an application.
Returns the list of style classes applied to widget.
Returns the CSS name that is used for self.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
Returns whether the window has been set to have decorations.
Gets the default size of the window.
A value of 0 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.
Returns whether the window will be destroyed with its transient parent.
Gets the reading direction for a particular widget.
See [methodGtk.Widget.set_direction].
Get the GdkDisplay for the toplevel window associated with
this widget.
This function can only be called after the widget has been
added to a widget hierarchy with a GtkWindow at the top.
In general, you should only create display specific resources when a widget has been realized, and you should free those resources when the widget is unrealized.
Returns whether the widget should grab focus when it is clicked with the mouse.
See [methodGtk.Widget.set_focus_on_click].
Gets whether “focus rectangles” are supposed to be visible.
Determines whether widget can own the input focus.
See [methodGtk.Widget.set_focusable].
Returns the cairo_font_options_t of widget.
Seee [methodGtk.Widget.set_font_options].
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 [methodGdk.FrameClock.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
[methodGdk.FrameClock.get_frame_time], and then update the animation
by calling [methodGdk.FrameClock.get_frame_time] again during each repaint.
[methodGdk.FrameClock.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 [methodGtk.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.
Returns the group for window.
If the window has no group, then the default group is returned.
Returns whether this window reacts to F10 key presses by activating a menubar it contains.
Returns the current value of the has-tooltip property.
Returns the content height of the widget.
This function returns the height passed to its
size-allocate implementation, which is the height you
should be using in [vfuncGtk.Widget.snapshot].
For pointer events, see [methodGtk.Widget.contains].
Gets whether the widget would like any available extra horizontal space.
When a user resizes a GtkWindow, widgets with expand=TRUE
generally receive the extra space. For example, a list or
scrollable area or document in your window would often be set to
expand.
Containers should use [methodGtk.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.
Gets whether gtk_widget_set_hexpand() has been used to explicitly set the expand flag on this widget.
If [propertyGtk.Widget:hexpand] property is set, then it
overrides any computed expand value based on child widgets.
If hexpand is not set, then the expand value depends on
whether any children of the widget would like to expand.
There are few reasons to use this function, but it’s here for completeness and consistency.
Returns whether the window will be hidden when the close button is clicked.
Returns the name of the themed icon for the window.
Retrieves the layout manager used by widget.
See [methodGtk.Widget.set_layout_manager].
Whether the widget is mapped.
Gets the bottom margin of widget.
Gets the end margin of widget.
Gets the start margin of widget.
Gets the top margin of widget.
Gets whether mnemonics are supposed to be visible.
Returns whether the window is modal.
Retrieves the name of a widget.
See [methodGtk.Widget.set_name] for the significance of widget names.
#Fetches the requested opacity for this widget.
See [methodGtk.Widget.set_opacity].
Returns the widgets overflow value.
Gets a PangoContext with the appropriate font map, font description,
and base direction for this widget.
Unlike the context returned by [methodGtk.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 listening to changes of the
[propertyGtk.Widget:root] property on the widget.
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 GtkFixed.
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 [idgtk_widget_measure] if you want to support baseline alignment.
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 g_value_unset().
Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.
the name of the property to get
return location for the property value
This function gets back user data pointers stored via g_object_set_qdata().
A #GQuark, naming the user data pointer
Determines whether widget is realized.
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 [methodGtk.Widget.set_receives_default].
Gets whether the widget prefers a height-for-width layout or a width-for-height layout.
Single-child widgets generally propagate the preference of their child, more complex widgets need to request something either in context of their children or in context of their allocation capabilities.
Gets the value set by gtk_window_set_resizable().
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 [methodGdk.Surface.get_scale_factor].
Returns the widget’s sensitivity.
This function returns the value that has been set using
[methodGtk.Widget.set_sensitive]).
The effective sensitivity of a widget is however determined
by both its own and its parent widget’s sensitivity.
See [methodGtk.Widget.is_sensitive].
Gets the settings object holding the settings used for this widget.
Note that this function can only be called when the GtkWidget
is attached to a toplevel, since the settings object is specific
to a particular GdkDisplay. If you want to monitor the widget for
changes in its settings, connect to the notify::display signal.
Returns the content width or height of the widget.
Which dimension is returned depends on orientation.
This is equivalent to calling [methodGtk.Widget.get_width]
for %GTK_ORIENTATION_HORIZONTAL or [methodGtk.Widget.get_height]
for %GTK_ORIENTATION_VERTICAL, but can be used when
writing orientation-independent code, such as when
implementing [ifaceGtk.Orientable] widgets.
the orientation to query
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
[methodGtk.Widget.set_size_request]. To get the size a widget will
actually request, call [methodGtk.Widget.measure] instead of
this function.
Returns the widget state as a flag set.
It is worth mentioning that the effective %GTK_STATE_FLAG_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
[flagsGtk.StateFlags] to pass to a [classGtk.StyleContext]
method, you should look at [methodGtk.StyleContext.get_state].
Returns the style context associated to widget.
The returned object is guaranteed to be the same
for the lifetime of widget.
Retrieves the surface transform of self.
This is the translation from self's surface coordinates into
self's widget coordinates.
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 [methodGtk.WidgetClass.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 GType to get a template child for
The “id” of the child defined in the template XML
Retrieves the title of the window.
Gets the contents of the tooltip for widget.
If the tooltip has not been set using
[methodGtk.Widget.set_tooltip_markup], this
function returns %NULL.
Gets the contents of the tooltip for widget.
If the widget's tooltip was set using
[methodGtk.Widget.set_tooltip_markup],
this function will return the escaped text.
Gets whether the widget would like any available extra vertical space.
See [methodGtk.Widget.get_hexpand] for more detail.
Gets whether gtk_widget_set_vexpand() has been used to explicitly set the expand flag on this widget.
See [methodGtk.Widget.get_hexpand_set] for more detail.
Determines whether the widget is visible.
If you want to take into account whether the widget’s
parent is also marked as visible, use
[methodGtk.Widget.is_visible] instead.
This function does not check if the widget is obscured in any way.
See [methodGtk.Widget.set_visible].
Returns the content width of the widget.
This function returns the width passed to its
size-allocate implementation, which is the width you
should be using in [vfuncGtk.Widget.snapshot].
For pointer events, see [methodGtk.Widget.contains].
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
Causes widget to have the keyboard focus for the GtkWindow it's inside.
If widget is not focusable, or its [vfuncGtk.Widget.grab_focus]
implementation cannot transfer the focus to a descendant of widget
that is focusable, it will not take focus and %FALSE will be returned.
Calling [methodGtk.Widget.grab_focus] on an already focused widget
is allowed, should not have an effect, and return %TRUE.
Returns whether css_class is currently applied to widget.
A style class, without the leading '.' used for notation of style classes
Returns whether window has an explicit window group.
Determines if the widget should show a visible indication that it has the global input focus.
This is a convenience function that takes into account whether
focus indication should currently be shown in the toplevel window
of widget. See [methodGtk.Window.get_focus_visible] for more
information about focus indication.
To find out if the widget has the global input focus, use
[methodGtk.Widget.has_focus].
Reverses the effects of gtk_widget_show().
This is causing the widget to be hidden (invisible to the user).
Returns whether the widget is currently being destroyed.
This information can sometimes be used to avoid doing unnecessary work.
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
[methodGtk.WidgetClass.set_template].
It is important to call this function in the instance initializer
of a GtkWidget subclass and not in GObject.constructed() or
GObject.constructor() for two reasons:
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 XMLA good rule of thumb is to call this function as the first thing in an instance initialization function.
Inserts group into widget.
Children of widget that implement [ifaceGtk.Actionable] can
then be associated with actions in group by setting their
“action-name” to prefix.action-name.
Note that inheritance is defined for individual actions. I.e.
even if you insert a group with prefix prefix, actions with
the same prefix will still be inherited from the parent, unless
the group contains an action with the same name.
If group is %NULL, a previously inserted group for name is
removed from widget.
the prefix for actions in group
a GActionGroup, or %NULL to remove the previously inserted group for name
Inserts widget into the child widget list of parent.
It will be placed after previous_sibling, or at the beginning if
previous_sibling is %NULL.
After calling this function, gtk_widget_get_prev_sibling(widget)
will return previous_sibling.
If parent is already set as the parent widget of widget, this
function can also be used to reorder widget in the child widget
list of parent.
This API is primarily meant for widget implementations; if you are just using a widget, you must use its own API for adding children.
the parent GtkWidget to insert widget into
the new previous sibling of widget
Inserts widget into the child widget list of parent.
It will be placed before next_sibling, or at the end if
next_sibling is %NULL.
After calling this function, gtk_widget_get_next_sibling(widget)
will return next_sibling.
If parent is already set as the parent widget of widget, this function
can also be used to reorder widget in the child widget list of parent.
This API is primarily meant for widget implementations; if you are just using a widget, you must use its own API for adding children.
the parent GtkWidget to insert widget into
the new next sibling of widget
Determines whether widget can be drawn to.
A widget can be drawn if it is mapped and visible.
Checks whether object has a [floating][floating-ref] reference.
Determines if the widget is the focus widget within its toplevel.
This does not mean that the [propertyGtk.Widget:has-focus]
property is necessarily set; [propertyGtk.Widget:has-focus]
will only be set if the toplevel widget additionally has the
global input focus.
Retrieves the current fullscreen state of window.
Note that since fullscreening is ultimately handled by the window
manager and happens asynchronously to an application request, you
shouldn’t assume the return value of this function changing
immediately (or at all), as an effect of calling
[methodGtk.Window.fullscreen] or [methodGtk.Window.unfullscreen].
If the window isn't yet mapped, the value returned will whether the initial requested state is fullscreen.
Retrieves the current maximized state of window.
Note that since maximization is ultimately handled by the window
manager and happens asynchronously to an application request, you
shouldn’t assume the return value of this function changing
immediately (or at all), as an effect of calling
[methodGtk.Window.maximize] or [methodGtk.Window.unmaximize].
If the window isn't yet mapped, the value returned will whether the initial requested state is maximized.
Returns the widget’s effective sensitivity.
This means it is sensitive itself and also its parent widget is sensitive.
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 [methodGtk.Widget.get_visible] and
[methodGtk.Widget.set_visible].
Emits the ::keynav-failed signal on the widget.
This function should be called whenever keyboard navigation within a single widget hits a boundary.
The return value of this function should be interpreted
in a way similar to the return value of
[methodGtk.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
[methodGtk.Widget.child_focus] on the widget’s toplevel.
The default [signalGtk.Widget::keynav-failed] handler returns
%FALSE for %GTK_DIR_TAB_FORWARD and %GTK_DIR_TAB_BACKWARD.
For the other values of GtkDirectionType it returns %TRUE.
Whenever the default handler returns %TRUE, it also calls
[methodGtk.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
[classGtk.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
Returns the widgets for which this widget is the target of a mnemonic.
Typically, these widgets will be labels. See, for example,
[methodGtk.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.
Causes a widget to be mapped if it isn’t already.
This function is only for use in widget implementations.
Asks to maximize window, so that it fills the screen.
Note that you shouldn’t assume the window is definitely maximized afterward, because other entities (e.g. the user or window manager could unmaximize it again, and not all window managers support maximization.
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 the result of this operation via the
[propertyGdk.Toplevel:state] property, or by listening to
notifications on the [propertyGtk.Window:maximized]
property.
Measures widget in the orientation orientation and for the given for_size.
As an example, if orientation is %GTK_ORIENTATION_HORIZONTAL and for_size
is 300, this functions will compute the minimum and natural width of widget
if it is allocated at a height of 300 pixels.
See GtkWidget’s geometry management section for
a more details on implementing GtkWidgetClass.measure().
the orientation to measure
Size for the opposite of orientation, i.e. if orientation is %GTK_ORIENTATION_HORIZONTAL, this is the height the widget should be measured with. The %GTK_ORIENTATION_VERTICAL case is analogous. This way, both height-for-width and width-for-height requests can be implemented. If no size is known, -1 can be passed.
Asks to minimize the specified window.
Note that you shouldn’t assume the window is definitely minimized afterward, because the windowing system might not support this functionality; other entities (e.g. the user or the window manager could unminimize it again, or there may not be a window manager in which case minimization isn’t possible, etc.
It’s permitted to call this function before showing a window, in which case the window will be minimized before it ever appears onscreen.
You can track result of this operation via the
[propertyGdk.Toplevel:state] property.
Emits the ::mnemonic-activate signal.
See [signalGtk.Widget::mnemonic-activate].
%TRUE if there are other widgets with the same mnemonic
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.:
enum
{
PROP_0,
PROP_FOO,
PROP_LAST
};
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
0, 100,
50,
G_PARAM_READWRITE);
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 #GParamSpec of a property installed on the class of object.
Returns a GListModel to track the children of widget.
Calling this function will enable extra internal bookkeeping to track children and emit signals on the returned listmodel. It may slow down operations a lot.
Applications should try hard to avoid calling this function because of the slowdowns.
Returns a GListModel to track the [classGtk.EventController]s
of widget.
Calling this function will enable extra internal bookkeeping to track controllers and emit signals on the returned listmodel. It may slow down operations a lot.
Applications should try hard to avoid calling this function because of the slowdowns.
Finds the descendant of widget closest to the point (x, y).
The point must be given in widget coordinates, so (0, 0) is assumed
to be the top left of widget's content area.
Usually widgets will return %NULL if the given coordinate is not
contained in widget checked via [methodGtk.Widget.contains].
Otherwise they will recursively try to find a child that does
not return %NULL. Widgets are however free to customize their
picking algorithm.
This function is used on the toplevel to determine the widget below the mouse cursor for purposes of hover highlighting and delivering events.
X coordinate to test, relative to widget's origin
Y coordinate to test, relative to widget's origin
Flags to influence what is picked
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, unminimizing 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 [methodGtk.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 [methodGtk.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
Flags the widget for a rerun of the [vfuncGtk.Widget.size_allocate]
function.
Use this function instead of [methodGtk.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 [methodGtk.Widget.set_halign].
This function is only for use in widget implementations.
Schedules this widget to be redrawn in the paint phase of the current or the next frame.
This means widget's [vfuncGtk.Widget.snapshot]
implementation will be called.
Flags a widget to have its size renegotiated.
This should be called when a widget for some reason has a new
size request. For example, when you change the text in a
[classGtk.Label], the 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 [vfuncGtk.Widget.size_allocate]
virtual method. Calls to gtk_widget_queue_resize() from inside
[vfuncGtk.Widget.size_allocate] will be silently ignored.
This function is only for use in widget implementations.
Creates the GDK resources associated with a widget.
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 this function 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
[signalGtk.Widget::realize].
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().
Removes controller from widget, so that it doesn't process
events anymore.
It should not be used again.
Widgets will remove all event controllers automatically when they are destroyed, there is normally no need to call this function.
a GtkEventController
Removes a style from widget.
After this, the style of widget will stop matching for css_class.
The style class to remove from widget, without the leading '.' used for notation of style classes
Removes a widget from the list of mnemonic labels for this widget.
See [methodGtk.Widget.list_mnemonic_labels]. The widget must
have previously been added to the list with
[methodGtk.Widget.add_mnemonic_label].
a GtkWidget that was previously set as a mnemonic label for widget with [methodGtk.Widget.add_mnemonic_label]
Removes a tick callback previously registered with gtk_widget_add_tick_callback().
an id returned by [methodGtk.Widget.add_tick_callback]
Resets the accessible property to its default value.
a GtkAccessibleProperty
Resets the accessible relation to its default value.
a GtkAccessibleRelation
Resets the accessible state to its default value.
a GtkAccessibleState
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Sets or unsets the GtkApplication 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 [methodGtk.Application.remove_window]
and/or [methodGtk.Application.add_window] on the old/new applications
as relevant.
a GtkApplication, or %NULL to unset
Specifies whether the input focus can enter the widget or any of its children.
Applications should set can_focus to %FALSE to mark a
widget as for pointer/touch use only.
Note that having can_focus be %TRUE is only one of the
necessary conditions for being focusable. A widget must
also be sensitive and focusable and not have an ancestor
that is marked as not can-focus in order to receive input
focus.
See [methodGtk.Widget.grab_focus] for actually setting
the input focus on a widget.
whether or not the input focus can enter the widget or any of its children
Sets whether widget can be the target of pointer events.
whether this widget should be able to receive pointer events
Sets whether widget should be mapped along with its parent.
The child visibility can be set for widget before it is added
to a container with [methodGtk.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 should never be called by an application.
if %TRUE, widget should be mapped along with its parent.
Clear all style classes applied to widget
and replace them with classes.
%NULL-terminated list of style classes to apply to widget.
Sets a named cursor to be shown when pointer devices point
towards widget.
This is a utility function that creates a cursor via
[ctorGdk.Cursor.new_from_name] and then sets it on widget
with [methodGtk.Widget.set_cursor]. See those functions for
details.
On top of that, this function allows name to be %NULL, which
will do the same as calling [methodGtk.Widget.set_cursor]
with a %NULL cursor.
The name of the cursor
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 #GQuark 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 #GQuark storage growing unbounded.
name of the key
data to associate with that key
Sets whether the window should be decorated.
By default, windows are decorated with a title bar, resize
controls, etc. Some window managers 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
[methodGtk.Widget.show].
On Windows, this function always works, since there’s no window manager policy involved.
%TRUE to decorate the window
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.
Unlike [methodGtk.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).
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
[methodGtk.Window.get_default_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
Sets whether the window should be deletable.
By default, windows have a close button in the window frame.
Some window managers 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 [methodGtk.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 are associated with, for example.
whether to destroy window with its transient parent
Sets the reading direction on a particular widget.
This direction controls the primary direction for widgets containing text, and also the direction in which the children of a container are packed. The ability to set the direction is present in order so that correct localization into languages with right-to-left reading directions can be done. Generally, applications will let the default reading direction present, except for containers where the containers are arranged in an order that is explicitly visual rather than logical (such as buttons for text justification).
If the direction is set to %GTK_TEXT_DIR_NONE, then the value
set by [funcGtk.Widget.set_default_direction] will be used.
the new direction
Sets the focus widget.
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 [methodGtk.Widget.grab_focus] instead of this function.
widget to be the new focus widget, or %NULL to unset any focus widget for the toplevel window.
Set child as the current focus child of widget.
This function is only suitable for widget implementations.
If you want a certain widget to get the input focus, call
[methodGtk.Widget.grab_focus] on it.
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 whether “focus rectangles” are supposed to be visible.
the new value
Specifies whether widget can own the input focus.
Widget implementations should set focusable to %TRUE in
their init() function if they want to receive keyboard input.
Note that having focusable be %TRUE is only one of the
necessary conditions for being focusable. A widget must
also be sensitive and can-focus and not have an ancestor
that is marked as not can-focus in order to receive input
focus.
See [methodGtk.Widget.grab_focus] for actually setting
the input focus on a widget.
whether or not widget can own the input focus
Sets the font map to use for Pango rendering.
The font map is the object that is used to look up fonts. Setting a custom font map can be useful in special situations, e.g. when you need to add application-specific fonts to the set of available fonts.
When not set, the widget will inherit the font map from its parent.
Sets the cairo_font_options_t used for Pango rendering
in this widget.
When not set, the default font options for the GdkDisplay
will be used.
a cairo_font_options_t to unset any previously set default font options
Sets whether this window should react to F10 key presses by activating a menubar it contains.
%TRUE to make window handle F10
Sets the has-tooltip property on widget to has_tooltip.
whether or not widget has a tooltip.
Sets whether the widget would like any available extra horizontal space.
When a user resizes a GtkWindow, widgets with expand=TRUE
generally receive the extra space. For example, a list or
scrollable area or document in your window would often be set to
expand.
Call this function to set the expand flag if you would like your widget to become larger horizontally when the window has extra room.
By default, widgets automatically expand if any of their children
want to expand. (To see if a widget will automatically expand given
its current children and state, call [methodGtk.Widget.compute_expand].
A container can decide how the expandability of children affects the
expansion of the container by overriding the compute_expand virtual
method on GtkWidget.).
Setting hexpand explicitly with this function will override the automatic expand behavior.
This function forces the widget to expand or not to expand,
regardless of children. The override occurs because
[methodGtk.Widget.set_hexpand] sets the hexpand-set property (see
[methodGtk.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 will be used.
The [propertyGtk.Widget:hexpand-set] property will be set
automatically when you call [methodGtk.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
If setting is %TRUE, then clicking the close button on the window
will not destroy it, but only hide it.
whether to hide the window when it is closed
Sets the icon for the window from a named themed icon.
See the docs for [classGtk.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.
the name of the themed icon
Sets the layout manager delegate instance that provides an
implementation for measuring and allocating the children of widget.
a GtkLayoutManager
Sets the bottom margin of widget.
the bottom margin
Sets the end margin of widget.
the end margin
Sets the start margin of widget.
the start margin
Sets the top margin of widget.
the top margin
Sets whether mnemonics are supposed to be visible.
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 [methodGtk.Window.set_transient_for] to make the dialog transient
for the parent; most window managers will then disallow lowering the
dialog below the parent.
whether the window is modal
Sets a widgets name.
Setting a name allows you to refer to the widget 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 [classGtk.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
Request the widget to be rendered partially transparent.
An opacity of 0 is fully transparent and an opacity of 1 is fully opaque.
Opacity works on both toplevel widgets and child widgets, although there are some limitations: For toplevel widgets, applying opacity depends on the capabilities of the windowing system. On X11, this has any effect only on X displays with a compositing manager, see gdk_display_is_composited(). On Windows and Wayland it should always work, although setting a window’s opacity after the window has been shown may cause some flicker.
Note that the opacity is inherited through inclusion — if you set
a toplevel to be partially translucent, all of its content will
appear translucent, since it is ultimatively rendered on that
toplevel. The opacity value itself is not inherited by child
widgets (since that would make widgets deeper in the hierarchy
progressively more translucent). As a consequence, [classGtk.Popover]s
and other [ifaceGtk.Native] widgets with their own surface will use their
own opacity value, and thus by default appear non-translucent,
even if they are attached to a toplevel that is translucent.
desired opacity, between 0 and 1
Sets how widget treats content that is drawn outside the
widget's content area.
See the definition of [enumGtk.Overflow] for details.
This setting is provided for widget implementations and should not be used by application code.
The default value is %GTK_OVERFLOW_VISIBLE.
desired overflow
Sets parent as the parent widget of widget.
This takes care of details such as updating the state and style
of the child to reflect its new location and resizing the parent.
The opposite function is [methodGtk.Widget.unparent].
This function is useful only when implementing subclasses of
GtkWidget.
Sets a property on an object.
the name of the property to set
the value
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.
whether or not widget can be a default widget.
Sets whether the user can resize a window.
Windows are user resizable by default.
%TRUE if the user can resize this window
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, [methodGtk.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.
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
properties
[propertyGtk.Widget:margin-start],
[propertyGtk.Widget:margin-end],
[propertyGtk.Widget:margin-top], and
[propertyGtk.Widget:margin-bottom], but it does include pretty
much all other padding or border properties set by any subclass
of GtkWidget.
width widget should request, or -1 to unset
height widget should request, or -1 to unset
Sets the startup notification ID.
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 GdkSurface.
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
[methodGtk.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
Turns on flag values in the current widget state.
Typical widget states are insensitive, prelighted, etc.
This function accepts the values %GTK_STATE_FLAG_DIR_LTR and
%GTK_STATE_FLAG_DIR_RTL but ignores them. If you want to set
the widget's direction, use [methodGtk.Widget.set_direction].
This function is for use in widget implementations.
State flags to turn on
Whether to clear state before turning on flags
Sets the title of the GtkWindow.
The title of a window will be displayed in its title bar; on the X Window System, the title bar is rendered by the window manager 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.
Passing %NULL does the same as setting the title to an empty string.
title of the window
Sets a custom titlebar for window.
A typical widget used here is [classGtk.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
[methodGtk.Widget.show].
Sets markup as the contents of the tooltip, which is marked
up with Pango markup.
This function will take care of setting the
[propertyGtk.Widget:has-tooltip] as a side effect, and of the
default handler for the [signalGtk.Widget::query-tooltip] signal.
See also [methodGtk.Tooltip.set_markup].
the contents of the tooltip for widget
Sets text as the contents of the tooltip.
If text contains any markup, it will be escaped.
This function will take care of setting
[propertyGtk.Widget:has-tooltip] as a side effect,
and of the default handler for the
[signalGtk.Widget::query-tooltip] signal.
See also [methodGtk.Tooltip.set_text].
the contents of the tooltip for widget
Dialog windows should be set transient for the main application
window they were spawned from. This allows window managers to e.g.
keep the dialog on top of the main window, or center the dialog
over the main window. [ctorGtk.Dialog.new_with_buttons] and other
convenience functions in GTK will sometimes call
gtk_window_set_transient_for() on your behalf.
Passing %NULL for parent unsets the current transient window.
On Windows, this function puts the child window on top of the parent, much as the window manager would have done on X.
Sets whether the widget would like any available extra vertical space.
See [methodGtk.Widget.set_hexpand] for more detail.
whether to expand
Sets whether the vexpand flag will be used.
See [methodGtk.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 [methodGtk.Widget.get_visible].
This function simply calls [methodGtk.Widget.show] or
[methodGtk.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
Returns whether widget should contribute to
the measuring and allocation of its parent.
This is %FALSE for invisible children, but also for children that have their own surface.
Flags a widget to be displayed.
Any widget that isn’t shown will not appear on the screen.
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.
Snapshot the a child of widget.
When a widget receives a call to the snapshot function,
it must send synthetic [vfuncGtk.Widget.snapshot] calls
to all children. This function provides a convenient way
of doing this. A widget, when it receives a call to its
[vfuncGtk.Widget.snapshot] function, calls
gtk_widget_snapshot_child() once for each child, passing in
the snapshot the widget received.
gtk_widget_snapshot_child() takes care of translating the origin of
snapshot, and deciding whether the child needs to be snapshot.
This function does nothing for children that implement GtkNative.
a child of widget
GtkSnapshot as passed to the widget. In particular, no calls to gtk_snapshot_translate() or other transform calls should have been made.
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
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 #GQuark, naming the user data pointer
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::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 widget must share a common ancestor.
a GtkWidget
X position relative to src_widget
Y position relative to src_widget
Triggers a tooltip query on the display where the toplevel
of widget is located.
Asks to remove the fullscreen state for window, and return to
its previous state.
Note that you shouldn’t assume the window is definitely not fullscreen afterward, because other entities (e.g. the user or window manager could fullscreen it again, and not all window managers honor requests to unfullscreen windows; normally the window will end up restored to its normal state. Just don’t write code that crashes if not.
You can track the result of this operation via the
[propertyGdk.Toplevel:state] property, or by listening to
notifications of the [propertyGtk.Window:fullscreened] property.
Causes a widget to be unmapped if it’s currently mapped.
This function is only for use in widget implementations.
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 maximize it again, and not all window managers honor requests to unmaximize.
You can track the result of this operation via the
[propertyGdk.Toplevel:state] property, or by listening to
notifications on the [propertyGtk.Window:maximized] property.
Asks to unminimize the specified window.
Note that you shouldn’t assume the window is definitely unminimized afterward, because the windowing system might not support this functionality; other entities (e.g. the user or the window manager could minimize it again, or there may not be a window manager in which case minimization isn’t possible, etc.
You can track result of this operation via the
[propertyGdk.Toplevel:state] property.
Dissociate widget from its parent.
This function is only for use in widget implementations, typically in dispose.
Causes a widget to be unrealized (frees all GDK resources associated with the widget).
This function is only useful in widget implementations.
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 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 instance. Use g_clear_object() for this.
Turns off flag values for the current widget state.
See [methodGtk.Widget.set_state_flags].
This function is for use in widget implementations.
State flags to turn off
Updates an array of accessible properties.
This function should be called by GtkWidget types whenever an accessible
property change must be communicated to assistive technologies.
This function is meant to be used by language bindings.
an array of GtkAccessibleProperty
an array of GValues, one for each property
Updates an array of accessible relations.
This function should be called by GtkWidget types whenever an accessible
relation change must be communicated to assistive technologies.
This function is meant to be used by language bindings.
an array of GtkAccessibleRelation
an array of GValues, one for each relation
Updates an array of accessible states.
This function should be called by GtkWidget types whenever an accessible
state change must be communicated to assistive technologies.
This function is meant to be used by language bindings.
an array of GtkAccessibleState
an array of GValues, one for each state
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.
#GClosure to watch
Obtains the current default reading direction.
See [funcGtk.Widget.set_default_direction].
Returns the fallback icon name for windows.
The returned string is owned by GTK and should not
be modified. It is only valid until the next call to
[funcGtk.Window.set_default_icon_name].
Find the #GParamSpec 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.
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 #GParamSpec, 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
#GTypeInfo.) 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 #GParamSpec for the new property
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
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.
Creates a new GtkWindow.
To get an undecorated window (no window borders), use
[methodGtk.Window.set_decorated].
All top-level windows created by gtk_window_new() are stored
in an internal top-level window list. This list can be obtained
from [funcGtk.Window.list_toplevels]. Due to GTK keeping a
reference to the window internally, gtk_window_new() does not
return a reference to the caller.
To delete a GtkWindow, call [methodGtk.Window.destroy].
Creates a new instance of a #GObject subtype and sets its properties.
Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.
the type id of the #GObject subtype to instantiate
an array of #GParameter
Sets whether the window should request startup notification.
By default, after showing the first GtkWindow, GTK calls
[methodGdk.Display.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
Sets the default reading direction for widgets.
See [methodGtk.Widget.set_direction].
the new default direction. This cannot be %GTK_TEXT_DIR_NONE.
Sets an icon to be used as fallback.
The fallback icon is used for windows that
haven't had [methodGtk.Window.set_icon_name]
called on them.
the name of the themed icon
Opens or closes the interactive debugger.
The debugger offers access to the widget hierarchy of the application and to useful debugging tools.
%TRUE to enable interactive debugging
A
GtkShortcutsWindowshows information about the keyboard shortcuts and gestures of an application.The shortcuts can be grouped, and you can have multiple sections in this window, corresponding to the major modes of your application.
Additionally, the shortcuts can be filtered by the current view, to avoid showing information that is not relevant in the current application context.
The recommended way to construct a
GtkShortcutsWindowis with [classGtk.Builder], by populating aGtkShortcutsWindowwith one or moreGtkShortcutsSectionobjects, which containGtkShortcutsGroupsthat in turn contain objects of classGtkShortcutsShortcut.A simple example:
This example has as single section. As you can see, the shortcut groups are arranged in columns, and spread across several pages if there are too many to find on a single page.
The .ui file for this example can be found here.
An example with multiple views:
This example shows a
GtkShortcutsWindowthat has been configured to show only the shortcuts relevant to the "stopwatch" view.The .ui file for this example can be found here.
An example with multiple sections:
This example shows a
GtkShortcutsWindowwith two sections, "Editor Shortcuts" and "Terminal Shortcuts".The .ui file for this example can be found here.