Package ch.bailu.gtk.gtk
Klasse Widget
- Alle implementierten Schnittstellen:
PointerInterface
- Bekannte direkte Unterklassen:
ActionBar,AppChooserButton,AppChooserWidget,AspectFrame,Avatar,Banner,Bin,BottomSheet,Box,BreakpointBin,Button,ButtonContent,Calendar,Carousel,CarouselIndicatorDots,CarouselIndicatorLines,CellView,CenterBox,CheckButton,Clamp,ClampScrollable,ColorButton,ColorChooserWidget,ColorDialogButton,ColumnView,ComboBox,Dialog,DragIcon,DrawingArea,DropDown,EditableLabel,Entry,Expander,FileChooserWidget,Fixed,Flap,FlowBox,FlowBoxChild,FontButton,FontChooserWidget,FontDialogButton,Frame,GLArea,GraphicsOffload,Grid,HeaderBar,HeaderBar,IconView,Image,InfoBar,InlineViewSwitcher,Inscription,Label,LayoutSlot,Leaflet,LevelBar,ListBase,ListBox,ListBoxRow,MediaControls,MenuButton,MultiLayoutView,NavigationPage,NavigationSplitView,NavigationView,Notebook,Overlay,OverlaySplitView,Paned,PasswordEntry,Picture,Popover,PopoverMenuBar,PreferencesGroup,PreferencesPage,ProgressBar,Range,Revealer,ScaleButton,Scrollbar,ScrolledWindow,SearchBar,SearchEntry,Separator,ShortcutLabel,ShortcutsShortcut,SpinButton,Spinner,Spinner,SplitButton,Squeezer,Stack,StackSidebar,StackSwitcher,Statusbar,StatusPage,Switch,TabBar,TabButton,TabOverview,TabView,Text,TextView,ToastOverlay,ToggleGroup,ToolbarView,TreeExpander,TreeView,Video,Viewport,ViewStack,ViewSwitcher,ViewSwitcherBar,ViewSwitcherTitle,Window,WindowControls,WindowHandle,WindowTitle,WrapBox
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 `GtkWidget` subclass 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
returns %GTK_SIZE_REQUEST_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_SIZE_REQUEST_HEIGHT_FOR_WIDTH mode:
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_HORIZONTAL and 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 of %GTK_ORIENTATION_VERTICAL and 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, `GtkWidget` caches 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_VERTICAL called 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_SIZE_REQUEST_HEIGHT_FOR_WIDTH widget
generally deals with width-for-height requests:
```c
static void
foo_widget_measure (GtkWidget *widget,
GtkOrientation orientation,
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.
### GtkWidget as GtkBuildable
The `GtkWidget` implementation of the `GtkBuildable` interface
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], `GtkWidget` supports
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>
```
`GtkWidget` allows 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>
```
`GtkWidget` allows 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 `GtkBuilder` XML, 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 by `GtkBuilder` but 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 your `GtkWidget` type:
```c
static void
foo_widget_class_init (FooWidgetClass *klass)
{
// ...
gtk_widget_class_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 *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 {
GtkWidget *hello_button;
GtkWidget *goodbye_button;
} FooWidgetPrivate;
G_DEFINE_TYPE_WITH_PRIVATE (FooWidget, foo_widget, GTK_TYPE_BOX)
static void
foo_widget_dispose (GObject *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_widget_class_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,
GtkButton *button)
{
g_print ("Hello, world!\n");
}
static void
foo_widget_class_init (FooWidgetClass *klass)
{
// ...
gtk_widget_class_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);
}
```
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 `GtkWidget` subclass 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
returns %GTK_SIZE_REQUEST_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_SIZE_REQUEST_HEIGHT_FOR_WIDTH mode:
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_HORIZONTAL and 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 of %GTK_ORIENTATION_VERTICAL and 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, `GtkWidget` caches 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_VERTICAL called 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_SIZE_REQUEST_HEIGHT_FOR_WIDTH widget
generally deals with width-for-height requests:
```c
static void
foo_widget_measure (GtkWidget *widget,
GtkOrientation orientation,
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.
### GtkWidget as GtkBuildable
The `GtkWidget` implementation of the `GtkBuildable` interface
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], `GtkWidget` supports
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>
```
`GtkWidget` allows 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>
```
`GtkWidget` allows 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 `GtkBuilder` XML, 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 by `GtkBuilder` but 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 your `GtkWidget` type:
```c
static void
foo_widget_class_init (FooWidgetClass *klass)
{
// ...
gtk_widget_class_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 *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 {
GtkWidget *hello_button;
GtkWidget *goodbye_button;
} FooWidgetPrivate;
G_DEFINE_TYPE_WITH_PRIVATE (FooWidget, foo_widget, GTK_TYPE_BOX)
static void
foo_widget_dispose (GObject *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_widget_class_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,
GtkButton *button)
{
g_print ("Hello, world!\n");
}
static void
foo_widget_class_init (FooWidgetClass *klass)
{
// ...
gtk_widget_class_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);
}
```
-
Verschachtelte Klassen - Übersicht
Verschachtelte KlassenModifizierer und TypKlasseBeschreibungstatic interfacestatic interfacestatic interfacestatic interfacestatic interfacestatic interfacestatic interfacestatic interfacestatic interfacestatic interfacestatic interfacestatic interfacestatic interfacestatic interfacestatic interfaceVon Klasse geerbte verschachtelte Klassen/Schnittstellen ch.bailu.gtk.gobject.Object
Object.OnBindingTransformFunc, Object.OnDuplicateFunc, Object.OnNotify, Object.OnToggleNotify, Object.OnWeakNotify -
Feldübersicht
FelderModifizierer und TypFeldBeschreibungstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final StringVon Klasse geerbte Felder ch.bailu.gtk.gobject.Object
SIGNAL_ON_NOTIFY -
Konstruktorübersicht
Konstruktoren -
Methodenübersicht
Modifizierer und TypMethodeBeschreibungvoidactionSetEnabled(Str action_name, boolean enabled) Enables or disables an action installed with
[method@Gtk.WidgetClass.install_action].voidactionSetEnabled(String action_name, boolean enabled) Enables or disables an action installed with
[method@Gtk.WidgetClass.install_action].booleanactivate()Activates the widget.booleanactivateAction(Str name, Str format_string, Object... _ellipsis) Activates an action for the widget.booleanactivateAction(String name, String format_string, Object... _ellipsis) Activates an action for the widget.booleanactivateActionVariant(Str name, Variant args) Activates an action for the widget.booleanactivateActionVariant(String name, Variant args) Activates an action for the widget.voidActivates the `default.activate` action for the widget.voidaddController(EventController controller) Adds an event controller to the widget.voidaddCssClass(Str css_class) Adds a style class to the widget.voidaddCssClass(String css_class) Adds a style class to the widget.voidaddMnemonicLabel(Widget label) Adds a widget to the list of mnemonic labels for this widget.intaddTickCallback(Widget.OnTickCallback callback, Pointer user_data, Widget.OnDestroyNotify notify) Queues an animation frame update and adds a callback to be called
before each frame.voidAssigns size, position, (optionally) a baseline and transform
to a child widget.Implements interfaceAccessible.Implements interfaceBuildable.Implements interfaceConstraintTarget.booleanchildFocus(int direction) Called by widgets as the user moves around the window using
keyboard shortcuts.booleancomputeBounds(Widget target, Rect out_bounds) Computes the bounds for @widget in the coordinate space of @target.booleancomputeExpand(int orientation) Computes whether a parent widget should give this widget
extra space when possible.booleancomputePoint(Widget target, Point point, Point out_point) Translates the given @point in @widget's coordinates to coordinates
in @target’s coordinate system.booleancomputeTransform(Widget target, Matrix out_transform) Computes a matrix suitable to describe a transformation from
@widget's coordinate system into @target's coordinate system.booleancontains(double x, double y) Tests if a given point is contained in the widget.Creates a new `PangoContext` that is configured for the widget.createPangoLayout(Str text) Creates a new `PangoLayout` that is configured for the widget.createPangoLayout(String text) Creates a new `PangoLayout` that is configured for the widget.voiddisposeTemplate(long widget_type) Clears the template children for the widget.booleandragCheckThreshold(int start_x, int start_y, int current_x, int current_y) Checks to see if a drag movement has passed the GTK drag threshold.voidNotifies the user about an input-related error on the widget.intVeraltet.intVeraltet.intVeraltet.voidgetAllocation(Rectangle allocation) Veraltet.getAncestor(long widget_type) Gets the first ancestor of the widget with type @widget_type.intReturns the baseline that has currently been allocated to the widget.booleanDetermines whether the input focus can enter the widget or any
of its children.booleanQueries whether the widget can be the target of pointer events.booleanGets the value set with [method@Gtk.Widget.set_child_visible].static ClassHandlerGets the clipboard object for the widget.voidGets the current foreground color for the widget’s style.Returns the list of style classes applied to the widget.Returns the CSS name of the widget.Gets the cursor set on the widget.static intObtains the default reading direction.intGets the reading direction for the widget.Get the display for the window that the widget belongs to.Returns the widget’s first child.booleanDetermines whether the widget can own the input focus.Returns the focus child of the widget.booleanReturns whether the widget should grab focus when it is clicked
with the mouse.Gets the font map of the widget.Veraltet.Obtains the frame clock for a widget.intGets the horizontal alignment of the widget.booleanReturns the current value of the `has-tooltip` property.intReturns the content height of the widget.booleanGets whether the widget would like any available extra horizontal
space.booleanGets whether the `hexpand` flag has been explicitly set.static intReturns the widget’s last child.Retrieves the layout manager of the widget.booleanGets the value of the [property@Gtk.Widget:limit-events] property.booleanReturns whether the widget is mapped.intGets the bottom margin of the widget.intGets the end margin of the widget.intGets the start margin of the widget.intGets the top margin of the widget.getName()Retrieves the name of a widget.Returns the nearest `GtkNative` ancestor of the widget.Returns the widget’s next sibling.doubleFetches the requested opacity for the widget.intReturns the widget’s overflow value.Gets a `PangoContext` that is configured for the widget.Returns the parent widget of the widget.static longstatic TypeSystem.TypeSizevoidgetPreferredSize(Requisition minimum_size, Requisition natural_size) Retrieves the minimum and natural size of a widget, taking
into account the widget’s preference for height-for-width management.Returns the widget’s previous sibling.Gets the primary clipboard of the widget.booleanDetermines whether the widget is realized.booleanDetermines 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.intGets whether the widget prefers a height-for-width layout
or a width-for-height layout.getRoot()Returns the `GtkRoot` widget of the widget.intRetrieves the internal scale factor that maps from window
coordinates to the actual device pixels.booleanReturns the widget’s sensitivity.Gets the settings object holding the settings used for the widget.intgetSize(int orientation) Returns the content width or height of the widget.voidgetSizeRequest(Int width, Int height) Gets the size request that was explicitly set for the widget.intReturns the widget state as a flag set.Veraltet.getTemplateChild(long widget_type, Str name) Fetches an object build from the template XML for @widget_type in
the widget.getTemplateChild(long widget_type, String name) Fetches an object build from the template XML for @widget_type in
the widget.Gets the contents of the tooltip for the widget.Gets the contents of the tooltip for the widget.static longstatic TypeSystem.TypeSizeintGets the vertical alignment of the widget.booleanGets whether the widget would like any available extra vertical
space.booleanGets whether the `vexpand` flag has been explicitly set.booleanDetermines whether the widget is visible.intgetWidth()Returns the content width of the widget.booleanCauses @widget to have the keyboard focus for the window
that it belongs to.booleanhasCssClass(Str css_class) Returns whether a style class is currently applied to the widget.booleanhasCssClass(String css_class) Returns whether a style class is currently applied to the widget.booleanDetermines whether the widget is the current default widget
within its toplevel.booleanhasFocus()Determines if the widget has the global input focus.booleanDetermines if the widget should show a visible indication that
it has the global input focus.voidhide()Veraltet.booleanReturns whether the widget is currently being destroyed.voidCreates and initializes child widgets defined in templates.voidinsertActionGroup(Str name, ActionGroup group) Inserts an action group into the widget's actions.voidinsertActionGroup(String name, ActionGroup group) Inserts an action group into the widget's actions.voidinsertAfter(Widget parent, Widget previous_sibling) Sets the parent widget of the widget.voidinsertBefore(Widget parent, Widget next_sibling) Sets the parent widget of the widget.booleanisAncestor(Widget ancestor) Determines whether the widget is a descendent of @ancestor.booleanDetermines whether the widget can be drawn to.booleanisFocus()Determines if the widget is the focus widget within its
toplevel.booleanReturns the widget’s effective sensitivity.booleanDetermines whether the widget and all its parents are marked as
visible.booleankeynavFailed(int direction) Emits the [signal@Gtk.Widget::keynav-failed] signal on the widget.Returns the widgets for which this widget is the target of a
mnemonic.voidmap()Causes a widget to be mapped if it isn’t already.voidmeasure(int orientation, int for_size, Int minimum, Int natural, Int minimum_baseline, Int natural_baseline) Measures @widget in the orientation @orientation and for the given @for_size.booleanmnemonicActivate(boolean group_cycling) Emits the [signal@Gtk.Widget::mnemonic-activate] signal.Returns a list model to track the children of the widget.Returns a list model to track the event controllers of the widget.onDestroy(Widget.OnDestroy signal) Connect to signal "destroy".Connect to signal "direction-changed".onHide(Widget.OnHide signal) Connect to signal "hide".onKeynavFailed(Widget.OnKeynavFailed signal) Connect to signal "keynav-failed".onMap(Widget.OnMap signal) Connect to signal "map".Connect to signal "mnemonic-activate".onMoveFocus(Widget.OnMoveFocus signal) Connect to signal "move-focus".onQueryTooltip(Widget.OnQueryTooltip signal) Connect to signal "query-tooltip".onRealize(Widget.OnRealize signal) Connect to signal "realize".onShow(Widget.OnShow signal) Connect to signal "show".Connect to signal "state-flags-changed".onUnmap(Widget.OnUnmap signal) Connect to signal "unmap".onUnrealize(Widget.OnUnrealize signal) Connect to signal "unrealize".pick(double x, double y, int flags) Finds the descendant of the widget closest to a point.voidFlags the widget for a rerun of the [vfunc@Gtk.Widget.size_allocate]
function.voidSchedules this widget to be redrawn.voidFlags a widget to have its size renegotiated.voidrealize()Creates the GDK resources associated with a widget.voidremoveController(EventController controller) Removes an event controller from the widget.voidremoveCssClass(Str css_class) Removes a style from the widget.voidremoveCssClass(String css_class) Removes a style from the widget.voidremoveMnemonicLabel(Widget label) Removes a widget from the list of mnemonic labels for this widget.voidremoveTickCallback(int id) Removes a tick callback previously registered with
[method@Gtk.Widget.add_tick_callback].voidsetCanFocus(boolean can_focus) Sets whether the input focus can enter the widget or
any of its children.voidsetCanTarget(boolean can_target) Sets whether the widget can be the target of pointer events.voidsetChildVisible(boolean child_visible) Sets whether the widget should be mapped along with its parent.voidsetCssClasses(Strs classes) Replaces the current style classes of the widget with @classes.voidSets the cursor to be shown when the pointer hovers over
the widget.voidsetCursorFromName(Str name) Sets the cursor to be shown when the pointer hovers over
the widget.voidsetCursorFromName(String name) Sets the cursor to be shown when the pointer hovers over
the widget.static voidsetDefaultDirection(int dir) Sets the default reading direction for widgets.voidsetDirection(int dir) Sets the reading direction on the widget.voidsetFocusable(boolean focusable) Sets whether the widget can own the input focus.voidsetFocusChild(Widget child) Set the focus child of the widget.voidsetFocusOnClick(boolean focus_on_click) Sets whether the widget should grab focus when it is clicked
with the mouse.voidsetFontMap(FontMap font_map) Sets the font map to use for text rendering in the widget.voidsetFontOptions(FontOptions options) Veraltet.voidsetHalign(int align) Sets the horizontal alignment of the widget.voidsetHasTooltip(boolean has_tooltip) Sets the `has-tooltip` property on the widget.voidsetHexpand(boolean expand) Sets whether the widget would like any available extra horizontal
space.voidsetHexpandSet(boolean set) Sets whether the hexpand flag will be used.voidsetLayoutManager(LayoutManager layout_manager) Sets the layout manager to use for measuring and allocating children
of the widget.voidsetLimitEvents(boolean limit_events) Sets whether the widget acts like a modal dialog,
with respect to event delivery.voidsetMarginBottom(int margin) Sets the bottom margin of the widget.voidsetMarginEnd(int margin) Sets the end margin of the widget.voidsetMarginStart(int margin) Sets the start margin of the widget.voidsetMarginTop(int margin) Sets the top margin of the widget.voidSets a widgets name.voidSets a widgets name.voidsetOpacity(double opacity) Requests the widget to be rendered partially transparent.voidsetOverflow(int overflow) Sets how the widget treats content that is drawn outside the
it's content area.voidSets the parent widget of the widget.voidsetReceivesDefault(boolean receives_default) 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.voidsetSensitive(boolean sensitive) Sets the sensitivity of the widget.voidsetSizeRequest(int width, int height) Sets the minimum size of the widget.voidsetStateFlags(int flags, boolean clear) Turns on flag values in the current widget state.voidsetTooltipMarkup(Str markup) Sets the contents of the tooltip for widget.voidsetTooltipMarkup(String markup) Sets the contents of the tooltip for widget.voidsetTooltipText(Str text) Sets the contents of the tooltip for the widget.voidsetTooltipText(String text) Sets the contents of the tooltip for the widget.voidsetValign(int align) Sets the vertical alignment of the widget.voidsetVexpand(boolean expand) Sets whether the widget would like any available extra vertical
space.voidsetVexpandSet(boolean set) Sets whether the vexpand flag will be used.voidsetVisible(boolean visible) Sets the visibility state of @widget.booleanReturns whether the widget should contribute to
the measuring and allocation of its parent.voidshow()Veraltet.voidsizeAllocate(Rectangle allocation, int baseline) Allocates widget with a transformation that translates
the origin to the position in @allocation.voidsnapshotChild(Widget child, Snapshot snapshot) Snapshots a child of the widget.voidTriggers a tooltip query on the display of the widget.voidunmap()Causes a widget to be unmapped if it’s currently mapped.voidunparent()Removes @widget from its parent.voidCauses a widget to be unrealized.voidunsetStateFlags(int flags) Turns off flag values for the current widget state.Von Klasse geerbte Methoden ch.bailu.gtk.type.PropertyHolder
getBooleanProperty, getIntProperty, getObjectProperty, getStringProperty, getStrProperty, setBooleanProperty, setIntProperty, setObjectProperty, setStringProperty, setStrPropertyVon Klasse geerbte Methoden ch.bailu.gtk.gobject.Object
addToggleRef, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, disconnect, disconnect, dupData, dupData, dupQdata, forceFloating, freezeNotify, get, get, getData, getData, getProperty, getProperty, getQdata, interfaceFindProperty, interfaceInstallProperty, isFloating, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, replaceData, replaceData, replaceQdata, runDispose, set, set, setData, setData, setDataFull, setDataFull, setProperty, setProperty, setQdata, setQdataFull, stealData, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnrefVon Klasse geerbte Methoden ch.bailu.gtk.type.Pointer
asCPointer, cast, connectSignal, disconnectSignals, disconnectSignals, equals, hashCode, throwIfNull, throwNullPointerException, toString, unregisterCallbacks, unregisterCallbacksVon Klasse geerbte Methoden ch.bailu.gtk.type.Type
asCPointer, asCPointer, asCPointerNotNull, asJnaPointer, asJnaPointer, asPointer, asPointer, cast, cast, throwIfNullVon Klasse geerbte Methoden java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitVon Schnittstelle geerbte Methoden ch.bailu.gtk.type.PointerInterface
asCPointerNotNull, asJnaPointer, asPointer, isNotNull, isNull
-
Felddetails
-
SIGNAL_ON_DESTROY
- Siehe auch:
-
SIGNAL_ON_DIRECTION_CHANGED
- Siehe auch:
-
SIGNAL_ON_HIDE
- Siehe auch:
-
SIGNAL_ON_KEYNAV_FAILED
- Siehe auch:
-
SIGNAL_ON_MAP
- Siehe auch:
-
SIGNAL_ON_MNEMONIC_ACTIVATE
- Siehe auch:
-
SIGNAL_ON_MOVE_FOCUS
- Siehe auch:
-
SIGNAL_ON_QUERY_TOOLTIP
- Siehe auch:
-
SIGNAL_ON_REALIZE
- Siehe auch:
-
SIGNAL_ON_SHOW
- Siehe auch:
-
SIGNAL_ON_STATE_FLAGS_CHANGED
- Siehe auch:
-
SIGNAL_ON_UNMAP
- Siehe auch:
-
SIGNAL_ON_UNREALIZE
- Siehe auch:
-
-
Konstruktordetails
-
Widget
-
-
Methodendetails
-
getClassHandler
-
actionSetEnabled
Enables or disables an action installed with
[method@Gtk.WidgetClass.install_action].- Parameter:
action_name- action name, such as "clipboard.paste"enabled- whether the action is now enabled
-
actionSetEnabled
Enables or disables an action installed with
[method@Gtk.WidgetClass.install_action].- Parameter:
action_name- action name, such as "clipboard.paste"enabled- whether the action is now enabled
-
activate
public boolean activate()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 @widget is not activatable, the function returns false.- Gibt zurück:
- true if the widget was activated
-
activateAction
Activates an action for the widget.
The action is looked up in the action groups associated with
@widget and its ancestors.
This is a wrapper around [method@Gtk.Widget.activate_action_variant]
that constructs the @args variant according to @format_string.- Parameter:
name- the name of the action to activateformat_string- `GVariant` format string for arguments_ellipsis- arguments, as given by format string- Gibt zurück:
- true if the action was activated
-
activateAction
Activates an action for the widget.
The action is looked up in the action groups associated with
@widget and its ancestors.
This is a wrapper around [method@Gtk.Widget.activate_action_variant]
that constructs the @args variant according to @format_string.- Parameter:
name- the name of the action to activateformat_string- `GVariant` format string for arguments_ellipsis- arguments, as given by format string- Gibt zurück:
- true if the action was activated
-
activateActionVariant
Activates an action for the widget.
The action is looked up in the action groups associated with
@widget 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].- Parameter:
name- the name of the action to activateargs- parameters to use- Gibt zurück:
- true if the action was activated
-
activateActionVariant
Activates an action for the widget.
The action is looked up in the action groups associated with
@widget 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].- Parameter:
name- the name of the action to activateargs- parameters to use- Gibt zurück:
- true if the action was activated
-
activateDefault
public void activateDefault()Activates the `default.activate` action for the widget.
The action is looked up in the same was as for
[method@Gtk.Widget.activate_action]. -
addController
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].- Parameter:
controller- an event controller that hasn't been added to a widget yet
-
addCssClass
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.- Parameter:
css_class- style class to add to @widget, without the leading period
-
addCssClass
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.- Parameter:
css_class- style class to add to @widget, without the leading period
-
addMnemonicLabel
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.- Parameter:
label- a widget that acts as a mnemonic label for @widget
-
addTickCallback
public int addTickCallback(Widget.OnTickCallback callback, @Nullable Pointer user_data, Widget.OnDestroyNotify notify) Queues an animation frame update and adds a callback to be called
before each frame.
Until the tick callback is removed, it will be called frequently
(usually at the frame rate of the output device or as quickly as
the application can be repainted, whichever is slower). For this
reason, is most suitable for handling graphics that change every
frame or every few frames.
The tick callback does not automatically imply a relayout or repaint.
If you want a repaint or relayout, and aren’t changing widget properties
that would trigger that (for example, changing the text of a 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].- Parameter:
callback- function to call for updating animationsuser_data- data to pass to @callbacknotify- function to call to free @user_data- Gibt zurück:
- an ID for this callback
-
allocate
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].- Parameter:
width- new widthheight- new heightbaseline- new baseline, or -1transform- transformation to be applied
-
childFocus
public boolean childFocus(int direction) 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.- Parameter:
direction- direction of focus movement- Gibt zurück:
- true if focus ended up inside @widget
-
computeBounds
Computes the bounds for @widget 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](coordinates.html)
overview to learn more.
If the operation is successful, true is returned. If @widget has no
bounds or the bounds cannot be expressed in @target's coordinate space
(for example if both widgets are in different windows), false is
returned and @bounds is set to the zero rectangle.
It is valid for @widget and @target to be the same widget.- Parameter:
target- the target widgetout_bounds- the rectangle taking the bounds- Gibt zurück:
- true if the bounds could be computed
-
computeExpand
public boolean computeExpand(int orientation) 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.- Parameter:
orientation- expand direction- Gibt zurück:
- whether widget tree rooted here should be expanded
-
computePoint
Translates the given @point in @widget'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.- Parameter:
target- the widget to transform intopoint- a point in @widget's coordinate systemout_point- set to the corresponding coordinates in @target's coordinate system- Gibt zurück:
- true if @src_widget and @dest_widget have a common ancestor, false otherwise
-
computeTransform
Computes a matrix suitable to describe a transformation from
@widget's coordinate system into @target's coordinate system.
The transform can not be computed in certain cases, for example
when @widget and @target do not share a common ancestor. In that
case @out_transform gets set to the identity matrix.
To learn more about widget coordinate systems, see the coordinate
system [overview](coordinates.html).- Parameter:
target- the target widget that the matrix will transform toout_transform- location to store the final transformation- Gibt zurück:
- true if the transform could be computed
-
contains
public boolean contains(double x, double y) 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.- Parameter:
x- X coordinate to test, relative to @widget's originy- Y coordinate to test, relative to @widget's origin- Gibt zurück:
- true if @widget contains the point (x, y)
-
createPangoContext
Creates a new `PangoContext` that is configured for the widget.
The `PangoContext` will have the appropriate font map,
font options, font description, and base direction set.
See also [method@Gtk.Widget.get_pango_context].- Gibt zurück:
- the new `PangoContext`
-
createPangoLayout
Creates a new `PangoLayout` that is configured for the widget.
The `PangoLayout` will have the appropriate font map,
font description, and base direction set.
If you keep a `PangoLayout` created in this way around,
you need to re-create it when the widgets `PangoContext`
is replaced. This can be tracked by listening to changes
of the [property@Gtk.Widget:root] property on the widget.- Parameter:
text- text to set on the layout- Gibt zurück:
- the new `PangoLayout`
-
createPangoLayout
Creates a new `PangoLayout` that is configured for the widget.
The `PangoLayout` will have the appropriate font map,
font description, and base direction set.
If you keep a `PangoLayout` created in this way around,
you need to re-create it when the widgets `PangoContext`
is replaced. This can be tracked by listening to changes
of the [property@Gtk.Widget:root] property on the widget.- Parameter:
text- text to set on the layout- Gibt zurück:
- the new `PangoLayout`
-
disposeTemplate
public void disposeTemplate(long widget_type) 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 `NULL` after 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 *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);
}
```- Parameter:
widget_type- the type of the widget to finalize the template for
-
dragCheckThreshold
public boolean dragCheckThreshold(int start_x, int start_y, int current_x, int current_y) Checks to see if a drag movement has passed the GTK drag threshold.- Parameter:
start_x- X coordinate of start of dragstart_y- Y coordinate of start of dragcurrent_x- current X coordinatecurrent_y- current Y coordinate- Gibt zurück:
- true if the drag threshold has been passed
-
errorBell
public void errorBell()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. -
getAllocatedBaseline
Veraltet.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().- Gibt zurück:
- the baseline of the @widget, or -1 if none
-
getAllocatedHeight
Veraltet.Returns the height that has currently been allocated to the widget.
To learn more about widget sizes, see the coordinate
system [overview](coordinates.html).- Gibt zurück:
- the height of the @widget
-
getAllocatedWidth
Veraltet.Returns the width that has currently been allocated to the widget.
To learn more about widget sizes, see the coordinate
system [overview](coordinates.html).- Gibt zurück:
- the width of the @widget
-
getAllocation
Veraltet.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.- Parameter:
allocation- a pointer to a `GtkAllocation` to copy to
-
getAncestor
Gets the first ancestor of the widget with type @widget_type.
For example, `gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)`
gets the first `GtkBox` that’s an ancestor of @widget. No
reference will be added to the returned widget; it should
not be unreferenced.
Note that unlike [method@Gtk.Widget.is_ancestor], this function
considers @widget to be an ancestor of itself.- Parameter:
widget_type- ancestor type- Gibt zurück:
- the ancestor widget
-
getBaseline
public int getBaseline()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 in `GtkWidgetClass.size_allocate()`.- Gibt zurück:
- the baseline of the @widget, or -1 if none
-
getCanFocus
public boolean getCanFocus()Determines whether the input focus can enter the widget or any
of its children.
See [method@Gtk.Widget.set_can_focus].- Gibt zurück:
- true if the input focus can enter @widget
-
getCanTarget
public boolean getCanTarget()Queries whether the widget can be the target of pointer events.- Gibt zurück:
- true if @widget can receive pointer events
-
getChildVisible
public boolean getChildVisible()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.- Gibt zurück:
- true if the widget is mapped with the parent
-
getClipboard
Gets the clipboard object for the widget.
This is a utility function to get the clipboard object for the
display that @widget is using.
Note that this function always works, even when @widget is not
realized yet.- Gibt zurück:
- the appropriate clipboard object
-
getColor
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.- Parameter:
color- return location for the color
-
getCssClasses
Returns the list of style classes applied to the widget.- Gibt zurück:
- a `NULL`-terminated list of css classes currently applied to @widget
-
getCssName
Returns the CSS name of the widget.- Gibt zurück:
- the CSS name
-
getCursor
Gets the cursor set on the widget.
See [method@Gtk.Widget.set_cursor] for details.- Gibt zurück:
- the cursor that is set on @widget
-
getDirection
public int getDirection()Gets the reading direction for the widget.
See [method@Gtk.Widget.set_direction].- Gibt zurück:
- the reading direction for the widget
-
getDisplay
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 `GtkRoot` at the top.
In general, you should only create display-specific
resources when a widget has been realized, and you should
free those resources when the widget is unrealized.- Gibt zurück:
- the display for this widget
-
getFirstChild
Returns the widget’s first child.
This function is primarily meant for widget implementations.- Gibt zurück:
- the widget's first child
-
getFocusChild
Returns the focus child of the widget.- Gibt zurück:
- the current focus child of @widget
-
getFocusOnClick
public boolean getFocusOnClick()Returns whether the widget should grab focus when it is clicked
with the mouse.
See [method@Gtk.Widget.set_focus_on_click].- Gibt zurück:
- true if the widget should grab focus when it is clicked with the mouse
-
getFocusable
public boolean getFocusable()Determines whether the widget can own the input focus.
See [method@Gtk.Widget.set_focusable].- Gibt zurück:
- true if @widget can own the input focus
-
getFontMap
Gets the font map of the widget.
See [method@Gtk.Widget.set_font_map].- Gibt zurück:
- the font map of @widget
-
getFontOptions
Veraltet.Returns the `cairo_font_options_t` of the widget.
Seee [method@Gtk.Widget.set_font_options].- Gibt zurück:
- the `cairo_font_options_t` of widget
-
getFrameClock
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.- Gibt zurück:
- the frame clock
-
getHalign
public int getHalign()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.- Gibt zurück:
- the horizontal alignment of @widget
-
getHasTooltip
public boolean getHasTooltip()Returns the current value of the `has-tooltip` property.- Gibt zurück:
- current value of `has-tooltip` on @widget
-
getHeight
public int getHeight()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](coordinates.html).- Gibt zurück:
- The height of @widget
-
getHexpand
public boolean getHexpand()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.- Gibt zurück:
- whether hexpand flag is set
-
getHexpandSet
public boolean getHexpandSet()Gets whether the `hexpand` flag has been explicitly set.
If [property@Gtk.Widget:hexpand] property is set, then it
overrides any computed expand value based on child widgets.
If `hexpand` is not set, then the expand value depends on
whether any children of the widget would like to expand.
There are few reasons to use this function, but it’s here
for completeness and consistency.- Gibt zurück:
- whether hexpand has been explicitly set
-
getLastChild
Returns the widget’s last child.
This function is primarily meant for widget implementations.- Gibt zurück:
- the widget's last child
-
getLayoutManager
Retrieves the layout manager of the widget.
See [method@Gtk.Widget.set_layout_manager].- Gibt zurück:
- the layout manager of @widget
-
getLimitEvents
public boolean getLimitEvents()Gets the value of the [property@Gtk.Widget:limit-events] property.- Gibt zurück:
-
getMapped
public boolean getMapped()Returns whether the widget is mapped.- Gibt zurück:
- true if the widget is mapped
-
getMarginBottom
public int getMarginBottom()Gets the bottom margin of the widget.- Gibt zurück:
- The bottom margin of @widget
-
getMarginEnd
public int getMarginEnd()Gets the end margin of the widget.- Gibt zurück:
- The end margin of @widget
-
getMarginStart
public int getMarginStart()Gets the start margin of the widget.- Gibt zurück:
- The start margin of @widget
-
getMarginTop
public int getMarginTop()Gets the top margin of the widget.- Gibt zurück:
- The top margin of @widget
-
getName
Retrieves the name of a widget.
See [method@Gtk.Widget.set_name] for the significance of widget names.- Gibt zurück:
- name of the widget
-
getNative
Returns the nearest `GtkNative` ancestor of the widget.
This function will return `NULL` if the widget is not
contained inside a widget tree with a native ancestor.
`GtkNative` widgets will return themselves here.- Gibt zurück:
- the `GtkNative` ancestor of @widget
-
getNextSibling
Returns the widget’s next sibling.
This function is primarily meant for widget implementations.- Gibt zurück:
- the widget's next sibling
-
getOpacity
public double getOpacity()Fetches the requested opacity for the widget.
See [method@Gtk.Widget.set_opacity].- Gibt zurück:
- the requested opacity for this widget
-
getOverflow
public int getOverflow()Returns the widget’s overflow value.- Gibt zurück:
- The widget's overflow value
-
getPangoContext
Gets a `PangoContext` that is configured for the widget.
The `PangoContext` will 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.- Gibt zurück:
- the `PangoContext` for the widget
-
getParent
Returns the parent widget of the widget.- Gibt zurück:
- the parent widget of @widget
-
getPreferredSize
public void getPreferredSize(@Nullable Requisition minimum_size, @Nullable Requisition natural_size) Retrieves the minimum and natural size of a widget, taking
into account the widget’s preference for height-for-width management.
This is used to retrieve a suitable size by container widgets which do
not impose any restrictions on the child placement. It can be used
to deduce toplevel window and menu sizes as well as child widgets in
free-form containers such as `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.- Parameter:
minimum_size- location for storing the minimum sizenatural_size- location for storing the natural size
-
getPrevSibling
Returns the widget’s previous sibling.
This function is primarily meant for widget implementations.- Gibt zurück:
- the widget's previous sibling
-
getPrimaryClipboard
Gets the primary clipboard of the widget.
This is a utility function to get the primary clipboard object
for the display that @widget is using.
Note that this function always works, even when @widget is not
realized yet.- Gibt zurück:
- the appropriate clipboard object
-
getRealized
public boolean getRealized()Determines whether the widget is realized.- Gibt zurück:
- true if @widget is realized
-
getReceivesDefault
public boolean getReceivesDefault()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].- Gibt zurück:
- true if @widget acts as the default widget when focused
-
getRequestMode
public int getRequestMode()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.- Gibt zurück:
- The `GtkSizeRequestMode` preferred by @widget.
-
getRoot
Returns the `GtkRoot` widget of the widget.
This function will return `NULL` if the widget is not contained
inside a widget tree with a root widget.
`GtkRoot` widgets will return themselves here.- Gibt zurück:
- the root widget of @widget
-
getScaleFactor
public int getScaleFactor()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.- Gibt zurück:
- the scale factor for @widget
-
getSensitive
public boolean getSensitive()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].- Gibt zurück:
- true if the widget is sensitive
-
getSettings
Gets the settings object holding the settings used for the widget.
Note that this function can only be called when the `GtkWidget`
is attached to a toplevel, since the settings object is specific
to a particular display. If you want to monitor the widget for
changes in its settings, connect to the `notify::display` signal.- Gibt zurück:
- the relevant settings object
-
getSize
public int getSize(int orientation) 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](coordinates.html).- Parameter:
orientation- the orientation to query- Gibt zurück:
- the size of @widget in @orientation
-
getSizeRequest
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.- Parameter:
width- return location for widthheight- return location for height
-
getStateFlags
public int getStateFlags()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 @widget 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].- Gibt zurück:
- the state flags of widget
-
getStyleContext
Veraltet.Returns the style context associated to the widget.
The returned object is guaranteed to be the same
for the lifetime of @widget.- Gibt zurück:
- the widgets style context
-
getTemplateChild
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 structure offsets.- Parameter:
widget_type- The `GType` to get a template child forname- ID of the child defined in the template XML- Gibt zurück:
- the object built in the template XML with the id @name
-
getTemplateChild
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 structure offsets.- Parameter:
widget_type- The `GType` to get a template child forname- ID of the child defined in the template XML- Gibt zurück:
- the object built in the template XML with the id @name
-
getTooltipMarkup
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`.- Gibt zurück:
- the tooltip text
-
getTooltipText
Gets the contents of the tooltip for the widget.
If the @widget's tooltip was set using
[method@Gtk.Widget.set_tooltip_markup],
this function will return the escaped text.- Gibt zurück:
- the tooltip text
-
getValign
public int getValign()Gets the vertical alignment of the widget.- Gibt zurück:
- the vertical alignment of @widget
-
getVexpand
public boolean getVexpand()Gets whether the widget would like any available extra vertical
space.
See [method@Gtk.Widget.get_hexpand] for more detail.- Gibt zurück:
- whether vexpand flag is set
-
getVexpandSet
public boolean getVexpandSet()Gets whether the `vexpand` flag has been explicitly set.
See [method@Gtk.Widget.get_hexpand_set] for more detail.- Gibt zurück:
- whether vexpand has been explicitly set
-
getVisible
public boolean getVisible()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].- Gibt zurück:
- true if the widget is visible
-
getWidth
public int getWidth()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](coordinates.html).- Gibt zurück:
- The width of @widget
-
grabFocus
public boolean grabFocus()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.- Gibt zurück:
- true if focus is now inside @widget
-
hasCssClass
Returns whether a style class is currently applied to the widget.- Parameter:
css_class- style class, without the leading period- Gibt zurück:
- true if @css_class is currently applied to @widget
-
hasCssClass
Returns whether a style class is currently applied to the widget.- Parameter:
css_class- style class, without the leading period- Gibt zurück:
- true if @css_class is currently applied to @widget
-
hasDefault
public boolean hasDefault()Determines whether the widget is the current default widget
within its toplevel.- Gibt zurück:
- true if @widget is the current default widget within its toplevel
-
hasFocus
public boolean hasFocus()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.- Gibt zurück:
- true if the widget has the global input focus
-
hasVisibleFocus
public boolean hasVisibleFocus()Determines if the widget should show a visible indication that
it has the global input focus.
This is a convenience function that takes into account whether
focus indication should currently be shown in the toplevel window
of @widget. See [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].- Gibt zurück:
- true if the widget should display a “focus rectangle”
-
hide
Veraltet.Reverses the effects of [method.Gtk.Widget.show].
This is causing the widget to be hidden (invisible to the user). -
inDestruction
public boolean inDestruction()Returns whether the widget is currently being destroyed.
This information can sometimes be used to avoid doing
unnecessary work.- Gibt zurück:
- true if @widget is being destroyed
-
initTemplate
public void initTemplate()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()` or
`GObject.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 to `g_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. -
insertActionGroup
Inserts an action group into the widget's actions.
Children of @widget 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 @widget.- Parameter:
name- the prefix for actions in @groupgroup- an action group
-
insertActionGroup
Inserts an action group into the widget's actions.
Children of @widget 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 @widget.- Parameter:
name- the prefix for actions in @groupgroup- an action group
-
insertAfter
Sets the parent widget of the widget.
In contrast to [method@Gtk.Widget.set_parent], this function
inserts @widget 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 @widget, this
function can also be used to reorder @widget 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.- Parameter:
parent- the parent widget to insert @widget intoprevious_sibling- the new previous sibling of @widget
-
insertBefore
Sets the parent widget of the widget.
In contrast to [method@Gtk.Widget.set_parent], this function
inserts @widget 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 @widget, this function
can also be used to reorder @widget 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.- Parameter:
parent- the parent widget to insert @widget intonext_sibling- the new next sibling of @widget
-
isAncestor
Determines whether the widget is a descendent of @ancestor.- Parameter:
ancestor- another `GtkWidget`- Gibt zurück:
- true if @ancestor contains @widget as a child, grandchild, great grandchild, etc
-
isDrawable
public boolean isDrawable()Determines whether the widget can be drawn to.
A widget can be drawn if it is mapped and visible.- Gibt zurück:
- true if @widget is drawable
-
isFocus
public boolean isFocus()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.- Gibt zurück:
- true if the widget is the focus widget
-
isSensitive
public boolean isSensitive()Returns the widget’s effective sensitivity.
This means it is sensitive itself and also its
parent widget is sensitive.- Gibt zurück:
- true if the widget is effectively sensitive
-
isVisible
public boolean isVisible()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].- Gibt zurück:
- true if the widget and all its parents are visible
-
listMnemonicLabels
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.- Gibt zurück:
- the list of mnemonic labels
-
map
public void map()Causes a widget to be mapped if it isn’t already.
This function is only for use in widget implementations. -
measure
public void measure(int orientation, int for_size, @Nullable Int minimum, @Nullable Int natural, @Nullable Int minimum_baseline, @Nullable Int natural_baseline) Measures @widget in the orientation @orientation and for the given @for_size.
As an example, if @orientation is %GTK_ORIENTATION_HORIZONTAL and @for_size
is 300, this functions will compute the minimum and natural width of @widget
if it is allocated at a height of 300 pixels.
See [GtkWidget’s geometry management section](class.Widget.html#height-for-width-geometry-management) for
a more details on implementing `GtkWidgetClass.measure()`.- Parameter:
orientation- the orientation to measurefor_size- Size for the opposite of @orientation, i.e. if @orientation is %GTK_ORIENTATION_HORIZONTAL, this is the height the widget should be measured with. The %GTK_ORIENTATION_VERTICAL case is analogous. This way, both height-for-width and width-for-height requests can be implemented. If no size is known, -1 can be passed.minimum- location to store the minimum sizenatural- location to store the natural sizeminimum_baseline- location to store the baseline position for the minimum size, or -1 to report no baselinenatural_baseline- location to store the baseline position for the natural size, or -1 to report no baseline
-
mnemonicActivate
public boolean mnemonicActivate(boolean group_cycling) Emits the [signal@Gtk.Widget::mnemonic-activate] signal.- Parameter:
group_cycling- true if there are other widgets with the same mnemonic- Gibt zurück:
- true if the signal has been handled
-
observeChildren
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.- Gibt zurück:
- a list model tracking @widget's children
-
observeControllers
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.- Gibt zurück:
- a list model tracking @widget's controllers
-
pick
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 @widget's content area.
Usually widgets will return `NULL` if the given coordinate is not
contained in @widget checked via [method@Gtk.Widget.contains].
Otherwise they will recursively try to find a child that does
not return `NULL`. Widgets are however free to customize their
picking algorithm.
This function is used on the toplevel to determine the widget
below the mouse cursor for purposes of hover highlighting and
delivering events.- Parameter:
x- x coordinate to test, relative to @widget's originy- y coordinate to test, relative to @widget's originflags- flags to influence what is picked- Gibt zurück:
- the widget's descendant at (x, y)
-
queueAllocate
public void queueAllocate()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 @widget'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. -
queueDraw
public void queueDraw()Schedules this widget to be redrawn.
The redraw will happen in the paint phase
of the current or the next frame.
This means @widget's [vfunc@Gtk.Widget.snapshot]
implementation will be called. -
queueResize
public void queueResize()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 to gtk_widget_queue_resize() from inside
[vfunc@Gtk.Widget.size_allocate] will be silently ignored.
This function is only for use in widget implementations. -
realize
public void realize()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]. -
removeController
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.- Parameter:
controller- an event controller
-
removeCssClass
Removes a style from the widget.
After this, the style of @widget will stop matching for @css_class.- Parameter:
css_class- style class to remove from @widget, without the leading period
-
removeCssClass
Removes a style from the widget.
After this, the style of @widget will stop matching for @css_class.- Parameter:
css_class- style class to remove from @widget, without the leading period
-
removeMnemonicLabel
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].- Parameter:
label- a widget that is a mnemonic label for @widget
-
removeTickCallback
public void removeTickCallback(int id) Removes a tick callback previously registered with
[method@Gtk.Widget.add_tick_callback].- Parameter:
id- an ID returned by [method@Gtk.Widget.add_tick_callback]
-
setCanFocus
public void setCanFocus(boolean can_focus) 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.- Parameter:
can_focus- whether the input focus can enter the widget or any of its children
-
setCanTarget
public void setCanTarget(boolean can_target) Sets whether the widget can be the target of pointer events.- Parameter:
can_target- whether this widget should be able to receive pointer events
-
setChildVisible
public void setChildVisible(boolean child_visible) 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.- Parameter:
child_visible- whether @widget should be mapped along with its parent
-
setCssClasses
Replaces the current style classes of the widget with @classes.- Parameter:
classes- `NULL`-terminated list of style classes
-
setCursor
Sets the cursor to be shown when the pointer hovers over
the widget.
If the @cursor is `NULL`, @widget will use the cursor
inherited from its parent.- Parameter:
cursor- the new cursor
-
setCursorFromName
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 @widget
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 a `NULL` cursor.- Parameter:
name- the name of the cursor
-
setCursorFromName
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 @widget
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 a `NULL` cursor.- Parameter:
name- the name of the cursor
-
setDirection
public void setDirection(int dir) 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.- Parameter:
dir- the new direction
-
setFocusChild
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.- Parameter:
child- a direct child widget of @widget or `NULL` to unset the focus child
-
setFocusOnClick
public void setFocusOnClick(boolean focus_on_click) Sets whether the widget should grab focus when it is clicked
with the mouse.
Making mouse clicks not grab focus is useful in places like
toolbars where you don’t want the keyboard focus removed from
the main area of the application.- Parameter:
focus_on_click- whether the widget should grab focus when clicked with the mouse
-
setFocusable
public void setFocusable(boolean focusable) 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.- Parameter:
focusable- whether or not @widget can own the input focus
-
setFontMap
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.- Parameter:
font_map- a `PangoFontMap`
-
setFontOptions
Veraltet.Sets the `cairo_font_options_t` used for text rendering
in the widget.
When not set, the default font options for the `GdkDisplay`
will be used.- Parameter:
options- a `cairo_font_options_t` struct to unset any previously set default font options
-
setHalign
public void setHalign(int align) Sets the horizontal alignment of the widget.- Parameter:
align- the horizontal alignment
-
setHasTooltip
public void setHasTooltip(boolean has_tooltip) Sets the `has-tooltip` property on the widget.- Parameter:
has_tooltip- whether or not @widget has a tooltip
-
setHexpand
public void setHexpand(boolean 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_expand` virtual method on
`GtkWidget`.).
Setting hexpand explicitly with this function will override the
automatic expand behavior.
This function forces the widget to expand or not to expand,
regardless of children. The override occurs because
[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.- Parameter:
expand- whether to expand
-
setHexpandSet
public void setHexpandSet(boolean set) 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.- Parameter:
set- value for hexpand-set property
-
setLayoutManager
Sets the layout manager to use for measuring and allocating children
of the widget.- Parameter:
layout_manager- a layout manager
-
setLimitEvents
public void setLimitEvents(boolean limit_events) Sets whether the widget acts like a modal dialog,
with respect to event delivery.- Parameter:
limit_events- whether to limit events
-
setMarginBottom
public void setMarginBottom(int margin) Sets the bottom margin of the widget.- Parameter:
margin- the bottom margin
-
setMarginEnd
public void setMarginEnd(int margin) Sets the end margin of the widget.- Parameter:
margin- the end margin
-
setMarginStart
public void setMarginStart(int margin) Sets the start margin of the widget.- Parameter:
margin- the start margin
-
setMarginTop
public void setMarginTop(int margin) Sets the top margin of the widget.- Parameter:
margin- the top margin
-
setName
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.- Parameter:
name- name for the widget
-
setName
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.- Parameter:
name- name for the widget
-
setOpacity
public void setOpacity(double opacity) 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.- Parameter:
opacity- desired opacity, between 0 and 1
-
setOverflow
public void setOverflow(int overflow) 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].- Parameter:
overflow- desired overflow value
-
setParent
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`.- Parameter:
parent- parent widget
-
setReceivesDefault
public void setReceivesDefault(boolean receives_default) 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.- Parameter:
receives_default- whether or not @widget can be a default widget
-
setSensitive
public void setSensitive(boolean 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.- Parameter:
sensitive- true to make the widget sensitive
-
setSizeRequest
public void setSizeRequest(int width, int height) 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`.- Parameter:
width- width @widget should request, or -1 to unsetheight- height @widget should request, or -1 to unset
-
setStateFlags
public void setStateFlags(int flags, boolean clear) 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.- Parameter:
flags- state flags to turn onclear- whether to clear state before turning on @flags
-
setTooltipMarkup
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].- Parameter:
markup- the contents of the tooltip for @widget
-
setTooltipMarkup
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].- Parameter:
markup- the contents of the tooltip for @widget
-
setTooltipText
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].- Parameter:
text- the contents of the tooltip for @widget
-
setTooltipText
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].- Parameter:
text- the contents of the tooltip for @widget
-
setValign
public void setValign(int align) Sets the vertical alignment of the widget.- Parameter:
align- the vertical alignment
-
setVexpand
public void setVexpand(boolean expand) Sets whether the widget would like any available extra vertical
space.
See [method@Gtk.Widget.set_hexpand] for more detail.- Parameter:
expand- whether to expand
-
setVexpandSet
public void setVexpandSet(boolean set) Sets whether the vexpand flag will be used.
See [method@Gtk.Widget.set_hexpand_set] for more detail.- Parameter:
set- value for vexpand-set property
-
setVisible
public void setVisible(boolean visible) Sets the visibility state of @widget.
Note that setting this to true doesn’t mean the widget is
actually viewable, see [method@Gtk.Widget.get_visible].- Parameter:
visible- whether the widget should be shown or not
-
shouldLayout
public boolean shouldLayout()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.- Gibt zurück:
- true if child should be included in measuring and allocating
-
show
Veraltet.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. -
sizeAllocate
Allocates widget with a transformation that translates
the origin to the position in @allocation.
This is a simple form of [method@Gtk.Widget.allocate].- Parameter:
allocation- position and size to be allocated to @widgetbaseline- the baseline of the child, or -1
-
snapshotChild
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`.- Parameter:
child- a child of @widgetsnapshot- snapshot as passed to the widget. In particular, no calls to [method@Gtk.Snapshot.translate] or other transform calls should have been made
-
triggerTooltipQuery
public void triggerTooltipQuery()Triggers a tooltip query on the display of the widget. -
unmap
public void unmap()Causes a widget to be unmapped if it’s currently mapped.
This function is only for use in widget implementations. -
unparent
public void unparent()Removes @widget from its parent.
This function is only for use in widget implementations,
typically in dispose. -
unrealize
public void unrealize()Causes a widget to be unrealized.
This frees all GDK resources associated with the widget.
This function is only useful in widget implementations. -
unsetStateFlags
public void unsetStateFlags(int flags) Turns off flag values for the current widget state.
See [method@Gtk.Widget.set_state_flags].
This function is for use in widget implementations.- Parameter:
flags- state flags to turn off
-
onDestroy
Connect to signal "destroy".
SeeWidget.OnDestroy.onDestroy()for signal description.
FieldSIGNAL_ON_DESTROYcontains original signal name and can be used as resource reference.- Parameter:
signal- callback function (lambda).- Gibt zurück:
SignalHandler. Can be used to disconnect signal and to release callback function.
-
onDirectionChanged
Connect to signal "direction-changed".
SeeWidget.OnDirectionChanged.onDirectionChanged(int)for signal description.
FieldSIGNAL_ON_DIRECTION_CHANGEDcontains original signal name and can be used as resource reference.- Parameter:
signal- callback function (lambda).- Gibt zurück:
SignalHandler. Can be used to disconnect signal and to release callback function.
-
onHide
Connect to signal "hide".
SeeWidget.OnHide.onHide()for signal description.
FieldSIGNAL_ON_HIDEcontains original signal name and can be used as resource reference.- Parameter:
signal- callback function (lambda).- Gibt zurück:
SignalHandler. Can be used to disconnect signal and to release callback function.
-
onMap
Connect to signal "map".
SeeWidget.OnMap.onMap()for signal description.
FieldSIGNAL_ON_MAPcontains original signal name and can be used as resource reference.- Parameter:
signal- callback function (lambda).- Gibt zurück:
SignalHandler. Can be used to disconnect signal and to release callback function.
-
onMnemonicActivate
Connect to signal "mnemonic-activate".
SeeWidget.OnMnemonicActivate.onMnemonicActivate(boolean)for signal description.
FieldSIGNAL_ON_MNEMONIC_ACTIVATEcontains original signal name and can be used as resource reference.- Parameter:
signal- callback function (lambda).- Gibt zurück:
SignalHandler. Can be used to disconnect signal and to release callback function.
-
onMoveFocus
Connect to signal "move-focus".
SeeWidget.OnMoveFocus.onMoveFocus(int)for signal description.
FieldSIGNAL_ON_MOVE_FOCUScontains original signal name and can be used as resource reference.- Parameter:
signal- callback function (lambda).- Gibt zurück:
SignalHandler. Can be used to disconnect signal and to release callback function.
-
onQueryTooltip
Connect to signal "query-tooltip".
SeeWidget.OnQueryTooltip.onQueryTooltip(int, int, boolean, ch.bailu.gtk.gtk.Tooltip)for signal description.
FieldSIGNAL_ON_QUERY_TOOLTIPcontains original signal name and can be used as resource reference.- Parameter:
signal- callback function (lambda).- Gibt zurück:
SignalHandler. Can be used to disconnect signal and to release callback function.
-
onRealize
Connect to signal "realize".
SeeWidget.OnRealize.onRealize()for signal description.
FieldSIGNAL_ON_REALIZEcontains original signal name and can be used as resource reference.- Parameter:
signal- callback function (lambda).- Gibt zurück:
SignalHandler. Can be used to disconnect signal and to release callback function.
-
onShow
Connect to signal "show".
SeeWidget.OnShow.onShow()for signal description.
FieldSIGNAL_ON_SHOWcontains original signal name and can be used as resource reference.- Parameter:
signal- callback function (lambda).- Gibt zurück:
SignalHandler. Can be used to disconnect signal and to release callback function.
-
onStateFlagsChanged
Connect to signal "state-flags-changed".
SeeWidget.OnStateFlagsChanged.onStateFlagsChanged(int)for signal description.
FieldSIGNAL_ON_STATE_FLAGS_CHANGEDcontains original signal name and can be used as resource reference.- Parameter:
signal- callback function (lambda).- Gibt zurück:
SignalHandler. Can be used to disconnect signal and to release callback function.
-
onUnmap
Connect to signal "unmap".
SeeWidget.OnUnmap.onUnmap()for signal description.
FieldSIGNAL_ON_UNMAPcontains original signal name and can be used as resource reference.- Parameter:
signal- callback function (lambda).- Gibt zurück:
SignalHandler. Can be used to disconnect signal and to release callback function.
-
onUnrealize
Connect to signal "unrealize".
SeeWidget.OnUnrealize.onUnrealize()for signal description.
FieldSIGNAL_ON_UNREALIZEcontains original signal name and can be used as resource reference.- Parameter:
signal- callback function (lambda).- Gibt zurück:
SignalHandler. Can be used to disconnect signal and to release callback function.
-
getDefaultDirection
public static int getDefaultDirection()Obtains the default reading direction.
See [func@Gtk.Widget.set_default_direction].- Gibt zurück:
- the current default direction
-
setDefaultDirection
public static void setDefaultDirection(int dir) Sets the default reading direction for widgets.
See [method@Gtk.Widget.set_direction].- Parameter:
dir- the new default direction, either [enum@Gtk.TextDirection.ltr] or [enum@Gtk.TextDirection.rtl]
-
asAccessible
Implements interfaceAccessible. Call this to get access to interface functions.- Gibt zurück:
Accessible
-
asBuildable
Implements interfaceBuildable. Call this to get access to interface functions.- Gibt zurück:
Buildable
-
asConstraintTarget
Implements interfaceConstraintTarget. Call this to get access to interface functions.- Gibt zurück:
ConstraintTarget
-
getTypeID
public static long getTypeID() -
getParentTypeID
public static long getParentTypeID() -
getTypeSize
-
getParentTypeSize
-
getInstanceSize
public static int getInstanceSize()
-