GtkSizeGroup

GtkSizeGroup — Grouping widgets so they request the same size

Synopsis


#include <gtk/gtk.h>


            GtkSizeGroup;
enum        GtkSizeGroupMode;
GtkSizeGroup* gtk_size_group_new            (GtkSizeGroupMode mode);
void        gtk_size_group_set_mode         (GtkSizeGroup *size_group,
                                             GtkSizeGroupMode mode);
GtkSizeGroupMode gtk_size_group_get_mode    (GtkSizeGroup *size_group);
void        gtk_size_group_set_ignore_hidden
                                            (GtkSizeGroup *size_group,
                                             gboolean ignore_hidden);
gboolean    gtk_size_group_get_ignore_hidden
                                            (GtkSizeGroup *size_group);
void        gtk_size_group_add_widget       (GtkSizeGroup *size_group,
                                             GtkWidget *widget);
void        gtk_size_group_remove_widget    (GtkSizeGroup *size_group,
                                             GtkWidget *widget);
GSList*     gtk_size_group_get_widgets      (GtkSizeGroup *size_group);

Object Hierarchy


  GObject
   +----GtkSizeGroup

Implemented Interfaces

GtkSizeGroup implements GtkBuildable.

Properties


  "ignore-hidden"        gboolean              : Read / Write
  "mode"                 GtkSizeGroupMode      : Read / Write

Description

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 GtkTable 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.

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.

Example 42. 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>

Details

GtkSizeGroup

typedef struct _GtkSizeGroup GtkSizeGroup;

enum GtkSizeGroupMode

typedef enum {
  GTK_SIZE_GROUP_NONE,
  GTK_SIZE_GROUP_HORIZONTAL,
  GTK_SIZE_GROUP_VERTICAL,
  GTK_SIZE_GROUP_BOTH
} GtkSizeGroupMode;

The mode of the size group determines the directions in which the size group affects the requested sizes of its component widgets.

GTK_SIZE_GROUP_NONE group has no effect
GTK_SIZE_GROUP_HORIZONTAL group affects horizontal requisition
GTK_SIZE_GROUP_VERTICAL group affects vertical requisition
GTK_SIZE_GROUP_BOTH group affects both horizontal and vertical requisition

gtk_size_group_new ()

GtkSizeGroup* gtk_size_group_new            (GtkSizeGroupMode mode);

Create a new GtkSizeGroup.

mode : the mode for the new size group.
Returns : a newly created GtkSizeGroup

gtk_size_group_set_mode ()

void        gtk_size_group_set_mode         (GtkSizeGroup *size_group,
                                             GtkSizeGroupMode mode);

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_MODE_HORIZONTAL) all have the same vertical requisition (GTK_SIZE_GROUP_MODE_VERTICAL), or should all have the same requisition in both directions (GTK_SIZE_GROUP_MODE_BOTH).

size_group : a GtkSizeGroup
mode : the mode to set for the size group.

gtk_size_group_get_mode ()

GtkSizeGroupMode gtk_size_group_get_mode    (GtkSizeGroup *size_group);

Gets the current mode of the size group. See gtk_size_group_set_mode().

size_group : a GtkSizeGroup
Returns : the current mode of the size group.

gtk_size_group_set_ignore_hidden ()

void        gtk_size_group_set_ignore_hidden
                                            (GtkSizeGroup *size_group,
                                             gboolean ignore_hidden);

Sets whether unmapped widgets should be ignored when calculating the size.

size_group : a GtkSizeGroup
ignore_hidden : whether unmapped widgets should be ignored when calculating the size

Since 2.8

gtk_size_group_get_ignore_hidden ()

gboolean    gtk_size_group_get_ignore_hidden
                                            (GtkSizeGroup *size_group);

Returns if invisible widgets are ignored when calculating the size.

size_group : a GtkSizeGroup
Returns : TRUE if invisible widgets are ignored.

Since 2.8

gtk_size_group_add_widget ()

void        gtk_size_group_add_widget       (GtkSizeGroup *size_group,
                                             GtkWidget *widget);

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().

size_group : a GtkSizeGroup
widget : the GtkWidget to add

gtk_size_group_remove_widget ()

void        gtk_size_group_remove_widget    (GtkSizeGroup *size_group,
                                             GtkWidget *widget);

Removes a widget from a GtkSizeGroup.

size_group : a GtkSizeGrup
widget : the GtkWidget to remove

gtk_size_group_get_widgets ()

GSList*     gtk_size_group_get_widgets      (GtkSizeGroup *size_group);

Returns the list of widgets associated with size_group.

size_group : a GtkSizeGrup
Returns : a GSList of widgets. The list is owned by GTK+ and should not be modified.

Since 2.10

Property Details

The "ignore-hidden" property

  "ignore-hidden"        gboolean              : Read / Write

If TRUE, unmapped widgets are ignored when determining the size of the group.

Default value: FALSE

Since 2.8

The "mode" property

  "mode"                 GtkSizeGroupMode      : Read / Write

The directions in which the size group affects the requested sizes of its component widgets.

Default value: GTK_SIZE_GROUP_HORIZONTAL