GI.Clutter.Objects.ScrollActor

The ScrollActor structure contains only private data, and should be accessed using the provided API.

Since: 1.12

Exported types

newtype ScrollActor

Memory-managed wrapper type.

Constructors

ScrollActor (ManagedPtr ScrollActor)

Instances

Eq ScrollActor

Defined in GI.Clutter.Objects.ScrollActor

Methods

(==) :: ScrollActor -> ScrollActor -> Bool

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

GObject ScrollActor

Defined in GI.Clutter.Objects.ScrollActor

ManagedPtrNewtype ScrollActor

Defined in GI.Clutter.Objects.ScrollActor

Methods

toManagedPtr :: ScrollActor -> ManagedPtr ScrollActor

TypedObject ScrollActor

Defined in GI.Clutter.Objects.ScrollActor

Methods

glibType :: IO GType

HasParentTypes ScrollActor

Defined in GI.Clutter.Objects.ScrollActor

IsGValue (Maybe ScrollActor)

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

Defined in GI.Clutter.Objects.ScrollActor

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes ScrollActor

Defined in GI.Clutter.Objects.ScrollActor

type ParentTypes ScrollActor = '[Actor, Object, ImplementorIface, Animatable, Container, Scriptable]

class (GObject o, IsDescendantOf ScrollActor o) => IsScrollActor o

Type class for types which can be safely cast to ScrollActor, for instance with toScrollActor.

Instances

(GObject o, IsDescendantOf ScrollActor o) => IsScrollActor o

Defined in GI.Clutter.Objects.ScrollActor

toScrollActor :: (MonadIO m, IsScrollActor o) => o -> m ScrollActor

Cast to ScrollActor, 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

addAction, addActionWithName, addActor, addChild, addConstraint, addConstraintWithName, addEffect, addEffectWithName, addTransition, allocate, allocateAlignFill, allocateAvailableSize, allocatePreferredSize, animateProperty, animateWithAlphav, animateWithTimelinev, animatev, applyRelativeTransformToPoint, applyTransformToPoint, bindModel, bindProperty, bindPropertyFull, childGetProperty, childNotify, childSetProperty, clearActions, clearConstraints, clearEffects, contains, continuePaint, createChildMeta, createPangoContext, createPangoLayout, destroy, destroyAllChildren, destroyChildMeta, detachAnimation, event, findChildByName, findProperty, forceFloating, foreach, foreachWithInternals, freezeNotify, getv, grabKeyFocus, hasActions, hasAllocation, hasClip, hasConstraints, hasEffects, hasKeyFocus, hasOverlaps, hasPointer, hide, hideAll, insertChildAbove, insertChildAtIndex, insertChildBelow, interpolateValue, isFloating, isInClonePaint, isMapped, isRealized, isRotated, isScaled, isVisible, lower, lowerBottom, lowerChild, map, moveAnchorPoint, moveAnchorPointFromGravity, moveBy, needsExpand, notify, notifyByPspec, paint, parseCustomNode, popInternal, pushInternal, queueRedraw, queueRedrawWithClip, queueRelayout, raise, raiseChild, raiseTop, realize, ref, refSink, removeAction, removeActionByName, removeActor, removeAllChildren, removeAllTransitions, removeChild, removeClip, removeConstraint, removeConstraintByName, removeEffect, removeEffectByName, removeTransition, reparent, replaceChild, restoreEasingState, runDispose, saveEasingState, scrollToPoint, scrollToRect, shouldPickPaint, show, showAll, sortDepthOrder, stealData, stealQdata, thawNotify, transformStagePoint, unmap, unparent, unrealize, unref, unsetFlags, watchClosure.

Getters

