GI.Handy.Objects.Squeezer

No description available in the introspection data.

Exported types

newtype Squeezer

Memory-managed wrapper type.

Constructors

Squeezer (ManagedPtr Squeezer)

Instances

Eq Squeezer

Defined in GI.Handy.Objects.Squeezer

Methods

(==) :: Squeezer -> Squeezer -> Bool

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

GObject Squeezer

Defined in GI.Handy.Objects.Squeezer

ManagedPtrNewtype Squeezer

Defined in GI.Handy.Objects.Squeezer

Methods

toManagedPtr :: Squeezer -> ManagedPtr Squeezer

TypedObject Squeezer

Defined in GI.Handy.Objects.Squeezer

Methods

glibType :: IO GType

HasParentTypes Squeezer

Defined in GI.Handy.Objects.Squeezer

IsGValue (Maybe Squeezer)

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

Defined in GI.Handy.Objects.Squeezer

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes Squeezer

Defined in GI.Handy.Objects.Squeezer

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

class (GObject o, IsDescendantOf Squeezer o) => IsSqueezer o

Type class for types which can be safely cast to Squeezer, for instance with toSqueezer.

Instances

(GObject o, IsDescendantOf Squeezer o) => IsSqueezer o

Defined in GI.Handy.Objects.Squeezer

toSqueezer :: (MonadIO m, IsSqueezer o) => o -> m Squeezer

Cast to Squeezer, 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, 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, insertActionGroup, intersect, 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, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, stealData, stealQdata, styleAttach, styleGetProperty, thawChildNotify, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unregisterWindow, unsetFocusChain, unsetStateFlags, watchClosure.

Getters

getAccessible, getActionGroup, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getBorderWidth, getCanDefault, getCanFocus, getChildEnabled, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getCompositeName, getData, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEvents, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusVadjustment, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getHomogeneous, getInternalChild, getInterpolateSize, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, 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, getScaleFactor, getScreen, getSensitive, getSettings, getSizeRequest, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTemplateChild, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getTransitionDuration, getTransitionRunning, getTransitionType, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisibleChild, getVisual, getWindow, getXalign, getYalign.

Setters

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

getChildEnabled

squeezerGetChildEnabled

Arguments

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

=> a

self: a Squeezer

-> b

child: a child of self

-> m Bool

Returns: True if child is enabled, False otherwise.

Gets whether child is enabled.

See squeezerSetChildEnabled.

getHomogeneous

squeezerGetHomogeneous

Arguments

:: (HasCallStack, MonadIO m, IsSqueezer a)

=> a

self: a Squeezer

-> m Bool

Returns: True if self is homogeneous, False is not

Gets whether self is homogeneous.

See squeezerSetHomogeneous.

Since: 0.0.10

getInterpolateSize

squeezerGetInterpolateSize

Arguments

:: (HasCallStack, MonadIO m, IsSqueezer a)

=> a

self: A Squeezer

-> m Bool

Returns: True if self interpolates its size on visible child change, False if not

Gets whether self should interpolate its size on visible child change.

See squeezerSetInterpolateSize.

Since: 0.0.10

getTransitionDuration

squeezerGetTransitionDuration

Arguments

:: (HasCallStack, MonadIO m, IsSqueezer a)

=> a

self: a Squeezer

-> m Word32

Returns: the transition duration

Gets the amount of time (in milliseconds) that transitions between children in self will take.

getTransitionRunning

squeezerGetTransitionRunning

Arguments

:: (HasCallStack, MonadIO m, IsSqueezer a)

=> a

self: a Squeezer

-> m Bool

Returns: True if the transition is currently running, False otherwise.

Gets whether self is currently in a transition from one child to another.

getTransitionType

squeezerGetTransitionType

Arguments

:: (HasCallStack, MonadIO m, IsSqueezer a)

=> a

self: a Squeezer

-> m SqueezerTransitionType

Returns: the current transition type of self

Gets the type of animation that will be used for transitions between children in self.

getVisibleChild

squeezerGetVisibleChild

Arguments

:: (HasCallStack, MonadIO m, IsSqueezer a)

=> a

self: a Squeezer

-> m (Maybe Widget)

Returns: the visible child of the Squeezer

Gets the currently visible child of self, or Nothing if there are no visible children.

getXalign

squeezerGetXalign

Arguments

:: (HasCallStack, MonadIO m, IsSqueezer a)

=> a

self: a Squeezer

-> m Float

Returns: the xalign property

Gets the Squeezer:xalign property for self.

Since: 1.0

getYalign

squeezerGetYalign

Arguments

:: (HasCallStack, MonadIO m, IsSqueezer a)

=> a

self: a Squeezer

-> m Float

Returns: the yalign property

Gets the Squeezer:yalign property for self.

Since: 1.0

new

squeezerNew

Arguments

:: (HasCallStack, MonadIO m)

=> m Squeezer

Returns: a new Squeezer

Creates a new Squeezer container.

setChildEnabled

squeezerSetChildEnabled

Arguments

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

=> a

self: a Squeezer

-> b

child: a child of self

-> Bool

enabled: True to enable the child, False to disable it

-> m ()

Make self enable or disable child. If a child is disabled, it will be ignored when looking for the child fitting the available size best. This allows to programmatically and prematurely hide a child of self even if it fits in the available space.

This can be used e.g. to ensure a certain child is hidden below a certain window width, or any other constraint you find suitable.

setHomogeneous

squeezerSetHomogeneous

Arguments

:: (HasCallStack, MonadIO m, IsSqueezer a)

=> a

self: a Squeezer

-> Bool

homogeneous: True to make self homogeneous

-> m ()

