Copyright | Will Thompson, Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
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 Grid
widget.
In detail, the size requested for each widget in a 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 sizeGroupSetMode
) 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 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 AttachOptionsFill
flag.
SizeGroup
objects are referenced by each widget in the size group,
so once you have added all widgets to a SizeGroup
, you can drop
the initial reference to the size group with objectUnref
. 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 SizeGroupModeHorizontal
or SizeGroupModeBoth
, 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
SizeGroupModeVertical
or SizeGroupModeBoth
.
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 SizeGroupModeVertical
or SizeGroupModeBoth
:
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 Label
: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: > >class="GtkSizeGroup" > name="mode"GTK_SIZE_GROUP_HORIZONTAL/property > widgets > name="radio1"/ > name="radio2"/ > /widgets >/object
- newtype SizeGroup = SizeGroup (ManagedPtr SizeGroup)
- class GObject o => IsSizeGroup o
- toSizeGroup :: IsSizeGroup o => o -> IO SizeGroup
- noSizeGroup :: Maybe SizeGroup
- data SizeGroupAddWidgetMethodInfo
- sizeGroupAddWidget :: (HasCallStack, MonadIO m, IsSizeGroup a, IsWidget b) => a -> b -> m ()
- data SizeGroupGetIgnoreHiddenMethodInfo
- sizeGroupGetIgnoreHidden :: (HasCallStack, MonadIO m, IsSizeGroup a) => a -> m Bool
- data SizeGroupGetModeMethodInfo
- sizeGroupGetMode :: (HasCallStack, MonadIO m, IsSizeGroup a) => a -> m SizeGroupMode
- data SizeGroupGetWidgetsMethodInfo
- sizeGroupGetWidgets :: (HasCallStack, MonadIO m, IsSizeGroup a) => a -> m [Widget]
- sizeGroupNew :: (HasCallStack, MonadIO m) => SizeGroupMode -> m SizeGroup
- data SizeGroupRemoveWidgetMethodInfo
- sizeGroupRemoveWidget :: (HasCallStack, MonadIO m, IsSizeGroup a, IsWidget b) => a -> b -> m ()
- data SizeGroupSetIgnoreHiddenMethodInfo
- sizeGroupSetIgnoreHidden :: (HasCallStack, MonadIO m, IsSizeGroup a) => a -> Bool -> m ()
- data SizeGroupSetModeMethodInfo
- sizeGroupSetMode :: (HasCallStack, MonadIO m, IsSizeGroup a) => a -> SizeGroupMode -> m ()
- data SizeGroupIgnoreHiddenPropertyInfo
- constructSizeGroupIgnoreHidden :: IsSizeGroup o => Bool -> IO (GValueConstruct o)
- getSizeGroupIgnoreHidden :: (MonadIO m, IsSizeGroup o) => o -> m Bool
- setSizeGroupIgnoreHidden :: (MonadIO m, IsSizeGroup o) => o -> Bool -> m ()
- sizeGroupIgnoreHidden :: AttrLabelProxy "ignoreHidden"
- data SizeGroupModePropertyInfo
- constructSizeGroupMode :: IsSizeGroup o => SizeGroupMode -> IO (GValueConstruct o)
- getSizeGroupMode :: (MonadIO m, IsSizeGroup o) => o -> m SizeGroupMode
- setSizeGroupMode :: (MonadIO m, IsSizeGroup o) => o -> SizeGroupMode -> m ()
- sizeGroupMode :: AttrLabelProxy "mode"
Exported types
GObject SizeGroup Source # | |
IsObject SizeGroup Source # | |
IsSizeGroup SizeGroup Source # | |
IsBuildable SizeGroup Source # | |
((~) * info (ResolveSizeGroupMethod t SizeGroup), MethodInfo * info SizeGroup p) => IsLabel t (SizeGroup -> p) Source # | |
((~) * info (ResolveSizeGroupMethod t SizeGroup), MethodInfo * info SizeGroup p) => IsLabelProxy t (SizeGroup -> p) Source # | |
HasAttributeList * SizeGroup Source # | |
type AttributeList SizeGroup Source # | |
type SignalList SizeGroup Source # | |
class GObject o => IsSizeGroup o Source #
toSizeGroup :: IsSizeGroup o => o -> IO SizeGroup Source #
Methods
addWidget
data SizeGroupAddWidgetMethodInfo Source #
((~) * signature (b -> m ()), MonadIO m, IsSizeGroup a, IsWidget b) => MethodInfo * SizeGroupAddWidgetMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsSizeGroup a, IsWidget b) | |
=> a |
|
-> b |
|
-> m () |
Adds a widget to a SizeGroup
. 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 sizeGroupSetMode
.
When the widget is destroyed or no longer referenced elsewhere, it will be removed from the size group.
getIgnoreHidden
data SizeGroupGetIgnoreHiddenMethodInfo Source #
((~) * signature (m Bool), MonadIO m, IsSizeGroup a) => MethodInfo * SizeGroupGetIgnoreHiddenMethodInfo a signature Source # | |
sizeGroupGetIgnoreHidden Source #
:: (HasCallStack, MonadIO m, IsSizeGroup a) | |
=> a |
|
-> m Bool | Returns: |
Deprecated: (Since version 3.22)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 Stack
instead to hide widgets while still having their size taken into account.
Returns if invisible widgets are ignored when calculating the size.
Since: 2.8
getMode
data SizeGroupGetModeMethodInfo Source #
((~) * signature (m SizeGroupMode), MonadIO m, IsSizeGroup a) => MethodInfo * SizeGroupGetModeMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsSizeGroup a) | |
=> a |
|
-> m SizeGroupMode | Returns: the current mode of the size group. |
Gets the current mode of the size group. See sizeGroupSetMode
.
getWidgets
data SizeGroupGetWidgetsMethodInfo Source #
((~) * signature (m [Widget]), MonadIO m, IsSizeGroup a) => MethodInfo * SizeGroupGetWidgetsMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsSizeGroup a) | |
=> a |
|
-> m [Widget] | Returns: a |
Returns the list of widgets associated with sizeGroup
.
Since: 2.10
new
:: (HasCallStack, MonadIO m) | |
=> SizeGroupMode |
|
-> m SizeGroup | Returns: a newly created |
Create a new SizeGroup
.
removeWidget
data SizeGroupRemoveWidgetMethodInfo Source #
((~) * signature (b -> m ()), MonadIO m, IsSizeGroup a, IsWidget b) => MethodInfo * SizeGroupRemoveWidgetMethodInfo a signature Source # | |
sizeGroupRemoveWidget Source #
:: (HasCallStack, MonadIO m, IsSizeGroup a, IsWidget b) | |
=> a |
|
-> b |
|
-> m () |
Removes a widget from a SizeGroup
.
setIgnoreHidden
data SizeGroupSetIgnoreHiddenMethodInfo Source #
((~) * signature (Bool -> m ()), MonadIO m, IsSizeGroup a) => MethodInfo * SizeGroupSetIgnoreHiddenMethodInfo a signature Source # | |
sizeGroupSetIgnoreHidden Source #
:: (HasCallStack, MonadIO m, IsSizeGroup a) | |
=> a |
|
-> Bool |
|
-> m () |
Deprecated: (Since version 3.22)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 Stack
instead to hide widgets while still having their size taken into account.
Sets whether unmapped widgets should be ignored when calculating the size.
Since: 2.8
setMode
data SizeGroupSetModeMethodInfo Source #
((~) * signature (SizeGroupMode -> m ()), MonadIO m, IsSizeGroup a) => MethodInfo * SizeGroupSetModeMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsSizeGroup a) | |
=> a |
|
-> SizeGroupMode |
|
-> m () |
Sets the SizeGroupMode
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 (SizeGroupModeHorizontal
)
all have the same vertical requisition (SizeGroupModeVertical
),
or should all have the same requisition in both directions
(SizeGroupModeBoth
).
Properties
ignoreHidden
data SizeGroupIgnoreHiddenPropertyInfo Source #
constructSizeGroupIgnoreHidden :: IsSizeGroup o => Bool -> IO (GValueConstruct o) Source #
getSizeGroupIgnoreHidden :: (MonadIO m, IsSizeGroup o) => o -> m Bool Source #
setSizeGroupIgnoreHidden :: (MonadIO m, IsSizeGroup o) => o -> Bool -> m () Source #
sizeGroupIgnoreHidden :: AttrLabelProxy "ignoreHidden" Source #
mode
data SizeGroupModePropertyInfo Source #
constructSizeGroupMode :: IsSizeGroup o => SizeGroupMode -> IO (GValueConstruct o) Source #
getSizeGroupMode :: (MonadIO m, IsSizeGroup o) => o -> m SizeGroupMode Source #
setSizeGroupMode :: (MonadIO m, IsSizeGroup o) => o -> SizeGroupMode -> m () Source #
sizeGroupMode :: AttrLabelProxy "mode" Source #