gi-gobject-2.0.21: GObject bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (inaki@blueleaf.cc)
Safe HaskellNone
LanguageHaskell2010

GI.GObject.Structs.EnumValue

Contents

Description

A structure which contains a single enum value, its name, and its nickname.

Synopsis

Exported types

newtype EnumValue Source #

Memory-managed wrapper type.

Constructors

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

Defined in GI.GObject.Structs.EnumValue

Methods

wrappedPtrCalloc :: IO (Ptr EnumValue) #

wrappedPtrCopy :: EnumValue -> IO EnumValue #

wrappedPtrFree :: Maybe (GDestroyNotify EnumValue) #

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

Defined in GI.GObject.Structs.EnumValue

Methods

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

newZeroEnumValue :: MonadIO m => m EnumValue Source #

Construct a EnumValue struct initialized to zero.

noEnumValue :: Maybe EnumValue Source #

A convenience alias for Nothing :: Maybe EnumValue.

Properties

value

the enum value

getEnumValueValue :: MonadIO m => EnumValue -> m Int32 Source #

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

get enumValue #value

setEnumValueValue :: MonadIO m => EnumValue -> Int32 -> m () Source #

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

set enumValue [ #value := value ]

valueName

the name of the value

clearEnumValueValueName :: MonadIO m => EnumValue -> m () Source #

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

clear #valueName

getEnumValueValueName :: MonadIO m => EnumValue -> m (Maybe Text) Source #

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

get enumValue #valueName

setEnumValueValueName :: MonadIO m => EnumValue -> CString -> m () Source #

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

set enumValue [ #valueName := value ]

valueNick

the nickname of the value

clearEnumValueValueNick :: MonadIO m => EnumValue -> m () Source #

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

clear #valueNick

getEnumValueValueNick :: MonadIO m => EnumValue -> m (Maybe Text) Source #

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

get enumValue #valueNick

setEnumValueValueNick :: MonadIO m => EnumValue -> CString -> m () Source #

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

set enumValue [ #valueNick := value ]