Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: TypeValueInitFuncCallback

[1591:7] extends: object

Initializes the value contents by setting the fields of the value->data array. The data array of the #GValue passed into this function was zero-filled with memset(), so no care has to be taken to free any old contents. For example, in the case of a string value that may never be %NULL, the implementation might look like: |[ value->data[0].v_pointer = g_strdup (""); ]|

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • TypeValueInitFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (value)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: WeakNotifyCallback

[1814:7] extends: object

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 disposed 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. In particular, this means it’s invalid to call g_object_ref(), g_weak_ref_init(), g_weak_ref_set(), g_object_add_toggle_ref(), g_object_weak_ref(), g_object_add_weak_pointer() or any function which calls them on the object from this callback.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • WeakNotifyCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (data, where_the_object_was)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: BaseFinalizeFuncCallback

[16:7] extends: object

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.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • BaseFinalizeFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (g_class)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: TypePluginUnuseCallback

[1370:7] extends: object

The type of the @unuse_plugin function of #GTypePluginClass.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • TypePluginUnuseCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (plugin)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: CallbackCallback

[306:7] extends: object

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.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • CallbackCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline ()

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: InstanceInitFuncCallback

[644:7] extends: object

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. Initialization of a derived instance involves calling all its parent types instance initializers, so the class member of the instance is altered during its initialization to always point to the class that belongs to the type the current initializer was introduced for. The extended members of @instance are guaranteed to have been filled with zeros before this function is called.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • InstanceInitFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (instance, g_class)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: BaseInitFuncCallback

[92:7] extends: object

A callback function used by the type system to do base initialization of the class structures of derived types. This function 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.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • BaseInitFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (g_class)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: ObjectGetPropertyFuncCallback

[930:7] extends: object

The type of the @get_property function of #GObjectClass.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • ObjectGetPropertyFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (object, property_id, value, pspec)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: ObjectSetPropertyFuncCallback

[1002:7] extends: object

The type of the @set_property function of #GObjectClass.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • ObjectSetPropertyFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (object, property_id, value, pspec)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: TypeInterfaceCheckFuncCallback

[1300:7] extends: object

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

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • TypeInterfaceCheckFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (check_data, g_iface)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: BoxedCopyFuncCallback

[163:7] extends: object

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

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • BoxedCopyFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (boxed)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: TypeValuePeekPointerFuncCallback

[1664:7] extends: object

If the value contents fit into a pointer, such as objects or strings, return this pointer, so the caller can peek at the current contents. To extend on our above string example: |[ return value->data[0].v_pointer; ]|

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • TypeValuePeekPointerFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (value)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: InterfaceInitFuncCallback

