gobject.c.types

Undocumented in source.

Public Imports

glib.c.types
public import glib.c.types;

Members

Aliases

GBaseFinalizeFunc
alias GBaseFinalizeFunc = void function(void* gClass)

A callback function used by the type system to finalize those portions of a derived types class structure that were setup from the corresponding GBaseInitFunc() function. Class finalization basically works the inverse way in which class initialization is performed. See GClassInitFunc() for a discussion of the class initialization process.

GBaseInitFunc
alias GBaseInitFunc = void function(void* gClass)

A callback function used by the type system to do base initialization of the class structures of derived types. It is called as part of the initialization process of all derived classes and should reallocate or reset all dynamic class members copied over from the parent class. For example, class members (such as strings) that are not sufficiently handled by a plain memory copy of the parent class into the derived class have to be altered. See GClassInitFunc() for a discussion of the class initialization process.

GBindingTransformFunc
alias GBindingTransformFunc = int function(GBinding* binding, GValue* fromValue, GValue* toValue, void* userData)

A function to be called to transform from_value to to_value. If this is the transform_to function of a binding, then from_value is the source_property on the source object, and to_value is the target_property on the target object. If this is the transform_from function of a G_BINDING_BIDIRECTIONAL binding, then those roles are reversed.

GBoxedCopyFunc
alias GBoxedCopyFunc = void* function(void* boxed)

This function is provided by the user and should produce a copy of the passed in boxed structure.

GBoxedFreeFunc
alias GBoxedFreeFunc = void function(void* boxed)

This function is provided by the user and should free the boxed structure passed.

GCallback
alias GCallback = void function()

The type used for callback functions in structure definitions and function signatures. This doesn't mean that all callback functions must take no parameters and return void. The required signature of a callback function is determined by the context in which is used (e.g. the signal to which it is connected). Use G_CALLBACK() to cast the callback function to a GCallback

GClassFinalizeFunc
alias GClassFinalizeFunc = void function(void* gClass, void* classData)

A callback function used by the type system to finalize a class. This function is rarely needed, as dynamically allocated class resources should be handled by GBaseInitFunc() and GBaseFinalizeFunc(). Also, specification of a GClassFinalizeFunc() in the GTypeInfo structure of a static type is invalid, because classes of static types will never be finalized (they are artificially kept alive when their reference count drops to zero).

GClassInitFunc
alias GClassInitFunc = void function(void* gClass, void* classData)

A callback function used by the type system to initialize the class of a specific type. This function should initialize all static class members.

GClosureMarshal
alias GClosureMarshal = void function(GClosure* closure, GValue* returnValue, uint nParamValues, GValue* paramValues, void* invocationHint, void* marshalData)

The type used for marshaller functions.

GClosureNotify
alias GClosureNotify = void function(void* data, GClosure* closure)

The type used for the various notification callbacks which can be registered on closures.

GInstanceInitFunc
alias GInstanceInitFunc = void function(GTypeInstance* instance_, void* gClass)

A callback function used by the type system to initialize a new instance of a type. This function initializes all instance members and allocates any resources required by it.

GInterfaceFinalizeFunc
alias GInterfaceFinalizeFunc = void function(void* gIface, void* ifaceData)

A callback function used by the type system to finalize an interface. This function should destroy any internal data and release any resources allocated by the corresponding GInterfaceInitFunc() function.

GInterfaceInitFunc
alias GInterfaceInitFunc = void function(void* gIface, void* ifaceData)

A callback function used by the type system to initialize a new interface. This function should initialize all internal data and allocate any resources required by the interface.

GObjectFinalizeFunc
alias GObjectFinalizeFunc = void function(GObject* object)

The type of the finalize function of gobject.ObjectClass

GObjectGetPropertyFunc
alias GObjectGetPropertyFunc = void function(GObject* object, uint propertyId, GValue* value, GParamSpec* pspec)

The type of the get_property function of gobject.ObjectClass

GObjectSetPropertyFunc
alias GObjectSetPropertyFunc = void function(GObject* object, uint propertyId, GValue* value, GParamSpec* pspec)

