Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
GI.Dazzle.Objects.DockRevealer
Contents
Description
This widget is a bit like Revealer
with a couple of important
differences. First, it only supports a couple transition types
(the direction to slide reveal). Additionally, the size of the
child allocation will not change during the animation. This is not
as generally useful as an upstream GTK+ widget, but is extremely
important for the panel case to avoid things looking strange while
animating into and out of view.
Synopsis
- newtype DockRevealer = DockRevealer (ManagedPtr DockRevealer)
- class (GObject o, IsDescendantOf DockRevealer o) => IsDockRevealer o
- toDockRevealer :: (MonadIO m, IsDockRevealer o) => o -> m DockRevealer
- dockRevealerAnimateToPosition :: (HasCallStack, MonadIO m, IsDockRevealer a) => a -> Int32 -> Word32 -> m ()
- dockRevealerGetChildRevealed :: (HasCallStack, MonadIO m, IsDockRevealer a) => a -> m Bool
- dockRevealerGetPosition :: (HasCallStack, MonadIO m, IsDockRevealer a) => a -> m Int32
- dockRevealerGetPositionSet :: (HasCallStack, MonadIO m, IsDockRevealer a) => a -> m Bool
- dockRevealerGetRevealChild :: (HasCallStack, MonadIO m, IsDockRevealer a) => a -> m Bool
- dockRevealerGetTransitionDuration :: (HasCallStack, MonadIO m, IsDockRevealer a) => a -> m Word32
- dockRevealerGetTransitionType :: (HasCallStack, MonadIO m, IsDockRevealer a) => a -> m DockRevealerTransitionType
- dockRevealerIsAnimating :: (HasCallStack, MonadIO m, IsDockRevealer a) => a -> m Bool
- dockRevealerNew :: (HasCallStack, MonadIO m) => m DockRevealer
- dockRevealerSetPosition :: (HasCallStack, MonadIO m, IsDockRevealer a) => a -> Int32 -> m ()
- dockRevealerSetPositionSet :: (HasCallStack, MonadIO m, IsDockRevealer a) => a -> Bool -> m ()
- dockRevealerSetRevealChild :: (HasCallStack, MonadIO m, IsDockRevealer a) => a -> Bool -> m ()
- dockRevealerSetTransitionDuration :: (HasCallStack, MonadIO m, IsDockRevealer a) => a -> Word32 -> m ()
- dockRevealerSetTransitionType :: (HasCallStack, MonadIO m, IsDockRevealer a) => a -> DockRevealerTransitionType -> m ()
- getDockRevealerChildRevealed :: (MonadIO m, IsDockRevealer o) => o -> m Bool
- constructDockRevealerPosition :: (IsDockRevealer o, MonadIO m) => Int32 -> m (GValueConstruct o)
- getDockRevealerPosition :: (MonadIO m, IsDockRevealer o) => o -> m Int32
- setDockRevealerPosition :: (MonadIO m, IsDockRevealer o) => o -> Int32 -> m ()
- constructDockRevealerPositionSet :: (IsDockRevealer o, MonadIO m) => Bool -> m (GValueConstruct o)
- getDockRevealerPositionSet :: (MonadIO m, IsDockRevealer o) => o -> m Bool
- setDockRevealerPositionSet :: (MonadIO m, IsDockRevealer o) => o -> Bool -> m ()
- constructDockRevealerRevealChild :: (IsDockRevealer o, MonadIO m) => Bool -> m (GValueConstruct o)
- getDockRevealerRevealChild :: (MonadIO m, IsDockRevealer o) => o -> m Bool
- setDockRevealerRevealChild :: (MonadIO m, IsDockRevealer o) => o -> Bool -> m ()
- constructDockRevealerTransitionDuration :: (IsDockRevealer o, MonadIO m) => Word32 -> m (GValueConstruct o)
- getDockRevealerTransitionDuration :: (MonadIO m, IsDockRevealer o) => o -> m Word32
- setDockRevealerTransitionDuration :: (MonadIO m, IsDockRevealer o) => o -> Word32 -> m ()
- constructDockRevealerTransitionType :: (IsDockRevealer o, MonadIO m) => DockRevealerTransitionType -> m (GValueConstruct o)
- getDockRevealerTransitionType :: (MonadIO m, IsDockRevealer o) => o -> m DockRevealerTransitionType
- setDockRevealerTransitionType :: (MonadIO m, IsDockRevealer o) => o -> DockRevealerTransitionType -> m ()
Exported types
newtype DockRevealer Source #
Memory-managed wrapper type.
Constructors
DockRevealer (ManagedPtr DockRevealer) |
Instances
Eq DockRevealer Source # | |
Defined in GI.Dazzle.Objects.DockRevealer | |
GObject DockRevealer Source # | |
Defined in GI.Dazzle.Objects.DockRevealer | |
ManagedPtrNewtype DockRevealer Source # | |
Defined in GI.Dazzle.Objects.DockRevealer Methods toManagedPtr :: DockRevealer -> ManagedPtr DockRevealer | |
TypedObject DockRevealer Source # | |
Defined in GI.Dazzle.Objects.DockRevealer | |
HasParentTypes DockRevealer Source # | |
Defined in GI.Dazzle.Objects.DockRevealer | |
IsGValue (Maybe DockRevealer) Source # | Convert |
Defined in GI.Dazzle.Objects.DockRevealer Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe DockRevealer -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe DockRevealer) | |
type ParentTypes DockRevealer Source # | |
Defined in GI.Dazzle.Objects.DockRevealer |
class (GObject o, IsDescendantOf DockRevealer o) => IsDockRevealer o Source #
Type class for types which can be safely cast to DockRevealer
, for instance with toDockRevealer
.
Instances
(GObject o, IsDescendantOf DockRevealer o) => IsDockRevealer o Source # | |
Defined in GI.Dazzle.Objects.DockRevealer |
toDockRevealer :: (MonadIO m, IsDockRevealer o) => o -> m DockRevealer Source #
Cast to DockRevealer
, 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, animateToPosition, 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, isAnimating, 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, getChild, getChildRequisition, getChildRevealed, 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, getInternalChild, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getModifierMask, getModifierStyle, getName, getNoShowAll, getOpacity, getPangoContext, getParent, getParentWindow, getPath, getPathForChild, getPointer, getPosition, getPositionSet, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRequisition, getResizeMode, getRevealChild, getRootWindow, getScaleFactor, getScreen, getSensitive, getSettings, getSizeRequest, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTemplateChild, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getTransitionDuration, getTransitionType, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisual, getWindow.
Setters
setAccelPath, setAllocation, setAppPaintable, setBorderWidth, setBuildableProperty, setCanDefault, setCanFocus, setChildVisible, setClip, setCompositeName, setData, setDataFull, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEvents, setFocusChain, setFocusChild, setFocusHadjustment, setFocusOnClick, setFocusVadjustment, setFontMap, setFontOptions, setHalign, setHasTooltip, setHasWindow, setHexpand, setHexpandSet, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setName, setNoShowAll, setOpacity, setParent, setParentWindow, setPosition, setPositionSet, setProperty, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setResizeMode, setRevealChild, setSensitive, setSizeRequest, setState, setStateFlags, setStyle, setSupportMultidevice, setTooltipMarkup, setTooltipText, setTooltipWindow, setTransitionDuration, setTransitionType, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow.
animateToPosition
dockRevealerAnimateToPosition :: (HasCallStack, MonadIO m, IsDockRevealer a) => a -> Int32 -> Word32 -> m () Source #
No description available in the introspection data.
getChildRevealed
dockRevealerGetChildRevealed :: (HasCallStack, MonadIO m, IsDockRevealer a) => a -> m Bool Source #
No description available in the introspection data.
getPosition
dockRevealerGetPosition :: (HasCallStack, MonadIO m, IsDockRevealer a) => a -> m Int32 Source #
No description available in the introspection data.
getPositionSet
dockRevealerGetPositionSet :: (HasCallStack, MonadIO m, IsDockRevealer a) => a -> m Bool Source #
No description available in the introspection data.
getRevealChild
dockRevealerGetRevealChild :: (HasCallStack, MonadIO m, IsDockRevealer a) => a -> m Bool Source #
No description available in the introspection data.
getTransitionDuration
dockRevealerGetTransitionDuration :: (HasCallStack, MonadIO m, IsDockRevealer a) => a -> m Word32 Source #
No description available in the introspection data.
getTransitionType
dockRevealerGetTransitionType :: (HasCallStack, MonadIO m, IsDockRevealer a) => a -> m DockRevealerTransitionType Source #
No description available in the introspection data.
isAnimating
dockRevealerIsAnimating Source #
Arguments
:: (HasCallStack, MonadIO m, IsDockRevealer a) | |
=> a |
|
-> m Bool | Returns: |
This is a helper to check if the revealer is animating. You probably don't want to poll this function. Connect to notifychildRevealed or notifyrevealChild instead.
new
dockRevealerNew :: (HasCallStack, MonadIO m) => m DockRevealer Source #
No description available in the introspection data.
setPosition
dockRevealerSetPosition :: (HasCallStack, MonadIO m, IsDockRevealer a) => a -> Int32 -> m () Source #
No description available in the introspection data.
setPositionSet
dockRevealerSetPositionSet :: (HasCallStack, MonadIO m, IsDockRevealer a) => a -> Bool -> m () Source #
No description available in the introspection data.
setRevealChild
dockRevealerSetRevealChild :: (HasCallStack, MonadIO m, IsDockRevealer a) => a -> Bool -> m () Source #
No description available in the introspection data.
setTransitionDuration
dockRevealerSetTransitionDuration :: (HasCallStack, MonadIO m, IsDockRevealer a) => a -> Word32 -> m () Source #
No description available in the introspection data.
setTransitionType
dockRevealerSetTransitionType :: (HasCallStack, MonadIO m, IsDockRevealer a) => a -> DockRevealerTransitionType -> m () Source #
No description available in the introspection data.
Properties
childRevealed
No description available in the introspection data.
getDockRevealerChildRevealed :: (MonadIO m, IsDockRevealer o) => o -> m Bool Source #
Get the value of the “child-revealed
” property.
When overloading is enabled, this is equivalent to
get
dockRevealer #childRevealed
position
No description available in the introspection data.
constructDockRevealerPosition :: (IsDockRevealer o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “position
” property. This is rarely needed directly, but it is used by new
.
getDockRevealerPosition :: (MonadIO m, IsDockRevealer o) => o -> m Int32 Source #
Get the value of the “position
” property.
When overloading is enabled, this is equivalent to
get
dockRevealer #position
setDockRevealerPosition :: (MonadIO m, IsDockRevealer o) => o -> Int32 -> m () Source #
Set the value of the “position
” property.
When overloading is enabled, this is equivalent to
set
dockRevealer [ #position:=
value ]
positionSet
No description available in the introspection data.
constructDockRevealerPositionSet :: (IsDockRevealer o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “position-set
” property. This is rarely needed directly, but it is used by new
.
getDockRevealerPositionSet :: (MonadIO m, IsDockRevealer o) => o -> m Bool Source #
Get the value of the “position-set
” property.
When overloading is enabled, this is equivalent to
get
dockRevealer #positionSet
setDockRevealerPositionSet :: (MonadIO m, IsDockRevealer o) => o -> Bool -> m () Source #
Set the value of the “position-set
” property.
When overloading is enabled, this is equivalent to
set
dockRevealer [ #positionSet:=
value ]
revealChild
No description available in the introspection data.
constructDockRevealerRevealChild :: (IsDockRevealer o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “reveal-child
” property. This is rarely needed directly, but it is used by new
.
getDockRevealerRevealChild :: (MonadIO m, IsDockRevealer o) => o -> m Bool Source #
Get the value of the “reveal-child
” property.
When overloading is enabled, this is equivalent to
get
dockRevealer #revealChild
setDockRevealerRevealChild :: (MonadIO m, IsDockRevealer o) => o -> Bool -> m () Source #
Set the value of the “reveal-child
” property.
When overloading is enabled, this is equivalent to
set
dockRevealer [ #revealChild:=
value ]
transitionDuration
No description available in the introspection data.
constructDockRevealerTransitionDuration :: (IsDockRevealer o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “transition-duration
” property. This is rarely needed directly, but it is used by new
.
getDockRevealerTransitionDuration :: (MonadIO m, IsDockRevealer o) => o -> m Word32 Source #
Get the value of the “transition-duration
” property.
When overloading is enabled, this is equivalent to
get
dockRevealer #transitionDuration
setDockRevealerTransitionDuration :: (MonadIO m, IsDockRevealer o) => o -> Word32 -> m () Source #
Set the value of the “transition-duration
” property.
When overloading is enabled, this is equivalent to
set
dockRevealer [ #transitionDuration:=
value ]
transitionType
No description available in the introspection data.
constructDockRevealerTransitionType :: (IsDockRevealer o, MonadIO m) => DockRevealerTransitionType -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “transition-type
” property. This is rarely needed directly, but it is used by new
.
getDockRevealerTransitionType :: (MonadIO m, IsDockRevealer o) => o -> m DockRevealerTransitionType Source #
Get the value of the “transition-type
” property.
When overloading is enabled, this is equivalent to
get
dockRevealer #transitionType
setDockRevealerTransitionType :: (MonadIO m, IsDockRevealer o) => o -> DockRevealerTransitionType -> m () Source #
Set the value of the “transition-type
” property.
When overloading is enabled, this is equivalent to
set
dockRevealer [ #transitionType:=
value ]