Optionalproperties: Partial<Adw.WrapLayout.ConstructorProps>Internal$signalsCompile-time signal type information.
This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.
Static$gtypeSince 1.7alignThe alignment of the children within each line.
0 means the children are placed at the start of the line, 1 means they are placed at the end of the line. 0.5 means they are placed in the middle of the line.
Alignment is only used when WrapLayout.justify is set to
ADW_JUSTIFY_NONE, or on the last line when the
WrapLayout.justify_last_line is FALSE.
Since 1.7child_The spacing between widgets on the same line.
Since 1.7child_The length unit for child spacing.
Allows the spacing to vary depending on the text scale factor.
Since 1.7childThe spacing between widgets on the same line.
Since 1.7childThe length unit for child spacing.
Allows the spacing to vary depending on the text scale factor.
Since 1.7justifyDetermines whether and how each complete line should be stretched to fill the entire widget.
If set to ADW_JUSTIFY_FILL, each widget in the line will be stretched,
keeping consistent spacing, so that the line fills the entire widget.
If set to ADW_JUSTIFY_SPREAD, the spacing between widgets will be
increased, keeping widget sizes intact. The first and last widget will be
aligned with the beginning and end of the line. If the line only contains a
single widget, it will be stretched regardless.
If set to ADW_JUSTIFY_NONE, the line will not be stretched and the
children will be placed together within the line, according to
WrapLayout.align.
By default this doesn't affect the last line, as it will be incomplete. Use WrapLayout.justify_last_line to justify it as well.
Since 1.7justify_Whether the last line should be stretched to fill the entire widget.
See WrapLayout.justify.
Since 1.7justifyWhether the last line should be stretched to fill the entire widget.
See WrapLayout.justify.
Since 1.7line_Since 1.7line_Since 1.7line_The length unit for line spacing.
Allows the spacing to vary depending on the text scale factor.
Since 1.7lineSince 1.7lineSince 1.7lineThe length unit for line spacing.
Allows the spacing to vary depending on the text scale factor.
Since 1.7natural_Determines the natural size for each line.
It should be used to limit the line lengths, for example when used in popovers.
Since 1.7natural_The length unit for natural line length.
Allows the length to vary depending on the text scale factor.
Since 1.7naturalDetermines the natural size for each line.
It should be used to limit the line lengths, for example when used in popovers.
Since 1.7naturalThe length unit for natural line length.
Allows the length to vary depending on the text scale factor.
Since 1.7pack_Since 1.7packSince 1.7wrap_The policy for line wrapping.
If set to ADW_WRAP_NATURAL, the box will wrap to the next line as soon as
the previous line cannot fit any more children without shrinking them past
their natural size.
If set to ADW_WRAP_MINIMUM, the box will try to fit as many children into
each line as possible, shrinking them down to their minimum size before
wrapping to the next line.
Since 1.7wrap_Since 1.7wrapThe policy for line wrapping.
If set to ADW_WRAP_NATURAL, the box will wrap to the next line as soon as
the previous line cannot fit any more children without shrinking them past
their natural size.
If set to ADW_WRAP_MINIMUM, the box will try to fit as many children into
each line as possible, shrinking them down to their minimum size before
wrapping to the next line.
Since 1.7wrapThe orientation of the orientable.
Creates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
GObject.Binding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A GObject.Object can have multiple bindings.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Complete version of g_object_bind_property().
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well. The transform_from function is only used in case
of bidirectional bindings, otherwise it will be ignored
The binding will automatically be removed when either the source or the
target instances are finalized. This will release the reference that is
being held on the GObject.Binding instance; if you want to hold on to the
GObject.Binding instance, you will need to hold a reference to it.
To remove the binding, call g_binding_unbind().
A GObject.Object can have multiple bindings.
The same user_data parameter will be used for both transform_to
and transform_from transformation functions; the notify function will
be called once, when the binding is removed. If you need different data
for each transformation function, please use
g_object_bind_property_with_closures() instead.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
Optionaltransform_to: BindingTransformFuncthe transformation function from the source to the target, or null to use the default
Optionaltransform_from: BindingTransformFuncthe transformation function from the target to the source, or null to use the default
Optionalnotify: DestroyNotifya function to call when disposing the binding, to free resources used by the transformation functions, or null if not required
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of
g_object_bind_property_full(), using GClosures instead of
function pointers.
the property on source to bind
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Blocks a handler of an instance so it will not be called during any signal emissions
Handler ID of the handler to be blocked
SignalconnectSignalconnect_Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
Handler ID of the handler to be disconnected
SignalemitThis function is intended for GObject.Object implementations to re-enforce
a [floating][floating-ref] object reference. Doing this is seldom
required: all GInitiallyUnowneds are created with a floating reference
which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object. If the freeze count is
non-zero, the emission of "notify" signals on object is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
GObject.Object::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Gets the alignment of the children within each line.
the child alignment
Gets spacing between widgets on the same line.
spacing between widgets on the same line
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
the data if found, or null if no such data exists.
Gets whether and how each complete line is stretched to fill the entire widget.
the justify mode
Gets whether the last line should be stretched to fill the entire widget.
whether the last line is justified
Gets whether all lines should take the same amount of space.
whether lines should be homogeneous
Gets the spacing between lines.
the line spacing
Gets the natural size for each line.
the natural length
Retrieves the orientation of the orientable.
the orientation of the orientable
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
The name of the property to get
Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
This function gets back user data pointers stored via
g_object_set_qdata().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Gets whether wrap direction is reversed.
whether wrap direction is reversed
Gets n_properties properties for an object.
Obtained properties will be set to values. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Checks whether object has a [floating][floating-ref] reference.
true if object has a floating reference
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than
g_object_notify().
One way to avoid using g_object_notify() from within the
class that registered the properties, and using g_object_notify_by_pspec()
instead, is to store the GParamSpec used with
g_object_class_install_property() inside a static array, e.g.:
typedef enum
{
PROP_FOO = 1,
PROP_LAST
} MyObjectProperty;
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
0, 100,
50,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the GObject.ParamSpec of a property installed on the class of object.
Increases the reference count of object.
Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type
of object will be propagated to the return type (using the GCC typeof()
extension), so any casting the caller needs to do on the return type must be
explicit.
the same object
Increase the reference count of object, and possibly remove the
[floating][floating-ref] reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
object
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
Object containing the properties to set
Sets the alignment of the children within each line.
0 means the children are placed at the start of the line, 1 means they are placed at the end of the line. 0.5 means they are placed in the middle of the line.
Alignment is only used when WrapLayout.justify is set to
ADW_JUSTIFY_NONE, or on the last line when the
WrapLayout.justify_last_line is FALSE.
the child alignment
Sets the spacing between widgets on the same line.
the child spacing
Sets the length unit for child spacing.
Allows the spacing to vary depending on the text scale factor.
the length unit
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a GLib.Quark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the GLib.Quark storage growing unbounded.
name of the key
Optionaldata: anydata to associate with that key
Sets whether and how each complete line should be stretched to fill the entire widget.
If set to ADW_JUSTIFY_FILL, each widget in the line will be stretched,
keeping consistent spacing, so that the line fills the entire widget.
If set to ADW_JUSTIFY_SPREAD, the spacing between widgets will be
increased, keeping widget sizes intact. The first and last widget will be
aligned with the beginning and end of the line. If the line only contains a
single widget, it will be stretched regardless.
If set to ADW_JUSTIFY_NONE, the line will not be stretched and the children
will be placed together within the line, according to
WrapLayout.align.
By default this doesn't affect the last line, as it will be incomplete. Use WrapLayout.justify_last_line to justify it as well.
the justify mode
Sets whether the last line should be stretched to fill the entire widget.
See WrapLayout.justify.
whether to justify the last line
Sets whether all lines should take the same amount of space.
whether lines should be homogeneous
Sets the spacing between lines.
the line spacing
Sets the length unit for line spacing.
Allows the spacing to vary depending on the text scale factor.
the length unit
Sets the natural size for each line.
It should be used to limit the line lengths, for example when used in popovers.
the natural length
Sets the length unit for natural line length.
Allows the length to vary depending on the text scale factor.
the length unit
Sets the orientation of the orientable.
the orientable’s new orientation
Sets the direction children are packed in each line.
the new line direction
Sets a property on an object.
The name of the property to set
The value to set the property to
Sets the policy for line wrapping.
If set to ADW_WRAP_NATURAL, the box will wrap to the next line as soon as
the previous line cannot fit any more children without shrinking them past
their natural size.
If set to ADW_WRAP_MINIMUM, the box will try to fit as many children into
each line as possible, shrinking them down to their minimum size before
wrapping to the next line.
the new wrap policy
Sets whether wrap direction should be reversed.
By default, lines wrap downwards in a horizontal box, and towards the end
in a vertical box. If set to TRUE, they wrap upwards or towards the start
respectively.
whether to reverse wrap direction
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
the data if found, or null if no such data exists.
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of
g_object_steal_qdata() would have left the destroy function set,
and thus the partial string list would have been freed upon
g_object_set_qdata_full().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
Name of the signal to stop emission of
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Unblocks a handler so it will be called again during any signal emissions
Handler ID of the handler to be unblocked
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the GObject.Object may be reused in future (for example, if it is
an instance variable of another object), it is recommended to clear the
pointer to null rather than retain a dangling pointer to a potentially
invalid GObject.Object instance. Use g_clear_object() for this.
Virtualvfunc_the constructed function is called by g_object_new() as the
final step of the object creation process. At the point of the call, all
construction properties have been set on the object. The purpose of this
call is to allow for object initialisation steps that can only be performed
after construction properties have been set. constructed implementors
should chain up to the constructed call of their parent class to allow it
to complete its initialisation.
Virtualvfunc_Virtualvfunc_the dispose function is supposed to drop all references to other
objects, but keep the instance otherwise intact, so that client method
invocations still work. It may be run multiple times (due to reference
loops). Before returning, dispose should chain up to the dispose method
of the parent class.
Virtualvfunc_instance finalization function, should finish the finalization of
the instance begun in dispose and chain up to the finalize method of the
parent class.
Virtualvfunc_Virtualvfunc_Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
Virtualvfunc_the generic setter for all properties of this type. Should be
overridden for every type with properties. If implementations of
set_property don't emit property change notification explicitly, this will
be done implicitly by the type system. However, if the notify signal is
emitted explicitly, the type system will not emit it a second time.
This function essentially limits the life time of the closure to
the life time of the object. That is, when the object is finalized,
the closure is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure, to ensure that an extra
reference count is held on object during invocation of the
closure. Usually, this function will be called on closures that
use this object as closure data.
GObject.Closure to watch
StaticnewAssigns the given width, height, and baseline to
a widget, and computes the position and sizes of the children of
the widget using the layout management policy of manager.
the Gtk.Widget using manager
the new width of the widget
the new height of the widget
the baseline position of the widget, or -1
Retrieves a Gtk.LayoutChild instance for the Gtk.LayoutManager, creating one if necessary.
The child widget must be a child of the widget using manager.
The Gtk.LayoutChild instance is owned by the Gtk.LayoutManager,
and is guaranteed to exist as long as child is a child of the
Gtk.Widget using the given Gtk.LayoutManager.
Queues a resize on the Gtk.Widget using manager, if any.
This function should be called by subclasses of Gtk.LayoutManager in response to changes to their layout management policies.
Measures the size of the widget using manager, for the
given orientation and size.
See the Gtk.Widget documentation on layout management for more details.
the Gtk.Widget using manager
the orientation to measure
Size for the opposite of orientation; for instance, if the orientation is Gtk.Orientation.HORIZONTAL, this is the height of the widget; if the orientation is Gtk.Orientation.VERTICAL, this is the width of the widget. This allows to measure the height for the given width, and the width for the given height. Use -1 if the size is not known
Virtualvfunc_Assigns the given width, height, and baseline to
a widget, and computes the position and sizes of the children of
the widget using the layout management policy of manager.
the Gtk.Widget using manager
the new width of the widget
the new height of the widget
the baseline position of the widget, or -1
Virtualvfunc_Create a Gtk.LayoutChild instance for the given for_child widget.
Virtualvfunc_a virtual function, used to return the preferred request mode for the layout manager; for instance, "width for height" or "height for width"; see Gtk.SizeRequestMode
Virtualvfunc_Measures the size of the widget using manager, for the
given orientation and size.
See the Gtk.Widget documentation on layout management for more details.
the Gtk.Widget using manager
the orientation to measure
Size for the opposite of orientation; for instance, if the orientation is Gtk.Orientation.HORIZONTAL, this is the height of the widget; if the orientation is Gtk.Orientation.VERTICAL, this is the width of the widget. This allows to measure the height for the given width, and the width for the given height. Use -1 if the size is not known
Virtualvfunc_a virtual function, called when the widget using the layout manager is attached to a Gtk.Root
Virtualvfunc_a virtual function, called when the widget using the layout manager is detached from a Gtk.Root
Static_Staticcompat_Optionaldata: anyStaticfind_Staticinstall_Staticinstall_the id for the new property
the GObject.ParamSpec for the new property
Staticinterface_Find the GObject.ParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Staticinterface_Add a property to an interface; this is only useful for interfaces
that are added to GObject-derived types. Adding a property to an
interface forces all objects classes with that interface to have a
compatible property. The compatible property could be a newly
created GObject.ParamSpec, but normally
g_object_class_override_property() will be used so that the object
class only needs to provide an implementation and inherits the
property description, default value, bounds, and so forth from the
interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
GObject.TypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the GObject.ParamSpec for the new property
Staticinterface_Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Staticlist_StaticnewvStaticoverride_the new property ID
the name of a property registered in a parent class or in an interface of this class.
A box-like layout that can wrap into multiple lines.
Adw.WrapLayout is similar to Gtk.BoxLayout, but can wrap lines when the widgets cannot fit otherwise. Unlike Gtk.FlowBox, the children aren't arranged into a grid and behave more like words in a wrapping label.
Like Gtk.BoxLayout, Adw.WrapLayout is orientable and has spacing:
::: note Unlike Gtk.BoxLayout, Adw.WrapLayout cannot follow the CSS
border-spacingproperty.Use the WrapLayout.natural_line_length property to determine the layout's natural size, e.g. when using it in a Gtk.Popover.
Normally, a horizontal Adw.WrapLayout wraps left to right and top to bottom for left-to-right languages. Both of these directions can be reversed, using the WrapLayout.pack_direction and WrapLayout.wrap_reverse properties. Additionally, the alignment of each line can be controlled with the WrapLayout.align property.
Lines can be justified using the WrapLayout.justify property, filling the entire line by either increasing child size or spacing depending on the value. Set WrapLayout.justify_last_line to justify the last line as well.
By default, Adw.WrapLayout wraps as soon as the previous line cannot fit any more children without shrinking them past their natural size. Set WrapLayout.wrap_policy to Adw.WrapPolicy.MINIMUM to only wrap once all the children in the previous line have been shrunk to their minimum size.
To make each line take the same amount of space, set WrapLayout.line_homogeneous to
TRUE.Spacing and natural line length can scale with the text scale factor, use the WrapLayout.child_spacing_unit, WrapLayout.line_spacing_unit and/or WrapLayout.natural_line_length_unit properties to enable that behavior.
See WrapBox.
Since
1.7