Top | ![]() |
![]() |
![]() |
![]() |
|
e_activity_new () |
|
e_activity_cancel () |
|
e_activity_describe () |
|
e_activity_get_alert_sink () |
|
e_activity_set_alert_sink () |
|
e_activity_get_cancellable () |
|
e_activity_set_cancellable () |
const |
e_activity_get_icon_name () |
|
e_activity_set_icon_name () |
|
e_activity_get_percent () |
|
e_activity_set_percent () |
EActivityState | e_activity_get_state () |
|
e_activity_set_state () |
const |
e_activity_get_text () |
|
e_activity_set_text () |
const |
e_activity_get_last_known_text () |
|
e_activity_handle_cancellation () |
void e_activity_cancel ();
EActivity *activity
Convenience function cancels activity
's
activity
's E_ACTIVITY_CANCELLED
. It merely requests that the associated
operation be cancelled. Only after the operation finishes with
a G_IO_ERROR_CANCELLED
should the activity
's e_activity_handle_cancellation()
). During this
interim period e_activity_describe()
will indicate the activity
is "cancelling".
gchar * e_activity_describe ();
EActivity *activity
Returns a description of the current state of the activity
based on
the
Free the returned string with g_free()
EAlertSink * e_activity_get_alert_sink ();
EActivity *activity
Returns the activity
, if one was provided.
The
void e_activity_set_alert_sink (,
EActivity *activity);
EAlertSink *alert_sink
Sets (or clears) the activity
.
The
GCancellable * e_activity_get_cancellable ();
EActivity *activity
Returns the activity
, if one was provided.
Generally the activity
's
void e_activity_set_cancellable (,
EActivity *activity);
GCancellable *cancellable
Sets (or clears) the activity
.
Generally the activity
's
constgchar * e_activity_get_icon_name ();
EActivity *activity
Returns the themed icon name for activity
, if one was provided.
Generally widgets like activity
's E_ACTIVITY_RUNNING
or
E_ACTIVITY_WAITING
, but will override the icon for E_ACTIVITY_CANCELLED
and E_ACTIVITY_COMPLETED
.
void e_activity_set_icon_name (,
EActivity *activityconst
);gchar *icon_name
Sets (or clears) the themed icon name for activity
.
Generally widgets like activity
's E_ACTIVITY_RUNNING
or
E_ACTIVITY_WAITING
, but will override the icon for E_ACTIVITY_CANCELLED
and E_ACTIVITY_COMPLETED
.
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 e_activity_describe()
, but only if the value is between 0 and 100.
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 e_activity_describe()
, but only if the value is between 0 and 100.
EActivityState
e_activity_get_state (EActivity *activity
);
Returns the state of activity
.
Generally widgets like 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.
void e_activity_set_state (,
EActivity *activityEActivityState state
);
Sets the state of activity
.
Generally widgets like 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.
constgchar * e_activity_get_text ();
EActivity *activity
Returns a message describing what activity
is doing.
Generally widgets like e_activity_describe()
.
void e_activity_set_text (,
EActivity *activityconst
);gchar *text
Sets (or clears) a message describing what activity
is doing.
Generally widgets like e_activity_describe()
.
constgchar * e_activity_get_last_known_text ();
EActivity *activity
Returns the last non-empty activity
was doing even if it
currently has no description.
Mostly useful for debugging.