GI.GObject.Structs.Parameter

The GParameter struct is an auxiliary structure used to hand parameter name/value pairs to objectNewv.

Exported types

newtype Parameter

Memory-managed wrapper type.

Constructors

Parameter (ManagedPtr Parameter)

Instances

Eq Parameter

Defined in GI.GObject.Structs.Parameter

Methods

(==) :: Parameter -> Parameter -> Bool

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

BoxedPtr Parameter

Defined in GI.GObject.Structs.Parameter

Methods

boxedPtrCopy :: Parameter -> IO Parameter

boxedPtrFree :: Parameter -> IO ()

CallocPtr Parameter

Defined in GI.GObject.Structs.Parameter

Methods

boxedPtrCalloc :: IO (Ptr Parameter)

ManagedPtrNewtype Parameter

Defined in GI.GObject.Structs.Parameter

Methods

toManagedPtr :: Parameter -> ManagedPtr Parameter

tag ~ 'AttrSet => Constructible Parameter tag

Defined in GI.GObject.Structs.Parameter

Methods

new :: MonadIO m => (ManagedPtr Parameter -> Parameter) -> [AttrOp Parameter tag] -> m Parameter

newZeroParameter :: MonadIO m => m Parameter

Construct a Parameter struct initialized to zero.

Methods

Properties

name

the parameter name

clearParameterName :: MonadIO m => Parameter -> m ()

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

clear #name

getParameterName :: MonadIO m => Parameter -> m (Maybe Text)

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

get parameter #name

setParameterName :: MonadIO m => Parameter -> CString -> m ()

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

set parameter [ #name := value ]

value

the parameter value

clearParameterValue :: MonadIO m => Parameter -> m ()

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

clear #value

getParameterValue :: MonadIO m => Parameter -> m (Maybe GValue)

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

get parameter #value

setParameterValue :: MonadIO m => Parameter -> Ptr GValue -> m ()

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

set parameter [ #value := value ]