| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.GObject.Structs.EnumValue
Description
A structure which contains a single enum value, its name, and its nickname.
Synopsis
- newtype EnumValue = EnumValue (ManagedPtr EnumValue)
- newZeroEnumValue :: MonadIO m => m EnumValue
- getEnumValueValue :: MonadIO m => EnumValue -> m Int32
- setEnumValueValue :: MonadIO m => EnumValue -> Int32 -> m ()
- clearEnumValueValueName :: MonadIO m => EnumValue -> m ()
- getEnumValueValueName :: MonadIO m => EnumValue -> m (Maybe Text)
- setEnumValueValueName :: MonadIO m => EnumValue -> CString -> m ()
- clearEnumValueValueNick :: MonadIO m => EnumValue -> m ()
- getEnumValueValueNick :: MonadIO m => EnumValue -> m (Maybe Text)
- setEnumValueValueNick :: MonadIO m => EnumValue -> CString -> m ()
Exported types
Memory-managed wrapper type.
Constructors
| EnumValue (ManagedPtr EnumValue) |
Instances
| Eq EnumValue Source # | |
| CallocPtr EnumValue Source # | |
Defined in GI.GObject.Structs.EnumValue Methods boxedPtrCalloc :: IO (Ptr EnumValue) # | |
| BoxedPtr EnumValue Source # | |
Defined in GI.GObject.Structs.EnumValue | |
| ManagedPtrNewtype EnumValue Source # | |
Defined in GI.GObject.Structs.EnumValue Methods | |
| tag ~ 'AttrSet => Constructible EnumValue tag Source # | |
Defined in GI.GObject.Structs.EnumValue | |
newZeroEnumValue :: MonadIO m => m EnumValue Source #
Construct a EnumValue struct initialized to zero.
Methods
Overloaded methods
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
setenumValue [ #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
setenumValue [ #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
setenumValue [ #valueNick:=value ]