Sets self to be homogeneous or not. If it is homogeneous, self will request the same size for all its children for its opposite orientation, e.g. if self is oriented horizontally and is homogeneous, it will request the same height for all its children. If it isn't, self may change size when a different child becomes visible.

Since: 0.0.10

setInterpolateSize

squeezerSetInterpolateSize

Arguments

:: (HasCallStack, MonadIO m, IsSqueezer a)

=> a

self: A Squeezer

-> Bool

interpolateSize: True to interpolate the size

-> m ()

Sets whether or not self will interpolate the size of its opposing orientation when changing the visible child. If True, self will interpolate its size between the one of the previous visible child and the one of the new visible child, according to the set transition duration and the orientation, e.g. if self is horizontal, it will interpolate the its height.

Since: 0.0.10

setTransitionDuration

squeezerSetTransitionDuration

Arguments

:: (HasCallStack, MonadIO m, IsSqueezer a)

=> a

self: a Squeezer

-> Word32

duration: the new duration, in milliseconds

-> m ()

Sets the duration that transitions between children in self will take.

setTransitionType

squeezerSetTransitionType

Arguments

:: (HasCallStack, MonadIO m, IsSqueezer a)

=> a

self: a Squeezer

-> SqueezerTransitionType

transition: the new transition type

-> m ()

Sets the type of animation that will be used for transitions between children in self. Available types include various kinds of fades and slides.

The transition type can be changed without problems at runtime, so it is possible to change the animation based on the child that is about to become current.

setXalign

squeezerSetXalign

Arguments

:: (HasCallStack, MonadIO m, IsSqueezer a)

=> a

self: a Squeezer

-> Float

xalign: the new xalign value, between 0 and 1

-> m ()

Sets the Squeezer:xalign property for self.

Since: 1.0

setYalign

squeezerSetYalign

Arguments

:: (HasCallStack, MonadIO m, IsSqueezer a)

=> a

self: a Squeezer

-> Float

yalign: the new yalign value, between 0 and 1

-> m ()

Sets the Squeezer:yalign property for self.

Since: 1.0

Properties

homogeneous

No description available in the introspection data.

constructSqueezerHomogeneous :: (IsSqueezer 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.

getSqueezerHomogeneous :: (MonadIO m, IsSqueezer o) => o -> m Bool

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

get squeezer #homogeneous

setSqueezerHomogeneous :: (MonadIO m, IsSqueezer o) => o -> Bool -> m ()

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

set squeezer [ #homogeneous := value ]

interpolateSize

No description available in the introspection data.

constructSqueezerInterpolateSize :: (IsSqueezer o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getSqueezerInterpolateSize :: (MonadIO m, IsSqueezer o) => o -> m Bool

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

get squeezer #interpolateSize

setSqueezerInterpolateSize :: (MonadIO m, IsSqueezer o) => o -> Bool -> m ()

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

set squeezer [ #interpolateSize := value ]

transitionDuration

No description available in the introspection data.

constructSqueezerTransitionDuration :: (IsSqueezer o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getSqueezerTransitionDuration :: (MonadIO m, IsSqueezer o) => o -> m Word32

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

get squeezer #transitionDuration

setSqueezerTransitionDuration :: (MonadIO m, IsSqueezer o) => o -> Word32 -> m ()

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

set squeezer [ #transitionDuration := value ]

transitionRunning

No description available in the introspection data.

getSqueezerTransitionRunning :: (MonadIO m, IsSqueezer o) => o -> m Bool

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

get squeezer #transitionRunning

transitionType

No description available in the introspection data.

constructSqueezerTransitionType :: (IsSqueezer o, MonadIO m) => SqueezerTransitionType -> m (GValueConstruct o)

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

getSqueezerTransitionType :: (MonadIO m, IsSqueezer o) => o -> m SqueezerTransitionType

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

get squeezer #transitionType

setSqueezerTransitionType :: (MonadIO m, IsSqueezer o) => o -> SqueezerTransitionType -> m ()

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

set squeezer [ #transitionType := value ]

visibleChild

No description available in the introspection data.

getSqueezerVisibleChild :: (MonadIO m, IsSqueezer o) => o -> m (Maybe Widget)

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

get squeezer #visibleChild

xalign

The xalign property determines the horizontal alignment of the children inside the squeezer's size allocation. Compare this to Widget:halign, which determines how the squeezer's size allocation is positioned in the space available for the squeezer. The range goes from 0 (start) to 1 (end).

This will affect the position of children too wide to fit in the squeezer as they are fading out.

Since: 1.0

constructSqueezerXalign :: (IsSqueezer o, MonadIO m) => Float -> m (GValueConstruct o)

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

getSqueezerXalign :: (MonadIO m, IsSqueezer o) => o -> m Float

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

get squeezer #xalign

setSqueezerXalign :: (MonadIO m, IsSqueezer o) => o -> Float -> m ()

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

set squeezer [ #xalign := value ]

yalign

The yalign property determines the vertical alignment of the children inside the squeezer's size allocation. Compare this to Widget:valign, which determines how the squeezer's size allocation is positioned in the space available for the squeezer. The range goes from 0 (top) to 1 (bottom).

This will affect the position of children too tall to fit in the squeezer as they are fading out.

Since: 1.0

constructSqueezerYalign :: (IsSqueezer o, MonadIO m) => Float -> m (GValueConstruct o)

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

getSqueezerYalign :: (MonadIO m, IsSqueezer o) => o -> m Float

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

get squeezer #yalign

setSqueezerYalign :: (MonadIO m, IsSqueezer o) => o -> Float -> m ()

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

set squeezer [ #yalign := value ]