Ags.Task¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` ()
	`failure` (error)
	`launch` ()
	`set_flags` (flags)
	`test_flags` (flags)
	`unset_flags` (flags)

Virtual Methods¶

Inherited:: GObject.Object (7)

	`do_failure` (error)
	`do_launch` ()

Properties¶

Name	Type	Flags	Short Description
`task-launcher`	`Ags.TaskLauncher`	r/w	The task launcher object

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`failure`	The `::failure` signal is emited if `::launch` fails
`launch`	The `::launch` signal is emited in a thread safe context

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access
flags	`int`	r
gobject	`GObject.Object`	r
obj_mutex	`GLib.RecMutex`	r
task_launcher	`GObject.Object`	r
task_name	`str`	r

Class Details¶

class Ags.Task(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Ags.TaskClass

classmethod new()¶

Returns:: the new Ags.Task
Return type:: Ags.Task

Create a new Ags.Task.

New in version 3.0.0.

failure(error)¶

Parameters:: error (GLib.Error) – is None on success

Signals failure of task.

New in version 3.0.0.

launch()¶: Intercept task.

New in version 3.0.0.

set_flags(flags)¶

Parameters:: flags (Ags.TaskFlags) – see enum Ags.TaskFlags

Enable a feature of Ags.Task.

New in version 3.0.0.

test_flags(flags)¶

Parameters:: flags (Ags.TaskFlags) – the flags
Returns:: True if flags are set, else False
Return type:: bool

Test flags to be set on self.

New in version 3.0.0.

unset_flags(flags)¶

Parameters:: flags (Ags.TaskFlags) – see enum Ags.TaskFlags

Disable a feature of Ags.Task.

New in version 3.0.0.

do_failure(error) virtual¶

Parameters:: error (GLib.Error) – is None on success

Signals failure of task.

New in version 3.0.0.

do_launch() virtual¶: Intercept task.

New in version 3.0.0.

Signal Details¶

Ags.Task.signals.failure(task, error)¶

Signal Name:

failure

Flags:

RUN_LAST

Parameters:

task (Ags.Task) – The object which received the signal
error (object or None) – the GLib.Error-struct

The ::failure signal is emited if ::launch fails

New in version 3.0.0.

Ags.Task.signals.launch(task)¶

Signal Name:: launch
Flags:: RUN_LAST
Parameters:: task (Ags.Task) – The object which received the signal

The ::launch signal is emited in a thread safe context

New in version 3.0.0.

Property Details¶

Ags.Task.props.task_launcher¶

Name:: task-launcher
Type:: Ags.TaskLauncher
Default Value:: None
Flags:: READABLE, WRITABLE

The assigned Ags.TaskLauncher

New in version 3.0.0.