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.EnumClass

Description

The class of an enumeration type holds information about its possible values.

Synopsis

Exported types

newtype EnumClass Source #

Memory-managed wrapper type.

Constructors

EnumClass (ManagedPtr EnumClass) 

Instances

Instances details
Eq EnumClass Source # 
Instance details

Defined in GI.GObject.Structs.EnumClass

BoxedPtr EnumClass Source # 
Instance details

Defined in GI.GObject.Structs.EnumClass

CallocPtr EnumClass Source # 
Instance details

Defined in GI.GObject.Structs.EnumClass

ManagedPtrNewtype EnumClass Source # 
Instance details

Defined in GI.GObject.Structs.EnumClass

Methods

toManagedPtr :: EnumClass -> ManagedPtr EnumClass

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

Defined in GI.GObject.Structs.EnumClass

Methods

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

newZeroEnumClass :: MonadIO m => m EnumClass Source #

Construct a EnumClass struct initialized to zero.

Methods

Properties

gTypeClass

the parent class

getEnumClassGTypeClass :: MonadIO m => EnumClass -> m TypeClass Source #

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

get enumClass #gTypeClass

maximum

the largest possible value.

getEnumClassMaximum :: MonadIO m => EnumClass -> m Int32 Source #

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

get enumClass #maximum

setEnumClassMaximum :: MonadIO m => EnumClass -> Int32 -> m () Source #

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

set enumClass [ #maximum := value ]

minimum

the smallest possible value.

getEnumClassMinimum :: MonadIO m => EnumClass -> m Int32 Source #

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

get enumClass #minimum

setEnumClassMinimum :: MonadIO m => EnumClass -> Int32 -> m () Source #

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

set enumClass [ #minimum := value ]

nValues

the number of possible values.

getEnumClassNValues :: MonadIO m => EnumClass -> m Word32 Source #

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

get enumClass #nValues

setEnumClassNValues :: MonadIO m => EnumClass -> Word32 -> m () Source #

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

set enumClass [ #nValues := value ]

values

an array of EnumValue structs describing the individual values.

clearEnumClassValues :: MonadIO m => EnumClass -> m () Source #

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

clear #values

getEnumClassValues :: MonadIO m => EnumClass -> m (Maybe EnumValue) Source #

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

get enumClass #values

setEnumClassValues :: MonadIO m => EnumClass -> Ptr EnumValue -> m () Source #

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

set enumClass [ #values := value ]