The type of the set_property function of gobject.ObjectClass

GSignalAccumulator
alias GSignalAccumulator = int function(GSignalInvocationHint* ihint, GValue* returnAccu, GValue* handlerReturn, void* data)

The signal accumulator is a special callback function that can be used to collect return values of the various callbacks that are called during a signal emission. The signal accumulator is specified at signal creation time, if it is left NULL, no accumulation of callback return values is performed. The return value of signal emissions is then the value returned by the last callback.

GSignalCMarshaller
alias GSignalCMarshaller = GClosureMarshal

This is the signature of marshaller functions, required to marshall arrays of parameter values to signal emissions into C language callback invocations. It is merely an alias to GClosureMarshal since the gobject.Closure mechanism takes over responsibility of actual function invocation for the signal system.

GSignalCVaMarshaller
alias GSignalCVaMarshaller = GVaClosureMarshal

This is the signature of va_list marshaller functions, an optional marshaller that can be used in some situations to avoid marshalling the signal argument into GValues.

GSignalEmissionHook
alias GSignalEmissionHook = int function(GSignalInvocationHint* ihint, uint nParamValues, GValue* paramValues, void* data)

A simple function pointer to get invoked when the signal is emitted. This allows you to tie a hook to the signal type, so that it will trap all emissions of that signal, from any object.

GToggleNotify
alias GToggleNotify = void function(void* data, GObject* object, int isLastRef)

A callback function used for notification when the state of a toggle reference changes. See g_object_add_toggle_ref().

GTypeClassCacheFunc
alias GTypeClassCacheFunc = int function(void* cacheData, GTypeClass* gClass)

A callback function which is called when the reference count of a class drops to zero. It may use TypeClass.ref to prevent the class from being freed. You should not call TypeClass.unref from a GTypeClassCacheFunc function to prevent infinite recursion, use TypeClass.unrefUncached instead.

GTypeInterfaceCheckFunc
alias GTypeInterfaceCheckFunc = void function(void* checkData, void* gIface)

A callback called after an interface vtable is initialized. See g_type_add_interface_check().

GTypePluginCompleteInterfaceInfo
alias GTypePluginCompleteInterfaceInfo = void function(GTypePlugin* plugin, GType instanceType, GType interfaceType, GInterfaceInfo* info)

The type of the complete_interface_info function of GTypePluginClass

GTypePluginCompleteTypeInfo
alias GTypePluginCompleteTypeInfo = void function(GTypePlugin* plugin, GType gType, GTypeInfo* info, GTypeValueTable* valueTable)

The type of the complete_type_info function of GTypePluginClass

GTypePluginUnuse
alias GTypePluginUnuse = void function(GTypePlugin* plugin)

The type of the unuse_plugin function of GTypePluginClass

GTypePluginUse
alias GTypePluginUse = void function(GTypePlugin* plugin)

The type of the use_plugin function of GTypePluginClass, which gets called to increase the use count of plugin.

GVaClosureMarshal
alias GVaClosureMarshal = void function(GClosure* closure, GValue* returnValue, void* instance_, void* args, void* marshalData, int nParams, GType* paramTypes)

This is the signature of va_list marshaller functions, an optional marshaller that can be used in some situations to avoid marshalling the signal argument into GValues.

GValueTransform
alias GValueTransform = void function(GValue* srcValue, GValue* destValue)

The type of value transformation functions which can be registered with Value.registerTransformFunc.

GWeakNotify
alias GWeakNotify = void function(void* data, GObject* whereTheObjectWas)

A GWeakNotify function can be added to an object as a callback that gets triggered when the object is finalized. Since the object is already being finalized when the GWeakNotify is called, there's not much you could do with the object, apart from e.g. using its address as hash-index or the like.

Enums

GBindingFlags
enum GBindingFlags

Flags to be passed to g_object_bind_property() or g_object_bind_property_full().

GConnectFlags
enum GConnectFlags

The connection flags are used to specify the behaviour of a signal's connection.

GParamFlags
enum GParamFlags

