SizeGroupProtocol

public protocol SizeGroupProtocol : ObjectProtocol, BuildableProtocol

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

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

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 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 GtkLabel: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:

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

The SizeGroupProtocol protocol exposes the methods and properties of an underlying GtkSizeGroup instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see SizeGroup. Alternatively, use SizeGroupRef as a lighweight, unowned reference if you already have an instance you just want to use.

Show on GitHub

ptr
Untyped pointer to the underlying GtkSizeGroup instance.
Declaration
Swift

var ptr: UnsafeMutableRawPointer! { get }
Show on GitHub
size_group_ptr Default implementation
Typed pointer to the underlying GtkSizeGroup instance.

Default Implementation

Return the stored, untyped pointer as a typed pointer to the GtkSizeGroup instance.
Declaration
Swift

var size_group_ptr: UnsafeMutablePointer<GtkSizeGroup>! { get }
Show on GitHub
init(raw:)
Required Initialiser for types conforming to SizeGroupProtocol
Declaration
Swift

init(raw: UnsafeMutableRawPointer)
Show on GitHub

SizeGroup Class


                    
                    
                    bind(property:to:_:flags:transformFrom:transformTo:)

Extension method

Bind a SizeGroupPropertyName source property to a given target object.

Declaration

Swift

@discardableResult
@inlinable
func bind<Q, T>(property source_property: SizeGroupPropertyName, to target: T, _ target_property: Q, flags f: BindingFlags = .default, transformFrom transform_from: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }, transformTo transform_to: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }) -> BindingRef! where Q : PropertyNameProtocol, T : ObjectProtocol

Parameters

`source_property`	the source property to bind
`target`	the target object to bind to
`target_property`	the target property to bind to
`flags`	the flags to pass to the `Binding`
`transform_from`	`ValueTransformer` to use for forward transformation
`transform_to`	`ValueTransformer` to use for backwards transformation

Return Value

binding reference or nil in case of an error

Show on GitHub


                    
                    
                    get(property:)

Extension method

Get the value of a SizeGroup property

Declaration

Swift

@inlinable
func get(property: SizeGroupPropertyName) -> GLibObject.Value

Parameters


                                property

the property to get the value for

Return Value

the value of the named property

Show on GitHub


                    
                    
                    set(property:value:)

Extension method

Set the value of a SizeGroup property. Note that this will only have an effect on properties that are writable and not construct-only!

Declaration

Swift

@inlinable
func set(property: SizeGroupPropertyName, value v: GLibObject.Value)

Parameters


                                property

the property to get the value for

Return Value

the value of the named property

Show on GitHub

SizeGroup Class: SizeGroupProtocol extension (methods and fields)

add(widget:) Extension method
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 gtk_size_group_set_mode().

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

@inlinable func add<WidgetT>(widget: WidgetT) where WidgetT : WidgetProtocol
Show on GitHub
getIgnoreHidden() Extension method
Returns if invisible widgets are ignored when calculating the size.

get_ignore_hidden is deprecated: Measuring the size of hidden widgets has not worked reliably for a long time. In most cases, they will report a size of 0 nowadays, and thus, their size will not affect the other size group members. In effect, size groups will always operate as if this property was %TRUE. Use a #GtkStack instead to hide widgets while still having their size taken into account.
Declaration
Swift

@available(*, deprecated) @inlinable func getIgnoreHidden() -> Bool
Show on GitHub
getMode() Extension method
Gets the current mode of the size group. See gtk_size_group_set_mode().
Declaration
Swift

@inlinable func getMode() -> GtkSizeGroupMode
Show on GitHub
getWidgets() Extension method
Returns the list of widgets associated with size_group.
Declaration
Swift

@inlinable func getWidgets() -> GLib.SListRef!
Show on GitHub
remove(widget:) Extension method
Removes a widget from a GtkSizeGroup.
Declaration
Swift

@inlinable func remove<WidgetT>(widget: WidgetT) where WidgetT : WidgetProtocol
Show on GitHub
set(ignoreHidden:) Extension method
Sets whether unmapped widgets should be ignored when calculating the size.

set_ignore_hidden is deprecated: Measuring the size of hidden widgets has not worked reliably for a long time. In most cases, they will report a size of 0 nowadays, and thus, their size will not affect the other size group members. In effect, size groups will always operate as if this property was %TRUE. Use a #GtkStack instead to hide widgets while still having their size taken into account.
Declaration
Swift

@available(*, deprecated) @inlinable func set(ignoreHidden: Bool)
Show on GitHub
set(mode:) Extension method
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 (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).
Declaration
Swift

@inlinable func set(mode: GtkSizeGroupMode)
Show on GitHub
ignoreHidden Extension method
Returns if invisible widgets are ignored when calculating the size.

get_ignore_hidden is deprecated: Measuring the size of hidden widgets has not worked reliably for a long time. In most cases, they will report a size of 0 nowadays, and thus, their size will not affect the other size group members. In effect, size groups will always operate as if this property was %TRUE. Use a #GtkStack instead to hide widgets while still having their size taken into account.
Declaration
Swift

@inlinable var ignoreHidden: Bool { get nonmutating set }
Show on GitHub


                    
                    
                    mode

Extension method

Undocumented

Declaration

Swift

@inlinable
var mode: GtkSizeGroupMode { get nonmutating set }

Show on GitHub

widgets Extension method
Returns the list of widgets associated with size_group.
Declaration
Swift

@inlinable var widgets: GLib.SListRef! { get }
Show on GitHub
parentInstance Extension method
Undocumented
Declaration
Swift

@inlinable var parentInstance: GObject { get }
Show on GitHub

SizeGroupProtocol

GtkSizeGroup as GtkBuildable

Declaration

Default Implementation

Declaration

Declaration

SizeGroup Class

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

SizeGroup Class: SizeGroupProtocol extension (methods and fields)

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration