GI.Clutter.Objects.LayoutManager

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

Since: 1.2

Exported types

newtype LayoutManager

Memory-managed wrapper type.

Constructors

LayoutManager (ManagedPtr LayoutManager)

Instances

Eq LayoutManager

Defined in GI.Clutter.Objects.LayoutManager

Methods

(==) :: LayoutManager -> LayoutManager -> Bool

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

GObject LayoutManager

Defined in GI.Clutter.Objects.LayoutManager

ManagedPtrNewtype LayoutManager

Defined in GI.Clutter.Objects.LayoutManager

Methods

toManagedPtr :: LayoutManager -> ManagedPtr LayoutManager

TypedObject LayoutManager

Defined in GI.Clutter.Objects.LayoutManager

Methods

glibType :: IO GType

HasParentTypes LayoutManager

Defined in GI.Clutter.Objects.LayoutManager

IsGValue (Maybe LayoutManager)

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

Defined in GI.Clutter.Objects.LayoutManager

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes LayoutManager

Defined in GI.Clutter.Objects.LayoutManager

type ParentTypes LayoutManager = '[Object]

class (GObject o, IsDescendantOf LayoutManager o) => IsLayoutManager o

Type class for types which can be safely cast to LayoutManager, for instance with toLayoutManager.

Instances

(GObject o, IsDescendantOf LayoutManager o) => IsLayoutManager o

Defined in GI.Clutter.Objects.LayoutManager

toLayoutManager :: (MonadIO m, IsLayoutManager o) => o -> m LayoutManager

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

allocate, beginAnimation, bindProperty, bindPropertyFull, childGetProperty, childSetProperty, endAnimation, findChildProperty, forceFloating, freezeNotify, getv, isFloating, layoutChanged, listChildProperties, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getAnimationProgress, getChildMeta, getData, getPreferredHeight, getPreferredWidth, getProperty, getQdata.

Setters

setContainer, setData, setDataFull, setProperty.

allocate

layoutManagerAllocate

Arguments

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

=> a

manager: a LayoutManager

-> b

container: the Container using manager

-> ActorBox

allocation: the ActorBox containing the allocated area of container

-> [AllocationFlags]

flags: the allocation flags

-> m ()

Allocates the children of container given an area

See also actorAllocate

Since: 1.2

beginAnimation

layoutManagerBeginAnimation

Arguments

:: (HasCallStack, MonadIO m, IsLayoutManager a)

=> a

manager: a LayoutManager

-> Word32

duration: the duration of the animation, in milliseconds

-> CULong

mode: the easing mode of the animation

-> m Alpha

Returns: The Alpha created by the layout manager; the returned instance is owned by the layout manager and should not be unreferenced

Deprecated: (Since version 1.12)

Begins an animation of duration milliseconds, using the provided easing mode

The easing mode can be specified either as a AnimationMode or as a logical id returned by clutter_alpha_register_func()

The result of this function depends on the manager implementation

Since: 1.2

childGetProperty

layoutManagerChildGetProperty

Arguments

:: (HasCallStack, MonadIO m, IsLayoutManager a, IsContainer b, IsActor c)

=> a

manager: a LayoutManager

-> b

container: a Container using manager

-> c

actor: a Actor child of container

-> Text

propertyName: the name of the property to get

-> GValue

value: a Value with the value of the property to get

-> m ()

Gets a property on the LayoutMeta created by manager and attached to a child of container

The Value must already be initialized to the type of the property and has to be unset with valueUnset after extracting the real value out of it

Since: 1.2

childSetProperty

layoutManagerChildSetProperty

Arguments

:: (HasCallStack, MonadIO m, IsLayoutManager a, IsContainer b, IsActor c)

=> a

manager: a LayoutManager

-> b

container: a Container using manager

-> c

actor: a Actor child of container

-> Text

propertyName: the name of the property to set

-> GValue

value: a Value with the value of the property to set

-> m ()

Sets a property on the LayoutMeta created by manager and attached to a child of container

Since: 1.2

endAnimation

layoutManagerEndAnimation

Arguments

:: (HasCallStack, MonadIO m, IsLayoutManager a)

=> a

manager: a LayoutManager

-> m ()

Deprecated: (Since version 1.12)

