GI.Gtk.Objects.FlowBox

A GtkFlowBox positions child widgets in sequence according to its orientation.

For instance, with the horizontal orientation, the widgets will be arranged from left to right, starting a new row under the previous row when necessary. Reducing the width in this case will require more rows, so a larger height will be requested.

Likewise, with the vertical orientation, the widgets will be arranged from top to bottom, starting a new column to the right when necessary. Reducing the height will require more columns, so a larger width will be requested.

The size request of a GtkFlowBox alone may not be what you expect; if you need to be able to shrink it along both axes and dynamically reflow its children, you may have to wrap it in a ScrolledWindow to enable that.

The children of a GtkFlowBox can be dynamically sorted and filtered.

Although a GtkFlowBox must have only FlowBoxChild children, you can add any kind of widget to it via containerAdd, and a GtkFlowBoxChild widget will automatically be inserted between the box and the widget.

Also see ListBox.

GtkFlowBox was added in GTK+ 3.12.

CSS nodes

plain code

flowbox
├── flowboxchild
│   ╰── <child>
├── flowboxchild
│   ╰── <child>
┊
╰── [rubberband]

GtkFlowBox uses a single CSS node with name flowbox. GtkFlowBoxChild uses a single CSS node with name flowboxchild. For rubberband selection, a subnode with name rubberband is used.

Exported types

newtype FlowBox

Memory-managed wrapper type.

Constructors

FlowBox (ManagedPtr FlowBox)

Instances

Eq FlowBox

Defined in GI.Gtk.Objects.FlowBox

Methods

(==) :: FlowBox -> FlowBox -> Bool

(/=) :: FlowBox -> FlowBox -> Bool

GObject FlowBox

Defined in GI.Gtk.Objects.FlowBox

ManagedPtrNewtype FlowBox

Defined in GI.Gtk.Objects.FlowBox

Methods

toManagedPtr :: FlowBox -> ManagedPtr FlowBox

TypedObject FlowBox

Defined in GI.Gtk.Objects.FlowBox

Methods

glibType :: IO GType

HasParentTypes FlowBox

Defined in GI.Gtk.Objects.FlowBox

IsGValue (Maybe FlowBox)

Convert FlowBox to and from GValue. See toGValue and fromGValue.

Defined in GI.Gtk.Objects.FlowBox

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe FlowBox -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe FlowBox)

type ParentTypes FlowBox

Defined in GI.Gtk.Objects.FlowBox

type ParentTypes FlowBox = '[Container, Widget, Object, ImplementorIface, Buildable, Orientable]

class (GObject o, IsDescendantOf FlowBox o) => IsFlowBox o

Type class for types which can be safely cast to FlowBox, for instance with toFlowBox.

Instances

(GObject o, IsDescendantOf FlowBox o) => IsFlowBox o

Defined in GI.Gtk.Objects.FlowBox

toFlowBox :: (MonadIO m, IsFlowBox o) => o -> m FlowBox

Cast to FlowBox, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

activate, add, addAccelerator, addChild, addDeviceEvents, addEvents, addMnemonicLabel, addTickCallback, bindModel, bindProperty, bindPropertyFull, canActivateAccel, checkResize, childFocus, childGetProperty, childNotify, childNotifyByPspec, childSetProperty, childType, classPath, computeExpand, constructChild, createPangoContext, createPangoLayout, customFinished, customTagEnd, customTagStart, destroy, destroyed, deviceIsShadowed, dragBegin, dragBeginWithCoordinates, dragCheckThreshold, dragDestAddImageTargets, dragDestAddTextTargets, dragDestAddUriTargets, dragDestFindTarget, dragDestGetTargetList, dragDestGetTrackMotion, dragDestSet, dragDestSetProxy, dragDestSetTargetList, dragDestSetTrackMotion, dragDestUnset, dragGetData, dragHighlight, dragSourceAddImageTargets, dragSourceAddTextTargets, dragSourceAddUriTargets, dragSourceGetTargetList, dragSourceSet, dragSourceSetIconGicon, dragSourceSetIconName, dragSourceSetIconPixbuf, dragSourceSetIconStock, dragSourceSetTargetList, dragSourceUnset, dragUnhighlight, draw, ensureStyle, errorBell, event, forall, forceFloating, foreach, freezeChildNotify, freezeNotify, getv, grabAdd, grabDefault, grabFocus, grabRemove, hasDefault, hasFocus, hasGrab, hasRcStyle, hasScreen, hasVisibleFocus, hide, hideOnDelete, inDestruction, initTemplate, inputShapeCombineRegion, insert, insertActionGroup, intersect, invalidateFilter, invalidateSort, isAncestor, isComposited, isDrawable, isFloating, isFocus, isSensitive, isToplevel, isVisible, keynavFailed, listAccelClosures, listActionPrefixes, listMnemonicLabels, map, mnemonicActivate, modifyBase, modifyBg, modifyCursor, modifyFg, modifyFont, modifyStyle, modifyText, notify, notifyByPspec, overrideBackgroundColor, overrideColor, overrideCursor, overrideFont, overrideSymbolicColor, parserFinished, path, propagateDraw, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, ref, refSink, regionIntersect, registerWindow, remove, removeAccelerator, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reparent, resetRcStyles, resetStyle, resizeChildren, runDispose, selectAll, selectChild, selectedForeach, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, stealData, stealQdata, styleAttach, styleGetProperty, thawChildNotify, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unregisterWindow, unselectAll, unselectChild, unsetFocusChain, unsetStateFlags, watchClosure.

