class Gtk::SizeGroup
- Gtk::SizeGroup
- GObject::Object
- Reference
- Object
Overview
Gtk::SizeGroup
groups widgets together so they all request the same size.
This is typically useful when you want a column of widgets to have the
same size, but you can’t use a Gtk::Grid
.
In detail, the size requested for each widget in a Gtk::SizeGroup
is
the maximum of the sizes that would have been requested for each
widget in the size group if they were not in the size group. The mode
of the size group (see Gtk::SizeGroup#mode=
) determines whether
this applies to the horizontal size, the vertical size, or both sizes.
Note that size groups only affect the amount of space requested, not
the size that the widgets finally receive. If you want the widgets in
a Gtk::SizeGroup
to actually be the same size, you need to pack them in
such a way that they get the size they request and not more.
Gtk::SizeGroup
objects are referenced by each widget in the size group,
so once you have added all widgets to a Gtk::SizeGroup
, you can drop
the initial reference to the size group with g_object_unref(). If the
widgets in the size group are subsequently destroyed, then they will
be removed from the size group and drop their references on the size
group; when all widgets have been removed, the size group will be
freed.
Widgets can be part of multiple size groups; GTK will compute the horizontal size of a widget from the horizontal requisition of all widgets that can be reached from the widget by a chain of size groups of type %GTK_SIZE_GROUP_HORIZONTAL or %GTK_SIZE_GROUP_BOTH, and the vertical size from the vertical requisition of all widgets that can be reached from the widget by a chain of size groups of type %GTK_SIZE_GROUP_VERTICAL or %GTK_SIZE_GROUP_BOTH.
Note that only non-contextual sizes of every widget are ever consulted by size groups (since size groups have no knowledge of what size a widget will be allocated in one dimension, it cannot derive how much height a widget will receive for a given width). When grouping widgets that trade height for width in mode %GTK_SIZE_GROUP_VERTICAL or %GTK_SIZE_GROUP_BOTH: the height for the minimum width will be the requested height for all widgets in the group. The same is of course true when horizontally grouping width for height widgets.
Widgets that trade height-for-width should set a reasonably large minimum width by way of [property@Gtk.Label:width-chars] for instance. Widgets with static sizes as well as widgets that grow (such as ellipsizing text) need no such considerations.
Gtk::SizeGroup as Gtk::Buildable
Size groups can be specified in a UI definition by placing an
An example of a UI definition fragment with Gtk::SizeGroup
:
WARNING ⚠️ The following code is in xml ⚠️
<object class="Gtk::SizeGroup">
<property name="mode">horizontal</property>
<widgets>
<widget name="radio1"/>
<widget name="radio2"/>
</widgets>
</object>
Included Modules
Defined in:
lib/gi-crystal/src/auto/gtk-4.0/size_group.crConstructors
-
.new(mode : Gtk::SizeGroupMode) : self
Create a new
Gtk::SizeGroup
. -
.new
Initialize a new
SizeGroup
. - .new(*, mode : Gtk::SizeGroupMode | Nil = nil)
Class Method Summary
-
.g_type : UInt64
Returns the type id (GType) registered in GLib type system.
Instance Method Summary
-
#==(other : self)
Returns
true
if this reference is the same as other. -
#add_widget(widget : Gtk::Widget) : Nil
Adds a widget to a
Gtk::SizeGroup
. -
#hash(hasher)
See
Object#hash(hasher)
-
#mode : Gtk::SizeGroupMode
Gets the current mode of the size group.
-
#mode=(mode : Gtk::SizeGroupMode) : Nil
Sets the
Gtk::SizeGroupMode
of the size group. -
#remove_widget(widget : Gtk::Widget) : Nil
Removes a widget from a
Gtk::SizeGroup
. -
#widgets : GLib::SList
Returns the list of widgets associated with size_group.
Instance methods inherited from module Gtk::Buildable
buildable_id : String | Nil
buildable_id,
to_unsafe
to_unsafe
Constructor methods inherited from module Gtk::Buildable
cast(obj : GObject::Object) : self
cast
Class methods inherited from module Gtk::Buildable
cast?(obj : GObject::Object) : self | Nil
cast?,
g_type : UInt64
g_type
Instance methods inherited from class GObject::Object
==(other : self)
==,
bind_property(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags) : GObject::Binding
bind_property,
bind_property_full(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags, transform_to : GObject::Closure, transform_from : GObject::Closure) : GObject::Binding
bind_property_full,
data(key : String) : Pointer(Void) | Nil
data,
finalize
finalize,
freeze_notify : Nil
freeze_notify,
getv(names : Enumerable(String), values : Enumerable(_)) : Nil
getv,
hash(hasher)
hash,
notify(property_name : String) : Nil
notify,
notify_by_pspec(pspec : GObject::ParamSpec) : Nil
notify_by_pspec,
notify_signal
notify_signal,
property(property_name : String, value : _) : Nil
property,
qdata(quark : UInt32) : Pointer(Void) | Nil
qdata,
ref_count : UInt32
ref_count,
run_dispose : Nil
run_dispose,
set_data(key : String, data : Pointer(Void) | Nil) : Nil
set_data,
set_property(property_name : String, value : _) : Nil
set_property,
steal_data(key : String) : Pointer(Void) | Nil
steal_data,
steal_qdata(quark : UInt32) : Pointer(Void) | Nil
steal_qdata,
thaw_notify : Nil
thaw_notify,
to_unsafe : Pointer(Void)
to_unsafe,
watch_closure(closure : GObject::Closure) : Nil
watch_closure
Constructor methods inherited from class GObject::Object
cast(obj : GObject::Object) : self
cast,
new(pointer : Pointer(Void), transfer : GICrystal::Transfer)new new, newv(object_type : UInt64, parameters : Enumerable(GObject::Parameter)) : self newv
Class methods inherited from class GObject::Object
cast?(obj : GObject::Object) : self | Nil
cast?,
compat_control(what : UInt64, data : Pointer(Void) | Nil) : UInt64
compat_control,
g_type : UInt64
g_type,
interface_find_property(g_iface : GObject::TypeInterface, property_name : String) : GObject::ParamSpec
interface_find_property,
interface_list_properties(g_iface : GObject::TypeInterface) : Enumerable(GObject::ParamSpec)
interface_list_properties
Macros inherited from class GObject::Object
previous_vfunc(*args)
previous_vfunc,
previous_vfunc!(*args)
previous_vfunc!,
signal(signature)
signal
Constructor Detail
Class Method Detail
Returns the type id (GType) registered in GLib type system.
Instance Method Detail
Returns true
if this reference is the same as other. Invokes same?
.
Adds a widget to a Gtk::SizeGroup
.
In the future, the requisition
of the widget will be determined as the maximum of its requisition
and the requisition of the other widgets in the size group.
Whether this applies horizontally, vertically, or in both directions
depends on the mode of the size group.
See Gtk::SizeGroup#mode=
.
When the widget is destroyed or no longer referenced elsewhere, it will be removed from the size group.
Sets the Gtk::SizeGroupMode
of the size group.
The mode of the size group determines whether the widgets in the size group should all have the same horizontal requisition (%GTK_SIZE_GROUP_HORIZONTAL) all have the same vertical requisition (%GTK_SIZE_GROUP_VERTICAL), or should all have the same requisition in both directions (%GTK_SIZE_GROUP_BOTH).