GObject.ParamSpecPool

Fields

None

Methods

class new (type_prefixing)
  insert (pspec, owner_type)
  list (owner_type)
  list_owned (owner_type)
  lookup (param_name, owner_type, walk_ancestors)
  remove (pspec)

Details

class GObject.ParamSpecPool

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

classmethod new(type_prefixing)[source]
Parameters:type_prefixing (bool) – Whether the pool will support type-prefixed property names.
Returns:a newly allocated GObject.ParamSpecPool.
Return type:GObject.ParamSpecPool

Creates a new GObject.ParamSpecPool.

If type_prefixing 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 type_prefixing to False.

insert(pspec, owner_type)[source]
Parameters:

Inserts a GObject.ParamSpec in the pool.

list(owner_type)[source]
Parameters:owner_type (GObject.GType) – the owner to look for
Returns:a newly allocated array containing pointers to all GObject.ParamSpecs owned by owner_type in the pool
Return type:[GObject.ParamSpec]

Gets an array of all GObject.ParamSpecs owned by owner_type in the pool.

list_owned(owner_type)[source]
Parameters:owner_type (GObject.GType) – the owner to look for
Returns:a GLib.List of all GObject.ParamSpecs owned by owner_type in the pool:obj:GObject.ParamSpecs <GObject.ParamSpec>.
Return type:[GObject.ParamSpec]

Gets an GLib.List of all GObject.ParamSpecs owned by owner_type in the pool.

lookup(param_name, owner_type, walk_ancestors)[source]
Parameters:
  • param_name (str) – the name to look for
  • owner_type (GObject.GType) – the owner to look for
  • walk_ancestors (bool) – If True, also try to find a GObject.ParamSpec with param_name owned by an ancestor of owner_type.
Returns:

The found GObject.ParamSpec, or None if no matching GObject.ParamSpec was found.

Return type:

GObject.ParamSpec

Looks up a GObject.ParamSpec in the pool.

remove(pspec)[source]
Parameters:pspec (GObject.ParamSpec) – the GObject.ParamSpec to remove

Removes a GObject.ParamSpec from the pool.