TypeModuleProtocol
public protocol TypeModuleProtocol : ObjectProtocol, TypePluginProtocol
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 g_type_module_register_type()
and g_type_module_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
g_type_module_use()
and g_type_module_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
.
The TypeModuleProtocol
protocol exposes the methods and properties of an underlying GTypeModule
instance.
The default implementation of these can be found in the protocol extension below.
For a concrete class that implements these methods and properties, see TypeModule
.
Alternatively, use TypeModuleRef
as a lighweight, unowned
reference if you already have an instance you just want to use.
-
Untyped pointer to the underlying
GTypeModule
instance.Declaration
Swift
var ptr: UnsafeMutableRawPointer! { get }
-
type_module_ptr
Default implementationTyped pointer to the underlying
GTypeModule
instance.Default Implementation
Return the stored, untyped pointer as a typed pointer to the
GTypeModule
instance.Declaration
Swift
var type_module_ptr: UnsafeMutablePointer<GTypeModule>! { get }
-
Required Initialiser for types conforming to
TypeModuleProtocol
Declaration
Swift
init(raw: UnsafeMutableRawPointer)
-
addInterface(instanceType:
Extension methodinterfaceType: interfaceInfo: ) 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
module
isnil
this will callg_type_add_interface_static()
instead. This can be used when making a static build of the module.Declaration
Swift
@inlinable func addInterface<InterfaceInfoT>(instanceType: GType, interfaceType: GType, interfaceInfo: InterfaceInfoT) where InterfaceInfoT : InterfaceInfoProtocol
-
registerEnum(name:
Extension methodconstStaticValues: ) Looks up or registers an enumeration that is implemented with a particular type plugin. If a type with name
type_name
was previously registered, theGType
identifier for the type is returned, otherwise the type is newly registered, and the resultingGType
identifier returned.As long as any instances of the type exist, the type plugin will not be unloaded.
Since 2.56 if
module
isnil
this will callg_type_register_static()
instead. This can be used when making a static build of the module.Declaration
Swift
@inlinable func registerEnum<EnumValueT>(name: UnsafePointer<gchar>!, constStaticValues: EnumValueT) -> GType where EnumValueT : EnumValueProtocol
-
registerFlags(name:
Extension methodconstStaticValues: ) 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, theGType
identifier for the type is returned, otherwise the type is newly registered, and the resultingGType
identifier returned.As long as any instances of the type exist, the type plugin will not be unloaded.
Since 2.56 if
module
isnil
this will callg_type_register_static()
instead. This can be used when making a static build of the module.Declaration
Swift
@inlinable func registerFlags<FlagsValueT>(name: UnsafePointer<gchar>!, constStaticValues: FlagsValueT) -> GType where FlagsValueT : FlagsValueProtocol
-
registerType(parentType:
Extension methodtypeName: typeInfo: flags: ) Looks up or registers a type that is implemented with a particular type plugin. If a type with name
type_name
was previously registered, theGType
identifier for the type is returned, otherwise the type is newly registered, and the resultingGType
identifier returned.When reregistering a type (typically because a module is unloaded then reloaded, and reinitialized),
module
andparent_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
module
isnil
this will callg_type_register_static()
instead. This can be used when making a static build of the module.Declaration
Swift
@inlinable func registerType<TypeInfoT>(parentType: GType, typeName: UnsafePointer<gchar>!, typeInfo: TypeInfoT, flags: TypeFlags) -> GType where TypeInfoT : TypeInfoProtocol
-
set(name:
Extension method) Sets the name for a
GTypeModule
Declaration
Swift
@inlinable func set(name: UnsafePointer<gchar>!)
-
unuse()
Extension methodDecreases the use count of a
GTypeModule
by one. If the result is zero, the module will be unloaded. (However, theGTypeModule
will not be freed, and types associated with theGTypeModule
are not unregistered. Once aGTypeModule
is initialized, it must exist forever.)Declaration
Swift
@inlinable func unuse()
-
use()
Extension methodIncreases the use count of a
GTypeModule
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.Declaration
Swift
@inlinable func use() -> Bool
-
parentInstance
Extension methodUndocumented
Declaration
Swift
@inlinable var parentInstance: GObject { get }
-
useCount
Extension methodUndocumented
Declaration
Swift
@inlinable var useCount: guint { get }
-
typeInfos
Extension methodUndocumented
Declaration
Swift
@inlinable var typeInfos: SListRef! { get }
-
interfaceInfos
Extension methodUndocumented
Declaration
Swift
@inlinable var interfaceInfos: SListRef! { get }
-
name
Extension methodthe name of the module
Declaration
Swift
@inlinable var name: UnsafeMutablePointer<gchar>! { get }