GI.Clutter.Interfaces.Scriptable

Scriptable is an opaque structure whose members cannot be directly accessed

Since: 0.6

Exported types

newtype Scriptable

Memory-managed wrapper type.

Constructors

Scriptable (ManagedPtr Scriptable)

Instances

Eq Scriptable

Defined in GI.Clutter.Interfaces.Scriptable

Methods

(==) :: Scriptable -> Scriptable -> Bool

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

GObject Scriptable

Defined in GI.Clutter.Interfaces.Scriptable

ManagedPtrNewtype Scriptable

Defined in GI.Clutter.Interfaces.Scriptable

Methods

toManagedPtr :: Scriptable -> ManagedPtr Scriptable

TypedObject Scriptable

Defined in GI.Clutter.Interfaces.Scriptable

Methods

glibType :: IO GType

HasParentTypes Scriptable

Defined in GI.Clutter.Interfaces.Scriptable

IsGValue (Maybe Scriptable)

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

Defined in GI.Clutter.Interfaces.Scriptable

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes Scriptable

Defined in GI.Clutter.Interfaces.Scriptable

type ParentTypes Scriptable = '[Object]

class (GObject o, IsDescendantOf Scriptable o) => IsScriptable o

Type class for types which can be safely cast to Scriptable, for instance with toScriptable.

Instances

(GObject o, IsDescendantOf Scriptable o) => IsScriptable o

Defined in GI.Clutter.Interfaces.Scriptable

toScriptable :: (MonadIO m, IsScriptable o) => o -> m Scriptable

Cast to Scriptable, 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, parseCustomNode, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getData, getId, getProperty, getQdata.

Setters

setCustomProperty, setData, setDataFull, setId, setProperty.

getId

scriptableGetId

Arguments

:: (HasCallStack, MonadIO m, IsScriptable a)

=> a

scriptable: a Scriptable

-> m Text

Returns: the id of the object. The returned string is owned by the scriptable object and should never be modified of freed

Retrieves the id of scriptable set using scriptableSetId.

Since: 0.6

parseCustomNode

scriptableParseCustomNode

Arguments

:: (HasCallStack, MonadIO m, IsScriptable a, IsScript b)

=> a

scriptable: a Scriptable

-> b

script: the Script creating the scriptable instance

-> GValue

value: the generic value to be set

-> Text

name: the name of the node

-> Node

node: the JSON node to be parsed

-> m Bool

Returns: True if the node was successfully parsed, False otherwise.

Parses the passed JSON node. The implementation must set the type of the passed Value pointer using valueInit.

Since: 0.6

setCustomProperty

scriptableSetCustomProperty

Arguments

:: (HasCallStack, MonadIO m, IsScriptable a, IsScript b)

=> a

scriptable: a Scriptable

-> b

script: the Script creating the scriptable instance

-> Text

name: the name of the property

-> GValue

value: the value of the property

-> m ()

Overrides the common properties setting. The underlying virtual function should be used when implementing custom properties.

Since: 0.6

setId

scriptableSetId

Arguments

:: (HasCallStack, MonadIO m, IsScriptable a)

=> a

scriptable: a Scriptable

-> Text

id_: the Script id of the object

-> m ()

Sets id_ as the unique Clutter script it for this instance of ScriptableIface.

This name can be used by user interface designer applications to define a unique name for an object constructable using the UI definition language parsed by Script.

Since: 0.6