package gobject-introspection

  1. Overview
  2. Docs
package gobject-introspection
Legend:
Library
Module
Module type
Parameter
Class
Class type
include module type of struct include Arg_info end
type direction =
  1. | In
    (*

    in argument.

    *)
  2. | Out
    (*

    out argument.

    *)
  3. | InOut
    (*

    in and out argument.

    *)

The direction of a Arg_info.

val string_of_direction : direction -> string

The transfer is the exchange of data between two parts, from the callee to the caller. The callee is either a function/method/signal or an object/interface where a property is defined. The caller is the side accessing a property or calling a function. GITransfer specifies who's responsible for freeing the resources after the ownership transfer is complete. In case of a containing type such as a list, an array or a hash table the container itself is specified differently from the items within the container itself. Each container is freed differently, check the documentation for the types themselves for information on how to free them.

type transfer =
  1. | Nothing
    (*

    transfer nothing from the callee (function or the type instance the property belongs to) to the caller. The callee retains the ownership of the transfer and the caller doesn't need to do anything to free up the resources of this transfer.

    *)
  2. | Container
    (*

    transfer the container (list, array, hash table) from the callee to the caller. The callee retains the ownership of the individual items in the container and the caller has to free up the container resources (g_list_free()/ g_hash_table_destroy() etc) of this transfer.

    *)
  3. | Everything
    (*

    transfer everything, eg the container and its contents from the callee to the caller. This is the case when the callee creates a copy of all the data it returns. The caller is responsible for cleaning up the container and item resources of this transfer.

    *)
val string_of_transfert : transfer -> string
type scope_type =
  1. | Invalid
    (*

    The argument is not of callback type.

    *)
  2. | Call
    (*

    The callback and associated user_data is only used during the call to this function.

    *)
  3. | Async
    (*

    The callback and associated user_data is only used until the callback is invoked, and the callback. is invoked always exactly once.

    *)
  4. | Notified
    (*

    The callback and and associated user_data is used until the caller is notfied via the destroy_notify.

    *)

Scope type of a Arg_info representing callback, determines how the callback is invoked and is used to decided when the invoke structs can be freed.

val string_of_scope_type : scope_type -> string
module Enums (T : Cstubs.Types.TYPE) : sig ... end