Through the GParamFlags flag values, certain aspects of parameters can be configured. See also G_PARAM_STATIC_STRINGS

GSignalFlags
enum GSignalFlags

The signal flags are used to specify a signal's behaviour, the overall signal description outlines how especially the RUN flags control the stages of a signal emission.

GSignalMatchType
enum GSignalMatchType

The match types specify what g_signal_handlers_block_matched(), g_signal_handlers_unblock_matched() and g_signal_handlers_disconnect_matched() match signals by.

GType
enum GType

A value which represents the unique identifier of a registered type.

GTypeDebugFlags
enum GTypeDebugFlags

These flags used to be passed to g_type_init_with_debug_flags() which is now deprecated.

GTypeFlags
enum GTypeFlags

Bit masks used to check or determine characteristics of a type.

GTypeFundamentalFlags
enum GTypeFundamentalFlags

Bit masks used to check or determine specific characteristics of a fundamental type.

Manifest constants

PARAM_MASK
enum PARAM_MASK;

Mask containing the bits of gobject.ParamSpec.flags which are reserved for GLib.

PARAM_STATIC_STRINGS
enum PARAM_STATIC_STRINGS;

GParamFlags value alias for G_PARAM_STATIC_NAME | G_PARAM_STATIC_NICK | G_PARAM_STATIC_BLURB.

PARAM_USER_SHIFT
enum PARAM_USER_SHIFT;

Minimum shift count to be used for user defined flags, to be stored in gobject.ParamSpec.flags. The maximum allowed is 10.

SIGNAL_FLAGS_MASK
enum SIGNAL_FLAGS_MASK;

A mask for all GSignalFlags bits.

SIGNAL_MATCH_MASK
enum SIGNAL_MATCH_MASK;

A mask for all GSignalMatchType bits.

TYPE_FLAG_RESERVED_ID_BIT
enum TYPE_FLAG_RESERVED_ID_BIT;

A bit in the type number that's supposed to be left untouched.

TYPE_FUNDAMENTAL_MAX
enum TYPE_FUNDAMENTAL_MAX;

An integer constant that represents the number of identifiers reserved for types that are assigned at compile-time.

TYPE_FUNDAMENTAL_SHIFT
enum TYPE_FUNDAMENTAL_SHIFT;

Shift value used in converting numbers to type IDs.

TYPE_RESERVED_BSE_FIRST
enum TYPE_RESERVED_BSE_FIRST;

First fundamental type number to create a new fundamental type id with G_TYPE_MAKE_FUNDAMENTAL() reserved for BSE.

TYPE_RESERVED_BSE_LAST
enum TYPE_RESERVED_BSE_LAST;

Last fundamental type number reserved for BSE.

TYPE_RESERVED_GLIB_FIRST
enum TYPE_RESERVED_GLIB_FIRST;

First fundamental type number to create a new fundamental type id with G_TYPE_MAKE_FUNDAMENTAL() reserved for GLib.

TYPE_RESERVED_GLIB_LAST
enum TYPE_RESERVED_GLIB_LAST;

Last fundamental type number reserved for GLib.

TYPE_RESERVED_USER_FIRST
enum TYPE_RESERVED_USER_FIRST;

First available fundamental type number to create new fundamental type id with G_TYPE_MAKE_FUNDAMENTAL().

VALUE_NOCOPY_CONTENTS
enum VALUE_NOCOPY_CONTENTS;

If passed to G_VALUE_COLLECT(), allocated data won't be copied but used verbatim. This does not affect ref-counted types like objects.

Structs

GCClosure
struct GCClosure

A gobject.CClosure is a specialization of gobject.Closure for C function callbacks.

GClosure
struct GClosure

Undocumented in source.

GEnumClass
struct GEnumClass

The class of an enumeration type holds information about its possible values.

GEnumValue
struct GEnumValue

A structure which contains a single enum value, its name, and its nickname.

GFlagsClass
struct GFlagsClass

The class of a flags type holds information about its possible values.

GFlagsValue
struct GFlagsValue

A structure which contains a single flags value, its name, and its nickname.

