Package: gtk

Class gtk-size-group

Superclasses

gtk-buildable, g-object, common-lisp:standard-object, common-lisp:t

Documented Subclasses

None

Direct Slots

ignore-hidden
The ignore-hidden property of type :boolean (Read / Write)
If true, unmapped widgets are ignored when determining the size of the group.
Warning: The ignore-hidden property has been deprecated since version 3.22 and should not be used in newly-written code. 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 gtk-stack instead to hide widgets while still having their size taken into account.
Default value: nil
mode
The mode property of type gtk-size-group-mode (Read / Write)
The directions in which the size group affects the requested sizes of its component widgets.
Default value: :horizontal

Details

gtk-size-group 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 cannot use a gtk-grid widget.

In detail, the size requested for each widget in a gtk-size-group 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 the gtk-size-group-mode function, 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-size-group 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 :fill flag.

gtk-size-group objects are referenced by each widget in the size group, so once you have added all widgets to a gtk-size-group, you can drop the initial reference to the size group with the g-object-unref function. 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 :horizontal or :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 :vertical or :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 :vertical or :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 "width-chars" for instance. Widgets with static sizes as well as widgets that grow (such as ellipsizing text) need no such considerations.

gtk-size-group as gtk-buildable
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.

Example: A UI definition fragment with gtk-size-group
   <object class="GtkSizeGroup">
     <property name="mode">GTK_SIZE_GROUP_HORIZONTAL</property>
     <widgets>
       <widget name="radio1"/>
       <widget name="radio2"/>
     </widgets>
   </object>    
 

Slot Access Functions

Inherited Slot Access Functions

2013-5-23