:right-sidebar: True

SizeGroup
===================================================================

.. currentmodule:: gi.repository.Gtk





.. class:: SizeGroup(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.GObject.Object`



Implemented Interfaces: :class:`~gi.repository.Gtk.Buildable`



``GtkSizeGroup`` 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 ``GtkGrid``.

In detail, the size requested for each widget in a ``GtkSizeGroup`` 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 :obj:`~gi.repository.Gtk.SizeGroup.set_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 ``GtkSizeGroup`` 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.

``GtkSizeGroup`` objects are referenced by each widget in the size group,
so once you have added all widgets to a ``GtkSizeGroup``, you can drop
the initial reference to the size group with :func:`~gi.repository.GObject.GObject.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 :const:`~gi.repository.Gtk.SizeGroupMode.HORIZONTAL` or :const:`~gi.repository.Gtk.SizeGroupMode.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
:const:`~gi.repository.Gtk.SizeGroupMode.VERTICAL` or :const:`~gi.repository.Gtk.SizeGroupMode.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 :const:`~gi.repository.Gtk.SizeGroupMode.VERTICAL` or :const:`~gi.repository.Gtk.SizeGroupMode.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 :obj:`~gi.repository.Gtk.Label.props.width_chars` for instance. Widgets with
static sizes as well as widgets that grow (such as ellipsizing text) need no
such considerations.

GtkSizeGroup as GtkBuildable
----------------------------

Size groups can be specified in a UI definition by placing an ``<object>``
element with ``class="GtkSizeGroup"`` somewhere in the UI definition. The
widgets that belong to the size group are specified by a ``<widgets>`` element
that may contain multiple ``<widget>`` elements, one for each member of the
size group. The ”name” attribute gives the id of the widget.

An example of a UI definition fragment with ``GtkSizeGroup``:

.. code-block::
   :dedent:

   <object class="GtkSizeGroup">
     <property name="mode">horizontal</property>
     <widgets>
       <widget name="radio1"/>
       <widget name="radio2"/>
     </widgets>
   </object>




Constructors
------------

.. rst-class:: interim-class

.. class:: SizeGroup
   :no-index:


   .. classmethod:: new(mode: ~gi.repository.Gtk.SizeGroupMode) -> ~gi.repository.Gtk.SizeGroup

      Create a new ``GtkSizeGroup``.







      :param mode: the mode for the new size group.









Methods
-------

.. rst-class:: interim-class

.. class:: SizeGroup
   :no-index:


   .. method:: add_widget(widget: ~gi.repository.Gtk.Widget) -> None

      Adds a widget to a ``GtkSizeGroup``.

      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 :obj:`~gi.repository.Gtk.SizeGroup.set_mode`.

      When the widget is destroyed or no longer referenced elsewhere, it
      will be removed from the size group.







      :param widget: the ``GtkWidget`` to add





   .. method:: get_mode() -> ~gi.repository.Gtk.SizeGroupMode

      Gets the current mode of the size group.










   .. method:: get_widgets() -> list[~gi.repository.Gtk.Widget]

      Returns the list of widgets associated with ``size_group``.










   .. method:: remove_widget(widget: ~gi.repository.Gtk.Widget) -> None

      Removes a widget from a ``GtkSizeGroup``.







      :param widget: the ``GtkWidget`` to remove





   .. method:: set_mode(mode: ~gi.repository.Gtk.SizeGroupMode) -> None

      Sets the ``GtkSizeGroupMode`` 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
      (:const:`~gi.repository.Gtk.SizeGroupMode.HORIZONTAL`) all have the same vertical requisition
      (:const:`~gi.repository.Gtk.SizeGroupMode.VERTICAL`), or should all have the same requisition
      in both directions (:const:`~gi.repository.Gtk.SizeGroupMode.BOTH`).







      :param mode: the mode to set for the size group.









Properties
----------

.. rst-class:: interim-class

.. class:: SizeGroup
   :no-index:
   

   .. attribute:: props.mode
      :type: ~gi.repository.Gtk.SizeGroupMode

      The direction in which the size group affects requested sizes.















Fields
------

.. rst-class:: interim-class

.. class:: SizeGroup
   :no-index:
   

   .. attribute:: parent_instance