PkProgress

PkProgress — Transaction progress information

Synopsis

#define             PK_PROGRESS_TYPE_ERROR
struct              PkProgress;
struct              PkProgressClass;
PkProgress *        pk_progress_new                     (void);
void                pk_progress_test                    (gpointer user_data);
enum                PkProgressType;
void                (*PkProgressCallback)               (PkProgress *progress,
                                                         PkProgressType type,
                                                         gpointer user_data);
gboolean            pk_progress_set_package_id          (PkProgress *progress,
                                                         const gchar *package_id);
gboolean            pk_progress_set_transaction_id      (PkProgress *progress,
                                                         const gchar *package_id);
gboolean            pk_progress_set_percentage          (PkProgress *progress,
                                                         gint percentage);
gboolean            pk_progress_set_subpercentage       (PkProgress *progress,
                                                         gint subpercentage);
gboolean            pk_progress_set_status              (PkProgress *progress,
                                                         PkStatusEnum status);
gboolean            pk_progress_set_role                (PkProgress *progress,
                                                         PkRoleEnum role);
gboolean            pk_progress_set_allow_cancel        (PkProgress *progress,
                                                         gboolean allow_cancel);
gboolean            pk_progress_set_caller_active       (PkProgress *progress,
                                                         gboolean caller_active);
gboolean            pk_progress_set_elapsed_time        (PkProgress *progress,
                                                         guint elapsed_time);
gboolean            pk_progress_set_remaining_time      (PkProgress *progress,
                                                         guint remaining_time);
gboolean            pk_progress_set_speed               (PkProgress *progress,
                                                         guint speed);
gboolean            pk_progress_set_uid                 (PkProgress *progress,
                                                         guint uid);
gboolean            pk_progress_set_package             (PkProgress *progress,
                                                         PkPackage *package);
                    PkProgressPrivate;

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_TYPE_ERROR

#define PK_PROGRESS_TYPE_ERROR		(pk_progress_error_get_type ())


struct PkProgress

struct PkProgress {
	 GObject		 parent;
	 PkProgressPrivate *priv;
};


struct PkProgressClass

struct PkProgressClass {
	GObjectClass parent_class;
	/* padding for future expansion */
	void (*_pk_reserved1) (void);
	void (*_pk_reserved2) (void);
	void (*_pk_reserved3) (void);
	void (*_pk_reserved4) (void);
	void (*_pk_reserved5) (void);
};


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

Since 0.5.2


pk_progress_test ()

void                pk_progress_test                    (gpointer user_data);


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_PACKAGE,
	PK_PROGRESS_TYPE_INVALID
} PkProgressType;


PkProgressCallback ()

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


pk_progress_set_package_id ()

gboolean            pk_progress_set_package_id          (PkProgress *progress,
                                                         const gchar *package_id);

progress :

a valid PkProgress instance

Since 0.5.2


pk_progress_set_transaction_id ()

gboolean            pk_progress_set_transaction_id      (PkProgress *progress,
                                                         const gchar *package_id);

progress :

a valid PkProgress instance

Since 0.5.3


pk_progress_set_percentage ()

gboolean            pk_progress_set_percentage          (PkProgress *progress,
                                                         gint percentage);

Since 0.5.2


pk_progress_set_subpercentage ()

gboolean            pk_progress_set_subpercentage       (PkProgress *progress,
                                                         gint subpercentage);

Since 0.5.2


pk_progress_set_status ()

gboolean            pk_progress_set_status              (PkProgress *progress,
                                                         PkStatusEnum status);

Since 0.5.2


pk_progress_set_role ()

gboolean            pk_progress_set_role                (PkProgress *progress,
                                                         PkRoleEnum role);

Since 0.5.2


pk_progress_set_allow_cancel ()

gboolean            pk_progress_set_allow_cancel        (PkProgress *progress,
                                                         gboolean allow_cancel);

Since 0.5.2


pk_progress_set_caller_active ()

gboolean            pk_progress_set_caller_active       (PkProgress *progress,
                                                         gboolean caller_active);

Since 0.5.2


pk_progress_set_elapsed_time ()

gboolean            pk_progress_set_elapsed_time        (PkProgress *progress,
                                                         guint elapsed_time);

Since 0.5.2


pk_progress_set_remaining_time ()

gboolean            pk_progress_set_remaining_time      (PkProgress *progress,
                                                         guint remaining_time);

Since 0.5.2


pk_progress_set_speed ()

gboolean            pk_progress_set_speed               (PkProgress *progress,
                                                         guint speed);

Since 0.5.2


pk_progress_set_uid ()

gboolean            pk_progress_set_uid                 (PkProgress *progress,
                                                         guint uid);

Since 0.5.2


pk_progress_set_package ()

gboolean            pk_progress_set_package             (PkProgress *progress,
                                                         PkPackage *package);

Since 0.5.2


PkProgressPrivate

typedef struct _PkProgressPrivate PkProgressPrivate;

Private PkProgress data