Ags.TaskCompletion¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37), Ags.Connectable (13)
Structs:: GObject.ObjectClass (5)

class	`new` (task, data)
	`complete` ()
	`set_flags` (flags)
	`test_flags` (flags)
	`unset_flags` (flags)

Virtual Methods¶

Inherited:: GObject.Object (7), Ags.Connectable (13)

do_complete ()

Properties¶

Name	Type	Flags	Short Description
`task`	`GObject.Object`	r/w	The task to complete

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`complete`	The `::complete` signal is emited as a task was finished

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access
connectable_flags	`int`	r
data	`object`	r
flags	`int`	r
gobject	`GObject.Object`	r
obj_mutex	`GLib.RecMutex`	r
task	`GObject.Object`	r
uuid	`Ags.UUID`	r

Class Details¶

class Ags.TaskCompletion(**kwargs)¶

Bases:: GObject.Object, Ags.Connectable
Abstract:: No
Structure:: Ags.TaskCompletionClass

classmethod new(task, data)¶

Parameters:

task (GObject.Object) – the Ags.Task
data (object or None) – pointer to user data

Returns:

the new Ags.TaskCompletion

Return type:

Ags.TaskCompletion

Create a new instance of Ags.TaskCompletion.

New in version 3.0.0.

complete()¶: Emit ::complete signal

New in version 3.0.0.

set_flags(flags)¶

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

Enable a feature of Ags.TaskCompletion.

New in version 3.0.0.

test_flags(flags)¶

Parameters:: flags (Ags.TaskCompletionFlags) – 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.TaskCompletionFlags) – see enum Ags.TaskCompletionFlags

Disable a feature of Ags.TaskCompletion.

New in version 3.0.0.

do_complete() virtual¶: Emit ::complete signal

New in version 3.0.0.

Signal Details¶

Ags.TaskCompletion.signals.complete(task_completion)¶

Signal Name:: complete
Flags:: RUN_LAST
Parameters:: task_completion (Ags.TaskCompletion) – The object which received the signal

The ::complete signal is emited as a task was finished

New in version 3.0.0.

Property Details¶

Ags.TaskCompletion.props.task¶

Name:: task
Type:: GObject.Object
Default Value:: None
Flags:: READABLE, WRITABLE

The assigned task.

New in version 3.0.0.