WpTransition

WpTransition

GObject
    ╰──WpTransition

Wp.Transition.prototype.new

function Wp.Transition.prototype.new(type: GObject.Type, source_object: GObject.Object, cancellable: Gio.Cancellable, callback: Gio.AsyncReadyCallback, callback_data: Object): {
    // javascript wrapper for 'wp_transition_new'
}

Creates a Wp.Transition acting on source_object. When the transition is done, callback will be invoked.

The transition does not automatically start executing steps. You must call Wp.Transition.prototype.advance after creating it in order to start it.

Note that the transition is automatically unref'ed after the callback has been executed. If you wish to keep an additional reference on it, you need to ref it explicitly.

Wp.Transition.prototype.new_closure

function Wp.Transition.prototype.new_closure(type: GObject.Type, source_object: GObject.Object, cancellable: Gio.Cancellable, closure: GObject.Closure): {
    // javascript wrapper for 'wp_transition_new_closure'
}

Creates a Wp.Transition acting on source_object. When the transition is done, closure will be invoked.

The transition does not automatically start executing steps. You must call Wp.Transition.prototype.advance after creating it in order to start it.

Note that the transition is automatically unref'ed after the closure has been executed. If you wish to keep an additional reference on it, you need to ref it explicitly.

Wp.Transition.prototype.advance

function Wp.Transition.prototype.advance(): {
    // javascript wrapper for 'wp_transition_advance'
}

Advances the transition to the next step.

This initially calls vfunc_get_next_step() in order to determine what the next step is. If vfunc_get_next_step() returns a step different than the previous one, it calls vfunc_execute_step() to execute it.

The very first time that vfunc_get_next_step() is called, its step parameter equals Wp.TransitionStep.NONE.

When vfunc_get_next_step() returns Wp.TransitionStep.NONE, this function completes the transition, calling the transition's callback and then unref-ing the transition.

When vfunc_get_next_step() returns Wp.TransitionStep.ERROR, this function calls Wp.Transition.prototype.return_error, unless it has already been called directly by vfunc_get_next_step().

In error conditions, vfunc_execute_step() is called once with step being Wp.TransitionStep.ERROR, allowing the implementation to rollback any changes or cancel underlying jobs, if necessary.

Wp.Transition.prototype.get_completed

function Wp.Transition.prototype.get_completed(): {
    // javascript wrapper for 'wp_transition_get_completed'
}

Wp.Transition.prototype.get_data

function Wp.Transition.prototype.get_data(): {
    // javascript wrapper for 'wp_transition_get_data'
}

Gets self 's data. See Wp.Transition.prototype.set_data.

Wp.Transition.prototype.get_source_object

function Wp.Transition.prototype.get_source_object(): {
    // javascript wrapper for 'wp_transition_get_source_object'
}

Gets the source object from the transition. Like Gio.AsyncResult.prototype.get_source_object, but does not ref the object.

Wp.Transition.prototype.get_source_tag

function Wp.Transition.prototype.get_source_tag(): {
    // javascript wrapper for 'wp_transition_get_source_tag'
}

Gets self 's source tag. See Wp.Transition.prototype.set_source_tag.

Wp.Transition.prototype.had_error

function Wp.Transition.prototype.had_error(): {
    // javascript wrapper for 'wp_transition_had_error'
}

Wp.Transition.prototype.is_tagged

function Wp.Transition.prototype.is_tagged(tag: Object): {
    // javascript wrapper for 'wp_transition_is_tagged'
}

Checks if self has the given tag (generally a function pointer indicating the function self was created by).

Wp.Transition.prototype.return_error

function Wp.Transition.prototype.return_error(error: GLib.Error): {
    // javascript wrapper for 'wp_transition_return_error'
}

Completes the transition with an error. This can be called anytime from within any virtual function or an async job handler.

Note that in most cases this will also unref the transition, so it is not safe to access it after this function has been called.

Wp.Transition.prototype.set_data

function Wp.Transition.prototype.set_data(data: Object, data_destroy: GLib.DestroyNotify): {
    // javascript wrapper for 'wp_transition_set_data'
}

Sets self 's data (freeing the existing data, if any). This can be an arbitrary user structure that holds data associated with this transition.

Wp.Transition.prototype.set_source_tag

function Wp.Transition.prototype.set_source_tag(tag: Object): {
    // javascript wrapper for 'wp_transition_set_source_tag'
}

Sets self 's source tag. You can use this to tag a transition's return value with a particular pointer (usually a pointer to the function doing the tagging) and then later check it using Wp.Transition.prototype.get_source_tag (or Gio.AsyncResult.prototype.is_tagged) in the transition's "finish" function, to figure out if the response came from a particular place.

Wp.Transition.prototype.finish

function Wp.Transition.prototype.finish(res: Gio.AsyncResult): {
    // javascript wrapper for 'wp_transition_finish'
}

This is meant to be called from within the Gio.AsyncReadyCallback that was specified in Wp.Transition.prototype.new. It returns the final return status of the transition and its error, if there was one.

completed

“completed” Number

Flags : Read

vfunc_execute_step

function vfunc_execute_step(transition: Wp.Transition, step: Number): {
    // javascript implementation of the 'execute_step' virtual method
}

See Wp.Transition.prototype.advance

vfunc_get_next_step

function vfunc_get_next_step(transition: Wp.Transition, step: Number): {
    // javascript implementation of the 'get_next_step' virtual method
}

See Wp.Transition.prototype.advance

Wp.TransitionStep