Gtk.SizeGroup

Gtk.SizeGroup — Grouping widgets so they request the same size

Object Hierarchy:

    GObject
    ╰── Gtk.SizeGroup

Functions:

Description:

Gtk.SizeGroup provides a mechanism for grouping a number of widgets together so they all request the same amount of space. This is typically useful when you want a column of widgets to have the same size, but you can’t use a Gtk.Grid widget.

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::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 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. For example, if you are packing your widgets into a table, you would not include the %GTK_FILL flag.

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 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 \ element with class="Gtk.SizeGroup" somewhere in the UI definition. The widgets that belong to the size group are specified by a \ element that may contain multiple \ 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 Gtk.SizeGroup:

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

Function Details:

new()

new (mode:Gtk.SizeGroupMode) -> Gtk.SizeGroup

Create a new Gtk.SizeGroup.

  • Returns: a newly created Gtk.SizeGroup

set_mode()

set_mode (self, mode:Gtk.SizeGroupMode)

Sets the Gtk.SizeGroupMode of the size group. The mode of the sizegroup determines whether the widgets in the size group shouldall 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).

get_mode()

get_mode (self) -> Gtk.SizeGroupMode

Gets the current mode of the size group. See Gtk.SizeGroup:set_mode().

  • Returns: the current mode of the size group.

set_ignore_hidden()

set_ignore_hidden (self, ignore_hidden:bool)

Sets whether unmapped widgets should be ignored whencalculating the size.

  • Since: 2.8

get_ignore_hidden()

get_ignore_hidden (self) -> bool

Returns if invisible widgets are ignored when calculating the size.

  • Returns: True if invisible widgets are ignored.

  • Since: 2.8

add_widget()

add_widget (self, widget:Gtk.Widget)

Adds a widget to a Gtk.SizeGroup. In the future, the requisitionof the widget will be determined as the maximum of its requisitionand the requisition of the other widgets in the size group.Whether this applies horizontally, vertically, or in both directionsdepends on the mode of the size group. See Gtk.SizeGroup:set_mode(). When the widget is destroyed or no longer referenced elsewhere, it will be removed from the size group.

remove_widget()

remove_widget (self, widget:Gtk.Widget)

Removes a widget from a Gtk.SizeGroup.

get_widgets()

get_widgets (self) -> list

Returns the list of widgets associated with size_group.

  • Returns: a GSList ofwidgets. The list is owned by GTK+ and should not be modified.

  • Since: 2.10

Example:

import gi
gi.require_version('Gtk', '3.0')
from gi.repository import Gtk

class SizeGroup(Gtk.Window):
    def __init__(self):
        Gtk.Window.__init__(self)
        self.connect("destroy", Gtk.main_quit)

        box = Gtk.Box(orientation=Gtk.Orientation.HORIZONTAL, spacing=2)
        self.add(box)

        sizegroup = Gtk.SizeGroup()
        sizegroup.set_mode(Gtk.SizeGroupMode.HORIZONTAL)

        button = Gtk.Button(label="Arch")
        sizegroup.add_widget(button)
        box.pack_start(button, True, True, 0)

        button = Gtk.Button(label="Debian")
        sizegroup.add_widget(button)
        box.pack_start(button, True, True, 0)

        button = Gtk.Button(label="Red Hat\nEnterprise Linux")
        sizegroup.add_widget(button)
        box.pack_start(button, True, True, 0)

window = SizeGroup()
window.show_all()

Gtk.main()

results matching ""

    No results matching ""