Class

IdeTask

Description 

final class Ide.Task : GObject.Object
  implements Gio.AsyncResult {
  /* No available fields */
}
No description available.

Hierarchy

hierarchy this IdeTask implements_0 GAsyncResult this--implements_0 ancestor_0 GObject ancestor_0--this

Ancestors

Implements

Constructors

ide_task_new

Creates a new IdeTask.

Functions

ide_task_report_new_error
No description available.

Instance methods

ide_task_chain

Causes the result of self to also be delivered to other_task.

ide_task_get_cancellable

Gets the GCancellable for the task.

ide_task_get_complete_priority
No description available.

ide_task_get_completed

Gets the “completed” property. This is TRUE after the callback used when creating the task has been executed.

ide_task_get_kind
No description available.

ide_task_get_name

Gets the name assigned for the task.

ide_task_get_priority
No description available.

ide_task_get_return_on_cancel

Gets the return_on_cancel value, which means the task will return immediately when the GCancellable is cancelled.

ide_task_get_source_object

Gets the GObject used when creating the source object.

ide_task_get_source_tag
No description available.

ide_task_get_task_data

Gets the task data previously set with ide_task_set_task_data().

ide_task_had_error

Checks to see if the task had an error.

ide_task_is_valid

Checks if source_object matches the object the task was created with.

ide_task_propagate_boolean
No description available.

ide_task_propagate_boxed
No description available.

ide_task_propagate_int
No description available.

ide_task_propagate_object

Returns an object if the task completed with an object. Otherwise, NULL is returned.

ide_task_propagate_pointer
No description available.

ide_task_return_boolean

Sets the result of the task to result.

ide_task_return_boxed

This is similar to ide_task_return_pointer(), but allows the task to know the boxed GType so that the result may be propagated to chained tasks.

ide_task_return_error

Sets error as the result of the IdeTask.

ide_task_return_error_if_cancelled

Returns a new GError if the cancellable associated with the task has been cancelled. If so, TRUE is returned, otherwise FALSE.

ide_task_return_int

Sets the result of the task to result.

ide_task_return_new_error

Creates a new GError and sets it as the result for the task.

ide_task_return_object

Returns a new object instance.

ide_task_return_pointer

Returns a new raw pointer.

ide_task_run_in_thread

Scheules thread_func to be executed on a worker thread.

ide_task_set_check_cancellable

Setting check_cancellable to TRUE (the default) ensures that the GCancellable used when creating the IdeTask is checked for cancellation before propagating a result. If cancelled, an error will be returned instead of the result.

ide_task_set_complete_priority
No description available.

ide_task_set_kind
No description available.

ide_task_set_name

Sets a useful name for the task.

ide_task_set_priority
No description available.

ide_task_set_release_on_propagate

Setting this to TRUE (the default) ensures that the task will release all task data and source_object references after executing the configured callback. This is useful to ensure that dependent objects are finalized in the thread-default GMainContext the task was created in.

ide_task_set_return_on_cancel

Setting return_on_cancel to TRUE ensures that the task will cancel immediately when GCancellable::cancelled is emitted by the configured cancellable.

ide_task_set_source_tag

Sets the source tag for the task. Generally this is a function pointer of the function that created the task.

ide_task_set_task_data
No description available.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from GAsyncResult (4)
g_async_result_get_source_object

Gets the source object from a GAsyncResult.

g_async_result_get_user_data

Gets the user data from a GAsyncResult.

g_async_result_is_tagged

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

since: 2.34

g_async_result_legacy_propagate_error

If res is a GSimpleAsyncResult, this is equivalent to g_simple_async_result_propagate_error(). Otherwise it returns FALSE.

since: 2.34

Properties

Ide.Task:completed
No description available.

Signals

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure 

struct IdeTaskClass {
  GObjectClass parent_class;
  
}
No description available.
Class members
parent_class: GObjectClass
No description available.