Getters

getAccessible, getActionGroup, getActivateOnSingleClick, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getBorderWidth, getCanDefault, getCanFocus, getChildAtIndex, getChildAtPos, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getColumnSpacing, getCompositeName, getData, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEvents, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusVadjustment, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getHomogeneous, getInternalChild, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getMaxChildrenPerLine, getMinChildrenPerLine, getModifierMask, getModifierStyle, getName, getNoShowAll, getOpacity, getOrientation, getPangoContext, getParent, getParentWindow, getPath, getPathForChild, getPointer, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRequisition, getResizeMode, getRootWindow, getRowSpacing, getScaleFactor, getScreen, getSelectedChildren, getSelectionMode, getSensitive, getSettings, getSizeRequest, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTemplateChild, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisual, getWindow.

Setters

setAccelPath, setActivateOnSingleClick, setAllocation, setAppPaintable, setBorderWidth, setBuildableProperty, setCanDefault, setCanFocus, setChildVisible, setClip, setColumnSpacing, setCompositeName, setData, setDataFull, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEvents, setFilterFunc, setFocusChain, setFocusChild, setFocusHadjustment, setFocusOnClick, setFocusVadjustment, setFontMap, setFontOptions, setHadjustment, setHalign, setHasTooltip, setHasWindow, setHexpand, setHexpandSet, setHomogeneous, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setMaxChildrenPerLine, setMinChildrenPerLine, setName, setNoShowAll, setOpacity, setOrientation, setParent, setParentWindow, setProperty, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setResizeMode, setRowSpacing, setSelectionMode, setSensitive, setSizeRequest, setSortFunc, setState, setStateFlags, setStyle, setSupportMultidevice, setTooltipMarkup, setTooltipText, setTooltipWindow, setVadjustment, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow.

bindModel

flowBoxBindModel

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a, IsListModel b)

=> a

box: a FlowBox

-> Maybe b

model: the ListModel to be bound to box

-> FlowBoxCreateWidgetFunc

createWidgetFunc: a function that creates widgets for items

-> m ()

Binds model to box.

If box was already bound to a model, that previous binding is destroyed.

The contents of box are cleared and then filled with widgets that represent items from model. box is updated whenever model changes. If model is Nothing, box is left empty.

It is undefined to add or remove widgets directly (for example, with flowBoxInsert or containerAdd) while box is bound to a model.

Note that using a model is incompatible with the filtering and sorting functionality in GtkFlowBox. When using a model, filtering and sorting should be implemented by the model.

Since: 3.18

getActivateOnSingleClick

flowBoxGetActivateOnSingleClick

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a)

=> a

box: a FlowBox

-> m Bool

Returns: True if children are activated on single click, False otherwise

Returns whether children activate on single clicks.

Since: 3.12

getChildAtIndex

flowBoxGetChildAtIndex

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a)

=> a

box: a FlowBox

-> Int32

idx: the position of the child

-> m (Maybe FlowBoxChild)

Returns: the child widget, which will always be a FlowBoxChild or Nothing in case no child widget with the given index exists.

Gets the nth child in the box.

Since: 3.12

getChildAtPos

