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

Description

A ParamSpecPool maintains a collection of GParamSpecs which can be quickly accessed by owner and name. The implementation of the Object property system uses such a pool to store the GParamSpecs of the properties all object types.

Synopsis

Exported types

newtype ParamSpecPool Source #

Memory-managed wrapper type.

Constructors

ParamSpecPool (ManagedPtr ParamSpecPool) 

Instances

Instances details
Eq ParamSpecPool Source # 
Instance details

Defined in GI.GObject.Structs.ParamSpecPool

BoxedPtr ParamSpecPool Source # 
Instance details

Defined in GI.GObject.Structs.ParamSpecPool

ManagedPtrNewtype ParamSpecPool Source # 
Instance details

Defined in GI.GObject.Structs.ParamSpecPool

Methods

toManagedPtr :: ParamSpecPool -> ManagedPtr ParamSpecPool

Methods

Click to display all available methods, including inherited ones

Expand

Methods

insert, listOwned, lookup, remove.

Getters

None.

Setters

None.

insert

paramSpecPoolInsert Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ParamSpecPool

pool: a ParamSpecPool.

-> GParamSpec

pspec: the ParamSpec to insert

-> GType

ownerType: a GType identifying the owner of pspec

-> m () 

Inserts a ParamSpec in the pool.

listOwned

paramSpecPoolListOwned Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ParamSpecPool

pool: a ParamSpecPool

-> GType

ownerType: the owner to look for

-> m [GParamSpec]

Returns: a List of all GParamSpecs owned by ownerType in the poolGParamSpecs.

Gets an List of all GParamSpecs owned by ownerType in the pool.

lookup

paramSpecPoolLookup Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ParamSpecPool

pool: a ParamSpecPool

-> Text

paramName: the name to look for

-> GType

ownerType: the owner to look for

-> Bool

walkAncestors: If True, also try to find a ParamSpec with paramName owned by an ancestor of ownerType.

-> m GParamSpec

Returns: The found ParamSpec, or Nothing if no matching ParamSpec was found.

Looks up a ParamSpec in the pool.

new

paramSpecPoolNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Bool

typePrefixing: Whether the pool will support type-prefixed property names.

-> m ParamSpecPool

Returns: a newly allocated ParamSpecPool.

Creates a new ParamSpecPool.

If typePrefixing is True, lookups in the newly created pool will allow to specify the owner as a colon-separated prefix of the property name, like "GtkContainer:border-width". This feature is deprecated, so you should always set typePrefixing to False.

remove

paramSpecPoolRemove Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ParamSpecPool

pool: a ParamSpecPool

-> GParamSpec

pspec: the ParamSpec to remove

-> m () 

Removes a ParamSpec from the pool.