gi-gobject-2.0.16: GObject bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.GObject.Structs.Parameter

Contents

Description

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

Synopsis

Exported types

newtype Parameter Source #

Memory-managed wrapper type.

Constructors

Parameter (ManagedPtr Parameter) 
Instances
WrappedPtr Parameter Source # 
Instance details

Defined in GI.GObject.Structs.Parameter

Methods

wrappedPtrCalloc :: IO (Ptr Parameter) #

wrappedPtrCopy :: Parameter -> IO Parameter #

wrappedPtrFree :: Maybe (FunPtr (Ptr Parameter -> IO ())) #

tag ~ AttrSet => Constructible Parameter tag Source # 
Instance details

Defined in GI.GObject.Structs.Parameter

Methods

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

newZeroParameter :: MonadIO m => m Parameter Source #

Construct a Parameter struct initialized to zero.

noParameter :: Maybe Parameter Source #

A convenience alias for Nothing :: Maybe Parameter.

Properties

name

the parameter name

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

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) Source #

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

get parameter #name

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

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

set parameter [ #name := value ]

value

the parameter value

getParameterValue :: MonadIO m => Parameter -> m GValue Source #

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

get parameter #value