gi-gobject-2.0.26: GObject bindings
CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.GObject.Structs.FlagsClass

Description

The class of a flags type holds information about its possible values.

Synopsis

Exported types

newtype FlagsClass Source #

Memory-managed wrapper type.

Constructors

FlagsClass (ManagedPtr FlagsClass) 

Instances

Instances details
Eq FlagsClass Source # 
Instance details

Defined in GI.GObject.Structs.FlagsClass

BoxedPtr FlagsClass Source # 
Instance details

Defined in GI.GObject.Structs.FlagsClass

CallocPtr FlagsClass Source # 
Instance details

Defined in GI.GObject.Structs.FlagsClass

ManagedPtrNewtype FlagsClass Source # 
Instance details

Defined in GI.GObject.Structs.FlagsClass

Methods

toManagedPtr :: FlagsClass -> ManagedPtr FlagsClass

tag ~ 'AttrSet => Constructible FlagsClass tag Source # 
Instance details

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

set flagsClass [ #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

set flagsClass [ #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

set flagsClass [ #values := value ]