getAbsAllocationVertices, getAccessible, getAction, getActions, getAllocationBox, getAllocationGeometry, getAllocationVertices, getAnchorPoint, getAnchorPointGravity, getAnimation, getBackgroundColor, getChildAtIndex, getChildMeta, getChildTransform, getChildren, getClip, getClipToAllocation, getConstraint, getConstraints, getContent, getContentBox, getContentGravity, getContentRepeat, getContentScalingFilters, getData, getDefaultPaintVolume, getDepth, getEasingDelay, getEasingDuration, getEasingMode, getEffect, getEffects, getFirstChild, getFixedPositionSet, getFlags, getGeometry, getGid, getHeight, getId, getInitialState, getLastChild, getLayoutManager, getMargin, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getNChildren, getName, getNextSibling, getOffscreenRedirect, getOpacity, getPaintBox, getPaintOpacity, getPaintVisibility, getPaintVolume, getPangoContext, getParent, getPivotPoint, getPivotPointZ, getPosition, getPreferredHeight, getPreferredSize, getPreferredWidth, getPreviousSibling, getProperty, getQdata, getReactive, getRequestMode, getRotation, getRotationAngle, getScale, getScaleCenter, getScaleGravity, getScaleZ, getScrollMode, getShader, getSize, getStage, getTextDirection, getTransform, getTransformationMatrix, getTransformedPaintVolume, getTransformedPosition, getTransformedSize, getTransition, getTranslation, getWidth, getX, getXAlign, getXExpand, getY, getYAlign, getYExpand, getZPosition, getZRotationGravity.

Setters

setAllocation, setAnchorPoint, setAnchorPointFromGravity, setBackgroundColor, setChildAboveSibling, setChildAtIndex, setChildBelowSibling, setChildTransform, setClip, setClipToAllocation, setContent, setContentGravity, setContentRepeat, setContentScalingFilters, setCustomProperty, setData, setDataFull, setDepth, setEasingDelay, setEasingDuration, setEasingMode, setFinalState, setFixedPositionSet, setFlags, setGeometry, setHeight, setId, setLayoutManager, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setName, setOffscreenRedirect, setOpacity, setParent, setPivotPoint, setPivotPointZ, setPosition, setProperty, setReactive, setRequestMode, setRotation, setRotationAngle, setScale, setScaleFull, setScaleWithGravity, setScaleZ, setScrollMode, setShader, setShaderParam, setShaderParamFloat, setShaderParamInt, setSize, setTextDirection, setTransform, setTranslation, setWidth, setX, setXAlign, setXExpand, setY, setYAlign, setYExpand, setZPosition, setZRotationFromGravity.

getScrollMode

scrollActorGetScrollMode

Arguments

:: (HasCallStack, MonadIO m, IsScrollActor a)

=> a

actor: a ScrollActor

-> m [ScrollMode]

Returns: the scrolling mode

Retrieves the ScrollActor:scrollMode property

Since: 1.12

new

scrollActorNew

Arguments

:: (HasCallStack, MonadIO m)

=> m ScrollActor

Returns: The newly created ScrollActor instance.

Creates a new ScrollActor.

Since: 1.12

scrollToPoint

scrollActorScrollToPoint

Arguments

:: (HasCallStack, MonadIO m, IsScrollActor a)

=> a

actor: a ScrollActor

-> Point

point: a Point

-> m ()

Scrolls the contents of actor so that point is the new origin of the visible area.

The coordinates of point must be relative to the actor.

This function will use the currently set easing state of the actor to transition from the current scroll origin to the new one.

Since: 1.12

scrollToRect

scrollActorScrollToRect

Arguments

:: (HasCallStack, MonadIO m, IsScrollActor a)

=> a

actor: a ScrollActor

-> Rect

rect: a Rect

-> m ()

Scrolls actor so that rect is in the visible portion.

Since: 1.12

setScrollMode

scrollActorSetScrollMode

Arguments

:: (HasCallStack, MonadIO m, IsScrollActor a)

=> a

actor: a ScrollActor

-> [ScrollMode]

mode: a ScrollMode

-> m ()

Sets the ScrollActor:scrollMode property.

Since: 1.12

Properties

scrollMode

The scrollin direction.

Since: 1.12

constructScrollActorScrollMode :: (IsScrollActor o, MonadIO m) => [ScrollMode] -> m (GValueConstruct o)

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

getScrollActorScrollMode :: (MonadIO m, IsScrollActor o) => o -> m [ScrollMode]

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

get scrollActor #scrollMode

setScrollActorScrollMode :: (MonadIO m, IsScrollActor o) => o -> [ScrollMode] -> m ()

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

set scrollActor [ #scrollMode := value ]