TypeClassProtocol
public protocol TypeClassProtocol
An opaque structure used as the base of all classes.
The TypeClassProtocol
protocol exposes the methods and properties of an underlying GTypeClass
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 TypeClass
.
Alternatively, use TypeClassRef
as a lighweight, unowned
reference if you already have an instance you just want to use.
-
Untyped pointer to the underlying
GTypeClass
instance.Declaration
Swift
var ptr: UnsafeMutableRawPointer! { get }
-
_ptr
Default implementationTyped pointer to the underlying
GTypeClass
instance.Default Implementation
Return the stored, untyped pointer as a typed pointer to the
GTypeClass
instance.Declaration
Swift
var _ptr: UnsafeMutablePointer<GTypeClass>! { get }
-
Required Initialiser for types conforming to
TypeClassProtocol
Declaration
Swift
init(raw: UnsafeMutableRawPointer)
-
addPrivate(privateSize:
Extension method) Registers a private structure for an instantiatable type.
When an object is allocated, the private structures for the type and all of its parent types are allocated sequentially in the same memory block as the public structures, and are zero-filled.
Note that the accumulated size of the private structures of a type and all its parent types cannot exceed 64 KiB.
This function should be called in the type’s
class_init()
function. The private structure can be retrieved using theG_TYPE_INSTANCE_GET_PRIVATE()
macro.The following example shows attaching a private structure MyObjectPrivate to an object MyObject defined in the standard GObject fashion in the type’s
class_init()
function.Note the use of a structure member “priv” to avoid the overhead of repeatedly calling
MY_OBJECT_GET_PRIVATE()
.(C Language Example):
typedef struct _MyObject MyObject; typedef struct _MyObjectPrivate MyObjectPrivate; struct _MyObject { GObject parent; MyObjectPrivate *priv; }; struct _MyObjectPrivate { int some_field; }; static void my_object_class_init (MyObjectClass *klass) { g_type_class_add_private (klass, sizeof (MyObjectPrivate)); } static void my_object_init (MyObject *my_object) { my_object->priv = G_TYPE_INSTANCE_GET_PRIVATE (my_object, MY_TYPE_OBJECT, MyObjectPrivate); // my_object->priv->some_field will be automatically initialised to 0 } static int my_object_get_some_field (MyObject *my_object) { MyObjectPrivate *priv; g_return_val_if_fail (MY_IS_OBJECT (my_object), 0); priv = my_object->priv; return priv->some_field; }
add_private is deprecated: Use the G_ADD_PRIVATE() macro with the
G_DEFINE_*
family of macros to add instance private data to a typeDeclaration
Swift
@available(*, deprecated) @inlinable func addPrivate(privateSize: Int)
-
getInstancePrivateOffset()
Extension methodGets the offset of the private data for instances of
g_class
.This is how many bytes you should add to the instance pointer of a class in order to get the private data for the type represented by
g_class
.You can only call this function after you have registered a private data area for
g_class
usingg_type_class_add_private()
.Declaration
Swift
@inlinable func getInstancePrivateOffset() -> Int
-
getPrivate(privateType:
Extension method) Undocumented
Declaration
Swift
@inlinable func getPrivate(privateType: GType) -> gpointer?
-
peekParent()
Extension methodThis is a convenience function often needed in class initializers. It returns the class structure of the immediate parent type of the class passed in. Since derived classes hold a reference count on their parent classes as long as they are instantiated, the returned class will always exist.
This function is essentially equivalent to: g_type_class_peek (g_type_parent (G_TYPE_FROM_CLASS (g_class)))
Declaration
Swift
@inlinable func peekParent() -> GLibObject.TypeClassRef!
-
unref()
Extension methodDecrements the reference count of the class structure being passed in. Once the last reference count of a class has been released, classes may be finalized by the type system, so further dereferencing of a class pointer after
g_type_class_unref()
are invalid.Declaration
Swift
@inlinable func unref()
-
unrefUncached()
Extension methodA variant of
g_type_class_unref()
for use inGTypeClassCacheFunc
implementations. It unreferences a class without consulting the chain ofGTypeClassCacheFuncs
, avoiding the recursion which would occur otherwise.Declaration
Swift
@inlinable func unrefUncached()
-
typeCheckClassCast(isAType:
Extension method) Undocumented
Declaration
Swift
@inlinable func typeCheckClassCast(isAType: GType) -> GLibObject.TypeClassRef!
-
typeCheckClassIsA(isAType:
Extension method) Undocumented
Declaration
Swift
@inlinable func typeCheckClassIsA(isAType: GType) -> Bool
-
typeInterfacePeek(ifaceType:
Extension method) Returns the
GTypeInterface
structure of an interface to which the passed in class conforms.Declaration
Swift
@inlinable func typeInterfacePeek(ifaceType: GType) -> GLibObject.TypeInterfaceRef!
-
typeNameFromClass()
Extension methodUndocumented
Declaration
Swift
@inlinable func typeNameFromClass() -> String!
-
instancePrivateOffset
Extension methodGets the offset of the private data for instances of
g_class
.This is how many bytes you should add to the instance pointer of a class in order to get the private data for the type represented by
g_class
.You can only call this function after you have registered a private data area for
g_class
usingg_type_class_add_private()
.Declaration
Swift
@inlinable var instancePrivateOffset: Int { get }