Infinityc.ProgressRequest

Subclasses:

None

Methods

Inherited:

GObject.Object (37), Infinity.Request (5)

Structs:

GObject.ObjectClass (5)

	get_initiated ()
	initiated (total)
	progress ()

Virtual Methods

Inherited:

GObject.Object (7), Infinity.Request (2)

Properties

Inherited:

Infinityc.Request (2), Infinity.Request (2)

Name	Type	Flags	Short Description
current	int	r	The current number of finished operations
total	int	r	The total number of operations

Signals

Inherited:

GObject.Object (1), Infinity.Request (1)

Fields

Inherited:

GObject.Object (1), Infinity.Request (1)

Name	Type	Access	Description
parent	Infinityc.Request	r

Class Details

class Infinityc.ProgressRequest(**kwargs)

Bases:

Infinityc.Request

Abstract:

No

Structure:

Infinityc.ProgressRequestClass

Infinityc.ProgressRequest is an opaque data type. You should only access it via the public API functions.

get_initiated()

Returns:

Whether the request was initiated.

Return type:

bool

Returns whether the request was initiated, i.e. the total number of items is known.

initiated(total)

Parameters:

total (int) – The total number of items.

Initiates the request. A progress request is considered initiated as soon as the total number of items is known.

progress()

Indicates that one more operation has been performed and changes the Infinityc.ProgressRequest :current property accordingly. The request must be initiated before this function can be called.

Property Details

Infinityc.ProgressRequest.props.current

Name:

current

Type:

int

Default Value:

0

Flags:

READABLE

The current number of finished operations

Infinityc.ProgressRequest.props.total

Name:

total

Type:

int

Default Value:

0

Flags:

READABLE

The total number of operations