Libraries:Gtk:Gio:GInitable

Types

T

T is implemented by objects that can fail during initialization. If an object implements this interface the Init function must be called as the first thing after construction. If Init is not called, or if it returns an error, all further operations on the object should fail, generally with a Gtk.Gio.GIOErrorEnum.NotInitialized error.

Users of objects implementing this are not intended to use the interface method directly, instead it will be used automatically in various ways. For C applications you generally just call g_initable_new() directly, or indirectly via a foo_thing_new() wrapper. This will call Init under the cover, returning NULL and setting a Gtk.Glib.GError.T on failure (at which point the instance is unreferenced).

For bindings in languages where the native constructor supports exceptions the binding could check for objects implemention T during normal construction and automatically initialize them, throwing an exception on failure.

ParentT

Constants

InterfaceInfo : Std.Object.T

Nil : T

Functions

GetType() : Gtk.GObject.Type.T

New(object_type @ Gtk.GObject.Type.T, cancellable @ Gtk.Gio.GCancellable.T, error @ Std.Object.T, first_property_name @ Std.String.T, ... @ Std.Object.T) : Gtk.Gio.GInitable.T

Helper function for constructing GInitiable object. This is similar to g_object_new() but also initializes the object and returns NULL, setting an error on failure.

object_type	a GType supporting T.
cancellable	optional Gtk.Gio.GCancellable.T object, NULL to ignore.
error	a Gtk.Glib.GError.T location to store the error occurring, or NULL to ignore.
first_property_name	the name of the first property, or NULL if no properties
...	the value if the first property, followed by and other property value pairs, and ended by NULL.
Returns	a newly allocated GObject, or NULL on error. [transfer full]

NewValist(object_type @ Gtk.GObject.Type.T, first_property_name @ Std.String.T, var_args @ Agg.List.T, cancellable @ Gtk.Gio.GCancellable.T, error @ Std.Object.T) : Gtk.Gio.GInitable.T

Helper function for constructing GInitiable object. This is similar to g_object_new_valist() but also initializes the object and returns NULL, setting an error on failure.

object_type	a GType supporting T.
first_property_name	the name of the first property, followed by the value, and other property value pairs, and ended by NULL.
var_args	The var args list generated from first_property_name.
cancellable	optional Gtk.Gio.GCancellable.T object, NULL to ignore.
error	a Gtk.Glib.GError.T location to store the error occurring, or NULL to ignore.
Returns	a newly allocated GObject, or NULL on error. [transfer full]

Newv(object_type @ Gtk.GObject.Type.T, n_parameters @ Std.Integer.SmallT, parameters @ Gtk.GObject.GParameter.T, cancellable @ Gtk.Gio.GCancellable.T, error @ Std.Object.T) : Gtk.Gio.GInitable.T

Helper function for constructing GInitiable object. This is similar to g_object_newv() but also initializes the object and returns NULL, setting an error on failure.

object_type	a GType supporting T.
n_parameters	the number of parameters in parameters
parameters	the parameters to use to construct the object
cancellable	optional Gtk.Gio.GCancellable.T object, NULL to ignore.
error	a Gtk.Glib.GError.T location to store the error occurring, or NULL to ignore.
Returns	a newly allocated GObject, or NULL on error. [transfer full]

Methods

:Init(self @ T, cancellable @ Gtk.Gio.GCancellable.T, error @ Std.Object.T) : Std.Symbol.T

Initializes the object implementing the interface. This must be done before any real use of the object after initial construction.

Implementations may also support cancellation. If cancellable is not NULL, then initialization can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error Gtk.Gio.GIOErrorEnum.Cancelled will be returned. If cancellable is not NULL and the object doesn't support cancellable initialization the error Gtk.Gio.GIOErrorEnum.NotSupported will be returned.

If this function is not called, or returns with an error then all operations on the object should fail, generally returning the error Gtk.Gio.GIOErrorEnum.NotInitialized.

Implementations of this method must be idempotent, i.e. multiple calls to this function with the same argument should return the same results. Only the first call initializes the object, further calls return the result of the first call. This is so that its safe to implement the singleton pattern in the GObject constructor function.

initable	a T.
cancellable	optional Gtk.Gio.GCancellable.T object, NULL to ignore.
error	a Gtk.Glib.GError.T location to store the error occurring, or NULL to ignore.
Returns	TRUE if successful. If an error has occurred, this function will return FALSE and set error appropriately if present.

:Init(_ @ ParentT, _ @ Gtk.Gio.GCancellable.T, _ @ Std.Object.T)

GInitable