struct EActivity

struct EActivity;

e_activity_new ()

EActivity *         e_activity_new                      (void);

Creates a new EActivity.

e_activity_cancel ()

void                e_activity_cancel                   (EActivity *activity);

Convenience function cancels activity's "cancellable".

e_activity_describe ()

gchar *             e_activity_describe                 (EActivity *activity);

Returns a description of the current state of the activity based on the "text", "percent" and "state" properties. Suitable for displaying in a status bar or similar widget.

Free the returned string with g_free() when finished with it.

e_activity_get_alert_sink ()

EAlertSink *        e_activity_get_alert_sink           (EActivity *activity);

Returns the EAlertSink for activity, if one was provided.

The "alert-sink" property is convenient for when the user should be alerted about a failed asynchronous operation. Generally an "alert-sink" is set prior to dispatching the operation, and retrieved by a callback function when the operation completes.

e_activity_set_alert_sink ()

void                e_activity_set_alert_sink           (EActivity *activity,
                                                         EAlertSink *alert_sink);

Sets (or clears) the EAlertSink for activity.

The "alert-sink" property is convenient for when the user should be alerted about a failed asynchronous operation. Generally an "alert-sink" is set prior to dispatching the operation, and retrieved by a callback function when the operation completes.

e_activity_get_cancellable ()

GCancellable *      e_activity_get_cancellable          (EActivity *activity);

Returns the GCancellable for activity, if one was provided.

Generally the activity's "cancellable" property holds the same GCancellable instance passed to a cancellable function, so widgets like EActivityBar can bind the GCancellable to a cancel button.

e_activity_set_cancellable ()

void                e_activity_set_cancellable          (EActivity *activity,
                                                         GCancellable *cancellable);

Sets (or clears) the GCancellable for activity.

Generally the activity's "cancellable" property holds the same GCancellable instance passed to a cancellable function, so widgets like EActivityBar can bind the GCancellable to a cancel button.

e_activity_get_icon_name ()

const gchar *       e_activity_get_icon_name            (EActivity *activity);

Returns the themed icon name for activity, if one was provided.

Generally widgets like EActivityBar will honor the "icon-name" property while the activity's "state" is E_ACTIVITY_RUNNING or E_ACTIVITY_WAITING, but will override the icon for E_ACTIVITY_CANCELLED and E_ACTIVITY_COMPLETED.

e_activity_set_icon_name ()

void                e_activity_set_icon_name            (EActivity *activity,
                                                         const gchar *icon_name);

Sets (or clears) the themed icon name for activity.

Generally widgets like EActivityBar will honor the "icon-name" property while the activity's "state" is E_ACTIVITY_RUNNING or E_ACTIVITY_WAITING, but will override the icon for E_ACTIVITY_CANCELLED and E_ACTIVITY_COMPLETED.

e_activity_get_percent ()

gdouble             e_activity_get_percent              (EActivity *activity);

Returns the percent complete for activity as a value between 0 and 100, or a negative value if the percent complete is unknown.

Generally widgets like EActivityBar will display the percent complete by way of e_activity_describe(), but only if the value is between 0 and 100.

e_activity_set_percent ()

void                e_activity_set_percent              (EActivity *activity,
                                                         gdouble percent);

Sets the percent complete for activity. The value should be between 0 and 100, or negative if the percent complete is unknown.

Generally widgets like EActivityBar will display the percent complete by way of e_activity_describe(), but only if the value is between 0 and 100.

enum EActivityState

typedef enum {
	E_ACTIVITY_RUNNING,
	E_ACTIVITY_WAITING,
	E_ACTIVITY_CANCELLED,
	E_ACTIVITY_COMPLETED
} EActivityState;

Various states of an EActivity.

e_activity_get_state ()

EActivityState      e_activity_get_state                (EActivity *activity);

Returns the state of activity.

Generally widgets like EActivityBar will display the activity state by way of e_activity_describe() and possibly an icon. The activity state is E_ACTIVITY_RUNNING by default, and is usually only changed once when the associated operation is finished.

e_activity_set_state ()

void                e_activity_set_state                (EActivity *activity,
                                                         EActivityState state);

Sets the state of activity.

Generally widgets like EActivityBar will display the activity state by way of e_activity_describe() and possibly an icon. The activity state is E_ACTIVITY_RUNNING by default, and is usually only changed once when the associated operation is finished.

e_activity_get_text ()

const gchar *       e_activity_get_text                 (EActivity *activity);

Returns a message describing what activity is doing.

Generally widgets like EActivityBar will display the message by way of e_activity_describe().

e_activity_set_text ()

void                e_activity_set_text                 (EActivity *activity,
                                                         const gchar *text);

Sets (or clears) a message describing what activity is doing.

Generally widgets like EActivityBar will display the message by way of e_activity_describe().

e_activity_handle_cancellation ()

gboolean            e_activity_handle_cancellation      (EActivity *activity,
                                                         const GError *error);

Convenience function sets activity's "state" to E_ACTIVITY_CANCELLED if error is G_IO_ERROR_CANCELLED.

The "alert-sink" property

  "alert-sink"               EAlertSink*           : Read / Write / Construct

The "cancellable" property

  "cancellable"              GCancellable*         : Read / Write / Construct

The "icon-name" property

  "icon-name"                gchar*                : Read / Write / Construct

Default value: NULL

The "percent" property

  "percent"                  gdouble               : Read / Write / Construct

Default value: -1

The "state" property

  "state"                    EActivityState        : Read / Write / Construct

Default value: E_ACTIVITY_RUNNING

The "text" property

  "text"                     gchar*                : Read / Write / Construct

Default value: NULL