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 |
Container
is an opaque structure whose members cannot be directly
accessed
Since: 0.4
Synopsis
- newtype Container = Container (ManagedPtr Container)
- class (GObject o, IsDescendantOf Container o) => IsContainer o
- toContainer :: (MonadIO m, IsContainer o) => o -> m Container
- containerAddActor :: (HasCallStack, MonadIO m, IsContainer a, IsActor b) => a -> b -> m ()
- containerChildGetProperty :: (HasCallStack, MonadIO m, IsContainer a, IsActor b) => a -> b -> Text -> GValue -> m ()
- containerChildNotify :: (HasCallStack, MonadIO m, IsContainer a, IsActor b) => a -> b -> GParamSpec -> m ()
- containerChildSetProperty :: (HasCallStack, MonadIO m, IsContainer a, IsActor b) => a -> b -> Text -> GValue -> m ()
- containerClassFindChildProperty :: (HasCallStack, MonadIO m) => ObjectClass -> Text -> m GParamSpec
- containerCreateChildMeta :: (HasCallStack, MonadIO m, IsContainer a, IsActor b) => a -> b -> m ()
- containerDestroyChildMeta :: (HasCallStack, MonadIO m, IsContainer a, IsActor b) => a -> b -> m ()
- containerFindChildByName :: (HasCallStack, MonadIO m, IsContainer a) => a -> Text -> m Actor
- containerForeach :: (HasCallStack, MonadIO m, IsContainer a) => a -> Callback -> m ()
- containerForeachWithInternals :: (HasCallStack, MonadIO m, IsContainer a) => a -> Callback -> m ()
- containerGetChildMeta :: (HasCallStack, MonadIO m, IsContainer a, IsActor b) => a -> b -> m ChildMeta
- containerGetChildren :: (HasCallStack, MonadIO m, IsContainer a) => a -> m [Actor]
- containerLowerChild :: (HasCallStack, MonadIO m, IsContainer a, IsActor b, IsActor c) => a -> b -> Maybe c -> m ()
- containerRaiseChild :: (HasCallStack, MonadIO m, IsContainer a, IsActor b, IsActor c) => a -> b -> Maybe c -> m ()
- containerRemoveActor :: (HasCallStack, MonadIO m, IsContainer a, IsActor b) => a -> b -> m ()
- containerSortDepthOrder :: (HasCallStack, MonadIO m, IsContainer a) => a -> m ()
- type ContainerActorAddedCallback = Actor -> IO ()
- afterContainerActorAdded :: (IsContainer a, MonadIO m) => a -> ((?self :: a) => ContainerActorAddedCallback) -> m SignalHandlerId
- onContainerActorAdded :: (IsContainer a, MonadIO m) => a -> ((?self :: a) => ContainerActorAddedCallback) -> m SignalHandlerId
- type ContainerActorRemovedCallback = Actor -> IO ()
- afterContainerActorRemoved :: (IsContainer a, MonadIO m) => a -> ((?self :: a) => ContainerActorRemovedCallback) -> m SignalHandlerId
- onContainerActorRemoved :: (IsContainer a, MonadIO m) => a -> ((?self :: a) => ContainerActorRemovedCallback) -> m SignalHandlerId
- type ContainerChildNotifyCallback = Actor -> GParamSpec -> IO ()
- afterContainerChildNotify :: (IsContainer a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => ContainerChildNotifyCallback) -> m SignalHandlerId
- onContainerChildNotify :: (IsContainer a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => ContainerChildNotifyCallback) -> m SignalHandlerId
Exported types
Memory-managed wrapper type.
Instances
Eq Container Source # | |
GObject Container Source # | |
Defined in GI.Clutter.Interfaces.Container | |
ManagedPtrNewtype Container Source # | |
Defined in GI.Clutter.Interfaces.Container | |
TypedObject Container Source # | |
Defined in GI.Clutter.Interfaces.Container | |
HasParentTypes Container Source # | |
Defined in GI.Clutter.Interfaces.Container | |
IsGValue (Maybe Container) Source # | Convert |
Defined in GI.Clutter.Interfaces.Container | |
type ParentTypes Container Source # | |
Defined in GI.Clutter.Interfaces.Container |
class (GObject o, IsDescendantOf Container o) => IsContainer o Source #
Type class for types which can be safely cast to Container
, for instance with toContainer
.
Instances
(GObject o, IsDescendantOf Container o) => IsContainer o Source # | |
Defined in GI.Clutter.Interfaces.Container |
toContainer :: (MonadIO m, IsContainer o) => o -> m Container Source #
Methods
Click to display all available methods, including inherited ones
Methods
addActor, bindProperty, bindPropertyFull, childGetProperty, childNotify, childSetProperty, createChildMeta, destroyChildMeta, findChildByName, forceFloating, foreach, foreachWithInternals, freezeNotify, getv, isFloating, lowerChild, notify, notifyByPspec, raiseChild, ref, refSink, removeActor, runDispose, sortDepthOrder, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getChildMeta, getChildren, getData, getProperty, getQdata.
Setters
addActor
:: (HasCallStack, MonadIO m, IsContainer a, IsActor b) | |
=> a |
|
-> b |
|
-> m () |
Deprecated: (Since version 1.10)Use actorAddChild
instead.
Adds a Actor
to container
. This function will emit the
"actor-added" signal. The actor should be parented to
container
. You cannot add a Actor
to more than one
Container
.
This function will call ContainerIface
.add
(), which is a
deprecated virtual function. The default implementation will
call actorAddChild
.
Since: 0.4
childGetProperty
containerChildGetProperty Source #
:: (HasCallStack, MonadIO m, IsContainer a, IsActor b) | |
=> a |
|
-> b |
|
-> Text |
|
-> GValue |
|
-> m () |
Gets a container specific property of a child of container
, In general,
a copy is made of the property contents and the caller is responsible for
freeing the memory by calling valueUnset
.
Note that containerChildSetProperty
is really intended for
language bindings, clutter_container_child_set()
is much more convenient
for C programming.
Since: 0.8
childNotify
:: (HasCallStack, MonadIO m, IsContainer a, IsActor b) | |
=> a |
|
-> b |
|
-> GParamSpec |
|
-> m () |
Calls the ContainerIface
.child_notify
() virtual function
of Container
. The default implementation will emit the
childNotify signal.
Since: 1.6
childSetProperty
containerChildSetProperty Source #
:: (HasCallStack, MonadIO m, IsContainer a, IsActor b) | |
=> a |
|
-> b |
|
-> Text |
|
-> GValue |
|
-> m () |
Sets a container-specific property on a child of container
.
Since: 0.8
classFindChildProperty
containerClassFindChildProperty Source #
:: (HasCallStack, MonadIO m) | |
=> ObjectClass |
|
-> Text |
|
-> m GParamSpec | Returns: The |
Looks up the ParamSpec
for a child property of klass
.
Since: 0.8
createChildMeta
containerCreateChildMeta Source #
:: (HasCallStack, MonadIO m, IsContainer a, IsActor b) | |
=> a |
|
-> b |
|
-> m () |
Creates the ChildMeta
wrapping actor
inside the
container
, if the ContainerIface
::child_meta_type
class member is not set to G_TYPE_INVALID
.
This function is only useful when adding a Actor
to
a Container
implementation outside of the
Container
::add
() virtual function implementation.
Applications should not call this function.
Since: 1.2
destroyChildMeta
containerDestroyChildMeta Source #
:: (HasCallStack, MonadIO m, IsContainer a, IsActor b) | |
=> a |
|
-> b |
|
-> m () |
findChildByName
containerFindChildByName Source #
:: (HasCallStack, MonadIO m, IsContainer a) | |
=> a |
|
-> Text |
|
-> m Actor | Returns: The child actor with the requested name,
or |
Finds a child actor of a container by its name. Search recurses into any child container.
Since: 0.6
foreach
:: (HasCallStack, MonadIO m, IsContainer a) | |
=> a |
|
-> Callback |
|
-> m () |
Deprecated: (Since version 1.10)Use actorGetFirstChild
or actorGetLastChild
to retrieve the beginning of the list of children, and actorGetNextSibling
and actorGetPreviousSibling
to iterate over it; alternatively, use the ActorIter
API.
Calls callback
for each child of container
that was added
by the application (with containerAddActor
). Does
not iterate over "internal" children that are part of the
container's own implementation, if any.
This function calls the ContainerIface
.foreach
()
virtual function, which has been deprecated.
Since: 0.4
foreachWithInternals
containerForeachWithInternals Source #
:: (HasCallStack, MonadIO m, IsContainer a) | |
=> a |
|
-> Callback |
|
-> m () |
Deprecated: (Since version 1.10)See containerForeach
.
Calls callback
for each child of container
, including "internal"
children built in to the container itself that were never added
by the application.
This function calls the ContainerIface
.foreach_with_internals
()
virtual function, which has been deprecated.
Since: 1.0
getChildMeta
containerGetChildMeta Source #
:: (HasCallStack, MonadIO m, IsContainer a, IsActor b) | |
=> a |
|
-> b |
|
-> m ChildMeta | Returns: the |
Retrieves the ChildMeta
which contains the data about the
container
specific state for actor
.
Since: 0.8
getChildren
:: (HasCallStack, MonadIO m, IsContainer a) | |
=> a |
|
-> m [Actor] | Returns: a list
of |
Deprecated: (Since version 1.10)Use actorGetChildren
instead.
Retrieves all the children of container
.
Since: 0.4
lowerChild
:: (HasCallStack, MonadIO m, IsContainer a, IsActor b, IsActor c) | |
=> a |
|
-> b |
|
-> Maybe c |
|
-> m () |
Deprecated: (Since version 1.10)Use actorSetChildBelowSibling
instead.
Lowers actor
to sibling
level, in the depth ordering.
This function calls the ContainerIface
.lower
() virtual function,
which has been deprecated. The default implementation will call
actorSetChildBelowSibling
.
Since: 0.6
raiseChild
:: (HasCallStack, MonadIO m, IsContainer a, IsActor b, IsActor c) | |
=> a |
|
-> b |
|
-> Maybe c |
|
-> m () |
Deprecated: (Since version 1.10)Use actorSetChildAboveSibling
instead.
Raises actor
to sibling
level, in the depth ordering.
This function calls the ContainerIface
.raise
() virtual function,
which has been deprecated. The default implementation will call
actorSetChildAboveSibling
.
Since: 0.6
removeActor
:: (HasCallStack, MonadIO m, IsContainer a, IsActor b) | |
=> a |
|
-> b |
|
-> m () |
Deprecated: (Since version 1.10)Use actorRemoveChild
instead.
Removes actor
from container
. The actor should be unparented, so
if you want to keep it around you must hold a reference to it
yourself, using objectRef
. When the actor has been removed,
the "actor-removed" signal is emitted by container
.
This function will call ContainerIface
.remove
(), which is a
deprecated virtual function. The default implementation will call
actorRemoveChild
.
Since: 0.4
sortDepthOrder
containerSortDepthOrder Source #
:: (HasCallStack, MonadIO m, IsContainer a) | |
=> a |
|
-> m () |
Deprecated: (Since version 1.10)The ContainerIface
.sort_depth_order
() virtual function should not be used any more; the default implementation in Container
does not do anything.
Sorts a container's children using their depth. This function should not be normally used by applications.
Since: 0.6
Signals
actorAdded
type ContainerActorAddedCallback Source #
The actorAdded signal is emitted each time an actor
has been added to container
.
Since: 0.4
afterContainerActorAdded :: (IsContainer a, MonadIO m) => a -> ((?self :: a) => ContainerActorAddedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the actorAdded signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
container #actorAdded 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.
onContainerActorAdded :: (IsContainer a, MonadIO m) => a -> ((?self :: a) => ContainerActorAddedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the actorAdded signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
container #actorAdded callback
actorRemoved
type ContainerActorRemovedCallback Source #
The actorRemoved signal is emitted each time an actor
is removed from container
.
Since: 0.4
afterContainerActorRemoved :: (IsContainer a, MonadIO m) => a -> ((?self :: a) => ContainerActorRemovedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the actorRemoved signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
container #actorRemoved 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.
onContainerActorRemoved :: (IsContainer a, MonadIO m) => a -> ((?self :: a) => ContainerActorRemovedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the actorRemoved signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
container #actorRemoved callback
childNotify
type ContainerChildNotifyCallback Source #
= Actor |
|
-> GParamSpec |
|
-> IO () |
The childNotify signal is emitted each time a property is
being set through the clutter_container_child_set()
and
containerChildSetProperty
calls.
Since: 0.8
afterContainerChildNotify :: (IsContainer a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => ContainerChildNotifyCallback) -> m SignalHandlerId Source #
Connect a signal handler for the childNotify signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
container #childNotify callback
This signal admits a optional parameter detail
.
If it's not Nothing
, we will connect to “child-notify::detail
” instead.
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.
onContainerChildNotify :: (IsContainer a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => ContainerChildNotifyCallback) -> m SignalHandlerId Source #
Connect a signal handler for the childNotify signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
container #childNotify callback
This signal admits a optional parameter detail
.
If it's not Nothing
, we will connect to “child-notify::detail
” instead.