GI.Clutter.Objects.ChildMeta

Base interface for container specific state for child actors. A child data is meant to be used when you need to keep track of information about each individual child added to a container.

In order to use it you should create your own subclass of ChildMeta and set the ContainerIface child_meta_type interface member to your subclass type, like:

static void
my_container_iface_init (ClutterContainerIface *iface)
{
  // set the rest of the #ClutterContainer vtable

  container_iface->child_meta_type  = MY_TYPE_CHILD_META;
}

This will automatically create a ChildMeta of type MY_TYPE_CHILD_META for every actor that is added to the container.

The child data for an actor can be retrieved using the containerGetChildMeta function.

The properties of the data and your subclass can be manipulated with clutter_container_child_set() and clutter_container_child_get() which act like g_object_set() and g_object_get().

You can provide hooks for your own storage as well as control the instantiation by overriding the ContainerIface virtual functions ContainerIface.create_child_meta(), ContainerIface.destroy_child_meta(), and ContainerIface.get_child_meta().

Since: 0.8

Exported types

newtype ChildMeta

Memory-managed wrapper type.

Constructors

ChildMeta (ManagedPtr ChildMeta)

Instances

Eq ChildMeta

Defined in GI.Clutter.Objects.ChildMeta

Methods

(==) :: ChildMeta -> ChildMeta -> Bool

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

GObject ChildMeta

Defined in GI.Clutter.Objects.ChildMeta

ManagedPtrNewtype ChildMeta

Defined in GI.Clutter.Objects.ChildMeta

Methods

toManagedPtr :: ChildMeta -> ManagedPtr ChildMeta

TypedObject ChildMeta

Defined in GI.Clutter.Objects.ChildMeta

Methods

glibType :: IO GType

HasParentTypes ChildMeta

Defined in GI.Clutter.Objects.ChildMeta

IsGValue (Maybe ChildMeta)

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

Defined in GI.Clutter.Objects.ChildMeta

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes ChildMeta

Defined in GI.Clutter.Objects.ChildMeta

type ParentTypes ChildMeta = '[Object]

class (GObject o, IsDescendantOf ChildMeta o) => IsChildMeta o

Type class for types which can be safely cast to ChildMeta, for instance with toChildMeta.

Instances

(GObject o, IsDescendantOf ChildMeta o) => IsChildMeta o

Defined in GI.Clutter.Objects.ChildMeta

toChildMeta :: (MonadIO m, IsChildMeta o) => o -> m ChildMeta

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

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getActor, getContainer, getData, getProperty, getQdata.

Setters

setData, setDataFull, setProperty.

getActor

childMetaGetActor

Arguments

:: (HasCallStack, MonadIO m, IsChildMeta a)

=> a

data: a ChildMeta

-> m Actor

Returns: a Actor

Retrieves the actor wrapped by data

Since: 0.8

getContainer

childMetaGetContainer

Arguments

:: (HasCallStack, MonadIO m, IsChildMeta a)

=> a

data: a ChildMeta

-> m Container

Returns: a Container

Retrieves the container using data

Since: 0.8

Properties

actor

The Actor being wrapped by this ChildMeta

Since: 0.8

constructChildMetaActor :: (IsChildMeta o, MonadIO m, IsActor a) => a -> m (GValueConstruct o)

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

getChildMetaActor :: (MonadIO m, IsChildMeta o) => o -> m Actor

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

get childMeta #actor

container

The Container that created this ChildMeta.

Since: 0.8

constructChildMetaContainer :: (IsChildMeta o, MonadIO m, IsContainer a) => a -> m (GValueConstruct o)

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

getChildMetaContainer :: (MonadIO m, IsChildMeta o) => o -> m Container

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

get childMeta #container