brasero-status

brasero-status

Synopsis

                    BraseroStatus;
enum                BraseroStatusType;
BraseroStatus *     brasero_status_new                  (void);
void                brasero_status_free                 (BraseroStatus *status);
BraseroBurnResult   brasero_status_get_result           (BraseroStatus *status);
gdouble             brasero_status_get_progress         (BraseroStatus *status);
GError *            brasero_status_get_error            (BraseroStatus *status);
gchar *             brasero_status_get_current_action   (BraseroStatus *status);
void                brasero_status_set_completed        (BraseroStatus *status);
void                brasero_status_set_not_ready        (BraseroStatus *status,
                                                         gdouble progress,
                                                         const gchar *current_action);
void                brasero_status_set_error            (BraseroStatus *status,
                                                         GError *error);

Description

Details

BraseroStatus

typedef struct _BraseroStatus BraseroStatus;


enum BraseroStatusType

typedef enum {
	BRASERO_STATUS_OK			= 0,
	BRASERO_STATUS_ERROR,
	BRASERO_STATUS_QUESTION,
	BRASERO_STATUS_INFORMATION
} BraseroStatusType;


brasero_status_new ()

BraseroStatus *     brasero_status_new                  (void);

Creates a new BraseroStatus structure. Free it with brasero_status_free().

Returns :

a BraseroStatus pointer.

brasero_status_free ()

void                brasero_status_free                 (BraseroStatus *status);

Frees BraseroStatus structure.

status :

a BraseroStatus.

brasero_status_get_result ()

BraseroBurnResult   brasero_status_get_result           (BraseroStatus *status);

After an object (see brasero_burn_track_get_status()) has been requested its status, this function returns that status.

status :

a BraseroStatus.

Returns :

a BraseroBurnResult. BRASERO_BURN_OK if the object is ready. BRASERO_BURN_NOT_READY if some time should be given to the object before it is ready. BRASERO_BURN_ERR if there is an error.

brasero_status_get_progress ()

gdouble             brasero_status_get_progress         (BraseroStatus *status);

If brasero_status_get_result() returned BRASERO_BURN_NOT_READY, this function returns the progress regarding the operation completion.

status :

a BraseroStatus.

Returns :

a gdouble

brasero_status_get_error ()

GError *            brasero_status_get_error            (BraseroStatus *status);

If brasero_status_get_result() returned BRASERO_BURN_ERR, this function returns the error.

status :

a BraseroStatus.

Returns :

a GError

brasero_status_get_current_action ()

gchar *             brasero_status_get_current_action   (BraseroStatus *status);

If brasero_status_get_result() returned BRASERO_BURN_NOT_READY, this function returns a string describing the operation currently performed. Free the string when it is not needed anymore.

status :

a BraseroStatus.

Returns :

a gchar.

brasero_status_set_completed ()

void                brasero_status_set_completed        (BraseroStatus *status);

Sets the status for a request to BRASERO_BURN_OK.

status :

a BraseroStatus.

brasero_status_set_not_ready ()

void                brasero_status_set_not_ready        (BraseroStatus *status,
                                                         gdouble progress,
                                                         const gchar *current_action);

Sets the status for a request to BRASERO_BURN_NOT_READY. Allows to set a string describing the operation currently performed as well as the progress regarding the operation completion.

status :

a BraseroStatus.

progress :

a gdouble or -1.0.

current_action :

a gchar or NULL.

brasero_status_set_error ()

void                brasero_status_set_error            (BraseroStatus *status,
                                                         GError *error);

Sets the status for a request to BRASERO_BURN_ERR.

status :

a BraseroStatus.

error :

a GError or NULL.