GI.GObject.Structs.EnumValue

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

Exported types

newtype EnumValue

Memory-managed wrapper type.

Constructors

EnumValue (ManagedPtr EnumValue)

Instances

WrappedPtr EnumValue

Defined in GI.GObject.Structs.EnumValue

Methods

wrappedPtrCalloc :: IO (Ptr EnumValue)

wrappedPtrCopy :: EnumValue -> IO EnumValue

wrappedPtrFree :: Maybe (FunPtr (Ptr EnumValue -> IO ()))

tag ~ AttrSet => Constructible EnumValue tag

Defined in GI.GObject.Structs.EnumValue

Methods

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

newZeroEnumValue :: MonadIO m => m EnumValue

Construct a EnumValue struct initialized to zero.

noEnumValue :: Maybe EnumValue

A convenience alias for Nothing :: Maybe EnumValue.

Properties

value

the enum value

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

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

get enumValue #value

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

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 ()

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)

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 ()

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 ()

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)

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 ()

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

set enumValue [ #valueNick := value ]