GObject.TypeModule

g GObject.GInterface GObject.GInterface GObject.TypePlugin GObject.TypePlugin GObject.GInterface->GObject.TypePlugin GObject.Object GObject.Object GObject.TypeModule GObject.TypeModule GObject.Object->GObject.TypeModule GObject.TypePlugin->GObject.TypeModule

Subclasses:

None

Methods

Inherited:

GObject.Object (37), GObject.TypePlugin (4)

Structs:

GObject.ObjectClass (5)

add_interface (instance_type, interface_type, interface_info)

register_enum (name, const_static_values)

register_flags (name, const_static_values)

register_type (parent_type, type_name, type_info, flags)

set_name (name)

unuse ()

use ()

Virtual Methods

Inherited:

GObject.Object (7)

do_load ()

do_unload ()

Properties

None

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name

Type

Access

Description

interface_infos

[object]

r

name

str

r

the name of the module

parent_instance

GObject.Object

r

type_infos

[object]

r

use_count

int

r

Class Details

class GObject.TypeModule(**kwargs)
Bases:

GObject.Object, GObject.TypePlugin

Abstract:

Yes

Structure:

GObject.TypeModuleClass

GTypeModule provides a simple implementation of the GTypePlugin interface.

The model of GTypeModule is a dynamically loaded module which implements some number of types and interface implementations.

When the module is loaded, it registers its types and interfaces using [method`GObject`.TypeModule.register_type] and [method`GObject`.TypeModule.add_interface]. As long as any instances of these types and interface implementations are in use, the module is kept loaded. When the types and interfaces are gone, the module may be unloaded. If the types and interfaces become used again, the module will be reloaded. Note that the last reference cannot be released from within the module code, since that would lead to the caller’s code being unloaded before g_object_unref() returns to it.

Keeping track of whether the module should be loaded or not is done by using a use count - it starts at zero, and whenever it is greater than zero, the module is loaded. The use count is maintained internally by the type system, but also can be explicitly controlled by [method`GObject`.TypeModule.use] and [method`GObject`.TypeModule.unuse]. Typically, when loading a module for the first type, g_type_module_use() will be used to load it so that it can initialize its types. At some later point, when the module no longer needs to be loaded except for the type implementations it contains, g_type_module_unuse() is called.

GTypeModule does not actually provide any implementation of module loading and unloading. To create a particular module type you must derive from GTypeModule and implement the load and unload functions in GTypeModuleClass.

add_interface(instance_type, interface_type, interface_info)[source]
Parameters:

Registers an additional interface for a type, whose interface lives in the given type plugin. If the interface was already registered for the type in this plugin, nothing will be done.

As long as any instances of the type exist, the type plugin will not be unloaded.

Since 2.56 if self is None this will call GObject.type_add_interface_static() instead. This can be used when making a static build of the module.

register_enum(name, const_static_values)[source]
Parameters:

  • name (str) – name for the type

  • const_static_values (GObject.EnumValue) – an array of GObject.EnumValue structs for the possible enumeration values. The array is terminated by a struct with all members being 0.

Returns:

the new or existing type ID

Return type:

GObject.GType

Looks up or registers an enumeration that is implemented with a particular type plugin. If a type with name type_name was previously registered, the GObject.GType identifier for the type is returned, otherwise the type is newly registered, and the resulting GObject.GType identifier returned.

As long as any instances of the type exist, the type plugin will not be unloaded.

Since 2.56 if self is None this will call GObject.type_register_static() instead. This can be used when making a static build of the module.

New in version 2.6.

register_flags(name, const_static_values)[source]
Parameters:

  • name (str) – name for the type

  • const_static_values (GObject.FlagsValue) – an array of GObject.FlagsValue structs for the possible flags values. The array is terminated by a struct with all members being 0.

Returns:

the new or existing type ID

Return type:

GObject.GType

Looks up or registers a flags type that is implemented with a particular type plugin. If a type with name type_name was previously registered, the GObject.GType identifier for the type is returned, otherwise the type is newly registered, and the resulting GObject.GType identifier returned.

As long as any instances of the type exist, the type plugin will not be unloaded.

Since 2.56 if self is None this will call GObject.type_register_static() instead. This can be used when making a static build of the module.

New in version 2.6.

register_type(parent_type, type_name, type_info, flags)[source]
Parameters:
Returns:

the new or existing type ID

Return type:

GObject.GType

Looks up or registers a type that is implemented with a particular type plugin. If a type with name type_name was previously registered, the GObject.GType identifier for the type is returned, otherwise the type is newly registered, and the resulting GObject.GType identifier returned.

When reregistering a type (typically because a module is unloaded then reloaded, and reinitialized), self and parent_type must be the same as they were previously.

As long as any instances of the type exist, the type plugin will not be unloaded.

Since 2.56 if self is None this will call GObject.type_register_static() instead. This can be used when making a static build of the module.

set_name(name)[source]
Parameters:

name (str) – a human-readable name to use in error messages.

Sets the name for a GObject.TypeModule

unuse()[source]

Decreases the use count of a GObject.TypeModule by one. If the result is zero, the module will be unloaded. (However, the GObject.TypeModule will not be freed, and types associated with the GObject.TypeModule are not unregistered. Once a GObject.TypeModule is initialized, it must exist forever.)

use()[source]
Returns:

False if the plugin needed to be loaded and loading the plugin failed.

Return type:

bool

Increases the use count of a GObject.TypeModule by one. If the use count was zero before, the plugin will be loaded. If loading the plugin fails, the use count is reset to its prior value.

do_load() virtual
Return type:

bool

loads the module and registers one or more types using GObject.TypeModule.register_type().

do_unload() virtual

unloads the module