Ends an animation started by layoutManagerBeginAnimation

The result of this call depends on the manager implementation

Since: 1.2

findChildProperty

layoutManagerFindChildProperty

Arguments

:: (HasCallStack, MonadIO m, IsLayoutManager a)

=> a

manager: a LayoutManager

-> Text

name: the name of the property

-> m GParamSpec

Returns: a ParamSpec describing the property, or Nothing if no property with that name exists. The returned ParamSpec is owned by the layout manager and should not be modified or freed

Retrieves the ParamSpec for the layout property name inside the LayoutMeta sub-class used by manager

Since: 1.2

getAnimationProgress

layoutManagerGetAnimationProgress

Arguments

:: (HasCallStack, MonadIO m, IsLayoutManager a)

=> a

manager: a LayoutManager

-> m Double

Returns: the progress of the animation

Deprecated: (Since version 1.12)

Retrieves the progress of the animation, if one has been started by layoutManagerBeginAnimation

The returned value has the same semantics of the Alpha:alpha value

Since: 1.2

getChildMeta

layoutManagerGetChildMeta

Arguments

:: (HasCallStack, MonadIO m, IsLayoutManager a, IsContainer b, IsActor c)

=> a

manager: a LayoutManager

-> b

container: a Container using manager

-> c

actor: a Actor child of container

-> m LayoutMeta

Returns: a LayoutMeta, or Nothing if the LayoutManager does not have layout properties. The returned layout meta instance is owned by the LayoutManager and it should not be unreferenced

Retrieves the LayoutMeta that the layout manager associated to the actor child of container, eventually by creating one if the LayoutManager supports layout properties

Since: 1.0

getPreferredHeight

layoutManagerGetPreferredHeight

Arguments

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

=> a

manager: a LayoutManager

-> b

container: the Container using manager

-> Float

forWidth: the width for which the height should be computed, or -1

-> m (Float, Float)

Computes the minimum and natural heights of the container according to manager.

See also actorGetPreferredHeight

Since: 1.2

getPreferredWidth

layoutManagerGetPreferredWidth

Arguments

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

=> a

manager: a LayoutManager

-> b

container: the Container using manager

-> Float

forHeight: the height for which the width should be computed, or -1

-> m (Float, Float)

Computes the minimum and natural widths of the container according to manager.

See also actorGetPreferredWidth

Since: 1.2

layoutChanged

layoutManagerLayoutChanged

Arguments

:: (HasCallStack, MonadIO m, IsLayoutManager a)

=> a

manager: a LayoutManager

-> m ()

Emits the LayoutManager::layoutChanged signal on manager

This function should only be called by implementations of the LayoutManager class

Since: 1.2

setContainer

layoutManagerSetContainer

Arguments

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

=> a

manager: a LayoutManager

-> Maybe b

container: a Container using manager

-> m ()

If the LayoutManager sub-class allows it, allow adding a weak reference of the container using manager from within the layout manager

The layout manager should not increase the reference count of the container

Since: 1.2

Signals

layoutChanged

type LayoutManagerLayoutChangedCallback = IO ()

The layoutChanged signal is emitted each time a layout manager has been changed. Every Actor using the manager instance as a layout manager should connect a handler to the layoutChanged signal and queue a relayout on themselves:

 static void layout_changed (ClutterLayoutManager *manager,
                             ClutterActor         *self)
 {
   clutter_actor_queue_relayout (self);
 }
 ...
   self->manager = g_object_ref_sink (manager);
   g_signal_connect (self->manager, "layout-changed",
                     G_CALLBACK (layout_changed),
                     self);

Sub-classes of LayoutManager that implement a layout that can be controlled or changed using parameters should emit the layoutChanged signal whenever one of the parameters changes, by using layoutManagerLayoutChanged.

Since: 1.2

afterLayoutManagerLayoutChanged :: (IsLayoutManager a, MonadIO m) => a -> ((?self :: a) => LayoutManagerLayoutChangedCallback) -> m SignalHandlerId

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

after layoutManager #layoutChanged callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onLayoutManagerLayoutChanged :: (IsLayoutManager a, MonadIO m) => a -> ((?self :: a) => LayoutManagerLayoutChangedCallback) -> m SignalHandlerId

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

on layoutManager #layoutChanged callback