flowBoxGetChildAtPos

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a)

=> a

box: a FlowBox

-> Int32

x: the x coordinate of the child

-> Int32

y: the y coordinate of the child

-> m (Maybe FlowBoxChild)

Returns: the child widget, which will always be a FlowBoxChild or Nothing in case no child widget exists for the given x and y coordinates.

Gets the child in the (x, y) position.

Since: 3.22.6

getColumnSpacing

flowBoxGetColumnSpacing

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a)

=> a

box: a FlowBox

-> m Word32

Returns: the horizontal spacing

Gets the horizontal spacing.

Since: 3.12

getHomogeneous

flowBoxGetHomogeneous

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a)

=> a

box: a FlowBox

-> m Bool

Returns: True if the box is homogeneous.

Returns whether the box is homogeneous (all children are the same size). See boxSetHomogeneous.

Since: 3.12

getMaxChildrenPerLine

flowBoxGetMaxChildrenPerLine

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a)

=> a

box: a FlowBox

-> m Word32

Returns: the maximum number of children per line

Gets the maximum number of children per line.

Since: 3.12

getMinChildrenPerLine

flowBoxGetMinChildrenPerLine

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a)

=> a

box: a FlowBox

-> m Word32

Returns: the minimum number of children per line

Gets the minimum number of children per line.

Since: 3.12

getRowSpacing

flowBoxGetRowSpacing

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a)

=> a

box: a FlowBox

-> m Word32

Returns: the vertical spacing

Gets the vertical spacing.

Since: 3.12

getSelectedChildren

flowBoxGetSelectedChildren

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a)

=> a

box: a FlowBox

-> m [FlowBoxChild]

Returns: A List containing the Widget for each selected child. Free with g_list_free() when done.

Creates a list of all selected children.

Since: 3.12

getSelectionMode

flowBoxGetSelectionMode

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a)

=> a

box: a FlowBox

-> m SelectionMode

Returns: the SelectionMode

Gets the selection mode of box.

Since: 3.12

insert

flowBoxInsert

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a, IsWidget b)

=> a

box: a FlowBox

-> b

widget: the Widget to add

-> Int32

position: the position to insert child in

-> m ()

Inserts the widget into box at position.

If a sort function is set, the widget will actually be inserted at the calculated position and this function has the same effect as containerAdd.

If position is -1, or larger than the total number of children in the box, then the widget will be appended to the end.

Since: 3.12

invalidateFilter

flowBoxInvalidateFilter

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a)

=> a

box: a FlowBox

-> m ()

Updates the filtering for all children.

Call this function when the result of the filter function on the box is changed due ot an external factor. For instance, this would be used if the filter function just looked for a specific search term, and the entry with the string has changed.

Since: 3.12

invalidateSort

flowBoxInvalidateSort

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a)

=> a

box: a FlowBox

-> m ()

Updates the sorting for all children.

Call this when the result of the sort function on box is changed due to an external factor.

Since: 3.12

new

flowBoxNew

Arguments

:: (HasCallStack, MonadIO m)

=> m FlowBox

Returns: a new FlowBox container

Creates a GtkFlowBox.

Since: 3.12

selectAll

flowBoxSelectAll

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a)

=> a

box: a FlowBox

-> m ()

Select all children of box, if the selection mode allows it.

Since: 3.12

selectChild

flowBoxSelectChild

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a, IsFlowBoxChild b)

=> a

box: a FlowBox

-> b

child: a child of box

-> m ()

Selects a single child of box, if the selection mode allows it.

Since: 3.12

selectedForeach

flowBoxSelectedForeach

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a)

=> a

box: a FlowBox

-> FlowBoxForeachFunc

func: the function to call for each selected child

-> m ()

Calls a function for each selected child.

Note that the selection cannot be modified from within this function.

Since: 3.12

setActivateOnSingleClick

flowBoxSetActivateOnSingleClick

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a)

=> a

box: a FlowBox

-> Bool

single: True to emit child-activated on a single click

-> m ()

If single is True, children will be activated when you click on them, otherwise you need to double-click.

Since: 3.12

setColumnSpacing

flowBoxSetColumnSpacing

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a)

=> a

box: a FlowBox

-> Word32

spacing: the spacing to use

-> m ()

Sets the horizontal space to add between children. See the FlowBox:column-spacing property.

Since: 3.12

setFilterFunc

