Gtk.Widget¶
- Subclasses:
Gtk.ActionBar,Gtk.AppChooserButton,Gtk.AppChooserWidget,Gtk.AspectFrame,Gtk.Box,Gtk.Button,Gtk.Calendar,Gtk.CellView,Gtk.CenterBox,Gtk.CheckButton,Gtk.ColorButton,Gtk.ColorChooserWidget,Gtk.ColorDialogButton,Gtk.ColumnView,Gtk.ComboBox,Gtk.DragIcon,Gtk.DrawingArea,Gtk.DropDown,Gtk.EditableLabel,Gtk.Entry,Gtk.Expander,Gtk.FileChooserWidget,Gtk.Fixed,Gtk.FlowBox,Gtk.FlowBoxChild,Gtk.FontButton,Gtk.FontChooserWidget,Gtk.FontDialogButton,Gtk.Frame,Gtk.GLArea,Gtk.GraphicsOffload,Gtk.Grid,Gtk.HeaderBar,Gtk.IconView,Gtk.Image,Gtk.InfoBar,Gtk.Inscription,Gtk.Label,Gtk.LevelBar,Gtk.ListBase,Gtk.ListBox,Gtk.ListBoxRow,Gtk.MediaControls,Gtk.MenuButton,Gtk.Notebook,Gtk.Overlay,Gtk.Paned,Gtk.PasswordEntry,Gtk.Picture,Gtk.Popover,Gtk.PopoverMenuBar,Gtk.ProgressBar,Gtk.Range,Gtk.Revealer,Gtk.ScaleButton,Gtk.Scrollbar,Gtk.ScrolledWindow,Gtk.SearchBar,Gtk.SearchEntry,Gtk.Separator,Gtk.ShortcutLabel,Gtk.ShortcutsShortcut,Gtk.SpinButton,Gtk.Spinner,Gtk.Stack,Gtk.StackSidebar,Gtk.StackSwitcher,Gtk.Statusbar,Gtk.Switch,Gtk.Text,Gtk.TextView,Gtk.TreeExpander,Gtk.TreeView,Gtk.Video,Gtk.Viewport,Gtk.Window,Gtk.WindowControls,Gtk.WindowHandle
Methods¶
- Inherited:
- Structs:
Virtual Methods¶
- Inherited:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Properties¶
- Inherited:
Name |
Type |
Flags |
Short Description |
|---|---|---|---|
r/w/en |
|||
r/w/en |
|||
[ |
r/w |
||
r/w/co |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/en |
|||
r/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w |
|||
r/w/en |
|||
r/w/en |
|||
r/en |
|||
r/w/en |
|||
r/en |
|||
r |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
|||
r/w/en |
Signals¶
- Inherited:
Name |
Short Description |
|---|---|
Signals that all holders of a reference to the widget should release the reference that they hold. |
|
Emitted when the text direction of a widget changes. |
|
Emitted when widget is hidden. |
|
Emitted if keyboard navigation fails. |
|
Emitted when widget is going to be mapped. |
|
Emitted when a widget is activated via a mnemonic. |
|
Emitted when the focus is moved. |
|
Emitted when the widget’s tooltip is about to be shown. |
|
Emitted when widget is associated with a |
|
Emitted when widget is shown. |
|
Emitted when the widget state changes. |
|
Emitted when widget is going to be unmapped. |
|
Emitted when the |
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
|---|---|---|---|
parent_instance |
r |
Class Details¶
- class Gtk.Widget(**kwargs)¶
- Bases:
GObject.InitiallyUnowned,Gtk.Accessible,Gtk.Buildable,Gtk.ConstraintTarget- Abstract:
Yes
- Structure:
The base class for all widgets.
It manages the widget lifecycle, layout, states and style.
### Height-for-width Geometry Management
GTK uses a height-for-width (and width-for-height) geometry management system. Height-for-width means that a widget can change how much vertical space it needs, depending on the amount of horizontal space that it is given (and similar for width-for-height). The most common example is a label that reflows to fill up the available width, wraps to fewer lines, and therefore needs less height.
Height-for-width geometry management is implemented in GTK by way of two virtual methods:
[vfunc`Gtk`.Widget.get_request_mode]
[vfunc`Gtk`.Widget.measure]
There are some important things to keep in mind when implementing height-for-width and when using it in widget implementations.
If you implement a direct
GtkWidgetsubclass that supports height-for-width or width-for-height geometry management for itself or its child widgets, the [vfunc`Gtk`.Widget.get_request_mode] virtual function must be implemented as well and return the widget’s preferred request mode. The default implementation of this virtual function returnsGtk.SizeRequestMode.CONSTANT_SIZE, which means that the widget will only ever get -1 passed as the for_size value to its [vfunc`Gtk`.Widget.measure] implementation.The geometry management system will query a widget hierarchy in only one orientation at a time. When widgets are initially queried for their minimum sizes it is generally done in two initial passes in the [enum`Gtk`.SizeRequestMode] chosen by the toplevel.
For example, when queried in the normal
Gtk.SizeRequestMode.HEIGHT_FOR_WIDTHmode:First, the default minimum and natural width for each widget in the interface will be computed using [method`Gtk`.Widget.measure] with an orientation of
Gtk.Orientation.HORIZONTALand a for_size of -1. Because the preferred widths for each widget depend on the preferred widths of their children, this information propagates up the hierarchy, and finally a minimum and natural width is determined for the entire toplevel. Next, the toplevel will use the minimum width to query for the minimum height contextual to that width using [method`Gtk`.Widget.measure] with an orientation ofGtk.Orientation.VERTICALand a for_size of the just computed width. This will also be a highly recursive operation. The minimum height for the minimum width is normally used to set the minimum size constraint on the toplevel.After the toplevel window has initially requested its size in both dimensions it can go on to allocate itself a reasonable size (or a size previously specified with [method`Gtk`.Window.set_default_size]). During the recursive allocation process it’s important to note that request cycles will be recursively executed while widgets allocate their children. Each widget, once allocated a size, will go on to first share the space in one orientation among its children and then request each child’s height for its target allocated width or its width for allocated height, depending. In this way a widget will typically be requested its size a number of times before actually being allocated a size. The size a widget is finally allocated can of course differ from the size it has requested. For this reason,
GtkWidgetcaches a small number of results to avoid re-querying for the same sizes in one allocation cycle.If a widget does move content around to intelligently use up the allocated size then it must support the request in both ``GtkSizeRequestMode``s even if the widget in question only trades sizes in a single orientation.
For instance, a [class`Gtk`.Label] that does height-for-width word wrapping will not expect to have [vfunc`Gtk`.Widget.measure] with an orientation of
Gtk.Orientation.VERTICALcalled because that call is specific to a width-for-height request. In this case the label must return the height required for its own minimum possible width. By following this rule any widget that handles height-for-width or width-for-height requests will always be allocated at least enough space to fit its own content.Here are some examples of how a
Gtk.SizeRequestMode.HEIGHT_FOR_WIDTHwidget generally deals with width-for-height requests:```c static void foo_widget_measure (
Gtk.Widget*widget,Gtk.Orientationorientation, int for_size, int *minimum_size, int *natural_size, int *minimum_baseline, int *natural_baseline) { if (orientation ==Gtk.Orientation.HORIZONTAL) { // Calculate minimum and natural width } else // VERTICAL { if (i_am_in_height_for_width_mode) { int min_width, dummy;// First, get the minimum width of our widget GTK_WIDGET_GET_CLASS (widget)->measure (widget,
Gtk.Orientation.HORIZONTAL, -1, &min_width, &dummy, &dummy, &dummy);// Now use the minimum width to retrieve the minimum and natural height to display // that width. GTK_WIDGET_GET_CLASS (widget)->measure (widget,
Gtk.Orientation.VERTICAL, min_width, minimum_size, natural_size, &dummy, &dummy); } else { // … some widgets do both. } } } ```Often a widget needs to get its own request during size request or allocation. For example, when computing height it may need to also compute width. Or when deciding how to use an allocation, the widget may need to know its natural size. In these cases, the widget should be careful to call its virtual methods directly, like in the code example above.
It will not work to use the wrapper function [method`Gtk`.Widget.measure] inside your own [vfunc`Gtk`.Widget.size_allocate] implementation. These return a request adjusted by [class`Gtk`.SizeGroup], the widget’s align and expand flags, as well as its CSS style.
If a widget used the wrappers inside its virtual method implementations, then the adjustments (such as widget margins) would be applied twice. GTK therefore does not allow this and will warn if you try to do it.
Of course if you are getting the size request for another widget, such as a child widget, you must use [method`Gtk`.Widget.measure]; otherwise, you would not properly consider widget margins, [class`Gtk`.SizeGroup], and so forth.
GTK also supports baseline vertical alignment of widgets. This means that widgets are positioned such that the typographical baseline of widgets in the same row are aligned. This happens if a widget supports baselines, has a vertical alignment using baselines, and is inside a widget that supports baselines and has a natural “row” that it aligns to the baseline, or a baseline assigned to it by the grandparent.
Baseline alignment support for a widget is also done by the [vfunc`Gtk`.Widget.measure] virtual function. It allows you to report both a minimum and natural size.
If a widget ends up baseline aligned it will be allocated all the space in the parent as if it was
Gtk.Align.FILL, but the selected baseline can be found via [method`Gtk`.Widget.get_baseline]. If the baseline has a value other than -1 you need to align the widget such that the baseline appears at the position.###
Gtk.WidgetasGtk.BuildableThe
GtkWidgetimplementation of theGtkBuildableinterface supports various custom elements to specify additional aspects of widgets that are not directly expressed as properties.If the widget uses a [class`Gtk`.LayoutManager],
GtkWidgetsupports a custom<layout>element, used to define layout properties:``xml <object class=”GtkGrid” id=”my_grid”>
- <child>
- <object class=”GtkLabel” id=”label1”>
<property name=”label”>Description</property> <layout>
<property name=”column”>0</property> <property name=”row”>0</property> <property name=”row-span”>1</property> <property name=”column-span”>1</property>
</layout>
</object>
</child> <child>
- <object class=”GtkEntry” id=”description_entry”>
- <layout>
<property name=”column”>1</property> <property name=”row”>0</property> <property name=”row-span”>1</property> <property name=”column-span”>1</property>
</layout>
</object>
</child>
</object> ``
GtkWidgetallows style information such as style classes to be associated with widgets, using the custom<style>element:``xml <object class=”GtkButton” id=”button1”>
- <style>
<class name=”my-special-button-class”/> <class name=”dark-button”/>
</style>
</object> ``
GtkWidgetallows defining accessibility information, such as properties, relations, and states, using the custom<accessibility>element:``xml <object class=”GtkButton” id=”button1”>
- <accessibility>
<property name=”label”>Download</property> <relation name=”labelled-by”>label1</relation>
</accessibility>
</object> ``
### Building composite widgets from template XML
``GtkWidget ``exposes some facilities to automate the procedure of creating composite widgets using “templates”.
To create composite widgets with
GtkBuilderXML, one must associate the interface description with the widget class at class initialization time using [method`Gtk`.WidgetClass.set_template].The interface description semantics expected in composite template descriptions is slightly different from regular [class`Gtk`.Builder] XML.
Unlike regular interface descriptions, [method`Gtk`.WidgetClass.set_template] will expect a
<template>tag as a direct child of the toplevel<interface>tag. The<template>tag must specify the “class” attribute which must be the type name of the widget. Optionally, the “parent” attribute may be specified to specify the direct parent type of the widget type; this is ignored byGtkBuilderbut can be used by UI design tools to introspect what kind of properties and internal children exist for a given type when the actual type does not exist.The XML which is contained inside the
<template>tag behaves as if it were added to the<object>tag defining the widget itself. You may set properties on a widget by inserting<property>tags into the<template>tag, and also add<child>tags to add children and extend a widget in the normal way you would with<object>tags.Additionally,
<object>tags can also be added before and after the initial<template>tag in the normal way, allowing one to define auxiliary objects which might be referenced by other widgets declared as children of the<template>tag.Since, unlike the
<object>tag, the<template>tag does not contain an “id” attribute, if you need to refer to the instance of the object itself that the template will create, simply refer to the template class name in an applicable element content.Here is an example of a template definition, which includes an example of this in the
<signal>tag:``xml <interface>
- <template class=”FooWidget” parent=”GtkBox”>
<property name=”orientation”>horizontal</property> <property name=”spacing”>4</property> <child>
- <object class=”GtkButton” id=”hello_button”>
<property name=”label”>Hello World</property> <signal name=”clicked” handler=”hello_button_clicked” object=”FooWidget” swapped=”yes”/>
</object>
</child> <child>
- <object class=”GtkButton” id=”goodbye_button”>
<property name=”label”>Goodbye World</property>
</object>
</child>
</template>
</interface> ``
Typically, you’ll place the template fragment into a file that is bundled with your project, using
GResource. In order to load the template, you need to call [method`Gtk`.WidgetClass.set_template_from_resource] from the class initialization of yourGtkWidgettype:```c static void foo_widget_class_init (FooWidgetClass *klass) { // …
Gtk.WidgetClass.set_template_from_resource(GTK_WIDGET_CLASS (klass), “/com/example/ui/foowidget.ui”); } ```You will also need to call [method`Gtk`.Widget.init_template] from the instance initialization function:
```c static void foo_widget_init (FooWidget *self) {
Gtk.Widget.init_template(GTK_WIDGET (self));// Initialize the rest of the widget… } ```
as well as calling [method`Gtk`.Widget.dispose_template] from the dispose function:
```c static void foo_widget_dispose (
GObject.Object*gobject) { FooWidget *self = FOO_WIDGET (gobject);// Dispose objects for which you have a reference…
// Clear the template children for this widget type
Gtk.Widget.dispose_template(GTK_WIDGET (self), FOO_TYPE_WIDGET);G_OBJECT_CLASS (foo_widget_parent_class)->dispose (gobject); } ```
You can access widgets defined in the template using the [method`Gtk`.Widget.get_template_child] function, but you will typically declare a pointer in the instance private data structure of your type using the same name as the widget in the template definition, and call [method`Gtk`.WidgetClass.bind_template_child_full] (or one of its wrapper macros [func`Gtk`.widget_class_bind_template_child] and [func`Gtk`.widget_class_bind_template_child_private]) with that name, e.g.
```c typedef struct {
Gtk.Widget*hello_button;Gtk.Widget*goodbye_button; } FooWidgetPrivate;G_DEFINE_TYPE_WITH_PRIVATE (FooWidget, foo_widget, GTK_TYPE_BOX)
static void foo_widget_dispose (
GObject.Object*gobject) {Gtk.Widget.dispose_template(GTK_WIDGET (gobject), FOO_TYPE_WIDGET);G_OBJECT_CLASS (foo_widget_parent_class)->dispose (gobject); }
static void foo_widget_class_init (FooWidgetClass *klass) { // … G_OBJECT_CLASS (klass)->dispose = foo_widget_dispose;
Gtk.WidgetClass.set_template_from_resource(GTK_WIDGET_CLASS (klass), “/com/example/ui/foowidget.ui”); gtk_widget_class_bind_template_child_private (GTK_WIDGET_CLASS (klass), FooWidget, hello_button); gtk_widget_class_bind_template_child_private (GTK_WIDGET_CLASS (klass), FooWidget, goodbye_button); }static void foo_widget_init (FooWidget *widget) {
Gtk.Widget.init_template(GTK_WIDGET (widget)); } ```You can also use [method`Gtk`.WidgetClass.bind_template_callback_full] (or is wrapper macro [func`Gtk`.widget_class_bind_template_callback]) to connect a signal callback defined in the template with a function visible in the scope of the class, e.g.
```c // the signal handler has the instance and user data swapped // because of the swapped=”yes” attribute in the template XML static void hello_button_clicked (FooWidget *self,
Gtk.Button*button) { g_print (“Hello, world!\n”); }static void foo_widget_class_init (FooWidgetClass *klass) { // …
Gtk.WidgetClass.set_template_from_resource(GTK_WIDGET_CLASS (klass), “/com/example/ui/foowidget.ui”); gtk_widget_class_bind_template_callback (GTK_WIDGET_CLASS (klass), hello_button_clicked); } ```- classmethod add_shortcut(shortcut)¶
- Parameters:
shortcut (
Gtk.Shortcut) – the shortcut to add
Installs a shortcut in self.
Every instance created for self or its subclasses will inherit this shortcut and trigger it.
Shortcuts added this way will be triggered in the [enum`Gtk`.PropagationPhase.bubble] phase, which means they may also trigger if child widgets have focus.
This function must only be used in class initialization functions otherwise it is not guaranteed that the shortcut will be installed.
- classmethod bind_template_callback_full(callback_name, callback_symbol)¶
- Parameters:
callback_name (
str) – name of the callback as expected in the template XMLcallback_symbol (
GObject.Callback) – the callback symbol
Associates a name to be used in
Gtk.BuilderXML with a symbol.This function is not supported after [method`Gtk`.WidgetClass.set_template_scope] has been used on self.
See [method`Gtk`.BuilderCScope.add_callback_symbol].
Note that this must be called from a composite widget classes class initializer after calling [method`Gtk`.WidgetClass.set_template].
- classmethod bind_template_child_full(name, internal_child, struct_offset)¶
- Parameters:
name (
str) – ID of the child defined in the template XMLinternal_child (
bool) – whether the child should be accessible as an “internal-child” when this class is used inGtk.BuilderXMLstruct_offset (
int) – The 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
Assigns an object declared in the class template XML to be set to a location on a freshly built instance’s private data, or alternatively accessible via [method`Gtk`.Widget.get_template_child].
The struct can point either into the public instance, then you should use
G_STRUCT_OFFSET(WidgetType, member)for struct_offset, or in the private struct, then you should useG_PRIVATE_OFFSET(WidgetType, member).An explicit strong reference will be held automatically for the duration of your instance’s life cycle, it will be released automatically when
GObjectClass.dispose()runs on your instance and if a nonzero struct_offset is specified, then the automatic location in your instance public or private data will be set toNULL. You can however access an automated child pointer the first time your classesGObjectClass.dispose()runs, or alternatively in [signal`Gtk`.Widget::destroy].If internal_child is specified, [vfunc`Gtk`.Buildable.get_internal_child] will be automatically implemented by the widget class so there is no need to implement it manually.
The wrapper macros [func`Gtk`.widget_class_bind_template_child], [func`Gtk`.widget_class_bind_template_child_internal], [func`Gtk`.widget_class_bind_template_child_private] and [func`Gtk`.widget_class_bind_template_child_internal_private] might be more convenient to use.
Note that this must be called from a composite widget classes class initializer after calling [method`Gtk`.WidgetClass.set_template].
- classmethod get_accessible_role()¶
- Returns:
the accessible role for the widget class
- Return type:
Retrieves the accessible role used by the given widget class.
Different accessible roles have different states, and are rendered differently by assistive technologies.
See also: [method`Gtk`.Accessible.get_accessible_role].
- classmethod get_activate_signal()¶
- Returns:
a signal id, or 0 if the widget class does not specify an activation signal
- Return type:
Retrieves the signal id for the activation signal.
The activation signal is set using [method`Gtk`.WidgetClass.set_activate_signal].
- classmethod get_css_name()[source]¶
- Returns:
the CSS name of the given class
- Return type:
Gets the name used by this class for matching in CSS code.
See [method`Gtk`.WidgetClass.set_css_name] for details.
- classmethod get_default_direction()[source]¶
- Returns:
the current default direction
- Return type:
Obtains the default reading direction.
See [func`Gtk`.Widget.set_default_direction].
- classmethod get_layout_manager_type()¶
- Returns:
type of a
GtkLayoutManagersubclass, orG_TYPE_INVALID- Return type:
Retrieves the type of the [class`Gtk`.LayoutManager] used by widgets of class self.
See also: [method`Gtk`.WidgetClass.set_layout_manager_type].
- classmethod install_action(action_name, parameter_type, activate)¶
- Parameters:
action_name (
str) – a prefixed action name, such as “clipboard.paste”activate (
Gtk.WidgetActionActivateFunc) – callback to use when the action is activated
Adds an action for all instances of a widget class.
This function should be called at class initialization time.
Actions installed by this function are stateless. The only state they have is whether they are enabled or not (which can be changed with [method`Gtk`.Widget.action_set_enabled]).
- classmethod install_property_action(action_name, property_name)¶
- Parameters:
Installs an action called action_name on self and binds its state to the value of the property_name property.
This function will perform a few sanity checks on the property selected via property_name. Namely, the property must exist, must be readable, writable and must not be construct-only. There are also restrictions on the type of the given property, it must be boolean, int, unsigned int, double or string. If any of these conditions are not met, a critical warning will be printed and no action will be added.
The state type of the action matches the property type.
If the property is boolean, the action will have no parameter and toggle the property value. Otherwise, the action will have a parameter of the same type as the property.
- classmethod query_action(index_)¶
- Parameters:
index (
int) – position of the action to query- Returns:
true if the action was found
- owner:
return location for the type where the action was defined
- action_name:
return location for the action name
- parameter_type:
return location for the parameter type
- property_name:
return location for the property name
- Return type:
(
bool, owner:GObject.GType, action_name:str, parameter_type:GLib.VariantTypeorNone, property_name:strorNone)
Returns details about an action that has been installed for self.
See [method`Gtk`.WidgetClass.install_action] for details on how to install actions.
Note that this function will also return actions defined by parent classes. You can identify those by looking at owner.
- classmethod set_accessible_role(accessible_role)¶
- Parameters:
accessible_role (
Gtk.AccessibleRole) – the accessible role to use
Sets the accessible role used by the given widget class.
Different accessible roles have different states, and are rendered differently by assistive technologies.
- classmethod set_activate_signal(signal_id)¶
- Parameters:
signal_id (
int) – the id for the activate signal
Sets the activation signal for a widget class.
The signal will be emitted when calling [method`Gtk`.Widget.activate].
The signal_id must have been registered with [function.GObject.signal_new] or [func`GObject`.signal_newv] before calling this function.
- classmethod set_activate_signal_from_name(signal_name)¶
- Parameters:
signal_name (
str) – the name of the activate signal of widget_type
Sets the activation signal for a widget class.
The signal id will by looked up by signal_name.
The signal will be emitted when calling [method`Gtk`.Widget.activate].
The signal_name must have been registered with [function.GObject.signal_new] or [func`GObject`.signal_newv] before calling this function.
- classmethod set_css_name(name)¶
- Parameters:
name (
str) – name to use
Sets the name to be used for CSS matching of widgets.
If this function is not called for a given class, the name set on the parent class is used. By default,
GtkWidgetuses the name “widget”.
- classmethod set_default_direction(dir)[source]¶
- Parameters:
dir (
Gtk.TextDirection) – the new default direction, either [enum`Gtk`.TextDirection.ltr] or [enum`Gtk`.TextDirection.rtl]
Sets the default reading direction for widgets.
See [method`Gtk`.Widget.set_direction].
- classmethod set_layout_manager_type(type)¶
- Parameters:
type (
GObject.GType) – the object type that implements theGtkLayoutManagerfor self
Sets the type to be used for creating layout managers for widgets of self.
The given type must be a subtype of [class`Gtk`.LayoutManager].
This function should only be called from class init functions of widgets.
- classmethod set_template(template_bytes)¶
- Parameters:
template_bytes (
GLib.Bytes) –GBytesholding theGtkBuilderXML
This should be called at class initialization time to specify the
GtkBuilderXML to be used to extend a widget.For convenience, [method`Gtk`.WidgetClass.set_template_from_resource] is also provided.
Note that any class that installs templates must call [method`Gtk`.Widget.init_template] in the widget’s instance initializer.
- classmethod set_template_from_resource(resource_name)¶
- Parameters:
resource_name (
str) – resource path to load the template from
A convenience function that calls [method`Gtk`.WidgetClass.set_template] with the contents of a resource.
Note that any class that installs templates must call [method`Gtk`.Widget.init_template] in the widget’s instance initializer.
- classmethod set_template_scope(scope)¶
- Parameters:
scope (
Gtk.BuilderScope) –GtkBuilderScopeto use when loading the class template
Overrides the default scope to be used when parsing the class template.
This function is intended for language bindings.
Note that this must be called from a composite widget classes class initializer after calling [method`Gtk`.WidgetClass.set_template].
- action_set_enabled(action_name, enabled)[source]¶
- Parameters:
Enables or disables an action installed with [method`Gtk`.WidgetClass.install_action].
- activate()[source]¶
- Returns:
true if the widget was activated
- Return type:
Activates the widget.
The activation will emit the signal set using [method`Gtk`.WidgetClass.set_activate_signal] during class initialization.
Activation is what happens when you press <kbd>Enter</kbd> on a widget.
If you wish to handle the activation keybinding yourself, it is recommended to use [method`Gtk`.WidgetClass.add_shortcut] with an action created with [ctor`Gtk`.SignalAction.new].
If self is not activatable, the function returns false.
- activate_action(name, args)[source]¶
- Parameters:
name (
str) – the name of the action to activateargs (
GLib.VariantorNone) – parameters to use
- Returns:
true if the action was activated
- Return type:
Activates an action for the widget.
The action is looked up in the action groups associated with self and its ancestors.
If the action is in an action group added with [method`Gtk`.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 [method`Gio`.Action.get_parameter_type].
- activate_default()[source]¶
Activates the
default.activateaction for the widget.The action is looked up in the same was as for [method`Gtk`.Widget.activate_action].
- add_controller(controller)[source]¶
- Parameters:
controller (
Gtk.EventController) – an event controller that hasn’t been added to a widget yet
Adds an event controller to the widget.
The event controllers of a widget handle the events that are propagated to the widget.
You will usually want to call this function right after creating any kind of [class`Gtk`.EventController].
- add_css_class(css_class)[source]¶
- Parameters:
css_class (
str) – style class to add to self, without the leading period
Adds a style class to the widget.
After calling this function, the widget’s style will match for css_class, according to CSS matching rules.
Use [method`Gtk`.Widget.remove_css_class] to remove the style again.
- add_mnemonic_label(label)[source]¶
- Parameters:
label (
Gtk.Widget) – a widget that acts as a mnemonic label for self
Adds a widget to the list of mnemonic labels for this widget.
See [method`Gtk`.Widget.list_mnemonic_labels].
Note that 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.
- add_tick_callback(callback, *user_data)[source]¶
- Parameters:
callback (
Gtk.TickCallback) – function to call for updating animations
- Returns:
an ID for this callback
- Return type:
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 label), then you will have to call [method`Gtk`.Widget.queue_resize] or [method`Gtk`.Widget.queue_draw] yourself.
[method`Gdk`.FrameClock.get_frame_time] should generally be used for timing continuous animations and [method`Gdk`.FrameTimings.get_predicted_presentation_time] should be used if you are trying to display isolated frames at particular times.
This is a more convenient alternative to connecting directly to the [signal`Gdk`.FrameClock::update] signal of the frame clock, since you don’t have to worry about when a frame clock is assigned to a widget.
To remove a tick callback, pass the ID that is returned by this function to [method`Gtk`.Widget.remove_tick_callback].
- allocate(width, height, baseline, transform)[source]¶
- Parameters:
width (
int) – new widthheight (
int) – new heightbaseline (
int) – new baseline, or -1transform (
Gsk.TransformorNone) – transformation to be applied
Assigns size, position, (optionally) a baseline and transform to a child widget.
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.
This function is only used by widget implementations.
For a version that does not take a transform, see [method`Gtk`.Widget.size_allocate].
- child_focus(direction)[source]¶
- Parameters:
direction (
Gtk.DirectionType) – direction of focus movement- Returns:
true if focus ended up inside self
- Return type:
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 [vfunc`Gtk`.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 normally call [method`Gtk`.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 [method`Gtk`.Widget.grab_focus] to move the focus to a particular widget.
- compute_bounds(target)[source]¶
- Parameters:
target (
Gtk.Widget) – the target widget- Returns:
true if the bounds could be computed
- out_bounds:
the rectangle taking the bounds
- Return type:
(
bool, out_bounds:Graphene.Rect)
Computes the bounds for self in the coordinate space of target.
The bounds of widget are (the bounding box of) the region that it is expected to draw in. See the coordinate system overview to learn more.
If the operation is successful, true is returned. If self 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 self and target to be the same widget.
- compute_expand(orientation)[source]¶
- Parameters:
orientation (
Gtk.Orientation) – expand direction- Returns:
whether widget tree rooted here should be expanded
- Return type:
Computes whether a parent widget should give this widget extra space when possible.
Widgets with children should check this, rather than looking at [method`Gtk`.Widget.get_hexpand] or [method`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.
- compute_point(target, point)[source]¶
- Parameters:
target (
Gtk.Widget) – the widget to transform intopoint (
Graphene.Point) – a point in self's coordinate system
- Returns:
true if src_widget and dest_widget have a common ancestor, false otherwise
- out_point:
set to the corresponding coordinates in target's coordinate system
- Return type:
(
bool, out_point:Graphene.Point)
Translates the given point in self's coordinates to coordinates in target’s coordinate system.
In order to perform this operation, both widgets must share a a common ancestor. If that is not the case, out_point is set to (0, 0) and false is returned.
- compute_transform(target)[source]¶
- Parameters:
target (
Gtk.Widget) – the target widget that the matrix will transform to- Returns:
true if the transform could be computed
- out_transform:
location to store the final transformation
- Return type:
(
bool, out_transform:Graphene.Matrix)
Computes a matrix suitable to describe a transformation from self's coordinate system into target's coordinate system.
The transform can not be computed in certain cases, for example when self and target do not share a common ancestor. In that case out_transform gets set to the identity matrix.
To learn more about widget coordinate systems, see the coordinate system overview.
- contains(x, y)[source]¶
- Parameters:
- Returns:
true if self contains the point (x, y)
- Return type:
Tests if a given point is contained in the widget.
The coordinates for (x, y) must be in widget coordinates, so (0, 0) is assumed to be the top left of self's content area.
- create_pango_context()[source]¶
- Returns:
the new
PangoContext- Return type:
Creates a new
PangoContextthat is configured for the widget.The
PangoContextwill have the appropriate font map, font options, font description, and base direction set.See also [method`Gtk`.Widget.get_pango_context].
- create_pango_layout(text)[source]¶
- Parameters:
- Returns:
the new
PangoLayout- Return type:
Creates a new
PangoLayoutthat is configured for the widget.The
PangoLayoutwill have the appropriate font map, font description, and base direction set.If you keep a
PangoLayoutcreated in this way around, you need to re-create it when the widgetsPangoContextis replaced. This can be tracked by listening to changes of the [property`Gtk`.Widget:root] property on the widget.
- dispose_template(widget_type)[source]¶
- Parameters:
widget_type (
GObject.GType) – the type of the widget to finalize the template for
Clears the template children for the widget.
This function is the opposite of [method`Gtk`.Widget.init_template], and it is used to clear all the template children from a widget instance. If you bound a template child to a field in the instance structure, or in the instance private data structure, the field will be set to
NULLafter this function returns.You should call this function inside the
GObjectClass.dispose()implementation of any widget that called [method`Gtk`.Widget.init_template]. Typically, you will want to call this function last, right before chaining up to the parent type’s dispose implementation, e.g.```c static void some_widget_dispose (
GObject.Object*gobject) { SomeWidget *self = SOME_WIDGET (gobject);// Clear the template data for SomeWidget
Gtk.Widget.dispose_template(GTK_WIDGET (self), SOME_TYPE_WIDGET);G_OBJECT_CLASS (some_widget_parent_class)->dispose (gobject); } ```
New in version 4.8.
- drag_check_threshold(start_x, start_y, current_x, current_y)[source]¶
- Parameters:
- Returns:
true if the drag threshold has been passed
- Return type:
Checks to see if a drag movement has passed the GTK drag threshold.
- error_bell()[source]¶
Notifies the user about an input-related error on the widget.
If the [property`Gtk`.Settings:gtk-error-bell] setting is true, it calls [method`Gdk`.Surface.beep], otherwise it does nothing.
Note that the effect of [method`Gdk`.Surface.beep] can be configured in many ways, depending on the windowing backend and the desktop environment or window manager that is used.
- get_allocated_baseline()[source]¶
- Returns:
the baseline of the self, or -1 if none
- Return type:
Returns the baseline that has currently been allocated to the widget.
This function is intended to be used when implementing handlers for the ``GtkWidget``Class.snapshot() function, and when allocating child widgets in ``GtkWidget``Class.size_allocate().
Deprecated since version 4.12: Use [method`Gtk`.Widget.get_baseline] instead
- get_allocated_height()[source]¶
- Returns:
the height of the self
- Return type:
Returns the height that has currently been allocated to the widget.
To learn more about widget sizes, see the coordinate system overview.
Deprecated since version 4.12: Use [method`Gtk`.Widget.get_height] instead
- get_allocated_width()[source]¶
- Returns:
the width of the self
- Return type:
Returns the width that has currently been allocated to the widget.
To learn more about widget sizes, see the coordinate system overview.
Deprecated since version 4.12: Use [method`Gtk`.Widget.get_width] instead
- get_allocation()[source]¶
- Returns:
a pointer to a
GtkAllocationto copy to- Return type:
allocation:
Gdk.Rectangle
Retrieves the widget’s allocation.
Note, when implementing a layout widget: a widget’s allocation will be its “adjusted” allocation, that is, the widget’s parent typically calls [method`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. [method`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 [method`Gtk`.Widget.size_allocate] allocation, however.
So a layout widget is guaranteed that its children stay inside the assigned bounds, but not that they have exactly the bounds the widget assigned.
Deprecated since version 4.12: Use [method`Gtk`.Widget.compute_bounds], [method`Gtk`.Widget.get_width] or [method`Gtk`.Widget.get_height] instead.
- get_ancestor(widget_type)[source]¶
- Parameters:
widget_type (
GObject.GType) – ancestor type- Returns:
the ancestor widget
- Return type:
Gtk.WidgetorNone
Gets the first ancestor of the widget with type widget_type.
For example,
gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)gets the firstGtkBoxthat’s an ancestor of self. No reference will be added to the returned widget; it should not be unreferenced.Note that unlike [method`Gtk`.Widget.is_ancestor], this function considers self to be an ancestor of itself.
- get_baseline()[source]¶
- Returns:
the baseline of the self, or -1 if none
- Return type:
Returns the baseline that has currently been allocated to the widget.
This function is intended to be used when implementing handlers for the
GtkWidgetClass.snapshot()function, and when allocating child widgets inGtkWidgetClass.size_allocate().New in version 4.12.
- get_can_focus()[source]¶
- Returns:
true if the input focus can enter self
- Return type:
Determines whether the input focus can enter the widget or any of its children.
See [method`Gtk`.Widget.set_can_focus].
- get_can_target()[source]¶
- Returns:
true if self can receive pointer events
- Return type:
Queries whether the widget can be the target of pointer events.
- get_child_visible()[source]¶
- Returns:
true if the widget is mapped with the parent
- Return type:
Gets the value set with [method`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 widget implementations and should never be called by an application.
- get_clipboard()[source]¶
- Returns:
the appropriate clipboard object
- Return type:
Gets the clipboard object for the widget.
This is a utility function to get the clipboard object for the display that self is using.
Note that this function always works, even when self is not realized yet.
- get_color()[source]¶
- Returns:
return location for the color
- Return type:
color:
Gdk.RGBA
Gets the current foreground color for the widget’s style.
This function should only be used in snapshot implementations that need to do custom drawing with the foreground color.
New in version 4.10.
- get_css_classes()[source]¶
- Returns:
a
NULL-terminated list of css classes currently applied to self- Return type:
[
str]
Returns the list of style classes applied to the widget.
- get_cursor()[source]¶
- Returns:
the cursor that is set on self
- Return type:
Gdk.CursororNone
Gets the cursor set on the widget.
See [method`Gtk`.Widget.set_cursor] for details.
- get_direction()[source]¶
- Returns:
the reading direction for the widget
- Return type:
Gets the reading direction for the widget.
See [method`Gtk`.Widget.set_direction].
- get_display()[source]¶
- Returns:
the display for this widget
- Return type:
Get the display for the window that the widget belongs to.
This function can only be called after the widget has been added to a widget hierarchy with a
GtkRootat 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.
- get_first_child()[source]¶
- Returns:
the widget’s first child
- Return type:
Gtk.WidgetorNone
Returns the widget’s first child.
This function is primarily meant for widget implementations.
- get_focus_child()[source]¶
- Returns:
the current focus child of self
- Return type:
Gtk.WidgetorNone
Returns the focus child of the widget.
- get_focus_on_click()[source]¶
- Returns:
true if the widget should grab focus when it is clicked with the mouse
- Return type:
Returns whether the widget should grab focus when it is clicked with the mouse.
See [method`Gtk`.Widget.set_focus_on_click].
- get_focusable()[source]¶
- Returns:
true if self can own the input focus
- Return type:
Determines whether the widget can own the input focus.
See [method`Gtk`.Widget.set_focusable].
- get_font_map()[source]¶
- Returns:
the font map of self
- Return type:
Gets the font map of the widget.
See [method`Gtk`.Widget.set_font_map].
- get_font_options()[source]¶
- Returns:
the
cairo_font_options_tof widget- Return type:
Returns the
cairo_font_options_tof the widget.Seee [method`Gtk`.Widget.set_font_options].
Deprecated since version 4.16.
- get_frame_clock()[source]¶
- Returns:
the frame clock
- Return type:
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 [method`Gdk`.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 [method`Gdk`.FrameClock.get_frame_time], and then update the animation by calling [method`Gdk`.FrameClock.get_frame_time] again during each repaint.
[method`Gdk`.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 [method`Gtk`.Widget.queue_draw] which invalidates the widget (thus scheduling it to receive a draw on the next frame). [method`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.
- get_halign()[source]¶
- Returns:
the horizontal alignment of self
- Return type:
Gets the horizontal alignment of the widget.
For backwards compatibility reasons this method will never return one of the baseline alignments, but instead it will convert it to [enum`Gtk`.Align.fill] or [enum`Gtk`.Align.center].
Baselines are not supported for horizontal alignment.
- get_has_tooltip()[source]¶
- Returns:
current value of
has-tooltipon self- Return type:
Returns the current value of the
has-tooltipproperty.
- get_height()[source]¶
- Returns:
The height of self
- Return type:
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 [vfunc`Gtk`.Widget.snapshot].
For pointer events, see [method`Gtk`.Widget.contains].
To learn more about widget sizes, see the coordinate system overview.
- get_hexpand()[source]¶
- Returns:
whether hexpand flag is set
- Return type:
Gets whether the widget would like any available extra horizontal space.
When a user resizes a window, widgets with expand set to true generally receive the extra space. For example, a list or scrollable area or document in your window would often be set to expand.
Widgets with children should use [method`Gtk`.Widget.compute_expand] rather than this function, to see whether 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.
- get_hexpand_set()[source]¶
- Returns:
whether hexpand has been explicitly set
- Return type:
Gets whether the
hexpandflag has been explicitly set.If [property`Gtk`.Widget:hexpand] property is set, then it overrides any computed expand value based on child widgets. If
hexpandis 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.
- get_last_child()[source]¶
- Returns:
the widget’s last child
- Return type:
Gtk.WidgetorNone
Returns the widget’s last child.
This function is primarily meant for widget implementations.
- get_layout_manager()[source]¶
- Returns:
the layout manager of self
- Return type:
Retrieves the layout manager of the widget.
See [method`Gtk`.Widget.set_layout_manager].
- get_limit_events()[source]¶
- Return type:
Gets the value of the [property`Gtk`.Widget:limit-events] property.
New in version 4.18.
- get_mapped()[source]¶
- Returns:
true if the widget is mapped
- Return type:
Returns whether the widget is mapped.
- get_margin_bottom()[source]¶
- Returns:
The bottom margin of self
- Return type:
Gets the bottom margin of the widget.
- get_margin_end()[source]¶
- Returns:
The end margin of self
- Return type:
Gets the end margin of the widget.
- get_margin_start()[source]¶
- Returns:
The start margin of self
- Return type:
Gets the start margin of the widget.
- get_margin_top()[source]¶
- Returns:
The top margin of self
- Return type:
Gets the top margin of the widget.
- get_name()[source]¶
- Returns:
name of the widget
- Return type:
Retrieves the name of a widget.
See [method`Gtk`.Widget.set_name] for the significance of widget names.
- get_native()[source]¶
- Returns:
the
GtkNativeancestor of self- Return type:
Gtk.NativeorNone
Returns the nearest
GtkNativeancestor of the widget.This function will return
NULLif the widget is not contained inside a widget tree with a native ancestor.GtkNativewidgets will return themselves here.
- get_next_sibling()[source]¶
- Returns:
the widget’s next sibling
- Return type:
Gtk.WidgetorNone
Returns the widget’s next sibling.
This function is primarily meant for widget implementations.
- get_opacity()[source]¶
- Returns:
the requested opacity for this widget
- Return type:
Fetches the requested opacity for the widget.
See [method`Gtk`.Widget.set_opacity].
- get_overflow()[source]¶
- Returns:
The widget’s overflow value
- Return type:
Returns the widget’s overflow value.
- get_pango_context()[source]¶
- Returns:
the
PangoContextfor the widget- Return type:
Gets a
PangoContextthat is configured for the widget.The
PangoContextwill have the appropriate font map, font description, and base direction set.Unlike the context returned by [method`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 listening to changes of the [property`Gtk`.Widget:root] property on the widget.
- get_parent()[source]¶
- Returns:
the parent widget of self
- Return type:
Gtk.WidgetorNone
Returns the parent widget of the widget.
- get_preferred_size()[source]¶
- Returns:
- minimum_size:
location for storing the minimum size
- natural_size:
location for storing the natural size
- Return type:
(minimum_size:
Gtk.Requisition, natural_size:Gtk.Requisition)
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 [method`Gtk`.Widget.measure] if you want to support baseline alignment.
- get_prev_sibling()[source]¶
- Returns:
the widget’s previous sibling
- Return type:
Gtk.WidgetorNone
Returns the widget’s previous sibling.
This function is primarily meant for widget implementations.
- get_primary_clipboard()[source]¶
- Returns:
the appropriate clipboard object
- Return type:
Gets the primary clipboard of the widget.
This is a utility function to get the primary clipboard object for the display that self is using.
Note that this function always works, even when self is not realized yet.
- get_realized()[source]¶
- Returns:
true if self is realized
- Return type:
Determines whether the widget is realized.
- get_receives_default()[source]¶
- Returns:
true if self acts as the default widget when focused
- Return type:
Determines whether the widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default.
See [method`Gtk`.Widget.set_receives_default].
- get_request_mode()[source]¶
- Returns:
The
GtkSizeRequestModepreferred by self.- Return type:
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.
- get_root()[source]¶
-
Returns the
GtkRootwidget of the widget.This function will return
NULLif the widget is not contained inside a widget tree with a root widget.GtkRootwidgets will return themselves here.
- get_scale_factor()[source]¶
- Returns:
the scale factor for self
- Return type:
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 [method`Gdk`.Surface.get_scale_factor].
Note that modern systems may support *fractional* scaling, where the scale factor is not an integer. On such systems, this function will return the next higher integer value, but you probably want to use [method`Gdk`.Surface.get_scale] to get the fractional scale value.
- get_sensitive()[source]¶
- Returns:
true if the widget is sensitive
- Return type:
Returns the widget’s sensitivity.
This function returns the value that has been set using [method`Gtk`.Widget.set_sensitive]).
The effective sensitivity of a widget is however determined by both its own and its parent widget’s sensitivity. See [method`Gtk`.Widget.is_sensitive].
- get_settings()[source]¶
- Returns:
the relevant settings object
- Return type:
Gets the settings object holding the settings used for the widget.
Note that this function can only be called when the
GtkWidgetis attached to a toplevel, since the settings object is specific to a particular display. If you want to monitor the widget for changes in its settings, connect to thenotify::displaysignal.
- get_size(orientation)[source]¶
- Parameters:
orientation (
Gtk.Orientation) – the orientation to query- Returns:
the size of self in orientation
- Return type:
Returns the content width or height of the widget.
Which dimension is returned depends on orientation.
This is equivalent to calling [method`Gtk`.Widget.get_width] for [enum`Gtk`.Orientation.horizontal] or [method`Gtk`.Widget.get_height] for [enum`Gtk`.Orientation.vertical], but can be used when writing orientation-independent code, such as when implementing [iface`Gtk`.Orientable] widgets.
To learn more about widget sizes, see the coordinate system overview.
- get_size_request()[source]¶
- Returns:
- width:
return location for width
- height:
return location for height
- Return type:
Gets the size request that was explicitly set for the widget.
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 [method`Gtk`.Widget.set_size_request].
To get the size a widget will actually request, call [method`Gtk`.Widget.measure] instead of this function.
- get_state_flags()[source]¶
- Returns:
the state flags of widget
- Return type:
Returns the widget state as a flag set.
It is worth mentioning that the effective [flags`Gtk`.StateFlags.insensitive] state will be returned, that is, also based on parent insensitivity, even if self itself is sensitive.
Also note that if you are looking for a way to obtain the [flags`Gtk`.StateFlags] to pass to a [class`Gtk`.StyleContext] method, you should look at [method`Gtk`.StyleContext.get_state].
- get_style_context()[source]¶
- Returns:
the widgets style context
- Return type:
Returns the style context associated to the widget.
The returned object is guaranteed to be the same for the lifetime of self.
Deprecated since version 4.10: Style contexts will be removed in GTK 5
- get_template_child(widget_type, name)[source]¶
- Parameters:
widget_type (
GObject.GType) – TheGTypeto get a template child forname (
str) – ID of the child defined in the template XML
- Returns:
the object built in the template XML with the id name
- Return type:
Fetches an object build from the template XML for widget_type in the widget.
This will only report children which were previously declared with [method`Gtk`.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.Objectstructure offsets.
- get_tooltip_markup()[source]¶
-
Gets the contents of the tooltip for the widget.
If the tooltip has not been set using [method`Gtk`.Widget.set_tooltip_markup], this function returns
NULL.
- get_tooltip_text()[source]¶
-
Gets the contents of the tooltip for the widget.
If the self's tooltip was set using [method`Gtk`.Widget.set_tooltip_markup], this function will return the escaped text.
- get_valign()[source]¶
- Returns:
the vertical alignment of self
- Return type:
Gets the vertical alignment of the widget.
- get_vexpand()[source]¶
- Returns:
whether vexpand flag is set
- Return type:
Gets whether the widget would like any available extra vertical space.
See [method`Gtk`.Widget.get_hexpand] for more detail.
- get_vexpand_set()[source]¶
- Returns:
whether vexpand has been explicitly set
- Return type:
Gets whether the
vexpandflag has been explicitly set.See [method`Gtk`.Widget.get_hexpand_set] for more detail.
- get_visible()[source]¶
- Returns:
true if the widget is visible
- Return type:
Determines whether the widget is visible.
If you want to take into account whether the widget’s parent is also marked as visible, use [method`Gtk`.Widget.is_visible] instead.
This function does not check if the widget is obscured in any way.
See [method`Gtk`.Widget.set_visible].
- get_width()[source]¶
- Returns:
The width of self
- Return type:
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 [vfunc`Gtk`.Widget.snapshot].
For pointer events, see [method`Gtk`.Widget.contains].
To learn more about widget sizes, see the coordinate system overview.
- grab_focus()[source]¶
- Returns:
true if focus is now inside self
- Return type:
Causes self to have the keyboard focus for the window that it belongs to.
If self is not focusable, or its [vfunc`Gtk`.Widget.grab_focus] implementation cannot transfer the focus to a descendant of self that is focusable, it will not take focus and false will be returned.
Calling [method`Gtk`.Widget.grab_focus] on an already focused widget is allowed, should not have an effect, and return true.
- has_css_class(css_class)[source]¶
- Parameters:
css_class (
str) – style class, without the leading period- Returns:
true if css_class is currently applied to self
- Return type:
Returns whether a style class is currently applied to the widget.
- has_default()[source]¶
- Returns:
true if self is the current default widget within its toplevel
- Return type:
Determines whether the widget is the current default widget within its toplevel.
- has_focus()[source]¶
- Returns:
true if the widget has the global input focus
- Return type:
Determines if the widget has the global input focus.
See [method`Gtk`.Widget.is_focus] for the difference between having the global input focus, and only having the focus within a toplevel.
- has_visible_focus()[source]¶
- Returns:
true if the widget should display a “focus rectangle”
- Return type:
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 self. See [method`Gtk`.Window.get_focus_visible] for more information about focus indication.
To find out if the widget has the global input focus, use [method`Gtk`.Widget.has_focus].
- hide()[source]¶
Reverses the effects of [method.Gtk.Widget.show].
This is causing the widget to be hidden (invisible to the user).
Deprecated since version 4.10: Use [method`Gtk`.Widget.set_visible] instead
- in_destruction()[source]¶
- Returns:
true if self is being destroyed
- Return type:
Returns whether the widget is currently being destroyed.
This information can sometimes be used to avoid doing unnecessary work.
- init_template()[source]¶
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 [method`Gtk`.WidgetClass.set_template].
It is important to call this function in the instance initializer of a widget subclass and not in
GObject.constructed()orGObject.constructor()for two reasons:derived widgets will assume that the composite widgets defined by its parent classes have been created in their relative instance initializers
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 tog_object_new()should take precedence over properties set in the private template XML
A good rule of thumb is to call this function as the first thing in an instance initialization function.
- insert_action_group(name, group)[source]¶
- Parameters:
name (
str) – the prefix for actions in groupgroup (
Gio.ActionGrouporNone) – an action group
Inserts an action group into the widget’s actions.
Children of self that implement [iface`Gtk`.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 self.
- insert_after(parent, previous_sibling)[source]¶
- Parameters:
parent (
Gtk.Widget) – the parent widget to insert self intoprevious_sibling (
Gtk.WidgetorNone) – the new previous sibling of self
Sets the parent widget of the widget.
In contrast to [method`Gtk`.Widget.set_parent], this function inserts self at a specific position into the list of children of the parent widget.
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 self, this function can also be used to reorder self in the child widget list of parent.
This function is primarily meant for widget implementations; if you are just using a widget, you *must* use its own API for adding children.
- insert_before(parent, next_sibling)[source]¶
- Parameters:
parent (
Gtk.Widget) – the parent widget to insert self intonext_sibling (
Gtk.WidgetorNone) – the new next sibling of self
Sets the parent widget of the widget.
In contrast to [method`Gtk`.Widget.set_parent], this function inserts self at a specific position into the list of children of the parent widget.
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 self, this function can also be used to reorder self in the child widget list of parent.
This function is primarily meant for widget implementations; if you are just using a widget, you *must* use its own API for adding children.
- is_ancestor(ancestor)[source]¶
- Parameters:
ancestor (
Gtk.Widget) – anotherGtkWidget- Returns:
true if ancestor contains self as a child, grandchild, great grandchild, etc
- Return type:
Determines whether the widget is a descendent of ancestor.
- is_drawable()[source]¶
- Returns:
true if self is drawable
- Return type:
Determines whether the widget can be drawn to.
A widget can be drawn if it is mapped and visible.
- is_focus()[source]¶
- Returns:
true if the widget is the focus widget
- Return type:
Determines if the widget is the focus widget within its toplevel.
This does not mean that the [property`Gtk`.Widget:has-focus] property is necessarily set; [property`Gtk`.Widget:has-focus] will only be set if the toplevel widget additionally has the global input focus.
- is_sensitive()[source]¶
- Returns:
true if the widget is effectively sensitive
- Return type:
Returns the widget’s effective sensitivity.
This means it is sensitive itself and also its parent widget is sensitive.
- is_visible()[source]¶
- Returns:
true if the widget and all its parents are visible
- Return type:
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 [method`Gtk`.Widget.get_visible] and [method`Gtk`.Widget.set_visible].
- Parameters:
direction (
Gtk.DirectionType) – direction of focus movement- Returns:
true if stopping keyboard navigation is fine, false if the emitting widget should try to handle the keyboard navigation attempt in its parent widget
- Return type:
Emits the [signal`Gtk`.Widget::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 [method`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 [method`Gtk`.Widget.child_focus] on the widget’s toplevel.
The default [signal`Gtk`.Widget::keynav-failed] handler returns false for [enum`Gtk`.DirectionType.tab-forward] and [enum`Gtk`.DirectionType.tab-backward]. For the other values of [enum`Gtk`.DirectionType] it returns true.
Whenever the default handler returns true, it also calls [method`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 [class`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.
- list_mnemonic_labels()[source]¶
- Returns:
the list of mnemonic labels
- Return type:
Returns the widgets for which this widget is the target of a mnemonic.
Typically, these widgets will be labels. See, for example, [method`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.
- map()[source]¶
Causes a widget to be mapped if it isn’t already.
This function is only for use in widget implementations.
- measure(orientation, for_size)[source]¶
- Parameters:
orientation (
Gtk.Orientation) – the orientation to measurefor_size (
int) – Size for the opposite of orientation, i.e. if orientation isGtk.Orientation.HORIZONTAL, this is the height the widget should be measured with. TheGtk.Orientation.VERTICALcase 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.
- Returns:
- minimum:
location to store the minimum size
- natural:
location to store the natural size
- minimum_baseline:
location to store the baseline position for the minimum size, or -1 to report no baseline
- natural_baseline:
location to store the baseline position for the natural size, or -1 to report no baseline
- Return type:
(minimum:
int, natural:int, minimum_baseline:int, natural_baseline:int)
Measures self in the orientation orientation and for the given for_size.
As an example, if orientation is
Gtk.Orientation.HORIZONTALand for_size is 300, this functions will compute the minimum and natural width of self if it is allocated at a height of 300 pixels.See GtkWidget’s geometry management section for a more details on implementing
GtkWidgetClass.measure().
- mnemonic_activate(group_cycling)[source]¶
- Parameters:
group_cycling (
bool) – true if there are other widgets with the same mnemonic- Returns:
true if the signal has been handled
- Return type:
Emits the [signal`Gtk`.Widget::mnemonic-activate] signal.
- observe_children()[source]¶
- Returns:
a list model tracking self's children
- Return type:
Returns a list model to track the children of the 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.
- observe_controllers()[source]¶
- Returns:
a list model tracking self's controllers
- Return type:
Returns a list model to track the event controllers of the 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.
- pick(x, y, flags)[source]¶
- Parameters:
x (
float) – x coordinate to test, relative to self's originy (
float) – y coordinate to test, relative to self's originflags (
Gtk.PickFlags) – flags to influence what is picked
- Returns:
the widget’s descendant at (x, y)
- Return type:
Gtk.WidgetorNone
Finds the descendant of the widget closest to a point.
The point (x, y) must be given in widget coordinates, so (0, 0) is assumed to be the top left of self's content area.
Usually widgets will return
NULLif the given coordinate is not contained in self checked via [method`Gtk`.Widget.contains]. Otherwise they will recursively try to find a child that does not returnNULL. 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.
- queue_allocate()[source]¶
Flags the widget for a rerun of the [vfunc`Gtk`.Widget.size_allocate] function.
Use this function instead of [method`Gtk`.Widget.queue_resize] when the self's size request didn’t change but it wants to reposition its contents.
An example user of this function is [method`Gtk`.Widget.set_halign].
This function is only for use in widget implementations.
- queue_draw()[source]¶
Schedules this widget to be redrawn.
The redraw will happen in the paint phase of the current or the next frame.
This means self's [vfunc`Gtk`.Widget.snapshot] implementation will be called.
- queue_resize()[source]¶
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 [class`Gtk`.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 [vfunc`Gtk`.Widget.size_allocate] virtual method. Calls toGtk.Widget.queue_resize() from inside [vfunc`Gtk`.Widget.size_allocate] will be silently ignored.This function is only for use in widget implementations.
- realize()[source]¶
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 self 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 [signal`Gtk`.Widget::realize].
- remove_controller(controller)[source]¶
- Parameters:
controller (
Gtk.EventController) – an event controller
Removes an event controller from the widget.
The removed event controller will not receive any more events, and 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.
- remove_css_class(css_class)[source]¶
- Parameters:
css_class (
str) – style class to remove from self, without the leading period
Removes a style from the widget.
After this, the style of self will stop matching for css_class.
- remove_mnemonic_label(label)[source]¶
- Parameters:
label (
Gtk.Widget) – a widget that is a mnemonic label for self
Removes a widget from the list of mnemonic labels for this widget.
See [method`Gtk`.Widget.list_mnemonic_labels].
The widget must have previously been added to the list with [method`Gtk`.Widget.add_mnemonic_label].
- remove_tick_callback(id)[source]¶
- Parameters:
id (
int) – an ID returned by [method`Gtk`.Widget.add_tick_callback]
Removes a tick callback previously registered with [method`Gtk`.Widget.add_tick_callback].
- set_can_focus(can_focus)[source]¶
- Parameters:
can_focus (
bool) – whether the input focus can enter the widget or any of its children
Sets 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 [method`Gtk`.Widget.grab_focus] for actually setting the input focus on a widget.
- set_can_target(can_target)[source]¶
- Parameters:
can_target (
bool) – whether this widget should be able to receive pointer events
Sets whether the widget can be the target of pointer events.
- set_child_visible(child_visible)[source]¶
- Parameters:
child_visible (
bool) – whether self should be mapped along with its parent
Sets whether the widget should be mapped along with its parent.
The child visibility can be set for widget before it is added to a container with [method`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 widget implementations and should never be called by an application.
- set_css_classes(classes)[source]¶
- Parameters:
classes ([
str]) –NULL-terminated list of style classes
Replaces the current style classes of the widget with classes.
- set_cursor(cursor)[source]¶
- Parameters:
cursor (
Gdk.CursororNone) – the new cursor
Sets the cursor to be shown when the pointer hovers over the widget.
If the cursor is
NULL, self will use the cursor inherited from its parent.
- set_cursor_from_name(name)[source]¶
-
Sets the cursor to be shown when the pointer hovers over the widget.
This is a utility function that creates a cursor via [ctor`Gdk`.Cursor.new_from_name] and then sets it on self with [method`Gtk`.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 [method`Gtk`.Widget.set_cursor] with aNULLcursor.
- set_direction(dir)[source]¶
- Parameters:
dir (
Gtk.TextDirection) – the new direction
Sets the reading direction on the 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 prevail, except for widgets where the children are arranged in an order that is explicitly visual rather than logical (such as buttons for text justification).
If the direction is set to [enum`Gtk`.TextDirection.none], then the value set by [func`Gtk`.Widget.set_default_direction] will be used.
- set_focus_child(child)[source]¶
- Parameters:
child (
Gtk.WidgetorNone) – a direct child widget of self orNULLto unset the focus child
Set the focus child of the widget.
This function is only suitable for widget implementations. If you want a certain widget to get the input focus, call [method`Gtk`.Widget.grab_focus] on it.
- set_focus_on_click(focus_on_click)[source]¶
- Parameters:
focus_on_click (
bool) – whether the widget should grab focus when clicked with the mouse
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.
- set_focusable(focusable)[source]¶
- Parameters:
focusable (
bool) – whether or not self can own the input focus
Sets whether the 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 [method`Gtk`.Widget.grab_focus] for actually setting the input focus on a widget.
- set_font_map(font_map)[source]¶
- Parameters:
font_map (
Pango.FontMaporNone) – aPangoFontMap
Sets the font map to use for text rendering in the widget.
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.
- set_font_options(options)[source]¶
- Parameters:
options (
cairo.FontOptionsorNone) – acairo_font_options_tstruct to unset any previously set default font options
Sets the
cairo_font_options_tused for text rendering in the widget.When not set, the default font options for the
GdkDisplaywill be used.Deprecated since version 4.16.
- set_halign(align)[source]¶
- Parameters:
align (
Gtk.Align) – the horizontal alignment
Sets the horizontal alignment of the widget.
- set_has_tooltip(has_tooltip)[source]¶
- Parameters:
has_tooltip (
bool) – whether or not self has a tooltip
Sets the
has-tooltipproperty on the widget.
- set_hexpand(expand)[source]¶
- Parameters:
expand (
bool) – whether to expand
Sets whether the widget would like any available extra horizontal space.
When a user resizes a window, widgets with expand set to 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 [method`Gtk`.Widget.compute_expand]. A widget can decide how the expandability of children affects its own expansion by overriding the
compute_expandvirtual method onGtkWidget.).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 [method`Gtk`.Widget.set_hexpand] sets the hexpand-set property (see [method`Gtk`.Widget.set_hexpand_set]) which causes the widget’s hexpand value to be used, rather than looking at children and widget state.
- set_hexpand_set(set)[source]¶
- Parameters:
set (
bool) – value for hexpand-set property
Sets whether the hexpand flag will be used.
The [property`Gtk`.Widget:hexpand-set] property will be set automatically when you call [method`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.
- set_layout_manager(layout_manager)[source]¶
- Parameters:
layout_manager (
Gtk.LayoutManagerorNone) – a layout manager
Sets the layout manager to use for measuring and allocating children of the widget.
- set_limit_events(limit_events)[source]¶
- Parameters:
limit_events (
bool) – whether to limit events
Sets whether the widget acts like a modal dialog, with respect to event delivery.
New in version 4.18.
- set_margin_bottom(margin)[source]¶
- Parameters:
margin (
int) – the bottom margin
Sets the bottom margin of the widget.
- set_margin_end(margin)[source]¶
- Parameters:
margin (
int) – the end margin
Sets the end margin of the widget.
- set_margin_start(margin)[source]¶
- Parameters:
margin (
int) – the start margin
Sets the start margin of the widget.
- set_margin_top(margin)[source]¶
- Parameters:
margin (
int) – the top margin
Sets the top margin of the widget.
- set_name(name)[source]¶
- Parameters:
name (
str) – name for the widget
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 [class`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.
- set_opacity(opacity)[source]¶
- Parameters:
opacity (
float) – desired opacity, between 0 and 1
Requests 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 [method`Gdk`.Display.is_composited]. On Windows and Wayland it will 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, [class`Gtk`.Popover] instances and other [iface`Gtk`.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.
- set_overflow(overflow)[source]¶
- Parameters:
overflow (
Gtk.Overflow) – desired overflow value
Sets how the widget treats content that is drawn outside the it’s content area.
See the definition of [enum`Gtk`.Overflow] for details.
This setting is provided for widget implementations and should not be used by application code.
The default value is [enum`Gtk`.Overflow.visible].
- set_parent(parent)[source]¶
- Parameters:
parent (
Gtk.Widget) – parent widget
Sets the parent widget of the 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 [method`Gtk`.Widget.unparent].
This function is useful only when implementing subclasses of
GtkWidget.
- set_receives_default(receives_default)[source]¶
- Parameters:
receives_default (
bool) – whether or not self can be a default widget
Sets whether the widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default.
- set_sensitive(sensitive)[source]¶
- Parameters:
sensitive (
bool) – true to make the widget sensitive
Sets the sensitivity of the 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.
- set_size_request(width, height)[source]¶
- Parameters:
Sets the minimum size of the 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, [method`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.
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 is basically impossible to hardcode a size that will always work.
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 [property`Gtk`.Widget:margin-start], [property`Gtk`.Widget:margin-end], [property`Gtk`.Widget:margin-top], and [property`Gtk`.Widget:margin-bottom], but it does include pretty much all other padding or border properties set by any subclass of
GtkWidget.
- set_state_flags(flags, clear)[source]¶
- Parameters:
flags (
Gtk.StateFlags) – state flags to turn onclear (
bool) – whether to clear state before turning on flags
Turns on flag values in the current widget state.
Typical widget states are insensitive, prelighted, etc.
This function accepts the values [flags`Gtk`.StateFlags.dir-ltr] and [flags`Gtk`.StateFlags.dir-rtl] but ignores them. If you want to set the widget’s direction, use [method`Gtk`.Widget.set_direction].
This function is for use in widget implementations.
- set_tooltip_markup(markup)[source]¶
-
Sets the contents of the tooltip for widget.
markup must contain Pango markup.
This function will take care of setting the [property`Gtk`.Widget:has-tooltip] as a side effect, and of the default handler for the [signal`Gtk`.Widget::query-tooltip] signal.
See also [method`Gtk`.Tooltip.set_markup].
- set_tooltip_text(text)[source]¶
-
Sets the contents of the tooltip for the widget.
If text contains any markup, it will be escaped.
This function will take care of setting [property`Gtk`.Widget:has-tooltip] as a side effect, and of the default handler for the [signal`Gtk`.Widget::query-tooltip] signal.
See also [method`Gtk`.Tooltip.set_text].
- set_valign(align)[source]¶
- Parameters:
align (
Gtk.Align) – the vertical alignment
Sets the vertical alignment of the widget.
- set_vexpand(expand)[source]¶
- Parameters:
expand (
bool) – whether to expand
Sets whether the widget would like any available extra vertical space.
See [method`Gtk`.Widget.set_hexpand] for more detail.
- set_vexpand_set(set)[source]¶
- Parameters:
set (
bool) – value for vexpand-set property
Sets whether the vexpand flag will be used.
See [method`Gtk`.Widget.set_hexpand_set] for more detail.
- set_visible(visible)[source]¶
- Parameters:
visible (
bool) – whether the widget should be shown or not
Sets the visibility state of self.
Note that setting this to true doesn’t mean the widget is actually viewable, see [method`Gtk`.Widget.get_visible].
- should_layout()[source]¶
- Returns:
true if child should be included in measuring and allocating
- Return type:
Returns whether the 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, such as [class`Gtk`.Popover] instances.
- show()[source]¶
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 widget is shown, it is immediately realized and mapped; other shown widgets are realized and mapped when their toplevel widget is realized and mapped.
Deprecated since version 4.10: Use [method`Gtk`.Widget.set_visible] instead
- size_allocate(allocation, baseline)[source]¶
- Parameters:
allocation (
Gdk.Rectangle) – position and size to be allocated to selfbaseline (
int) – the baseline of the child, or -1
Allocates widget with a transformation that translates the origin to the position in allocation.
This is a simple form of [method`Gtk`.Widget.allocate].
- snapshot_child(child, snapshot)[source]¶
- Parameters:
child (
Gtk.Widget) – a child of selfsnapshot (
Gtk.Snapshot) – snapshot as passed to the widget. In particular, no calls to [method`Gtk`.Snapshot.translate] or other transform calls should have been made
Snapshots a child of the widget.
When a widget receives a call to the snapshot function, it must send synthetic [vfunc`Gtk`.Widget.snapshot] calls to all children. This function provides a convenient way of doing this. A widget, when it receives a call to its [vfunc`Gtk`.Widget.snapshot] function, calls
Gtk.Widget.snapshot_child() once for each child, passing in the snapshot the widget received.This function takes care of translating the origin of snapshot, and deciding whether the child needs to be snapshot.
It does nothing for children that implement
GtkNative.
- translate_coordinates(dest_widget, src_x, src_y)[source]¶
- Parameters:
dest_widget (
Gtk.Widget) – aGtk.Widgetsrc_x (
int) – X position relative to selfsrc_y (
int) – Y position relative to self
- Returns:
Noneif either widget was not realized, or there was no common ancestor. Otherwise a(dest_x, dest_y)tuple containing the X and Y position relative to dest_widget.- Return type:
Translates coordinates relative to self’s allocation to coordinates relative to dest_widget’s allocations.
In order to perform this operation, both widget must share a common ancestor. If that is not the case, dest_x and dest_y are set to 0 and false is returned.
Deprecated since version 4.12: Use [method`Gtk`.Widget.compute_point] instead
- unmap()[source]¶
Causes a widget to be unmapped if it’s currently mapped.
This function is only for use in widget implementations.
- unparent()[source]¶
Removes self from its parent.
This function is only for use in widget implementations, typically in dispose.
- unrealize()[source]¶
Causes a widget to be unrealized.
This frees all GDK resources associated with the widget.
This function is only useful in widget implementations.
- unset_state_flags(flags)[source]¶
- Parameters:
flags (
Gtk.StateFlags) – state flags to turn off
Turns off flag values for the current widget state.
See [method`Gtk`.Widget.set_state_flags].
This function is for use in widget implementations.
- do_compute_expand(hexpand_p, vexpand_p) virtual¶
-
Computes whether a container should give this widget extra space when possible.
- do_contains(x, y) virtual¶
- Parameters:
- Returns:
true if widget contains the point (x, y)
- Return type:
Tests if a given point is contained in the 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.
- do_css_changed(change) virtual¶
- Parameters:
change (
Gtk.CssStyleChange) –
Vfunc called when the CSS used by widget was changed. Widgets should then discard their caches that depend on CSS and queue resizes or redraws accordingly. The default implementation will take care of this for all the default CSS properties, so implementations must chain up.
- do_direction_changed(previous_direction) virtual¶
- Parameters:
previous_direction (
Gtk.TextDirection) –
Signal emitted when the text direction of a widget changes.
- do_focus(direction) virtual¶
- Parameters:
direction (
Gtk.DirectionType) –- Return type:
Vfunc for
Gtk.Widget.child_focus()
- do_get_request_mode() virtual¶
- Returns:
The
GtkSizeRequestModepreferred by widget.- Return type:
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.
- do_grab_focus() virtual¶
- Returns:
true if focus is now inside widget
- Return type:
Causes widget to have the keyboard focus for the window that it belongs to.
If widget is not focusable, or its [vfunc`Gtk`.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 [method`Gtk`.Widget.grab_focus] on an already focused widget is allowed, should not have an effect, and return true.
- do_hide() virtual¶
Reverses the effects of [method.Gtk.Widget.show].
This is causing the widget to be hidden (invisible to the user).
Deprecated since version 4.10: Use [method`Gtk`.Widget.set_visible] instead
- Parameters:
direction (
Gtk.DirectionType) – direction of focus movement- Returns:
true if stopping keyboard navigation is fine, false if the emitting widget should try to handle the keyboard navigation attempt in its parent widget
- Return type:
Emits the [signal`Gtk`.Widget::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 [method`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 [method`Gtk`.Widget.child_focus] on the widget’s toplevel.
The default [signal`Gtk`.Widget::keynav-failed] handler returns false for [enum`Gtk`.DirectionType.tab-forward] and [enum`Gtk`.DirectionType.tab-backward]. For the other values of [enum`Gtk`.DirectionType] it returns true.
Whenever the default handler returns true, it also calls [method`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 [class`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.
- do_map() virtual¶
Causes a widget to be mapped if it isn’t already.
This function is only for use in widget implementations.
- do_measure(orientation, for_size) virtual¶
- Parameters:
orientation (
Gtk.Orientation) – the orientation to measurefor_size (
int) – Size for the opposite of orientation, i.e. if orientation isGtk.Orientation.HORIZONTAL, this is the height the widget should be measured with. TheGtk.Orientation.VERTICALcase 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.
- Returns:
- minimum:
location to store the minimum size
- natural:
location to store the natural size
- minimum_baseline:
location to store the baseline position for the minimum size, or -1 to report no baseline
- natural_baseline:
location to store the baseline position for the natural size, or -1 to report no baseline
- Return type:
(minimum:
int, natural:int, minimum_baseline:int, natural_baseline:int)
Measures widget in the orientation orientation and for the given for_size.
As an example, if orientation is
Gtk.Orientation.HORIZONTALand 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().
- do_mnemonic_activate(group_cycling) virtual¶
- Parameters:
group_cycling (
bool) – true if there are other widgets with the same mnemonic- Returns:
true if the signal has been handled
- Return type:
Emits the [signal`Gtk`.Widget::mnemonic-activate] signal.
- do_move_focus(direction) virtual¶
- Parameters:
direction (
Gtk.DirectionType) –
Signal emitted when a change of focus is requested
- do_query_tooltip(x, y, keyboard_tooltip, tooltip) virtual¶
- Parameters:
x (
int) –y (
int) –keyboard_tooltip (
bool) –tooltip (
Gtk.Tooltip) –
- Return type:
Signal emitted when “has-tooltip” is
Trueand the hover timeout has expired with the cursor hovering “above” widget; or emitted when widget got focus in keyboard mode.
- do_realize() virtual¶
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 [signal`Gtk`.Widget::realize].
- do_root() virtual¶
Called when the widget gets added to a
GtkRootwidget. Must chain up
- do_set_focus_child(child) virtual¶
- Parameters:
child (
Gtk.WidgetorNone) – a direct child widget of widget orNULLto unset the focus child
Set the focus child of the widget.
This function is only suitable for widget implementations. If you want a certain widget to get the input focus, call [method`Gtk`.Widget.grab_focus] on it.
- do_show() virtual¶
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 widget is shown, it is immediately realized and mapped; other shown widgets are realized and mapped when their toplevel widget is realized and mapped.
Deprecated since version 4.10: Use [method`Gtk`.Widget.set_visible] instead
- do_size_allocate(width, height, baseline) virtual¶
-
Called to set the allocation, if the widget does not have a layout manager.
- do_snapshot(snapshot) virtual¶
- Parameters:
snapshot (
Gtk.Snapshot) –
Vfunc called when a new snapshot of the widget has to be taken.
- do_state_flags_changed(previous_state_flags) virtual¶
- Parameters:
previous_state_flags (
Gtk.StateFlags) –
Signal emitted when the widget state changes, see
Gtk.Widget.get_state_flags().
- do_system_setting_changed(settings) virtual¶
- Parameters:
settings (
Gtk.SystemSetting) –
Emitted when a system setting was changed. Must chain up.
- do_unmap() virtual¶
Causes a widget to be unmapped if it’s currently mapped.
This function is only for use in widget implementations.
- do_unrealize() virtual¶
Causes a widget to be unrealized.
This frees all GDK resources associated with the widget.
This function is only useful in widget implementations.
- do_unroot() virtual¶
Called when the widget is about to be removed from its
GtkRootwidget. Must chain up
Signal Details¶
- Gtk.Widget.signals.destroy(widget)¶
- Signal Name:
destroy- Flags:
- Parameters:
widget (
Gtk.Widget) – The object which received the signal
Signals that all holders of a reference to the widget should release the reference that they hold.
May result in finalization of the widget if all references are released.
This signal is not suitable for saving widget state.
- Gtk.Widget.signals.direction_changed(widget, previous_direction)¶
- Signal Name:
direction-changed- Flags:
- Parameters:
widget (
Gtk.Widget) – The object which received the signalprevious_direction (
Gtk.TextDirection) – the previous text direction
Emitted when the text direction of a widget changes.
- Gtk.Widget.signals.hide(widget)¶
- Signal Name:
hide- Flags:
- Parameters:
widget (
Gtk.Widget) – The object which received the signal
Emitted when widget is hidden.
- Signal Name:
keynav-failed- Flags:
- Parameters:
widget (
Gtk.Widget) – The object which received the signaldirection (
Gtk.DirectionType) – the direction of movement
- Returns:
true if stopping keyboard navigation is fine, false if the emitting widget should try to handle the keyboard navigation attempt in its parent widget
- Return type:
Emitted if keyboard navigation fails.
See [method`Gtk`.Widget.keynav_failed] for details.
- Gtk.Widget.signals.map(widget)¶
- Signal Name:
map- Flags:
- Parameters:
widget (
Gtk.Widget) – The object which received the signal
Emitted when widget is going to be mapped.
A widget is mapped when the widget is visible (which is controlled with [property`Gtk`.Widget:visible]) and all its parents up to the toplevel widget are also visible.
The
::mapsignal can be used to determine whether a widget will be drawn, for instance it can resume an animation that was stopped during the emission of [signal`Gtk`.Widget::unmap].
- Gtk.Widget.signals.mnemonic_activate(widget, group_cycling)¶
- Signal Name:
mnemonic-activate- Flags:
- Parameters:
widget (
Gtk.Widget) – The object which received the signalgroup_cycling (
bool) – true if there are other widgets with the same mnemonic
- Returns:
true to stop other handlers from being invoked for the event, false to propagate the event further
- Return type:
Emitted when a widget is activated via a mnemonic.
The default handler for this signal activates widget if group_cycling is false, or just makes widget grab focus if group_cycling is true.
- Gtk.Widget.signals.move_focus(widget, direction)¶
- Signal Name:
move-focus- Flags:
- Parameters:
widget (
Gtk.Widget) – The object which received the signaldirection (
Gtk.DirectionType) – the direction of the focus move
Emitted when the focus is moved.
The
::move-focussignal is a keybinding signal.The default bindings for this signal are <kbd>Tab</kbd> to move forward, and <kbd>Shift</kbd>+<kbd>Tab</kbd> to move backward.
- Gtk.Widget.signals.query_tooltip(widget, x, y, keyboard_mode, tooltip)¶
- Signal Name:
query-tooltip- Flags:
- Parameters:
widget (
Gtk.Widget) – The object which received the signalx (
int) – the x coordinate of the cursor position in widget coordinatesy (
int) – the y coordinate of the cursor position in widget coordinateskeyboard_mode (
bool) – true if the tooltip was triggered using the keyboardtooltip (
Gtk.Tooltip) – aGtkTooltip
- Returns:
true if tooltip should be shown right now, false otherwise
- Return type:
Emitted when the widget’s tooltip is about to be shown.
This happens when the [property`Gtk`.Widget:has-tooltip] property is true and the hover timeout has expired with the cursor hovering above widget; or emitted when widget got focus in keyboard mode.
Using the given coordinates, the signal handler should determine whether a tooltip should be shown for widget. If this is the case true should be returned, false otherwise. Note that if keyboard_mode is true, the values of x and y are undefined and should not be used.
The signal handler is free to manipulate tooltip with the therefore destined function calls.
- Gtk.Widget.signals.realize(widget)¶
- Signal Name:
realize- Flags:
- Parameters:
widget (
Gtk.Widget) – The object which received the signal
Emitted when widget is associated with a
GdkSurface.This means that [method`Gtk`.Widget.realize] has been called or the widget has been mapped (that is, it is going to be drawn).
- Gtk.Widget.signals.show(widget)¶
- Signal Name:
show- Flags:
- Parameters:
widget (
Gtk.Widget) – The object which received the signal
Emitted when widget is shown.
- Gtk.Widget.signals.state_flags_changed(widget, flags)¶
- Signal Name:
state-flags-changed- Flags:
- Parameters:
widget (
Gtk.Widget) – The object which received the signalflags (
Gtk.StateFlags) – the previous state flags
Emitted when the widget state changes.
See [method`Gtk`.Widget.get_state_flags].
- Gtk.Widget.signals.unmap(widget)¶
- Signal Name:
unmap- Flags:
- Parameters:
widget (
Gtk.Widget) – The object which received the signal
Emitted when widget is going to be unmapped.
A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.
As
::unmapindicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.
- Gtk.Widget.signals.unrealize(widget)¶
- Signal Name:
unrealize- Flags:
- Parameters:
widget (
Gtk.Widget) – The object which received the signal
Emitted when the
GdkSurfaceassociated with widget is destroyed.This means that [method`Gtk`.Widget.unrealize] has been called or the widget has been unmapped (that is, it is going to be hidden).
Property Details¶
- Gtk.Widget.props.can_focus¶
- Name:
can-focus- Type:
- Default Value:
- Flags:
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.
- Gtk.Widget.props.can_target¶
- Name:
can-target- Type:
- Default Value:
- Flags:
Whether the widget can receive pointer events.
- Gtk.Widget.props.css_classes¶
-
A list of css classes applied to this widget.
- Gtk.Widget.props.css_name¶
- Name:
css-name- Type:
- Default Value:
- Flags:
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.
- Gtk.Widget.props.cursor¶
- Name:
cursor- Type:
- Default Value:
- Flags:
The cursor used by widget.
- Gtk.Widget.props.focus_on_click¶
- Name:
focus-on-click- Type:
- Default Value:
- Flags:
Whether the widget should grab focus when it is clicked with the mouse.
This property is only relevant for widgets that can take focus.
- Gtk.Widget.props.focusable¶
- Name:
focusable- Type:
- Default Value:
- Flags:
Whether this widget itself will accept the input focus.
- Gtk.Widget.props.halign¶
- Name:
halign- Type:
- Default Value:
- Flags:
How to distribute horizontal space if widget gets extra space.
- Gtk.Widget.props.has_default¶
- Name:
has-default- Type:
- Default Value:
- Flags:
Whether the widget is the default widget.
- Gtk.Widget.props.has_focus¶
- Name:
has-focus- Type:
- Default Value:
- Flags:
Whether the widget has the input focus.
- Gtk.Widget.props.has_tooltip¶
- Name:
has-tooltip- Type:
- Default Value:
- Flags:
Enables or disables the emission of the [signal`Gtk`.Widget::query-tooltip] signal on widget.
A true value indicates that widget can have a tooltip, in this case the widget will be queried using [signal`Gtk`.Widget::query-tooltip] to determine whether it will provide a tooltip or not.
- Gtk.Widget.props.height_request¶
- Name:
height-request- Type:
- Default Value:
-1- Flags:
Overrides for height request of the widget.
If this is -1, the natural request will be used.
- Gtk.Widget.props.hexpand¶
- Name:
hexpand- Type:
- Default Value:
- Flags:
Whether to expand horizontally.
- Gtk.Widget.props.hexpand_set¶
- Name:
hexpand-set- Type:
- Default Value:
- Flags:
Whether to use the
hexpandproperty.
- Gtk.Widget.props.layout_manager¶
- Name:
layout-manager- Type:
- Default Value:
- Flags:
The [class`Gtk`.LayoutManager] 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.
- Gtk.Widget.props.limit_events¶
- Name:
limit-events- Type:
- Default Value:
- Flags:
Makes this widget act like a modal dialog, with respect to event delivery.
Global event controllers will not handle events with targets inside the widget, unless they are set up to ignore propagation limits. See [method`Gtk`.EventController.set_propagation_limit].
New in version 4.18.
- Gtk.Widget.props.margin_bottom¶
- Name:
margin-bottom- Type:
- Default Value:
0- Flags:
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 [method`Gtk`.Widget.set_size_request] for example.
- Gtk.Widget.props.margin_end¶
- Name:
margin-end- Type:
- Default Value:
0- Flags:
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 [method`Gtk`.Widget.set_size_request] for example.
- Gtk.Widget.props.margin_start¶
- Name:
margin-start- Type:
- Default Value:
0- Flags:
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 [method`Gtk`.Widget.set_size_request] for example.
- Gtk.Widget.props.margin_top¶
- Name:
margin-top- Type:
- Default Value:
0- Flags:
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 [method`Gtk`.Widget.set_size_request] for example.
- Gtk.Widget.props.name¶
-
The name of the widget.
- Gtk.Widget.props.opacity¶
- Name:
opacity- Type:
- Default Value:
1.0- Flags:
The requested opacity of the widget.
- Gtk.Widget.props.overflow¶
- Name:
overflow- Type:
- Default Value:
- Flags:
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.
- Gtk.Widget.props.parent¶
- Name:
parent- Type:
- Default Value:
- Flags:
The parent widget of this widget.
- Gtk.Widget.props.receives_default¶
- Name:
receives-default- Type:
- Default Value:
- Flags:
Whether the widget will receive the default action when it is focused.
- Gtk.Widget.props.root¶
- Name:
root- Type:
- Default Value:
- Flags:
The
GtkRootwidget of the widget tree containing this widget.This will be
NULLif the widget is not contained in a root widget.
- Gtk.Widget.props.scale_factor¶
-
The scale factor of the widget.
- Gtk.Widget.props.sensitive¶
- Name:
sensitive- Type:
- Default Value:
- Flags:
Whether the widget responds to input.
- Gtk.Widget.props.tooltip_markup¶
- Name:
tooltip-markup- Type:
- Default Value:
- Flags:
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Also see [method`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: [property`Gtk`.Widget:has-tooltip] will automatically be set to true and there will be taken care of [signal`Gtk`.Widget::query-tooltip] in the default signal handler.Note that if both [property`Gtk`.Widget:tooltip-text] and [property`Gtk`.Widget:tooltip-markup] are set, the last one wins.
- Gtk.Widget.props.tooltip_text¶
- Name:
tooltip-text- Type:
- Default Value:
- Flags:
Sets the text of tooltip to be the given string.
Also see [method`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: [property`Gtk`.Widget:has-tooltip] will automatically be set to true and there will be taken care of [signal`Gtk`.Widget::query-tooltip] in the default signal handler.Note that if both [property`Gtk`.Widget:tooltip-text] and [property`Gtk`.Widget:tooltip-markup] are set, the last one wins.
- Gtk.Widget.props.valign¶
- Name:
valign- Type:
- Default Value:
- Flags:
How to distribute vertical space if widget gets extra space.
- Gtk.Widget.props.vexpand¶
- Name:
vexpand- Type:
- Default Value:
- Flags:
Whether to expand vertically.
- Gtk.Widget.props.vexpand_set¶
- Name:
vexpand-set- Type:
- Default Value:
- Flags:
Whether to use the
vexpandproperty.
- Gtk.Widget.props.visible¶
- Name:
visible- Type:
- Default Value:
- Flags:
Whether the widget is visible.
- Gtk.Widget.props.width_request¶
- Name:
width-request- Type:
- Default Value:
-1- Flags:
Overrides for width request of the widget.
If this is -1, the natural request will be used.