| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
GI.GObject.Structs.FlagsClass
Description
The class of a flags type holds information about its possible values.
Synopsis
- newtype FlagsClass = FlagsClass (ManagedPtr FlagsClass)
- newZeroFlagsClass :: MonadIO m => m FlagsClass
- getFlagsClassGTypeClass :: MonadIO m => FlagsClass -> m TypeClass
- getFlagsClassMask :: MonadIO m => FlagsClass -> m Word32
- setFlagsClassMask :: MonadIO m => FlagsClass -> Word32 -> m ()
- getFlagsClassNValues :: MonadIO m => FlagsClass -> m Word32
- setFlagsClassNValues :: MonadIO m => FlagsClass -> Word32 -> m ()
- clearFlagsClassValues :: MonadIO m => FlagsClass -> m ()
- getFlagsClassValues :: MonadIO m => FlagsClass -> m (Maybe FlagsValue)
- setFlagsClassValues :: MonadIO m => FlagsClass -> Ptr FlagsValue -> m ()
Exported types
newtype FlagsClass Source #
Memory-managed wrapper type.
Constructors
| FlagsClass (ManagedPtr FlagsClass) |
Instances
| Eq FlagsClass Source # | |
Defined in GI.GObject.Structs.FlagsClass | |
| BoxedPtr FlagsClass Source # | |
Defined in GI.GObject.Structs.FlagsClass | |
| CallocPtr FlagsClass Source # | |
Defined in GI.GObject.Structs.FlagsClass Methods boxedPtrCalloc :: IO (Ptr FlagsClass) # | |
| ManagedPtrNewtype FlagsClass Source # | |
Defined in GI.GObject.Structs.FlagsClass Methods | |
| tag ~ 'AttrSet => Constructible FlagsClass tag Source # | |
Defined in GI.GObject.Structs.FlagsClass Methods new :: MonadIO m => (ManagedPtr FlagsClass -> FlagsClass) -> [AttrOp FlagsClass tag] -> m FlagsClass # | |
newZeroFlagsClass :: MonadIO m => m FlagsClass Source #
Construct a FlagsClass struct initialized to zero.
Methods
Properties
gTypeClass
the parent class
getFlagsClassGTypeClass :: MonadIO m => FlagsClass -> m TypeClass Source #
Get the value of the “g_type_class” field.
When overloading is enabled, this is equivalent to
get flagsClass #gTypeClass
mask
a mask covering all possible values.
getFlagsClassMask :: MonadIO m => FlagsClass -> m Word32 Source #
Get the value of the “mask” field.
When overloading is enabled, this is equivalent to
get flagsClass #mask
setFlagsClassMask :: MonadIO m => FlagsClass -> Word32 -> m () Source #
Set the value of the “mask” field.
When overloading is enabled, this is equivalent to
setflagsClass [ #mask:=value ]
nValues
the number of possible values.
getFlagsClassNValues :: MonadIO m => FlagsClass -> m Word32 Source #
Get the value of the “n_values” field.
When overloading is enabled, this is equivalent to
get flagsClass #nValues
setFlagsClassNValues :: MonadIO m => FlagsClass -> Word32 -> m () Source #
Set the value of the “n_values” field.
When overloading is enabled, this is equivalent to
setflagsClass [ #nValues:=value ]
values
an array of FlagsValue structs describing the
individual values.
clearFlagsClassValues :: MonadIO m => FlagsClass -> m () Source #
Set the value of the “values” field to Nothing.
When overloading is enabled, this is equivalent to
clear #values
getFlagsClassValues :: MonadIO m => FlagsClass -> m (Maybe FlagsValue) Source #
Get the value of the “values” field.
When overloading is enabled, this is equivalent to
get flagsClass #values
setFlagsClassValues :: MonadIO m => FlagsClass -> Ptr FlagsValue -> m () Source #
Set the value of the “values” field.
When overloading is enabled, this is equivalent to
setflagsClass [ #values:=value ]