GI.Clutter.Objects.Box

The Box structure contains only private data and should be accessed using the provided API

Since: 1.2

Exported types

newtype Box

Memory-managed wrapper type.

Constructors

Box (ManagedPtr Box)

Instances

Eq Box

Defined in GI.Clutter.Objects.Box

Methods

(==) :: Box -> Box -> Bool

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

GObject Box

Defined in GI.Clutter.Objects.Box

ManagedPtrNewtype Box

Defined in GI.Clutter.Objects.Box

Methods

toManagedPtr :: Box -> ManagedPtr Box

TypedObject Box

Defined in GI.Clutter.Objects.Box

Methods

glibType :: IO GType

HasParentTypes Box

Defined in GI.Clutter.Objects.Box

IsGValue (Maybe Box)

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

Defined in GI.Clutter.Objects.Box

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes Box

Defined in GI.Clutter.Objects.Box

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

class (GObject o, IsDescendantOf Box o) => IsBox o

Type class for types which can be safely cast to Box, for instance with toBox.

Instances

(GObject o, IsDescendantOf Box o) => IsBox o

Defined in GI.Clutter.Objects.Box

toBox :: (MonadIO m, IsBox o) => o -> m Box

Cast to Box, 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, packv, 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, 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, getColor, 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, 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, setColor, 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, setShader, setShaderParam, setShaderParamFloat, setShaderParamInt, setSize, setTextDirection, setTransform, setTranslation, setWidth, setX, setXAlign, setXExpand, setY, setYAlign, setYExpand, setZPosition, setZRotationFromGravity.

getColor

boxGetColor

Arguments

:: (HasCallStack, MonadIO m, IsBox a)

=> a

box: a Box

-> m Color

Deprecated: (Since version 1.10)Use actorGetBackgroundColor instead.

Retrieves the background color of box

If the Box:colorSet property is set to False the returned Color is undefined

Since: 1.2

getLayoutManager

boxGetLayoutManager

Arguments

:: (HasCallStack, MonadIO m, IsBox a)

=> a

box: a Box

-> m LayoutManager

Returns: a LayoutManager. The returned LayoutManager is owned by the Box and it should not be unreferenced

Deprecated: (Since version 1.10)Use actorGetLayoutManager instead.

Retrieves the LayoutManager instance used by box

Since: 1.2

new

boxNew

Arguments

:: (HasCallStack, MonadIO m, IsLayoutManager a)

=> a

manager: a LayoutManager

-> m Box

Returns: the newly created Box actor

Deprecated: (Since version 1.10)Use actorNew instead.

Creates a new Box. The children of the box will be layed out by the passed manager

Since: 1.2

packv

boxPackv

Arguments

:: (HasCallStack, MonadIO m, IsBox a, IsActor b)

=> a

box: a Box

-> b

actor: a Actor

-> [Text]

properties: a vector containing the property names to set

-> [GValue]

values: a vector containing the property values to set

-> m ()

Deprecated: (Since version 1.10)Use actorAddChild instead. To set specific layout properties, use clutter_layout_manager_child_set()

Vector-based variant of clutter_box_pack(), intended for language bindings to use

Since: 1.2

setColor

boxSetColor

Arguments

:: (HasCallStack, MonadIO m, IsBox a)

=> a

box: a Box

-> Maybe Color

color: the background color, or Nothing to unset

-> m ()

Deprecated: (Since version 1.10)Use actorSetBackgroundColor instead.

Sets (or unsets) the background color for box

Since: 1.2

setLayoutManager

boxSetLayoutManager

Arguments

:: (HasCallStack, MonadIO m, IsBox a, IsLayoutManager b)

=> a

box: a Box

-> b

manager: a LayoutManager

-> m ()

Deprecated: (Since version 1.10)Use actorSetLayoutManager instead.

Sets the LayoutManager for box

A LayoutManager is a delegate object that controls the layout of the children of box

Since: 1.2

Properties

color

The color to be used to paint the background of the Box. Setting this property will set the Box:colorSet property as a side effect

This property sets the Actor:backgroundColor property internally.

Since: 1.2

clearBoxColor :: (MonadIO m, IsBox o) => o -> m ()

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

clear #color

constructBoxColor :: (IsBox o, MonadIO m) => Color -> m (GValueConstruct o)

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

getBoxColor :: (MonadIO m, IsBox o) => o -> m (Maybe Color)

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

get box #color

setBoxColor :: (MonadIO m, IsBox o) => o -> Color -> m ()

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

set box [ #color := value ]

colorSet

Whether the Box:color property has been set.

This property reads the Actor:backgroundColorSet property internally.

Since: 1.2

constructBoxColorSet :: (IsBox o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getBoxColorSet :: (MonadIO m, IsBox o) => o -> m Bool

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

get box #colorSet

setBoxColorSet :: (MonadIO m, IsBox o) => o -> Bool -> m ()

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

set box [ #colorSet := value ]