GInterfaceInfo
struct GInterfaceInfo

A structure that provides information to the type system which is used specifically for managing interface types.

GObjectClass
struct GObjectClass

Undocumented in source.

GObjectConstructParam
struct GObjectConstructParam

The GObjectConstructParam struct is an auxiliary structure used to hand gobject.ParamSpec/gobject.Value pairs to the constructor of a gobject.ObjectClass

GParamSpec
struct GParamSpec

Undocumented in source.

GParamSpecBoolean
struct GParamSpecBoolean

Undocumented in source.

GParamSpecBoxed
struct GParamSpecBoxed

Undocumented in source.

GParamSpecChar
struct GParamSpecChar

Undocumented in source.

GParamSpecClass
struct GParamSpecClass

The class structure for the GParamSpec type. Normally, GParamSpec classes are filled by g_param_type_register_static().

GParamSpecDouble
struct GParamSpecDouble

Undocumented in source.

GParamSpecEnum
struct GParamSpecEnum

Undocumented in source.

GParamSpecFlags
struct GParamSpecFlags

Undocumented in source.

GParamSpecFloat
struct GParamSpecFloat

Undocumented in source.

GParamSpecGType
struct GParamSpecGType

Undocumented in source.

GParamSpecInt
struct GParamSpecInt

Undocumented in source.

GParamSpecInt64
struct GParamSpecInt64

Undocumented in source.

GParamSpecLong
struct GParamSpecLong

Undocumented in source.

GParamSpecObject
struct GParamSpecObject

Undocumented in source.

GParamSpecParam
struct GParamSpecParam

Undocumented in source.

GParamSpecPointer
struct GParamSpecPointer

Undocumented in source.

GParamSpecString
struct GParamSpecString

Undocumented in source.

GParamSpecTypeInfo
struct GParamSpecTypeInfo

This structure is used to provide the type system with the information required to initialize and destruct (finalize) a parameter's class and instances thereof. The initialized structure is passed to the g_param_type_register_static() The type system will perform a deep copy of this structure, so its memory does not need to be persistent across invocation of g_param_type_register_static().

GParamSpecUChar
struct GParamSpecUChar

Undocumented in source.

GParamSpecUInt
struct GParamSpecUInt

Undocumented in source.

GParamSpecUInt64
struct GParamSpecUInt64

Undocumented in source.

GParamSpecULong
struct GParamSpecULong

Undocumented in source.

GParamSpecUnichar
struct GParamSpecUnichar

Undocumented in source.

GParamSpecValueArray
struct GParamSpecValueArray

Undocumented in source.

GParamSpecVariant
struct GParamSpecVariant

Undocumented in source.

GParameter
struct GParameter

The GParameter struct is an auxiliary structure used to hand parameter name/value pairs to g_object_newv().

GSignalInvocationHint
struct GSignalInvocationHint

The GSignalInvocationHint structure is used to pass on additional information to callbacks during a signal emission.

GSignalQuery
struct GSignalQuery

A structure holding in-depth information for a specific signal. It is filled in by the g_signal_query() function.

GTypeFundamentalInfo
struct GTypeFundamentalInfo

A structure that provides information to the type system which is used specifically for managing fundamental types.

GTypeInfo
struct GTypeInfo

This structure is used to provide the type system with the information required to initialize and destruct (finalize) a type's class and its instances.

GTypeModule
struct GTypeModule

Undocumented in source.

GTypeModuleClass
struct GTypeModuleClass

In order to implement dynamic loading of types based on gobject.TypeModule, the load and unload functions in GTypeModuleClass must be implemented.

GTypePluginClass
struct GTypePluginClass

The GTypePlugin interface is used by the type system in order to handle the lifecycle of dynamically loaded types.

GTypeQuery
struct GTypeQuery

A structure holding information for a specific type. It is filled in by the g_type_query() function.

GTypeValueTable
struct GTypeValueTable

The GTypeValueTable provides the functions required by the gobject.Value implementation, to serve as a container for values of a type.

GValueArray
struct GValueArray

Undocumented in source.