[790:7] extends: object

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. The members of @iface_data are guaranteed to have been filled with zeros before this function is called.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • InterfaceInitFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (g_iface, iface_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: BoxedFreeFuncCallback

[233:7] extends: object

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

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • BoxedFreeFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (boxed)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: ToggleNotifyCallback

[1152:7] extends: object

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

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • ToggleNotifyCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (data, object, is_last_ref)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: TypeClassCacheFuncCallback

[1229:7] extends: object

A callback function which is called when the reference count of a class drops to zero. It may use g_type_class_ref() to prevent the class from being freed. You should not call g_type_class_unref() from a #GTypeClassCacheFunc function to prevent infinite recursion, use g_type_class_unref_uncached() instead. The functions have to check the class id passed in to figure whether they actually want to cache the class of this type, since all classes are routed through the same #GTypeClassCacheFunc chain.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • TypeClassCacheFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (cache_data, g_class)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: GObjectApi

[1884:14] static extends: object

Generated low-level function wrappers for namespace GObject.

Members

  • lib

Methods

  • getLib ()

  • cclosure_marshal_BOOLEAN__BOXED_BOXED (object closure, object return_value, int n_param_values, object param_values, invocation_hint, marshal_data)

    A #GClosureMarshal function for use with signals with handlers that take two boxed pointers as arguments and return a boolean. If you have such a signal, you will probably also need to use an accumulator, such as g_signal_accumulator_true_handled().

    • @p closure is A #GClosure..
    • @p return_value is A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value..
    • @p n_param_values is The length of the @param_values array..
    • @p param_values is An array of #GValues holding the arguments on which to invoke the callback of closure..
    • @p invocation_hint is The invocation hint given as the last argument to g_closure_invoke()..
    • @p marshal_data is Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal().
    • @r None.
  • cclosure_marshal_BOOLEAN__FLAGS (object closure, object return_value, int n_param_values, object param_values, invocation_hint, marshal_data)

    A #GClosureMarshal function for use with signals with handlers that take a flags type as an argument and return a boolean. If you have such a signal, you will probably also need to use an accumulator, such as g_signal_accumulator_true_handled().

    • @p closure is A #GClosure..
    • @p return_value is A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value..
    • @p n_param_values is The length of the @param_values array..
    • @p param_values is An array of #GValues holding the arguments on which to invoke the callback of closure..
    • @p invocation_hint is The invocation hint given as the last argument to g_closure_invoke()..
    • @p marshal_data is Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal().
    • @r None.
  • cclosure_marshal_STRING__OBJECT_POINTER (object closure, object return_value, int n_param_values, object param_values, invocation_hint, marshal_data)

    A #GClosureMarshal function for use with signals with handlers that take a #GObject and a pointer and produce a string. It is highly unlikely that your signal handler fits this description.

    • @p closure is A #GClosure..
    • @p return_value is A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value..
    • @p n_param_values is The length of the @param_values array..
    • @p param_values is An array of #GValues holding the arguments on which to invoke the callback of closure..
    • @p invocation_hint is The invocation hint given as the last argument to g_closure_invoke()..
    • @p marshal_data is Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal().
    • @r None.
  • cclosure_marshal_VOID__BOOLEAN (object closure, object return_value, int n_param_values, object param_values, invocation_hint, marshal_data)

    A #GClosureMarshal function for use with signals with a single boolean argument.

    • @p closure is A #GClosure..
    • @p return_value is A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value..
    • @p n_param_values is The length of the @param_values array..
    • @p param_values is An array of #GValues holding the arguments on which to invoke the callback of closure..
    • @p invocation_hint is The invocation hint given as the last argument to g_closure_invoke()..
    • @p marshal_data is Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal().
    • @r None.
  • cclosure_marshal_VOID__BOXED (object closure, object return_value, int n_param_values, object param_values, invocation_hint, marshal_data)

    A #GClosureMarshal function for use with signals with a single argument which is any boxed pointer type.

    • @p closure is A #GClosure..
    • @p return_value is A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value..
    • @p n_param_values is The length of the @param_values array..
    • @p param_values is An array of #GValues holding the arguments on which to invoke the callback of closure..
    • @p invocation_hint is The invocation hint given as the last argument to g_closure_invoke()..
    • @p marshal_data is Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal().
    • @r None.
  • cclosure_marshal_VOID__CHAR (object closure, object return_value, int n_param_values, object param_values, invocation_hint, marshal_data)

    A #GClosureMarshal function for use with signals with a single character argument.

    • @p closure is A #GClosure..
    • @p return_value is A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value..
    • @p n_param_values is The length of the @param_values array..
    • @p param_values is An array of #GValues holding the arguments on which to invoke the callback of closure..
    • @p invocation_hint is The invocation hint given as the last argument to g_closure_invoke()..
    • @p marshal_data is Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal().
    • @r None.
  • cclosure_marshal_VOID__DOUBLE (object closure, object return_value, int n_param_values, object param_values, invocation_hint, marshal_data)

    A #GClosureMarshal function for use with signals with one double-precision floating point argument.

    • @p closure is A #GClosure..
    • @p return_value is A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value..
    • @p n_param_values is The length of the @param_values array..
    • @p param_values is An array of #GValues holding the arguments on which to invoke the callback of closure..
    • @p invocation_hint is The invocation hint given as the last argument to g_closure_invoke()..
    • @p marshal_data is Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal().
    • @r None.
  • cclosure_marshal_VOID__ENUM (object closure, object return_value, int n_param_values, object param_values, invocation_hint, marshal_data)

    A #GClosureMarshal function for use with signals with a single argument with an enumerated type.

    • @p closure is A #GClosure..
    • @p return_value is A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value..
    • @p n_param_values is The length of the @param_values array..
    • @p param_values is An array of #GValues holding the arguments on which to invoke the callback of closure..
    • @p invocation_hint is The invocation hint given as the last argument to g_closure_invoke()..
    • @p marshal_data is Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal().
    • @r None.
  • cclosure_marshal_VOID__FLAGS (object closure, object return_value, int n_param_values, object param_values, invocation_hint, marshal_data)

    A #GClosureMarshal function for use with signals with a single argument with a flags types.

    • @p closure is A #GClosure..
    • @p return_value is A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value..
    • @p n_param_values is The length of the @param_values array..
    • @p param_values is An array of #GValues holding the arguments on which to invoke the callback of closure..
    • @p invocation_hint is The invocation hint given as the last argument to g_closure_invoke()..
    • @p marshal_data is Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal().
    • @r None.
  • cclosure_marshal_VOID__FLOAT (object closure, object return_value, int n_param_values, object param_values, invocation_hint, marshal_data)

    A #GClosureMarshal function for use with signals with one single-precision floating point argument.

    • @p closure is A #GClosure..
    • @p return_value is A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value..
    • @p n_param_values is The length of the @param_values array..
    • @p param_values is An array of #GValues holding the arguments on which to invoke the callback of closure..
    • @p invocation_hint is The invocation hint given as the last argument to g_closure_invoke()..
    • @p marshal_data is Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal().
    • @r None.
  • cclosure_marshal_VOID__INT (object closure, object return_value, int n_param_values, object param_values, invocation_hint, marshal_data)

    A #GClosureMarshal function for use with signals with a single integer argument.

    • @p closure is A #GClosure..
    • @p return_value is A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value..
    • @p n_param_values is The length of the @param_values array..
    • @p param_values is An array of #GValues holding the arguments on which to invoke the callback of closure..
    • @p invocation_hint is The invocation hint given as the last argument to g_closure_invoke()..
    • @p marshal_data is Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal().
    • @r None.
  • cclosure_marshal_VOID__LONG (object closure, object return_value, int n_param_values, object param_values, invocation_hint, marshal_data)

    A #GClosureMarshal function for use with signals with with a single long integer argument.

    • @p closure is A #GClosure..
    • @p return_value is A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value..
    • @p n_param_values is The length of the @param_values array..
    • @p param_values is An array of #GValues holding the arguments on which to invoke the callback of closure..
    • @p invocation_hint is The invocation hint given as the last argument to g_closure_invoke()..
    • @p marshal_data is Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal().
    • @r None.
  • cclosure_marshal_VOID__OBJECT (object closure, object return_value, int n_param_values, object param_values, invocation_hint, marshal_data)

    A #GClosureMarshal function for use with signals with a single #GObject argument.

    • @p closure is A #GClosure..
    • @p return_value is A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value..
    • @p n_param_values is The length of the @param_values array..
    • @p param_values is An array of #GValues holding the arguments on which to invoke the callback of closure..
    • @p invocation_hint is The invocation hint given as the last argument to g_closure_invoke()..
    • @p marshal_data is Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal().
    • @r None.
  • cclosure_marshal_VOID__PARAM (object closure, object return_value, int n_param_values, object param_values, invocation_hint, marshal_data)

    A #GClosureMarshal function for use with signals with a single argument of type #GParamSpec.

    • @p closure is A #GClosure..
    • @p return_value is A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value..
    • @p n_param_values is The length of the @param_values array..
    • @p param_values is An array of #GValues holding the arguments on which to invoke the callback of closure..
    • @p invocation_hint is The invocation hint given as the last argument to g_closure_invoke()..
    • @p marshal_data is Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal().
    • @r None.
  • cclosure_marshal_VOID__POINTER (object closure, object return_value, int n_param_values, object param_values, invocation_hint, marshal_data)

    A #GClosureMarshal function for use with signals with a single raw pointer argument type. If it is possible, it is better to use one of the more specific functions such as g_cclosure_marshal_VOID__OBJECT() or g_cclosure_marshal_VOID__OBJECT().

    • @p closure is A #GClosure..
    • @p return_value is A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value..
    • @p n_param_values is The length of the @param_values array..
    • @p param_values is An array of #GValues holding the arguments on which to invoke the callback of closure..
    • @p invocation_hint is The invocation hint given as the last argument to g_closure_invoke()..
    • @p marshal_data is Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal().
    • @r None.
  • cclosure_marshal_VOID__STRING (object closure, object return_value, int n_param_values, object param_values, invocation_hint, marshal_data)

    A #GClosureMarshal function for use with signals with a single string argument.

    • @p closure is A #GClosure..
    • @p return_value is A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value..
    • @p n_param_values is The length of the @param_values array..
    • @p param_values is An array of #GValues holding the arguments on which to invoke the callback of closure..
    • @p invocation_hint is The invocation hint given as the last argument to g_closure_invoke()..
    • @p marshal_data is Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal().
    • @r None.
  • cclosure_marshal_VOID__UCHAR (object closure, object return_value, int n_param_values, object param_values, invocation_hint, marshal_data)

    A #GClosureMarshal function for use with signals with a single unsigned character argument.

    • @p closure is A #GClosure..
    • @p return_value is A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value..
    • @p n_param_values is The length of the @param_values array..
    • @p param_values is An array of #GValues holding the arguments on which to invoke the callback of closure..
    • @p invocation_hint is The invocation hint given as the last argument to g_closure_invoke()..
    • @p marshal_data is Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal().
    • @r None.
  • cclosure_marshal_VOID__UINT (object closure, object return_value, int n_param_values, object param_values, invocation_hint, marshal_data)

    A #GClosureMarshal function for use with signals with with a single unsigned integer argument.

    • @p closure is A #GClosure..
    • @p return_value is A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value..
    • @p n_param_values is The length of the @param_values array..
    • @p param_values is An array of #GValues holding the arguments on which to invoke the callback of closure..
    • @p invocation_hint is The invocation hint given as the last argument to g_closure_invoke()..
    • @p marshal_data is Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal().
    • @r None.
  • cclosure_marshal_VOID__UINT_POINTER (object closure, object return_value, int n_param_values, object param_values, invocation_hint, marshal_data)

    A #GClosureMarshal function for use with signals with an unsigned int and a pointer as arguments.

    • @p closure is A #GClosure..
    • @p return_value is A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value..
    • @p n_param_values is The length of the @param_values array..
    • @p param_values is An array of #GValues holding the arguments on which to invoke the callback of closure..
    • @p invocation_hint is The invocation hint given as the last argument to g_closure_invoke()..
    • @p marshal_data is Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal().
    • @r None.
  • cclosure_marshal_VOID__ULONG (object closure, object return_value, int n_param_values, object param_values, invocation_hint, marshal_data)

    A #GClosureMarshal function for use with signals with a single unsigned long integer argument.

    • @p closure is A #GClosure..
    • @p return_value is A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value..
    • @p n_param_values is The length of the @param_values array..
    • @p param_values is An array of #GValues holding the arguments on which to invoke the callback of closure..
    • @p invocation_hint is The invocation hint given as the last argument to g_closure_invoke()..
    • @p marshal_data is Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal().
    • @r None.
  • cclosure_marshal_VOID__VARIANT (object closure, object return_value, int n_param_values, object param_values, invocation_hint, marshal_data)

    A #GClosureMarshal function for use with signals with a single #GVariant argument.

    • @p closure is A #GClosure..
    • @p return_value is A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value..
    • @p n_param_values is The length of the @param_values array..
    • @p param_values is An array of #GValues holding the arguments on which to invoke the callback of closure..
    • @p invocation_hint is The invocation hint given as the last argument to g_closure_invoke()..
    • @p marshal_data is Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal().
    • @r None.
  • cclosure_marshal_VOID__VOID (object closure, object return_value, int n_param_values, object param_values, invocation_hint, marshal_data)

    A #GClosureMarshal function for use with signals with no arguments.

    • @p closure is A #GClosure..
    • @p return_value is A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value..
    • @p n_param_values is The length of the @param_values array..
    • @p param_values is An array of #GValues holding the arguments on which to invoke the callback of closure..
    • @p invocation_hint is The invocation hint given as the last argument to g_closure_invoke()..
    • @p marshal_data is Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal().
    • @r None.
  • cclosure_marshal_generic (object closure, object return_gvalue, int n_param_values, object param_values, invocation_hint, marshal_data)

    A generic marshaller function implemented via libffi. Normally this function is not passed explicitly to g_signal_new(), but used automatically by GLib when specifying a %NULL marshaller.

    • @p closure is A #GClosure..
    • @p return_gvalue is A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value..
    • @p n_param_values is The length of the @param_values array..
    • @p param_values is An array of #GValues holding the arguments on which to invoke the callback of closure..
    • @p invocation_hint is The invocation hint given as the last argument to g_closure_invoke()..
    • @p marshal_data is Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal().
    • @r None.
  • clear_object (object object_ptr)

    Clears a reference to a #GObject. @object_ptr must not be %NULL. If the reference is %NULL then this function does nothing. Otherwise, the reference count of the object is decreased and the pointer is set to %NULL. A macro is also included that allows this function to be used without pointer casts.

    • @p object_ptr is a pointer to a #GObject reference.
    • @r None.
  • clear_signal_handler (int handler_id_ptr, object instance)

    Disconnects a handler from @instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to. The @handler_id_ptr is then set to zero, which is never a valid handler ID value (see g_signal_connect()). If the handler ID is 0 then this function does nothing. There is also a macro version of this function so that the code will be inlined.

    • @p handler_id_ptr is A pointer to a handler ID (of type #gulong) of the handler to be disconnected..
    • @p instance is The instance to remove the signal handler from. This pointer may be %NULL or invalid, if the handler ID is zero..
    • @r None.
  • enum_get_value (object enum_class, int value)

    Returns the #GEnumValue for a value.

    • @p enum_class is a #GEnumClass.
    • @p value is the value to look up.
  • enum_get_value_by_name (object enum_class, string name)

    Looks up a #GEnumValue by name.

    • @p enum_class is a #GEnumClass.
    • @p name is the name to look up.
  • enum_get_value_by_nick (object enum_class, string nick)

    Looks up a #GEnumValue by nickname.

    • @p enum_class is a #GEnumClass.
    • @p nick is the nickname to look up.
  • flags_get_first_value (object flags_class, int value)

    Returns the first #GFlagsValue which is set in @value.

    • @p flags_class is a #GFlagsClass.
    • @p value is the value.
  • flags_get_value_by_name (object flags_class, string name)

    Looks up a #GFlagsValue by name.

    • @p flags_class is a #GFlagsClass.
    • @p name is the name to look up.
  • flags_get_value_by_nick (object flags_class, string nick)

    Looks up a #GFlagsValue by nickname.

    • @p flags_class is a #GFlagsClass.
    • @p nick is the nickname to look up.
  • param_spec_boolean (string name, string nick, string blurb, bool default_value, string flags)

    Creates a new #GParamSpecBoolean instance specifying a %G_TYPE_BOOLEAN property. In many cases, it may be more appropriate to use an enum with g_param_spec_enum(), both to improve code clarity by using explicitly named values, and to allow for more values to be added in future without breaking API. See g_param_spec_internal() for details on property names.

    • @p name is canonical name of the property specified.
    • @p nick is nick name for the property specified.
    • @p blurb is description of the property specified.
    • @p default_value is default value for the property specified.
    • @p flags is flags for the property specified.
  • param_spec_double (string name, string nick, string blurb, double minimum, double maximum, double default_value, string flags)

    Creates a new #GParamSpecDouble instance specifying a %G_TYPE_DOUBLE property. See g_param_spec_internal() for details on property names.

    • @p name is canonical name of the property specified.
    • @p nick is nick name for the property specified.
    • @p blurb is description of the property specified.
    • @p minimum is minimum value for the property specified.
    • @p maximum is maximum value for the property specified.
    • @p default_value is default value for the property specified.
    • @p flags is flags for the property specified.
  • param_spec_float (string name, string nick, string blurb, double minimum, double maximum, double default_value, string flags)

    Creates a new #GParamSpecFloat instance specifying a %G_TYPE_FLOAT property. See g_param_spec_internal() for details on property names.

    • @p name is canonical name of the property specified.
    • @p nick is nick name for the property specified.
    • @p blurb is description of the property specified.
    • @p minimum is minimum value for the property specified.
    • @p maximum is maximum value for the property specified.
    • @p default_value is default value for the property specified.
    • @p flags is flags for the property specified.
  • param_spec_int (string name, string nick, string blurb, int minimum, int maximum, int default_value, string flags)

    Creates a new #GParamSpecInt instance specifying a %G_TYPE_INT property. See g_param_spec_internal() for details on property names.

    • @p name is canonical name of the property specified.
    • @p nick is nick name for the property specified.
    • @p blurb is description of the property specified.
    • @p minimum is minimum value for the property specified.
    • @p maximum is maximum value for the property specified.
    • @p default_value is default value for the property specified.
    • @p flags is flags for the property specified.
  • param_spec_long (string name, string nick, string blurb, int minimum, int maximum, int default_value, string flags)

    Creates a new #GParamSpecLong instance specifying a %G_TYPE_LONG property. See g_param_spec_internal() for details on property names.

    • @p name is canonical name of the property specified.
    • @p nick is nick name for the property specified.
    • @p blurb is description of the property specified.
    • @p minimum is minimum value for the property specified.
    • @p maximum is maximum value for the property specified.
    • @p default_value is default value for the property specified.
    • @p flags is flags for the property specified.
  • param_spec_override (string name, object overridden)

    Creates a new property of type #GParamSpecOverride. This is used to direct operations to another paramspec, and will not be directly useful unless you are implementing a new base type similar to GObject.

    • @p name is the name of the property..
    • @p overridden is The property that is being overridden.
  • param_spec_pointer (string name, string nick, string blurb, string flags)

    Creates a new #GParamSpecPointer instance specifying a pointer property. Where possible, it is better to use g_param_spec_object() or g_param_spec_boxed() to expose memory management information. See g_param_spec_internal() for details on property names.

    • @p name is canonical name of the property specified.
    • @p nick is nick name for the property specified.
    • @p blurb is description of the property specified.
    • @p flags is flags for the property specified.
  • param_spec_string (string name, string nick, string blurb, string default_value, string flags)

    Creates a new #GParamSpecString instance. See g_param_spec_internal() for details on property names.

    • @p name is canonical name of the property specified.
    • @p nick is nick name for the property specified.
    • @p blurb is description of the property specified.
    • @p default_value is default value for the property specified.
    • @p flags is flags for the property specified.
  • param_spec_uint (string name, string nick, string blurb, int minimum, int maximum, int default_value, string flags)

    Creates a new #GParamSpecUInt instance specifying a %G_TYPE_UINT property. See g_param_spec_internal() for details on property names.

    • @p name is canonical name of the property specified.
    • @p nick is nick name for the property specified.
    • @p blurb is description of the property specified.
    • @p minimum is minimum value for the property specified.
    • @p maximum is maximum value for the property specified.
    • @p default_value is default value for the property specified.
    • @p flags is flags for the property specified.
  • param_spec_ulong (string name, string nick, string blurb, int minimum, int maximum, int default_value, string flags)

    Creates a new #GParamSpecULong instance specifying a %G_TYPE_ULONG property. See g_param_spec_internal() for details on property names.

    • @p name is canonical name of the property specified.
    • @p nick is nick name for the property specified.
    • @p blurb is description of the property specified.
    • @p minimum is minimum value for the property specified.
    • @p maximum is maximum value for the property specified.
    • @p default_value is default value for the property specified.
    • @p flags is flags for the property specified.
  • param_spec_value_array (string name, string nick, string blurb, object element_spec, string flags)

    Creates a new #GParamSpecValueArray instance specifying a %G_TYPE_VALUE_ARRAY property. %G_TYPE_VALUE_ARRAY is a %G_TYPE_BOXED type, as such, #GValue structures for this property can be accessed with g_value_set_boxed() and g_value_get_boxed(). See g_param_spec_internal() for details on property names.

    • @p name is canonical name of the property specified.
    • @p nick is nick name for the property specified.
    • @p blurb is description of the property specified.
    • @p element_spec is a #GParamSpec describing the elements contained in arrays of this property, may be %NULL.
    • @p flags is flags for the property specified.
  • param_spec_variant (string name, string nick, string blurb, object type, object default_value, string flags)

    Creates a new #GParamSpecVariant instance specifying a #GVariant property. If @default_value is floating, it is consumed. See g_param_spec_internal() for details on property names.

    • @p name is canonical name of the property specified.
    • @p nick is nick name for the property specified.
    • @p blurb is description of the property specified.
    • @p type is a #GVariantType.
    • @p default_value is a #GVariant of type @type to use as the default value, or %NULL.
    • @p flags is flags for the property specified.
  • param_value_convert (object pspec, object src_value, object dest_value, bool strict_validation)

    Transforms @src_value into @dest_value if possible, and then validates

    • @dest_value, in order for it to conform to @pspec. If @strict_validation is %TRUE this function will only succeed if the transformed @dest_value complied to @pspec without modifications. See also g_value_type_transformable(), g_value_transform() and g_param_value_validate().
    • @p pspec is a valid #GParamSpec.
    • @p src_value is source #GValue.
    • @p dest_value is destination #GValue of correct type for @pspec.
    • @p strict_validation is %TRUE requires @dest_value to conform to @pspec without modifications.
  • param_value_defaults (object pspec, object value)

    Checks whether @value contains the default value as specified in @pspec.

    • @p pspec is a valid #GParamSpec.
    • @p value is a #GValue of correct type for @pspec.
  • param_value_is_valid (object pspec, object value)

    Return whether the contents of @value comply with the specifications set out by @pspec.

    • @p pspec is a valid #GParamSpec.
    • @p value is a #GValue of correct type for @pspec.
  • param_value_set_default (object pspec, object value)

    Sets @value to its default value as specified in @pspec.

    • @p pspec is a valid #GParamSpec.
    • @p value is a #GValue of correct type for @pspec; since 2.64, you can also pass an empty #GValue, initialized with %G_VALUE_INIT.
    • @r None.
  • param_value_validate (object pspec, object value)

    Ensures that the contents of @value comply with the specifications set out by @pspec. For example, a #GParamSpecInt might require that integers stored in @value may not be smaller than -42 and not be greater than +42. If @value contains an integer outside of this range, it is modified accordingly, so the resulting value will fit into the range -42 .. +42.

    • @p pspec is a valid #GParamSpec.
    • @p value is a #GValue of correct type for @pspec.
  • param_values_cmp (object pspec, object value1, object value2)

    Compares @value1 with @value2 according to @pspec, and return -1, 0 or +1, if @value1 is found to be less than, equal to or greater than

    • @value2, respectively.
    • @p pspec is a valid #GParamSpec.
    • @p value1 is a #GValue of correct type for @pspec.
    • @p value2 is a #GValue of correct type for @pspec.
  • signal_accumulator_first_wins (object ihint, object return_accu, object handler_return, dummy)

    A predefined #GSignalAccumulator for signals intended to be used as a hook for application code to provide a particular value. Usually only one such value is desired and multiple handlers for the same signal don't make much sense (except for the case of the default handler defined in the class structure, in which case you will usually want the signal connection to override the class handler). This accumulator will use the return value from the first signal handler that is run as the return value for the signal and not run any further handlers (ie: the first handler "wins").

    • @p ihint is standard #GSignalAccumulator parameter.
    • @p return_accu is standard #GSignalAccumulator parameter.
    • @p handler_return is standard #GSignalAccumulator parameter.
    • @p dummy is standard #GSignalAccumulator parameter.
  • signal_accumulator_true_handled (object ihint, object return_accu, object handler_return, dummy)

    A predefined #GSignalAccumulator for signals that return a boolean values. The behavior that this accumulator gives is that a return of %TRUE stops the signal emission: no further callbacks will be invoked, while a return of %FALSE allows the emission to continue. The idea here is that a %TRUE return indicates that the callback handled the signal, and no further handling is needed.

    • @p ihint is standard #GSignalAccumulator parameter.
    • @p return_accu is standard #GSignalAccumulator parameter.
    • @p handler_return is standard #GSignalAccumulator parameter.
    • @p dummy is standard #GSignalAccumulator parameter.
  • signal_connect_closure (object instance, string detailed_signal, object closure, bool after)

    Connects a closure to a signal for a particular object. If @closure is a floating reference (see g_closure_sink()), this function takes ownership of @closure. This function cannot fail. If the given signal name doesn’t exist, a critical warning is emitted. No validation is performed on the ‘detail’ string when specified in @detailed_signal, other than a non-empty check. Refer to the signals documentation for more details.

    • @p instance is the instance to connect to..
    • @p detailed_signal is a string of the form "signal-name::detail"..
    • @p closure is the closure to connect..
    • @p after is whether the handler should be called before or after the default handler of the signal..
  • signal_get_invocation_hint (object instance)

    Returns the invocation hint of the innermost signal emission of instance.

    • @p instance is the instance to query.
  • signal_handler_block (object instance, int handler_id)

    Blocks a handler of an instance so it will not be called during any signal emissions unless it is unblocked again. Thus "blocking" a signal handler means to temporarily deactivate it, a signal handler has to be unblocked exactly the same amount of times it has been blocked before to become active again. The @handler_id has to be a valid signal handler id, connected to a signal of @instance.

    • @p instance is The instance to block the signal handler of..
    • @p handler_id is Handler id of the handler to be blocked..
    • @r None.
  • signal_handler_disconnect (object instance, int handler_id)

    Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to. The @handler_id becomes invalid and may be reused. The

    • @handler_id has to be a valid signal handler id, connected to a signal of
    • @instance. ``
    • @p instance is The instance to remove the signal handler from..
    • @p handler_id is Handler id of the handler to be disconnected..
    • @r None.
  • signal_handler_is_connected (object instance, int handler_id)

    Returns whether @handler_id is the ID of a handler connected to

    • @instance. ``
    • @p instance is The instance where a signal handler is sought..
    • @p handler_id is the handler ID..
  • signal_handler_unblock (object instance, int handler_id)

    Undoes the effect of a previous g_signal_handler_block() call. A blocked handler is skipped during signal emissions and will not be invoked, unblocking it (for exactly the amount of times it has been blocked before) reverts its "blocked" state, so the handler will be recognized by the signal system and is called upon future or currently ongoing signal emissions (since the order in which handlers are called during signal emissions is deterministic, whether the unblocked handler in question is called as part of a currently ongoing emission depends on how far that emission has proceeded yet). The @handler_id has to be a valid id of a signal handler that is connected to a signal of @instance and is currently blocked.

    • @p instance is The instance to unblock the signal handler of..
    • @p handler_id is Handler id of the handler to be unblocked..
    • @r None.
  • signal_handlers_destroy (object instance)

    Destroy all signal handlers of a type instance. This function is an implementation detail of the #GObject dispose implementation, and should not be used outside of the type system.

    • @p instance is The instance whose signal handlers are destroyed.
    • @r None.
  • signal_is_valid_name (string name)

    Validate a signal name. This can be useful for dynamically-generated signals which need to be validated at run-time before actually trying to create them. See [func@GObject.signal_new] for details of the rules for valid names. The rules for signal names are the same as those for property names.

    • @p name is the canonical name of the signal.
  • signal_name (int signal_id)

    Given the signal's identifier, finds its name. Two different signals may have the same name, if they have differing types.

    • @p signal_id is the signal's identifying number..
  • signal_remove_emission_hook (int signal_id, int hook_id)

    Deletes an emission hook.

    • @p signal_id is the id of the signal.
    • @p hook_id is the id of the emission hook, as returned by g_signal_add_emission_hook().
    • @r None.
  • signal_stop_emission_by_name (object instance, string detailed_signal)

    Stops a signal's current emission. This is just like g_signal_stop_emission() except it will look up the signal id for you.

    • @p instance is the object whose signal handlers you wish to stop..
    • @p detailed_signal is a string of the form "signal-name::detail"..
    • @r None.
  • source_set_closure (object source, object closure)

    Set the callback for a source as a #GClosure. If the source is not one of the standard GLib types, the @closure_callback and @closure_marshal fields of the #GSourceFuncs structure must have been filled in with pointers to appropriate functions.

    • @p source is the source.
    • @p closure is a #GClosure.
    • @r None.
  • source_set_dummy_callback (object source)

    Sets a dummy callback for @source. The callback will do nothing, and if the source expects a #gboolean return value, it will return %TRUE. (If the source expects any other type of return value, it will return a 0/%NULL value; whatever g_value_init() initializes a #GValue to for that type.) If the source is not one of the standard GLib types, the

    • @closure_callback and @closure_marshal fields of the #GSourceFuncs structure must have been filled in with pointers to appropriate functions.
    • @p source is the source.
    • @r None.
  • strdup_value_contents (object value)

    Return a newly allocated string, which describes the contents of a #GValue. The main purpose of this function is to describe #GValue contents for debugging output, the way in which the contents are described may change between different GLib versions.

    • @p value is #GValue which contents are to be described..
  • type_check_instance (object instance)

    Private helper function to aid implementation of the G_TYPE_CHECK_INSTANCE() macro.

    • @p instance is a valid #GTypeInstance structure.
  • type_check_value (object value)

    Generated wrapper for GIR function type_check_value. Native symbol: g_type_check_value.

  • type_class_adjust_private_offset (g_class, int private_size_or_offset)

    Generated wrapper for GIR function type_class_adjust_private_offset. Native symbol: g_type_class_adjust_private_offset.

    • @r None.
  • type_default_interface_unref (object g_iface)

    Decrements the reference count for the type corresponding to the interface default vtable @g_iface. If the type is dynamic, then when no one is using the interface and all references have been released, the finalize function for the interface's default vtable (the @class_finalize member of #GTypeInfo) will be called.

    • @p g_iface is the default vtable structure for an interface, as returned by g_type_default_interface_ref().
    • @r None.
  • type_free_instance (object instance)

    Frees an instance of a type, returning it to the instance pool for the type, if there is one. Like g_type_create_instance(), this function is reserved for implementors of fundamental types.

    • @p instance is an instance of a type.
    • @r None.
  • type_get_type_registration_serial ()

    Returns an opaque serial number that represents the state of the set of registered types. Any time a type is registered this serial changes, which means you can cache information based on type lookups (such as g_type_from_name()) and know if the cache is still valid at a later time by comparing the current serial with the one at the type lookup.

  • type_init ()

    This function used to initialise the type system. Since GLib 2.36, the type system is initialised automatically and this function does nothing.

    • @r None.
  • type_init_with_debug_flags (string debug_flags)

    This function used to initialise the type system with debugging flags. Since GLib 2.36, the type system is initialised automatically and this function does nothing. If you need to enable debugging features, use the GOBJECT_DEBUG environment variable.

    • @p debug_flags is bitwise combination of #GTypeDebugFlags values for debugging purposes.
    • @r None.
  • type_name_from_class (object g_class)

    Generated wrapper for GIR function type_name_from_class. Native symbol: g_type_name_from_class.

  • type_name_from_instance (object instance)

    Generated wrapper for GIR function type_name_from_instance. Native symbol: g_type_name_from_instance.

class: TypeValueFreeFuncCallback

[1516:7] extends: object

Frees any old contents that might be left in the value->data array of the given value. No resources may remain allocated through the #GValue contents after this function returns. E.g. for our above string type: |[ // only free strings without a specific flag for static storage if (!(value->data[1].v_uint & G_VALUE_NOCOPY_CONTENTS)) g_free (value->data[0].v_pointer); ]|

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • TypeValueFreeFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (value)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: SignalAccumulatorCallback

[1079:7] extends: object

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.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • SignalAccumulatorCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (ihint, return_accu, handler_return, data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: ClosureNotifyCallback

[567:7] extends: object

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

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • ClosureNotifyCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (data, closure)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: ClassFinalizeFuncCallback

[380:7] extends: object

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).

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • ClassFinalizeFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (g_class, class_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: ClassInitFuncCallback

[496:7] extends: object

A callback function used by the type system to initialize the class of a specific type. This function should initialize all static class members. The initialization process of a class involves: - Copying common members from the parent class over to the derived class structure. - Zero initialization of the remaining members not copied over from the parent class. - Invocation of the GBaseInitFunc() initializers of all parent types and the class' type. - Invocation of the class' GClassInitFunc() initializer. Since derived classes are partially initialized through a memory copy of the parent class, the general rule is that GBaseInitFunc() and GBaseFinalizeFunc() should take care of necessary reinitialization and release of those class members that were introduced by the type that specified these GBaseInitFunc()/GBaseFinalizeFunc(). GClassInitFunc() should only care about initializing static class members, while dynamic class members (such as allocated strings or reference counted resources) are better handled by a GBaseInitFunc() for this type, so proper initialization of the dynamic class members is performed for class initialization of derived types as well. An example may help to correspond the intend of the different class initializers: |[ typedef struct { GObjectClass parent_class; gint static_integer; gchar *dynamic_string; } TypeAClass; static void type_a_base_class_init (TypeAClass *class) { class->dynamic_string = g_strdup ("some string"); } static void type_a_base_class_finalize (TypeAClass *class) { g_free (class->dynamic_string); } static void type_a_class_init (TypeAClass *class) { class->static_integer = 42; } typedef struct { TypeAClass parent_class; gfloat static_float; GString *dynamic_gstring; } TypeBClass; static void type_b_base_class_init (TypeBClass *class) { class->dynamic_gstring = g_string_new ("some other string"); } static void type_b_base_class_finalize (TypeBClass *class) { g_string_free (class->dynamic_gstring); } static void type_b_class_init (TypeBClass *class) { class->static_float = 3.14159265358979323846; } ]| Initialization of TypeBClass will first cause initialization of TypeAClass (derived classes reference their parent classes, see g_type_class_ref() on this). Initialization of TypeAClass roughly involves zero-initializing its fields, then calling its GBaseInitFunc() type_a_base_class_init() to allocate its dynamic members (dynamic_string), and finally calling its GClassInitFunc() type_a_class_init() to initialize its static members (static_integer). The first step in the initialization process of TypeBClass is then a plain memory copy of the contents of TypeAClass into TypeBClass and zero-initialization of the remaining fields in TypeBClass. The dynamic members of TypeAClass within TypeBClass now need reinitialization which is performed by calling type_a_base_class_init() with an argument of TypeBClass. After that, the GBaseInitFunc() of TypeBClass, type_b_base_class_init() is called to allocate the dynamic members of TypeBClass (dynamic_gstring), and finally the GClassInitFunc() of TypeBClass, type_b_class_init(), is called to complete the initialization process with the static members (static_float). Corresponding finalization counter parts to the GBaseInitFunc() functions have to be provided to release allocated resources at class finalization time.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • ClassInitFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (g_class, class_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: ValueTransformCallback

[1736:7] extends: object

The type of value transformation functions which can be registered with [func@GObject.Value.register_transform_func]. @dest_value will be initialized to the correct destination type.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • ValueTransformCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (src_value, dest_value)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: ObjectFinalizeFuncCallback

[860:7] extends: object

The type of the @finalize function of #GObjectClass.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • ObjectFinalizeFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (object)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: InterfaceFinalizeFuncCallback

[717:7] extends: object

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.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • InterfaceFinalizeFuncCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (g_iface, iface_data)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: TypePluginUseCallback

[1441:7] extends: object

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

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • TypePluginUseCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (plugin)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.