TypeModuleProtocol

public protocol TypeModuleProtocol : ObjectProtocol, TypePluginProtocol

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.

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 unref cannot happen in 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.

  • ptr

    Untyped pointer to the underlying GTypeModule instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer { get }
  • type_module_ptr Default implementation

    Typed 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 }

no TypeModule properties

TypeModule Class: TypeModuleProtocol extension (methods and fields)

  • 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 is nil this will call g_type_add_interface_static() instead. This can be used when making a static build of the module.

    Declaration

    Swift

    func addInterface(instanceType instance_type: GType, interfaceType interface_type: GType, interfaceInfo interface_info: InterfaceInfoProtocol)
  • 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 GType identifier for the type is returned, otherwise the type is newly registered, and the resulting GType identifier returned.

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

    Since 2.56 if module is nil this will call g_type_register_static() instead. This can be used when making a static build of the module.

    Declaration

    Swift

    func registerEnum(name: UnsafePointer<gchar>, constStaticValues const_static_values: EnumValueProtocol) -> 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 GType identifier for the type is returned, otherwise the type is newly registered, and the resulting GType identifier returned.

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

    Since 2.56 if module is nil this will call g_type_register_static() instead. This can be used when making a static build of the module.

    Declaration

    Swift

    func registerFlags(name: UnsafePointer<gchar>, constStaticValues const_static_values: FlagsValueProtocol) -> 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 GType identifier for the type is returned, otherwise the type is newly registered, and the resulting GType identifier returned.

    When reregistering a type (typically because a module is unloaded then reloaded, and reinitialized), module 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 module is nil this will call g_type_register_static() instead. This can be used when making a static build of the module.

    Declaration

    Swift

    func registerType(parentType parent_type: GType, typeName type_name: UnsafePointer<gchar>, typeInfo type_info: TypeInfoProtocol, flags: TypeFlags) -> GType
  • set(name:) Extension method

    Sets the name for a GTypeModule

    Declaration

    Swift

    func set(name: UnsafePointer<gchar>)
  • unuse() Extension method

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

    Declaration

    Swift

    func unuse()
  • use() Extension method

    Increases 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

    func use() -> Bool
  • parentInstance Extension method

    Undocumented

    Declaration

    Swift

    var parentInstance: GObject { get }
  • useCount Extension method

    Undocumented

    Declaration

    Swift

    var useCount: Int { get }
  • typeInfos Extension method

    Undocumented

    Declaration

    Swift

    var typeInfos: UnsafeMutablePointer<GSList> { get }
  • interfaceInfos Extension method

    Undocumented

    Declaration

    Swift

    var interfaceInfos: UnsafeMutablePointer<GSList> { get }
  • name Extension method

    the name of the module

    Declaration

    Swift

    var name: UnsafePointer<CChar> { get }