flowBoxSetFilterFunc

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a)

=> a

box: a FlowBox

-> Maybe FlowBoxFilterFunc

filterFunc: callback that lets you filter which children to show

-> m ()

By setting a filter function on the box one can decide dynamically which of the children to show. For instance, to implement a search function that only shows the children matching the search terms.

The filterFunc will be called for each child after the call, and it will continue to be called each time a child changes (via flowBoxChildChanged) or when flowBoxInvalidateFilter is called.

Note that using a filter function is incompatible with using a model (see flowBoxBindModel).

Since: 3.12

setHadjustment

flowBoxSetHadjustment

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a, IsAdjustment b)

=> a

box: a FlowBox

-> b

adjustment: an adjustment which should be adjusted when the focus is moved among the descendents of container

-> m ()

Hooks up an adjustment to focus handling in box. The adjustment is also used for autoscrolling during rubberband selection. See scrolledWindowGetHadjustment for a typical way of obtaining the adjustment, and flowBoxSetVadjustmentfor setting the vertical adjustment.

The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the box.

Since: 3.12

setHomogeneous

flowBoxSetHomogeneous

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a)

=> a

box: a FlowBox

-> Bool

homogeneous: True to create equal allotments, False for variable allotments

-> m ()

Sets the FlowBox:homogeneous property of box, controlling whether or not all children of box are given equal space in the box.

Since: 3.12

setMaxChildrenPerLine

flowBoxSetMaxChildrenPerLine

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a)

=> a

box: a FlowBox

-> Word32

nChildren: the maximum number of children per line

-> m ()

Sets the maximum number of children to request and allocate space for in box’s orientation.

Setting the maximum number of children per line limits the overall natural size request to be no more than nChildren children long in the given orientation.

Since: 3.12

setMinChildrenPerLine

flowBoxSetMinChildrenPerLine

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a)

=> a

box: a FlowBox

-> Word32

nChildren: the minimum number of children per line

-> m ()

Sets the minimum number of children to line up in box’s orientation before flowing.

Since: 3.12

setRowSpacing

flowBoxSetRowSpacing

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a)

=> a

box: a FlowBox

-> Word32

spacing: the spacing to use

-> m ()

Sets the vertical space to add between children. See the FlowBox:row-spacing property.

Since: 3.12

setSelectionMode

flowBoxSetSelectionMode

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a)

=> a

box: a FlowBox

-> SelectionMode

mode: the new selection mode

-> m ()

Sets how selection works in box. See SelectionMode for details.

Since: 3.12

setSortFunc

flowBoxSetSortFunc

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a)

=> a

box: a FlowBox

-> Maybe FlowBoxSortFunc

sortFunc: the sort function

-> m ()

By setting a sort function on the box, one can dynamically reorder the children of the box, based on the contents of the children.

The sortFunc will be called for each child after the call, and will continue to be called each time a child changes (via flowBoxChildChanged) and when flowBoxInvalidateSort is called.

Note that using a sort function is incompatible with using a model (see flowBoxBindModel).

Since: 3.12

setVadjustment

flowBoxSetVadjustment

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a, IsAdjustment b)

=> a

box: a FlowBox

-> b

adjustment: an adjustment which should be adjusted when the focus is moved among the descendents of container

-> m ()

Hooks up an adjustment to focus handling in box. The adjustment is also used for autoscrolling during rubberband selection. See scrolledWindowGetVadjustment for a typical way of obtaining the adjustment, and flowBoxSetHadjustmentfor setting the horizontal adjustment.

The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the box.

Since: 3.12

unselectAll

flowBoxUnselectAll

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a)

=> a

box: a FlowBox

-> m ()

Unselect all children of box, if the selection mode allows it.

Since: 3.12

unselectChild

flowBoxUnselectChild

Arguments

:: (HasCallStack, MonadIO m, IsFlowBox a, IsFlowBoxChild b)

=> a

box: a FlowBox

-> b

child: a child of box

-> m ()

Unselects a single child of box, if the selection mode allows it.

Since: 3.12

Properties

activateOnSingleClick

Determines whether children can be activated with a single click, or require a double-click.

