gi-clutter-1.0.5: clutter GObject bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Clutter.Objects.ActorMeta

Description

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

Since: 1.4

Synopsis

Exported types

newtype ActorMeta Source #

Memory-managed wrapper type.

Constructors

ActorMeta (ManagedPtr ActorMeta) 

Instances

Instances details
Eq ActorMeta Source # 
Instance details

Defined in GI.Clutter.Objects.ActorMeta

GObject ActorMeta Source # 
Instance details

Defined in GI.Clutter.Objects.ActorMeta

ManagedPtrNewtype ActorMeta Source # 
Instance details

Defined in GI.Clutter.Objects.ActorMeta

Methods

toManagedPtr :: ActorMeta -> ManagedPtr ActorMeta

TypedObject ActorMeta Source # 
Instance details

Defined in GI.Clutter.Objects.ActorMeta

Methods

glibType :: IO GType

HasParentTypes ActorMeta Source # 
Instance details

Defined in GI.Clutter.Objects.ActorMeta

IsGValue (Maybe ActorMeta) Source #

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

Instance details

Defined in GI.Clutter.Objects.ActorMeta

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes ActorMeta Source # 
Instance details

Defined in GI.Clutter.Objects.ActorMeta

type ParentTypes ActorMeta = '[Object]

class (GObject o, IsDescendantOf ActorMeta o) => IsActorMeta o Source #

Type class for types which can be safely cast to ActorMeta, for instance with toActorMeta.

Instances

Instances details
(GObject o, IsDescendantOf ActorMeta o) => IsActorMeta o Source # 
Instance details

Defined in GI.Clutter.Objects.ActorMeta

toActorMeta :: (MonadIO m, IsActorMeta o) => o -> m ActorMeta Source #

Cast to ActorMeta, for types for which this is known to be safe. For general casts, use castTo.

Methods

getActor

actorMetaGetActor Source #

Arguments

:: (HasCallStack, MonadIO m, IsActorMeta a) 
=> a

meta: a ActorMeta

-> m Actor

Returns: a pointer to a Actor or Nothing

Retrieves a pointer to the Actor that owns meta

Since: 1.4

getEnabled

actorMetaGetEnabled Source #

Arguments

:: (HasCallStack, MonadIO m, IsActorMeta a) 
=> a

meta: a ActorMeta

-> m Bool

Returns: True if the ActorMeta instance is enabled

Retrieves whether meta is enabled

Since: 1.4

getName

actorMetaGetName Source #

Arguments

:: (HasCallStack, MonadIO m, IsActorMeta a) 
=> a

meta: a ActorMeta

-> m Text

Returns: the name of the ActorMeta instance, or Nothing if none was set. The returned string is owned by the ActorMeta instance and it should not be modified or freed

Retrieves the name set using actorMetaSetName

Since: 1.4

setEnabled

actorMetaSetEnabled Source #

Arguments

:: (HasCallStack, MonadIO m, IsActorMeta a) 
=> a

meta: a ActorMeta

-> Bool

isEnabled: whether meta is enabled

-> m () 

Sets whether meta should be enabled or not

Since: 1.4

setName

actorMetaSetName Source #

Arguments

:: (HasCallStack, MonadIO m, IsActorMeta a) 
=> a

meta: a ActorMeta

-> Text

name: the name of meta

-> m () 

Sets the name of meta

The name can be used to identify the ActorMeta instance

Since: 1.4

Properties

actor

The Actor attached to the ActorMeta instance

Since: 1.4

getActorMetaActor :: (MonadIO m, IsActorMeta o) => o -> m Actor Source #

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

get actorMeta #actor

enabled

Whether or not the ActorMeta is enabled

Since: 1.4

constructActorMetaEnabled :: (IsActorMeta o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getActorMetaEnabled :: (MonadIO m, IsActorMeta o) => o -> m Bool Source #

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

get actorMeta #enabled

setActorMetaEnabled :: (MonadIO m, IsActorMeta o) => o -> Bool -> m () Source #

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

set actorMeta [ #enabled := value ]

name

The unique name to access the ActorMeta

Since: 1.4

constructActorMetaName :: (IsActorMeta o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getActorMetaName :: (MonadIO m, IsActorMeta o) => o -> m Text Source #

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

get actorMeta #name

setActorMetaName :: (MonadIO m, IsActorMeta o) => o -> Text -> m () Source #

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

set actorMeta [ #name := value ]