EActivity

EActivity

Synopsis

struct              EActivity;
EActivity *         e_activity_new                      (void);
gchar *             e_activity_describe                 (EActivity *activity);
EAlertSink *        e_activity_get_alert_sink           (EActivity *activity);
void                e_activity_set_alert_sink           (EActivity *activity,
                                                         EAlertSink *alert_sink);
GCancellable *      e_activity_get_cancellable          (EActivity *activity);
void                e_activity_set_cancellable          (EActivity *activity,
                                                         GCancellable *cancellable);
const gchar *       e_activity_get_icon_name            (EActivity *activity);
void                e_activity_set_icon_name            (EActivity *activity,
                                                         const gchar *icon_name);
gdouble             e_activity_get_percent              (EActivity *activity);
void                e_activity_set_percent              (EActivity *activity,
                                                         gdouble percent);
enum                EActivityState;
EActivityState      e_activity_get_state                (EActivity *activity);
void                e_activity_set_state                (EActivity *activity,
                                                         EActivityState state);
const gchar *       e_activity_get_text                 (EActivity *activity);
void                e_activity_set_text                 (EActivity *activity,
                                                         const gchar *text);
gboolean            e_activity_handle_cancellation      (EActivity *activity,
                                                         const GError *error);

Object Hierarchy

  GObject
   +----EActivity

Properties

  "alert-sink"               EAlertSink*           : Read / Write / Construct
  "cancellable"              GCancellable*         : Read / Write / Construct
  "icon-name"                gchar*                : Read / Write / Construct
  "percent"                  gdouble               : Read / Write / Construct
  "state"                    EActivityState        : Read / Write / Construct
  "text"                     gchar*                : Read / Write / Construct

Description

Details

struct EActivity

struct EActivity;

e_activity_new ()

EActivity *         e_activity_new                      (void);

e_activity_describe ()

gchar *             e_activity_describe                 (EActivity *activity);

e_activity_get_alert_sink ()

EAlertSink *        e_activity_get_alert_sink           (EActivity *activity);

e_activity_set_alert_sink ()

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

e_activity_get_cancellable ()

GCancellable *      e_activity_get_cancellable          (EActivity *activity);

e_activity_set_cancellable ()

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

e_activity_get_icon_name ()

const gchar *       e_activity_get_icon_name            (EActivity *activity);

e_activity_set_icon_name ()

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

e_activity_get_percent ()

gdouble             e_activity_get_percent              (EActivity *activity);

e_activity_set_percent ()

void                e_activity_set_percent              (EActivity *activity,
                                                         gdouble percent);

enum EActivityState

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

Various states of an EActivity.

E_ACTIVITY_RUNNING

The EActivity is running.

E_ACTIVITY_WAITING

The EActivity is waiting to be run.

E_ACTIVITY_CANCELLED

The EActivity has been cancelled.

E_ACTIVITY_COMPLETED

The EActivity has completed.

e_activity_get_state ()

EActivityState      e_activity_get_state                (EActivity *activity);

e_activity_set_state ()

void                e_activity_set_state                (EActivity *activity,
                                                         EActivityState state);

e_activity_get_text ()

const gchar *       e_activity_get_text                 (EActivity *activity);

e_activity_set_text ()

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

e_activity_handle_cancellation ()

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

Property Details

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