constructFlowBoxActivateOnSingleClick :: (IsFlowBox o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “activate-on-single-click” property. This is rarely needed directly, but it is used by new.

getFlowBoxActivateOnSingleClick :: (MonadIO m, IsFlowBox o) => o -> m Bool

Get the value of the “activate-on-single-click” property. When overloading is enabled, this is equivalent to

get flowBox #activateOnSingleClick

setFlowBoxActivateOnSingleClick :: (MonadIO m, IsFlowBox o) => o -> Bool -> m ()

Set the value of the “activate-on-single-click” property. When overloading is enabled, this is equivalent to

set flowBox [ #activateOnSingleClick := value ]

columnSpacing

The amount of horizontal space between two children.

constructFlowBoxColumnSpacing :: (IsFlowBox o, MonadIO m) => Word32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “column-spacing” property. This is rarely needed directly, but it is used by new.

getFlowBoxColumnSpacing :: (MonadIO m, IsFlowBox o) => o -> m Word32

Get the value of the “column-spacing” property. When overloading is enabled, this is equivalent to

get flowBox #columnSpacing

setFlowBoxColumnSpacing :: (MonadIO m, IsFlowBox o) => o -> Word32 -> m ()

Set the value of the “column-spacing” property. When overloading is enabled, this is equivalent to

set flowBox [ #columnSpacing := value ]

homogeneous

Determines whether all children should be allocated the same size.

constructFlowBoxHomogeneous :: (IsFlowBox o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “homogeneous” property. This is rarely needed directly, but it is used by new.

getFlowBoxHomogeneous :: (MonadIO m, IsFlowBox o) => o -> m Bool

Get the value of the “homogeneous” property. When overloading is enabled, this is equivalent to

get flowBox #homogeneous

setFlowBoxHomogeneous :: (MonadIO m, IsFlowBox o) => o -> Bool -> m ()

Set the value of the “homogeneous” property. When overloading is enabled, this is equivalent to

set flowBox [ #homogeneous := value ]

maxChildrenPerLine

The maximum amount of children to request space for consecutively in the given orientation.

constructFlowBoxMaxChildrenPerLine :: (IsFlowBox o, MonadIO m) => Word32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “max-children-per-line” property. This is rarely needed directly, but it is used by new.

getFlowBoxMaxChildrenPerLine :: (MonadIO m, IsFlowBox o) => o -> m Word32

Get the value of the “max-children-per-line” property. When overloading is enabled, this is equivalent to

get flowBox #maxChildrenPerLine

setFlowBoxMaxChildrenPerLine :: (MonadIO m, IsFlowBox o) => o -> Word32 -> m ()

Set the value of the “max-children-per-line” property. When overloading is enabled, this is equivalent to

set flowBox [ #maxChildrenPerLine := value ]

minChildrenPerLine

The minimum number of children to allocate consecutively in the given orientation.

Setting the minimum children per line ensures that a reasonably small height will be requested for the overall minimum width of the box.

constructFlowBoxMinChildrenPerLine :: (IsFlowBox o, MonadIO m) => Word32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “min-children-per-line” property. This is rarely needed directly, but it is used by new.

getFlowBoxMinChildrenPerLine :: (MonadIO m, IsFlowBox o) => o -> m Word32

Get the value of the “min-children-per-line” property. When overloading is enabled, this is equivalent to

get flowBox #minChildrenPerLine

setFlowBoxMinChildrenPerLine :: (MonadIO m, IsFlowBox o) => o -> Word32 -> m ()

Set the value of the “min-children-per-line” property. When overloading is enabled, this is equivalent to

set flowBox [ #minChildrenPerLine := value ]

rowSpacing

The amount of vertical space between two children.

constructFlowBoxRowSpacing :: (IsFlowBox o, MonadIO m) => Word32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “row-spacing” property. This is rarely needed directly, but it is used by new.

getFlowBoxRowSpacing :: (MonadIO m, IsFlowBox o) => o -> m Word32

Get the value of the “row-spacing” property. When overloading is enabled, this is equivalent to

get flowBox #rowSpacing

setFlowBoxRowSpacing :: (MonadIO m, IsFlowBox o) => o -> Word32 -> m ()

Set the value of the “row-spacing” property. When overloading is enabled, this is equivalent to

set flowBox [ #rowSpacing := value ]

selectionMode

The selection mode used by the flow box.

constructFlowBoxSelectionMode :: (IsFlowBox o, MonadIO m) => SelectionMode -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “selection-mode” property. This is rarely needed directly, but it is used by new.

getFlowBoxSelectionMode :: (MonadIO m, IsFlowBox o) => o -> m SelectionMode

Get the value of the “selection-mode” property. When overloading is enabled, this is equivalent to

get flowBox #selectionMode

setFlowBoxSelectionMode :: (MonadIO m, IsFlowBox o) => o -> SelectionMode -> m ()

Set the value of the “selection-mode” property. When overloading is enabled, this is equivalent to

set flowBox [ #selectionMode := value ]

Signals

activateCursorChild

type C_FlowBoxActivateCursorChildCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type FlowBoxActivateCursorChildCallback = IO ()

The activateCursorChild signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user activates the box.

afterFlowBoxActivateCursorChild :: (IsFlowBox a, MonadIO m) => a -> FlowBoxActivateCursorChildCallback -> m SignalHandlerId

Connect a signal handler for the activateCursorChild signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after flowBox #activateCursorChild callback

genClosure_FlowBoxActivateCursorChild :: MonadIO m => FlowBoxActivateCursorChildCallback -> m (GClosure C_FlowBoxActivateCursorChildCallback)

Wrap the callback into a GClosure.

mk_FlowBoxActivateCursorChildCallback :: C_FlowBoxActivateCursorChildCallback -> IO (FunPtr C_FlowBoxActivateCursorChildCallback)

Generate a function pointer callable from C code, from a C_FlowBoxActivateCursorChildCallback.

noFlowBoxActivateCursorChildCallback :: Maybe FlowBoxActivateCursorChildCallback

A convenience synonym for Nothing :: Maybe FlowBoxActivateCursorChildCallback.

onFlowBoxActivateCursorChild :: (IsFlowBox a, MonadIO m) => a -> FlowBoxActivateCursorChildCallback -> m SignalHandlerId

Connect a signal handler for the activateCursorChild signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on flowBox #activateCursorChild callback

wrap_FlowBoxActivateCursorChildCallback :: FlowBoxActivateCursorChildCallback -> C_FlowBoxActivateCursorChildCallback

Wrap a FlowBoxActivateCursorChildCallback into a C_FlowBoxActivateCursorChildCallback.

childActivated

type C_FlowBoxChildActivatedCallback = Ptr () -> Ptr FlowBoxChild -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type FlowBoxChildActivatedCallback

Arguments

 = FlowBoxChild

child: the child that is activated

-> IO ()

The childActivated signal is emitted when a child has been activated by the user.

afterFlowBoxChildActivated :: (IsFlowBox a, MonadIO m) => a -> FlowBoxChildActivatedCallback -> m SignalHandlerId

Connect a signal handler for the childActivated signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after flowBox #childActivated callback

genClosure_FlowBoxChildActivated :: MonadIO m => FlowBoxChildActivatedCallback -> m (GClosure C_FlowBoxChildActivatedCallback)

Wrap the callback into a GClosure.

mk_FlowBoxChildActivatedCallback :: C_FlowBoxChildActivatedCallback -> IO (FunPtr C_FlowBoxChildActivatedCallback)

Generate a function pointer callable from C code, from a C_FlowBoxChildActivatedCallback.

noFlowBoxChildActivatedCallback :: Maybe FlowBoxChildActivatedCallback

A convenience synonym for Nothing :: Maybe FlowBoxChildActivatedCallback.

onFlowBoxChildActivated :: (IsFlowBox a, MonadIO m) => a -> FlowBoxChildActivatedCallback -> m SignalHandlerId

Connect a signal handler for the childActivated signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on flowBox #childActivated callback

wrap_FlowBoxChildActivatedCallback :: FlowBoxChildActivatedCallback -> C_FlowBoxChildActivatedCallback

Wrap a FlowBoxChildActivatedCallback into a C_FlowBoxChildActivatedCallback.

moveCursor

type C_FlowBoxMoveCursorCallback = Ptr () -> CUInt -> Int32 -> Ptr () -> IO CInt

Type for the callback on the (unwrapped) C side.

type FlowBoxMoveCursorCallback

Arguments

 = MovementStep

step: the granularity fo the move, as a MovementStep

-> Int32

count: the number of step units to move

-> IO Bool

Returns: True to stop other handlers from being invoked for the event. False to propagate the event further.

The moveCursor signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user initiates a cursor movement.

Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to control the cursor programmatically.

The default bindings for this signal come in two variants, the variant with the Shift modifier extends the selection, the variant without the Shift modifer does not. There are too many key combinations to list them all here.

• Arrow keys move by individual children
• Home/End keys move to the ends of the box
• PageUp/PageDown keys move vertically by pages

afterFlowBoxMoveCursor :: (IsFlowBox a, MonadIO m) => a -> FlowBoxMoveCursorCallback -> m SignalHandlerId

Connect a signal handler for the moveCursor signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after flowBox #moveCursor callback

genClosure_FlowBoxMoveCursor :: MonadIO m => FlowBoxMoveCursorCallback -> m (GClosure C_FlowBoxMoveCursorCallback)

Wrap the callback into a GClosure.

mk_FlowBoxMoveCursorCallback :: C_FlowBoxMoveCursorCallback -> IO (FunPtr C_FlowBoxMoveCursorCallback)

Generate a function pointer callable from C code, from a C_FlowBoxMoveCursorCallback.

noFlowBoxMoveCursorCallback :: Maybe FlowBoxMoveCursorCallback

A convenience synonym for Nothing :: Maybe FlowBoxMoveCursorCallback.

onFlowBoxMoveCursor :: (IsFlowBox a, MonadIO m) => a -> FlowBoxMoveCursorCallback -> m SignalHandlerId

Connect a signal handler for the moveCursor signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on flowBox #moveCursor callback

wrap_FlowBoxMoveCursorCallback :: FlowBoxMoveCursorCallback -> C_FlowBoxMoveCursorCallback

Wrap a FlowBoxMoveCursorCallback into a C_FlowBoxMoveCursorCallback.

selectAll

type C_FlowBoxSelectAllCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type FlowBoxSelectAllCallback = IO ()

The selectAll signal is a [keybinding signal][GtkBindingSignal] which gets emitted to select all children of the box, if the selection mode permits it.

The default bindings for this signal is Ctrl-a.

afterFlowBoxSelectAll :: (IsFlowBox a, MonadIO m) => a -> FlowBoxSelectAllCallback -> m SignalHandlerId

Connect a signal handler for the selectAll signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after flowBox #selectAll callback

genClosure_FlowBoxSelectAll :: MonadIO m => FlowBoxSelectAllCallback -> m (GClosure C_FlowBoxSelectAllCallback)

Wrap the callback into a GClosure.

mk_FlowBoxSelectAllCallback :: C_FlowBoxSelectAllCallback -> IO (FunPtr C_FlowBoxSelectAllCallback)

Generate a function pointer callable from C code, from a C_FlowBoxSelectAllCallback.

noFlowBoxSelectAllCallback :: Maybe FlowBoxSelectAllCallback

A convenience synonym for Nothing :: Maybe FlowBoxSelectAllCallback.

onFlowBoxSelectAll :: (IsFlowBox a, MonadIO m) => a -> FlowBoxSelectAllCallback -> m SignalHandlerId

Connect a signal handler for the selectAll signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on flowBox #selectAll callback

wrap_FlowBoxSelectAllCallback :: FlowBoxSelectAllCallback -> C_FlowBoxSelectAllCallback

Wrap a FlowBoxSelectAllCallback into a C_FlowBoxSelectAllCallback.

selectedChildrenChanged

type C_FlowBoxSelectedChildrenChangedCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type FlowBoxSelectedChildrenChangedCallback = IO ()

The selectedChildrenChanged signal is emitted when the set of selected children changes.

Use flowBoxSelectedForeach or flowBoxGetSelectedChildren to obtain the selected children.

afterFlowBoxSelectedChildrenChanged :: (IsFlowBox a, MonadIO m) => a -> FlowBoxSelectedChildrenChangedCallback -> m SignalHandlerId

Connect a signal handler for the selectedChildrenChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after flowBox #selectedChildrenChanged callback

genClosure_FlowBoxSelectedChildrenChanged :: MonadIO m => FlowBoxSelectedChildrenChangedCallback -> m (GClosure C_FlowBoxSelectedChildrenChangedCallback)

Wrap the callback into a GClosure.

mk_FlowBoxSelectedChildrenChangedCallback :: C_FlowBoxSelectedChildrenChangedCallback -> IO (FunPtr C_FlowBoxSelectedChildrenChangedCallback)

Generate a function pointer callable from C code, from a C_FlowBoxSelectedChildrenChangedCallback.

noFlowBoxSelectedChildrenChangedCallback :: Maybe FlowBoxSelectedChildrenChangedCallback

A convenience synonym for Nothing :: Maybe FlowBoxSelectedChildrenChangedCallback.

onFlowBoxSelectedChildrenChanged :: (IsFlowBox a, MonadIO m) => a -> FlowBoxSelectedChildrenChangedCallback -> m SignalHandlerId

Connect a signal handler for the selectedChildrenChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on flowBox #selectedChildrenChanged callback

wrap_FlowBoxSelectedChildrenChangedCallback :: FlowBoxSelectedChildrenChangedCallback -> C_FlowBoxSelectedChildrenChangedCallback

Wrap a FlowBoxSelectedChildrenChangedCallback into a C_FlowBoxSelectedChildrenChangedCallback.

toggleCursorChild

type C_FlowBoxToggleCursorChildCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type FlowBoxToggleCursorChildCallback = IO ()

The toggleCursorChild signal is a [keybinding signal][GtkBindingSignal] which toggles the selection of the child that has the focus.

The default binding for this signal is Ctrl-Space.

afterFlowBoxToggleCursorChild :: (IsFlowBox a, MonadIO m) => a -> FlowBoxToggleCursorChildCallback -> m SignalHandlerId

Connect a signal handler for the toggleCursorChild signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after flowBox #toggleCursorChild callback

genClosure_FlowBoxToggleCursorChild :: MonadIO m => FlowBoxToggleCursorChildCallback -> m (GClosure C_FlowBoxToggleCursorChildCallback)

Wrap the callback into a GClosure.

mk_FlowBoxToggleCursorChildCallback :: C_FlowBoxToggleCursorChildCallback -> IO (FunPtr C_FlowBoxToggleCursorChildCallback)

Generate a function pointer callable from C code, from a C_FlowBoxToggleCursorChildCallback.

noFlowBoxToggleCursorChildCallback :: Maybe FlowBoxToggleCursorChildCallback

A convenience synonym for Nothing :: Maybe FlowBoxToggleCursorChildCallback.

onFlowBoxToggleCursorChild :: (IsFlowBox a, MonadIO m) => a -> FlowBoxToggleCursorChildCallback -> m SignalHandlerId

Connect a signal handler for the toggleCursorChild signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on flowBox #toggleCursorChild callback

wrap_FlowBoxToggleCursorChildCallback :: FlowBoxToggleCursorChildCallback -> C_FlowBoxToggleCursorChildCallback

Wrap a FlowBoxToggleCursorChildCallback into a C_FlowBoxToggleCursorChildCallback.

unselectAll

type C_FlowBoxUnselectAllCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type FlowBoxUnselectAllCallback = IO ()

The unselectAll signal is a [keybinding signal][GtkBindingSignal] which gets emitted to unselect all children of the box, if the selection mode permits it.

The default bindings for this signal is Ctrl-Shift-a.

afterFlowBoxUnselectAll :: (IsFlowBox a, MonadIO m) => a -> FlowBoxUnselectAllCallback -> m SignalHandlerId

Connect a signal handler for the unselectAll signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after flowBox #unselectAll callback

genClosure_FlowBoxUnselectAll :: MonadIO m => FlowBoxUnselectAllCallback -> m (GClosure C_FlowBoxUnselectAllCallback)

Wrap the callback into a GClosure.

mk_FlowBoxUnselectAllCallback :: C_FlowBoxUnselectAllCallback -> IO (FunPtr C_FlowBoxUnselectAllCallback)

Generate a function pointer callable from C code, from a C_FlowBoxUnselectAllCallback.

noFlowBoxUnselectAllCallback :: Maybe FlowBoxUnselectAllCallback

A convenience synonym for Nothing :: Maybe FlowBoxUnselectAllCallback.

onFlowBoxUnselectAll :: (IsFlowBox a, MonadIO m) => a -> FlowBoxUnselectAllCallback -> m SignalHandlerId

Connect a signal handler for the unselectAll signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on flowBox #unselectAll callback

wrap_FlowBoxUnselectAllCallback :: FlowBoxUnselectAllCallback -> C_FlowBoxUnselectAllCallback

Wrap a FlowBoxUnselectAllCallback into a C_FlowBoxUnselectAllCallback.