PkProgress

PkProgress — Transaction progress information

Synopsis

#define             PK_PROGRESS_ERROR
#define             PK_PROGRESS_TYPE_ERROR
                    PkProgressPrivate;
                    PkProgress;
GQuark              pk_progress_error_quark             (void);
PkProgress *        pk_progress_new                     (void);
enum                PkProgressType;
void                (*PkProgressCallback)               (PkProgress *progress,
                                                         PkProgressType type,
                                                         gpointer user_data);
void                pk_progress_test                    (gpointer user_data);

Object Hierarchy

  GObject
   +----PkProgress

Properties

  "allow-cancel"             gboolean              : Read / Write
  "caller-active"            gboolean              : Read / Write
  "elapsed-time"             guint                 : Read / Write
  "package-id"               gchar*                : Read / Write
  "percentage"               gint                  : Read / Write
  "remaining-time"           guint                 : Read / Write
  "role"                     guint                 : Read / Write
  "speed"                    guint                 : Read / Write
  "status"                   guint                 : Read / Write
  "subpercentage"            gint                  : Read / Write
  "transaction-id"           gchar*                : Read / Write
  "uid"                      guint                 : Read / Write

Description

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.

Details

PK_PROGRESS_ERROR

#define PK_PROGRESS_ERROR		(pk_progress_error_quark ())


PK_PROGRESS_TYPE_ERROR

#define PK_PROGRESS_TYPE_ERROR		(pk_progress_error_get_type ())


PkProgressPrivate

typedef struct _PkProgressPrivate PkProgressPrivate;

Private PkProgress data


PkProgress

typedef struct _PkProgress PkProgress;


pk_progress_error_quark ()

GQuark              pk_progress_error_quark             (void);

Returns :


pk_progress_new ()

PkProgress *        pk_progress_new                     (void);

PkProgress is a nice GObject wrapper for PackageKit and makes writing frontends easy.

Returns :

A new PkProgress instance

enum PkProgressType

typedef enum {
	PK_PROGRESS_TYPE_PACKAGE_ID,
	PK_PROGRESS_TYPE_TRANSACTION_ID,
	PK_PROGRESS_TYPE_PERCENTAGE,
	PK_PROGRESS_TYPE_SUBPERCENTAGE,
	PK_PROGRESS_TYPE_ALLOW_CANCEL,
	PK_PROGRESS_TYPE_STATUS,
	PK_PROGRESS_TYPE_ROLE,
	PK_PROGRESS_TYPE_CALLER_ACTIVE,
	PK_PROGRESS_TYPE_ELAPSED_TIME,
	PK_PROGRESS_TYPE_REMAINING_TIME,
	PK_PROGRESS_TYPE_SPEED,
	PK_PROGRESS_TYPE_UID,
	PK_PROGRESS_TYPE_INVALID
} PkProgressType;


PkProgressCallback ()

void                (*PkProgressCallback)               (PkProgress *progress,
                                                         PkProgressType type,
                                                         gpointer user_data);

progress :

type :

user_data :


pk_progress_test ()

void                pk_progress_test                    (gpointer user_data);

user_data :

Property Details

The "allow-cancel" property

  "allow-cancel"             gboolean              : Read / Write

Default value: FALSE


The "caller-active" property

  "caller-active"            gboolean              : Read / Write

Default value: FALSE


The "elapsed-time" property

  "elapsed-time"             guint                 : Read / Write

Default value: 0


The "package-id" property

  "package-id"               gchar*                : Read / Write

The full package_id, e.g. 'gnome-power-manager;0.1.2;i386;fedora'.

Default value: NULL


The "percentage" property

  "percentage"               gint                  : Read / Write

Allowed values: >= -1

Default value: -1


The "remaining-time" property

  "remaining-time"           guint                 : Read / Write

Default value: 0


The "role" property

  "role"                     guint                 : Read / Write

Allowed values: <= 35

Default value: 0


The "speed" property

  "speed"                    guint                 : Read / Write

Default value: 0


The "status" property

  "status"                   guint                 : Read / Write

Allowed values: <= 37

Default value: 0


The "subpercentage" property

  "subpercentage"            gint                  : Read / Write

Allowed values: >= -1

Default value: -1


The "transaction-id" property

  "transaction-id"           gchar*                : Read / Write

The transaction_id, e.g. '/892_deabbbdb_data'.

Default value: NULL


The "uid" property

  "uid"                      guint                 : Read / Write

Default value: 0