Top | ![]() |
![]() |
![]() |
![]() |
gboolean | allow-cancel | Read / Write |
gboolean | caller-active | Read / Write |
guint64 | download-size-remaining | Read / Write |
guint | elapsed-time | Read / Write |
PkItemProgress * | item-progress | Read / Write |
PkPackage * | package | Read / Write |
gchar * | package-id | Read / Write |
gint | percentage | Read / Write |
guint | remaining-time | Read / Write |
guint | role | Read / Write |
guint | speed | Read / Write |
guint | status | Read / Write |
guint64 | transaction-flags | Read / Write |
gchar * | transaction-id | Read / Write |
guint | uid | Read / Write |
This GObject is available to clients to be able to query details about the transaction. All of the details on this object are stored as properties.
PkProgress *
pk_progress_new (void
);
PkProgress is a nice GObject wrapper for PackageKit and makes writing frontends easy.
Since: 0.5.2
void (*PkProgressCallback) (PkProgress *progress
,PkProgressType type
,gpointer user_data
);
Function that is called when progress updates are given.
gboolean pk_progress_set_package_id (PkProgress *progress
,const gchar *package_id
);
Set the package ID this transaction is acting on.
Since: 0.5.2
const gchar *
pk_progress_get_package_id (PkProgress *progress
);
Get the package ID this transaction is acting on.
Since: 1.0.12
gboolean pk_progress_set_item_progress (PkProgress *progress
,PkItemProgress *item_progress
);
Set the item progress associated with this transaction.
Since: 0.8.1
PkItemProgress *
pk_progress_get_item_progress (PkProgress *progress
);
Get the item progress associated with this transaction.
Since: 1.0.12
gboolean pk_progress_set_transaction_id (PkProgress *progress
,const gchar *transaction_id
);
Set the ID used by this transaction.
Since: 0.5.3
const gchar *
pk_progress_get_transaction_id (PkProgress *progress
);
Get the ID used by this transaction.
Since: 1.0.12
gboolean pk_progress_set_percentage (PkProgress *progress
,gint percentage
);
Set the percentage complete of this transaction.
Since: 0.5.2
gint
pk_progress_get_percentage (PkProgress *progress
);
Get the percentage complete.
Since: 1.0.12
gboolean pk_progress_set_status (PkProgress *progress
,PkStatusEnum status
);
Set the status of this transaction.
Since: 0.5.2
PkStatusEnum
pk_progress_get_status (PkProgress *progress
);
Get the status of this transaction.
Since: 1.0.12
gboolean pk_progress_set_role (PkProgress *progress
,PkRoleEnum role
);
Set the role of this transaction.
Since: 0.5.2
PkRoleEnum
pk_progress_get_role (PkProgress *progress
);
Get the role of this transaction.
Since: 1.0.12
gboolean pk_progress_set_allow_cancel (PkProgress *progress
,gboolean allow_cancel
);
Set if this transaction can be cancelled.
progress |
a valid PkProgress instance |
|
allow_cancel |
|
Since: 0.5.2
gboolean
pk_progress_get_allow_cancel (PkProgress *progress
);
Get if this transaction can be cancelled.
Since: 1.0.12
gboolean pk_progress_set_caller_active (PkProgress *progress
,gboolean caller_active
);
Set if the transaction caller is connected.
progress |
a valid PkProgress instance |
|
caller_active |
|
Since: 0.5.2
gboolean
pk_progress_get_caller_active (PkProgress *progress
);
Get if the transaction caller is connected.
Since: 1.0.12
gboolean pk_progress_set_elapsed_time (PkProgress *progress
,guint elapsed_time
);
Set the amount of time the transaction has taken.
Since: 0.5.2
guint
pk_progress_get_elapsed_time (PkProgress *progress
);
Get the amount of time the transaction has taken.
Since: 1.0.12
gboolean pk_progress_set_remaining_time (PkProgress *progress
,guint remaining_time
);
Set the amount of time the transaction will take to complete.
Since: 0.5.2
guint
pk_progress_get_remaining_time (PkProgress *progress
);
Get the amount of time the transaction will take to complete.
Since: 1.0.12
gboolean pk_progress_set_speed (PkProgress *progress
,guint speed
);
Set the speed of this transaction.
Since: 0.5.2
guint
pk_progress_get_speed (PkProgress *progress
);
Get the speed of this transaction.
Since: 1.0.12
gboolean pk_progress_set_download_size_remaining (PkProgress *progress
,guint64 download_size_remaining
);
Set the number of bytes remaining to download.
progress |
a valid PkProgress instance |
|
download_size_remaining |
number of bytes remaining to download. |
Since: 0.8.0
guint64
pk_progress_get_download_size_remaining
(PkProgress *progress
);
Get the number of bytes remaining to download.
Since: 1.0.12
gboolean pk_progress_set_transaction_flags (PkProgress *progress
,guint64 transaction_flags
);
Set the flags associated with this transaction.
progress |
a valid PkProgress instance |
|
transaction_flags |
a PkBitfield containing PkTransactionFlagEnum values. |
Since: 0.8.8
guint64
pk_progress_get_transaction_flags (PkProgress *progress
);
Get the flags associated with this transaction.
Since: 1.0.12
gboolean pk_progress_set_uid (PkProgress *progress
,guint uid
);
Set the UID that started this transaction.
Since: 0.5.2
guint
pk_progress_get_uid (PkProgress *progress
);
Get the UID that started this transaction.
Since: 1.0.12
gboolean pk_progress_set_package (PkProgress *progress
,PkPackage *package
);
Set the package this transaction is acting on.
Since: 0.5.2
PkPackage *
pk_progress_get_package (PkProgress *progress
);
Get the package this transaction is acting on.
Since: 1.0.12
Flag to show which progress field has been updated.
package id updated |
||
transaction ID updated |
||
percentage updated |
||
allow cancel updated |
||
status updated |
||
role updated |
||
called active updated |
||
elapsed time updated |
||
remaining time updated |
||
speed updated |
||
download size remaining updated |
||
uid updated |
||
package updated |
||
item progress updated |
||
transaction flags updated |
||
“allow-cancel”
property “allow-cancel” gboolean
TRUE
if this transaction can be cancelled.
Flags: Read / Write
Default value: FALSE
Since: 0.5.2
“caller-active”
property “caller-active” gboolean
TRUE
if the transaction caller is still connected.
Flags: Read / Write
Default value: FALSE
Since: 0.5.2
“download-size-remaining”
property “download-size-remaining” guint64
Number of bytes remaining to download.
Flags: Read / Write
Default value: 0
Since: 0.8.0
“elapsed-time”
property “elapsed-time” guint
Amount of time the transaction has taken in seconds.
Flags: Read / Write
Default value: 0
Since: 0.5.2
“item-progress”
property“item-progress” PkItemProgress *
Item progress associated with this transaction.
Flags: Read / Write
Since: 0.8.1
“package”
property“package” PkPackage *
The package this transaction is acting on.
Flags: Read / Write
Since: 0.5.3
“package-id”
property “package-id” gchar *
Package ID this transaction is acting on.
Flags: Read / Write
Default value: NULL
Since: 0.5.2
“percentage”
property “percentage” gint
Percentage complete of this transaction.
Flags: Read / Write
Allowed values: >= -1
Default value: -1
Since: 0.5.2
“remaining-time”
property “remaining-time” guint
Amount of time the transaction will take to complete in seconds or 0 if unknown.
Flags: Read / Write
Default value: 0
Since: 0.5.2
“role”
property “role” guint
Role of this transaction.
Flags: Read / Write
Allowed values: <= 34
Default value: 0
Since: 0.5.2
“speed”
property “speed” guint
Transaction speed in bits per second or 0 if unknown.
Flags: Read / Write
Default value: 0
Since: 0.5.2
“status”
property “status” guint
Status of this transaction.
Flags: Read / Write
Allowed values: <= 37
Default value: 0
Since: 0.5.2
“transaction-flags”
property “transaction-flags” guint64
A PkBitfield containing PkTransactionFlagEnum associated with this transaction.
Flags: Read / Write
Default value: 0
Since: 0.8.8
“transaction-id”
property “transaction-id” gchar *
ID used by this transaction.
Flags: Read / Write
Default value: NULL
Since: 0.5.2
“uid”
property “uid” guint
The UID that started this transaction.
Flags: Read / Write
Default value: 0
Since: 0.5.2