gi-gobject-2.0.22: GObject bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.GObject.Structs.ParamSpecPool

Contents

Description

A tParamSpecPool maintains a collection of GParamSpecs which can be quickly accessed by owner and name. The implementation of the tObject 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
Eq ParamSpecPool Source # 
Instance details

Defined in GI.GObject.Structs.ParamSpecPool

WrappedPtr ParamSpecPool Source # 
Instance details

Defined in GI.GObject.Structs.ParamSpecPool

noParamSpecPool :: Maybe ParamSpecPool Source #

A convenience alias for Nothing :: Maybe ParamSpecPool.

Methods

Overloaded methods

insert

paramSpecPoolInsert Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ParamSpecPool

pool: a tParamSpecPool.

-> GParamSpec

pspec: the tParamSpec to insert

-> GType

ownerType: a tGType identifying the owner of pspec

-> m () 

Inserts a tParamSpec in the pool.

listOwned

paramSpecPoolListOwned Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ParamSpecPool

pool: a tParamSpecPool

-> GType

ownerType: the owner to look for

-> m [GParamSpec]

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

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

lookup

paramSpecPoolLookup Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ParamSpecPool

pool: a tParamSpecPool

-> Text

paramName: the name to look for

-> GType

ownerType: the owner to look for

-> Bool

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

-> m GParamSpec

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

Looks up a tParamSpec 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 tParamSpecPool.

Creates a new tParamSpecPool.

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 tParamSpecPool

-> GParamSpec

pspec: the tParamSpec to remove

-> m () 

Removes a tParamSpec from the pool.